fix(json-api-nestjs): Fix circular type for query obkect

klerick · klerick · commit e492cd186c97 · 2025-02-12T05:38:21.000+01:00
diff --git a/apps/json-api-server/src/app/app.module.ts b/apps/json-api-server/src/app/app.module.ts
@@ -3,7 +3,8 @@ import { LoggerModule } from 'nestjs-pino';
 
 import { TypeOrmDatabaseModule } from '@nestjs-json-api/typeorm-database';
 import { MicroOrmDatabaseModule } from '@nestjs-json-api/microorm-database';
-import { ResourcesModule } from './resources/resources.module';
+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';
 
@@ -12,10 +13,15 @@ const ormModule =
     ? TypeOrmDatabaseModule
     : MicroOrmDatabaseModule;
 
+const resourceModule =
+  process.env['ORM_TYPE'] === 'typeorm'
+    ? ResourcesTypeModule
+    : ResourcesMicroModule;
+
 @Module({
   imports: [
     ormModule,
-    ResourcesModule,
+    resourceModule,
     RpcModule,
     LoggerModule.forRoot({
       pinoHttp: {
diff --git a/apps/json-api-server/src/app/resources/controllers/entity-orm.ts b/apps/json-api-server/src/app/resources/controllers/entity-orm.ts
diff --git a/apps/json-api-server/src/app/resources/resources.module.ts b/apps/json-api-server/src/app/resources/resources.module.ts
diff --git a/libs/json-api/json-api-nestjs/project.json b/libs/json-api/json-api-nestjs/project.json
@@ -15,13 +15,34 @@
   "targets": {
     "build": {
       "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{options.outputPath}"
+      ],
       "options": {
         "outputPath": "dist/libs/json-api/json-api-nestjs",
         "tsConfig": "libs/json-api/json-api-nestjs/tsconfig.lib.json",
         "packageJson": "libs/json-api/json-api-nestjs/package.json",
         "main": "libs/json-api/json-api-nestjs/src/index.ts",
-        "assets": ["libs/json-api/json-api-nestjs/*.md"],
+        "assets": [
+          "libs/json-api/json-api-nestjs/*.md"
+        ],
+        "buildableProjectDepsInPackageJsonType": "peerDependencies",
+        "generateExportsField": true
+      }
+    },
+    "build-npm": {
+      "executor": "@nx/js:tsc",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "outputPath": "node_modules/@klerick/json-api-nestjs",
+        "tsConfig": "libs/json-api/json-api-nestjs/tsconfig.lib.json",
+        "packageJson": "libs/json-api/json-api-nestjs/package.json",
+        "main": "libs/json-api/json-api-nestjs/src/index.ts",
+        "assets": [
+          "libs/json-api/json-api-nestjs/*.md"
+        ],
         "buildableProjectDepsInPackageJsonType": "peerDependencies",
         "generateExportsField": true
       }
@@ -33,15 +54,21 @@
     },
     "publish": {
       "command": "node tools/scripts/publish.mjs json-api-nestjs {args.ver} {args.tag}",
-      "dependsOn": ["build"]
+      "dependsOn": [
+        "build"
+      ]
     },
     "test": {
       "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "outputs": [
+        "{workspaceRoot}/coverage/{projectRoot}"
+      ],
       "options": {
         "jestConfig": "libs/json-api/json-api-nestjs/jest.config.ts",
         "codeCoverage": true,
-        "coverageReporters": ["json-summary"]
+        "coverageReporters": [
+          "json-summary"
+        ]
       }
     },
     "upload-badge": {
@@ -52,7 +79,9 @@
         }
       ],
       "options": {
-        "commands": ["node tools/scripts/upload-badge.mjs json-api-nestjs"],
+        "commands": [
+          "node tools/scripts/upload-badge.mjs json-api-nestjs"
+        ],
         "cwd": "./",
         "parallel": false,
         "outputPath": "{workspaceRoot}/libs/json-api/json-api-nestjs"
diff --git a/libs/json-api/json-api-nestjs/src/index.ts b/libs/json-api/json-api-nestjs/src/index.ts
@@ -10,6 +10,7 @@ export {
   PostData,
   PostRelationshipData,
   PatchRelationshipData,
+  QueryOne,
 } from './lib/modules/mixin/zod';
 
 export {
diff --git a/libs/json-api/json-api-nestjs/src/lib/mock-utils/microrom/index.ts b/libs/json-api/json-api-nestjs/src/lib/mock-utils/microrom/index.ts
@@ -1,4 +1,3 @@
-import { DynamicModule } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import { MikroOrmModule } from '@mikro-orm/nestjs';
 import { EntityManager, MikroORM } from '@mikro-orm/core';
diff --git a/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/fields.ts b/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/fields.ts
@@ -20,6 +20,10 @@ type ZodRule<K extends readonly [string, ...string[]]> = ReturnType<
   typeof getZodRules<K>
 >;
 
+type TargetRelationShape<E extends ObjectLiteral> = {
+  [K in keyof RelationTree<E>]: ZodRule<RelationTree<E>[K]>;
+};
+
 export function zodFieldsQuery<E extends ObjectLiteral>(
   fields: ResultGetField<E>['field'],
   relationList: RelationTree<E>
@@ -28,9 +32,7 @@ export function zodFieldsQuery<E extends ObjectLiteral>(
     target: getZodRules(fields),
   };
 
-  const relation = {} as {
-    [K in keyof RelationTree<E>]: ZodRule<RelationTree<E>[K]>;
-  };
+  const relation = {} as TargetRelationShape<E>;
 
   for (const [key, value] of ObjectTyped.entries(relationList)) {
     relation[key] = getZodRules(value);
diff --git a/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/filter.ts b/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/filter.ts
@@ -163,6 +163,10 @@ type RelationFilterProps<E extends ObjectLiteral> = {
   [R in keyof RelationTree<E>]: ZodRulesForRelationShape<TypeOfArray<E[R]>>;
 };
 
+type TargetRelationShape<E extends ObjectLiteral> = {
+  [K in ResultGetField<E>['relations'][number]]: ZodOptional<ZodRuleFilterRelationSchema>;
+};
+
 export function zodFilterQuery<E extends ObjectLiteral>(
   fields: ResultGetField<E>['field'],
   relationTree: RelationTree<E>,
@@ -182,9 +186,7 @@ export function zodFilterQuery<E extends ObjectLiteral>(
       ...acum,
       [item]: zodRuleFilterRelationSchema.optional(),
     }),
-    {} as {
-      [K in ResultGetField<E>['relations'][number]]: ZodOptional<ZodRuleFilterRelationSchema>;
-    }
+    {} as TargetRelationShape<E>
   );
 
   const relationFilterProps = ObjectTyped.keys(relationTree).reduce(
diff --git a/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/index.ts b/libs/json-api/json-api-nestjs/src/lib/modules/mixin/zod/zod-query-schema/index.ts
@@ -81,7 +81,7 @@ function zodQueryOne<E extends ObjectLiteral>(
   entityRelationStructure: RelationTree<E>,
   propsArray: ArrayPropsForEntity<E>,
   propsType: AllFieldWithType<E>
-) {
+): ZodObject<Pick<Shape<E>, QueryField.fields | QueryField.include>, 'strict'> {
   return z
     .object({
       [QueryField.fields]: zodFieldsQuery(

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import { DynamicModule } from '@nestjs/common';`
`2`	`1`	`import { Test, TestingModule } from '@nestjs/testing';`
`3`	`2`	`import { MikroOrmModule } from '@mikro-orm/nestjs';`
`4`	`3`	`import { EntityManager, MikroORM } from '@mikro-orm/core';`