feat(json-api-server): Use new signature

klerick · klerick · commit 7054e93d8a8a · 2025-02-27T07:38:49.000+01:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -19,6 +19,12 @@
         ]
       }
     },
+    {
+      "files": ["*.test-d.ts"],
+      "rules": {
+        "@typescript-eslint/ban-ts-comment": "off"
+      }
+    },
     {
       "files": ["*.ts", "*.tsx"],
       "rules": {}
diff --git a/apps/json-api-server/project.json b/apps/json-api-server/project.json
@@ -20,5 +20,6 @@
       }
     }
   },
-  "tags": []
+  "tags": [],
+  "implicitDependencies": ["json-api-nestjs-typeorm", "json-api-nestjs-microorm"]
 }
diff --git a/apps/json-api-server/src/app/app.module.ts b/apps/json-api-server/src/app/app.module.ts
@@ -6,7 +6,6 @@ import { MicroOrmDatabaseModule } from '@nestjs-json-api/microorm-database';
 import { ResourcesTypeModule } from './resources/type-orm/resources-type.module';
 import { ResourcesMicroModule } from './resources/micro-orm/resources-micro.module';
 import { RpcModule } from './rpc/rpc.module';
-import * as process from 'process';
 
 const ormModule =
   process.env['ORM_TYPE'] === 'typeorm'
diff --git a/apps/json-api-server/src/app/resources/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts b/apps/json-api-server/src/app/resources/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts
@@ -1,10 +1,13 @@
 import { ParseUUIDPipe } from '@nestjs/common';
 import { JsonApi, JsonBaseController } from '@klerick/json-api-nestjs';
-
 import { BookList } from '@nestjs-json-api/microorm-database';
+
 @JsonApi(BookList, {
   pipeForId: ParseUUIDPipe,
   overrideRoute: 'override-book-list',
   allowMethod: ['getOne', 'postOne', 'deleteOne'],
 })
-export class ExtendBookListController extends JsonBaseController<BookList> {}
+export class ExtendBookListController extends JsonBaseController<
+  BookList,
+  'id'
+> {}
diff --git a/apps/json-api-server/src/app/resources/micro-orm/controllers/extend-user/extend-user.controller.ts b/apps/json-api-server/src/app/resources/micro-orm/controllers/extend-user/extend-user.controller.ts
@@ -15,12 +15,14 @@ import {
   JsonApiService,
   Query as QueryType,
   QueryOne,
-  ResourceObject,
-  EntityRelation,
   PatchRelationshipData,
-  ResourceObjectRelationships,
   PostData,
 } from '@klerick/json-api-nestjs';
+import {
+  ResourceObjectRelationships,
+  ResourceObject,
+  RelationKeys,
+} from '@klerick/json-api-nestjs-shared';
 import { ExamplePipe } from '../../service/example.pipe';
 import { ExampleService } from '../../service/example.service';
 import { ControllerInterceptor } from '../../service/controller.interceptor';
@@ -38,36 +40,36 @@ import { AtomicInterceptor } from '../../service/atomic.interceptor';
 @UseFilters(new HttpExceptionFilter())
 @UseInterceptors(ControllerInterceptor)
 @JsonApi(Users)
-export class ExtendUserController extends JsonBaseController<Users> {
+export class ExtendUserController extends JsonBaseController<Users, 'id'> {
   @InjectService() public service: JsonApiService<Users>;
   @Inject(ExampleService) protected exampleService: ExampleService;
   override getOne(
     id: string | number,
-    query: QueryOne<Users>
+    query: QueryOne<Users, 'id'>
   ): Promise<ResourceObject<Users>> {
     const t = query.fields?.target;
 
     return super.getOne(id, query);
   }
 
-  patchRelationship<Rel extends EntityRelation<Users>>(
+  patchRelationship<Rel extends RelationKeys<Users>>(
     id: string | number,
     relName: Rel,
     input: PatchRelationshipData
-  ): Promise<ResourceObjectRelationships<Users, Rel>> {
+  ): Promise<ResourceObjectRelationships<Users, 'id', Rel>> {
     return super.patchRelationship(id, relName, input);
   }
 
   // @UseInterceptors(AtomicInterceptor)
-  postOne(inputData: PostData<Users>): Promise<ResourceObject<Users>> {
+  postOne(inputData: PostData<Users, 'id'>): Promise<ResourceObject<Users>> {
     return super.postOne(inputData);
   }
 
   @EntityName('Users')
   @UseFilters(HttpExceptionMethodFilter)
   @UseInterceptors(MethodInterceptor)
   getAll(
-    @Query(ExamplePipe) query: QueryType<Users>
+    @Query(ExamplePipe) query: QueryType<Users, 'id'>
   ): Promise<ResourceObject<Users, 'array'>> {
     return super.getAll(query);
   }
diff --git a/apps/json-api-server/src/app/resources/micro-orm/resources-micro.module.ts b/apps/json-api-server/src/app/resources/micro-orm/resources-micro.module.ts
@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
-import { JsonApiModule, MicroOrmJsonApiModule } from '@klerick/json-api-nestjs';
+import { JsonApiModule } from '@klerick/json-api-nestjs';
+import { MicroOrmJsonApiModule } from '@klerick/json-api-nestjs-microorm';
 import {
   Users,
   Addresses,
diff --git a/apps/json-api-server/src/app/resources/micro-orm/service/example.pipe.ts b/apps/json-api-server/src/app/resources/micro-orm/service/example.pipe.ts
@@ -7,8 +7,13 @@ import {
 import { Query } from '@klerick/json-api-nestjs';
 import { Users } from '@nestjs-json-api/microorm-database';
 
-export class ExamplePipe implements PipeTransform<Query<Users>, Query<Users>> {
-  transform(value: Query<Users>, metadata: ArgumentMetadata): Query<Users> {
+export class ExamplePipe
+  implements PipeTransform<Query<Users, 'id'>, Query<Users, 'id'>>
+{
+  transform(
+    value: Query<Users, 'id'>,
+    metadata: ArgumentMetadata
+  ): Query<Users, 'id'> {
     if (value.filter.target?.firstName?.eq === 'testCustomPipe') {
       const error = {
         code: 'invalid_arguments',
diff --git a/apps/json-api-server/src/app/resources/type-orm/controllers/extend-book-list/extend-book-list.controller.ts b/apps/json-api-server/src/app/resources/type-orm/controllers/extend-book-list/extend-book-list.controller.ts
@@ -1,10 +1,13 @@
 import { ParseUUIDPipe } from '@nestjs/common';
 import { JsonApi, JsonBaseController } from '@klerick/json-api-nestjs';
-
 import { BookList } from '@nestjs-json-api/typeorm-database';
+
 @JsonApi(BookList, {
   pipeForId: ParseUUIDPipe,
   overrideRoute: 'override-book-list',
   allowMethod: ['getOne', 'postOne', 'deleteOne'],
 })
-export class ExtendBookListController extends JsonBaseController<BookList> {}
+export class ExtendBookListController extends JsonBaseController<
+  BookList,
+  'id'
+> {}
diff --git a/apps/json-api-server/src/app/resources/type-orm/controllers/extend-user/extend-user.controller.ts b/apps/json-api-server/src/app/resources/type-orm/controllers/extend-user/extend-user.controller.ts
@@ -15,12 +15,14 @@ import {
   JsonApiService,
   Query as QueryType,
   QueryOne,
-  ResourceObject,
-  EntityRelation,
   PatchRelationshipData,
-  ResourceObjectRelationships,
   PostData,
 } from '@klerick/json-api-nestjs';
+import {
+  ResourceObjectRelationships,
+  ResourceObject,
+  RelationKeys,
+} from '@klerick/json-api-nestjs-shared';
 import { ExamplePipe } from '../../service/example.pipe';
 import { ExampleService } from '../../service/example.service';
 import { ControllerInterceptor } from '../../service/controller.interceptor';
@@ -38,34 +40,34 @@ import { AtomicInterceptor } from '../../service/atomic.interceptor';
 @UseFilters(new HttpExceptionFilter())
 @UseInterceptors(ControllerInterceptor)
 @JsonApi(Users)
-export class ExtendUserController extends JsonBaseController<Users> {
+export class ExtendUserController extends JsonBaseController<Users, 'id'> {
   @InjectService() public service: JsonApiService<Users>;
   @Inject(ExampleService) protected exampleService: ExampleService;
   override getOne(
     id: string | number,
-    query: QueryOne<Users>
+    query: QueryOne<Users, 'id'>
   ): Promise<ResourceObject<Users>> {
     return super.getOne(id, query);
   }
 
-  patchRelationship<Rel extends EntityRelation<Users>>(
+  patchRelationship<Rel extends RelationKeys<Users>>(
     id: string | number,
     relName: Rel,
     input: PatchRelationshipData
-  ): Promise<ResourceObjectRelationships<Users, Rel>> {
+  ): Promise<ResourceObjectRelationships<Users, 'id', Rel>> {
     return super.patchRelationship(id, relName, input);
   }
 
   // @UseInterceptors(AtomicInterceptor)
-  postOne(inputData: PostData<Users>): Promise<ResourceObject<Users>> {
+  postOne(inputData: PostData<Users, 'id'>): Promise<ResourceObject<Users>> {
     return super.postOne(inputData);
   }
 
   @EntityName('Users')
   @UseFilters(HttpExceptionMethodFilter)
   @UseInterceptors(MethodInterceptor)
   getAll(
-    @Query(ExamplePipe) query: QueryType<Users>
+    @Query(ExamplePipe) query: QueryType<Users, 'id'>
   ): Promise<ResourceObject<Users, 'array'>> {
     return super.getAll(query);
   }
diff --git a/apps/json-api-server/src/app/resources/type-orm/resources-type.module.ts b/apps/json-api-server/src/app/resources/type-orm/resources-type.module.ts
@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
-import { JsonApiModule, TypeOrmJsonApiModule } from '@klerick/json-api-nestjs';
+import { JsonApiModule } from '@klerick/json-api-nestjs';
+import { TypeOrmJsonApiModule } from '@klerick/json-api-nestjs-typeorm';
 import {
   Users,
   Addresses,
diff --git a/apps/json-api-server/src/app/resources/type-orm/service/example.pipe.ts b/apps/json-api-server/src/app/resources/type-orm/service/example.pipe.ts
@@ -7,8 +7,13 @@ import {
 import { Query } from '@klerick/json-api-nestjs';
 import { Users } from '@nestjs-json-api/typeorm-database';
 
-export class ExamplePipe implements PipeTransform<Query<Users>, Query<Users>> {
-  transform(value: Query<Users>, metadata: ArgumentMetadata): Query<Users> {
+export class ExamplePipe
+  implements PipeTransform<Query<Users, 'id'>, Query<Users, 'id'>>
+{
+  transform(
+    value: Query<Users, 'id'>,
+    metadata: ArgumentMetadata
+  ): Query<Users, 'id'> {
     if (value.filter.target?.firstName?.eq === 'testCustomPipe') {
       const error = {
         code: 'invalid_arguments',
diff --git a/apps/json-api-server/src/main.ts b/apps/json-api-server/src/main.ts
@@ -9,26 +9,26 @@ import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { WsAdapter } from '@nestjs/platform-ws';
 
 import { AppModule } from './app/app.module';
+import { NestExpressApplication } from '@nestjs/platform-express';
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
+  const app = await NestFactory.create<NestExpressApplication>(AppModule);
   app.useWebSocketAdapter(new WsAdapter(app));
   const globalPrefix = 'api';
   app.setGlobalPrefix(globalPrefix);
 
   const config = new DocumentBuilder()
+    .setOpenAPIVersion('3.1.0')
     .setTitle('JSON API swagger example')
     .setDescription('The JSON API list example')
     .setVersion('1.0')
     .build();
+  app.set('query parser', 'extended');
 
   SwaggerModule.setup(
     'swagger',
     app,
-    () => ({
-      ...SwaggerModule.createDocument(app, config),
-      openapi: '3.1.0',
-    }),
+    () => SwaggerModule.createDocument(app, config),
     {}
   );
   await app.init();
diff --git a/apps/json-api-server/tsconfig.app.json b/apps/json-api-server/tsconfig.app.json
@@ -17,9 +17,11 @@
   "exclude": [
     "jest.config.ts",
     "src/**/*.spec.ts",
-    "src/**/*.test.ts"
+    "src/**/*.test.ts",
+    "**/*.test-d.ts"
   ],
   "include": [
-    "src/**/*.ts"
+    "src/**/*.ts",
+    "*.test-d.ts"
   ]
 }
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -15,17 +15,23 @@
     "skipDefaultLibCheck": true,
     "baseUrl": ".",
     "paths": {
-      "@klerick/json-api-nestjs": [
-        "libs/json-api/json-api-nestjs/src/index.ts"
-      ],
       "@klerick/json-api-nestjs-sdk": [
         "libs/json-api/json-api-nestjs-sdk/src/index.ts"
       ],
       "@klerick/json-api-nestjs-sdk/ngModule": [
         "libs/json-api/json-api-nestjs-sdk/src/ngModule.ts"
       ],
       "@klerick/json-api-nestjs-shared": [
-        "libs/json-api/json-api-nestjs-shared/src/index.ts"
+        "dist/libs/json-api/json-api-nestjs-shared"
+      ],
+      "@klerick/json-api-nestjs-typeorm": [
+        "dist/libs/json-api/json-api-nestjs-typeorm"
+      ],
+      "@klerick/json-api-nestjs": [
+        "dist/libs/json-api/json-api-nestjs"
+      ],
+      "@klerick/json-api-nestjs-microorm": [
+        "dist/libs/json-api/json-api-nestjs-microorm"
       ],
       "@klerick/nestjs-json-rpc": [
         "libs/json-rpc/nestjs-json-rpc/src/index.ts"

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,12 @@`
`19`	`19`	`]`
`20`	`20`	`}`
`21`	`21`	`},`
	`22`	`+ {`
	`23`	`+ "files": ["*.test-d.ts"],`
	`24`	`+ "rules": {`
	`25`	`+ "@typescript-eslint/ban-ts-comment": "off"`
	`26`	`+ }`
	`27`	`+ },`
`22`	`28`	`{`
`23`	`29`	`"files": [".ts", ".tsx"],`
`24`	`30`	`"rules": {}`
Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,6 @@`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`	`},`
`23`		`- "tags": []`
	`23`	`+ "tags": [],`
	`24`	`+ "implicitDependencies": ["json-api-nestjs-typeorm", "json-api-nestjs-microorm"]`
`24`	`25`	`}`