refactor(json-api-nestjs): change npm package should be in next version

Author: klerick

libs/json-api/json-api-nestjs/README.md

@@ -8,7 +8,7 @@
 
 # json-api-nestjs
 
-This plugin works upon TypeOrm library, which is used as the main database abstraction layer tool. The module
+This plugin works upon TypeOrm or MicroOrm library, which is used as the main database abstraction layer tool. The module
 automatically generates an API according to JSON API specification from the database structure (TypeORM entities). It
 supports features such as requests validation based on database fields types, request filtering, endpoints extending,
 data relations control and much more. Our module significantly reduces the development time of REST services by removing
@@ -24,15 +24,32 @@ $ npm install json-api-nestjs
 ## Example
 
 Once the installation process is complete, we can import the **JsonApiModule** into the root **AppModule**.
+### TypeOrm
+```typescript
+import {Module} from '@nestjs/common';
+import {JsonApiModule, TypeOrmJsonApiModule} from 'json-api-nestjs';
+import {Users} from 'type-orm/database';
 
+@Module({
+  imports: [
+    JsonApiModule.forRoot(TypeOrmJsonApiModule, {
+      entities: [Users]
+    }),
+  ],
+})
+export class AppModule {
+}
+```
+
+### MicroOrm
 ```typescript
 import {Module} from '@nestjs/common';
-import {JsonApiModule} from 'json-api-nestjs';
-import {Users} from 'database';
+import {JsonApiModule, MicroOrmJsonApiModule} from 'json-api-nestjs';
+import {Users} from 'micro-orm/database';
 
 @Module({
   imports: [
-    JsonApiModule.forRoot({
+    JsonApiModule.forRoot(MicroOrmJsonApiModule, {
       entities: [Users]
     }),
   ],
@@ -69,11 +86,14 @@ export interface ModuleOptions {
     debug?: boolean; // Debug info in result object, like error message
     pipeForId?: Type<PipeTransform> // Nestjs pipe for validate id params, by default ParseIntPipe
     operationUrl?: string // Url for atomic operation https://jsonapi.org/ext/atomic/
+    // TypeOrm
     useSoftDelete?: boolean // Use soft delete
     runInTransaction?: <Func extends (...args: any) => any>(
       isolationLevel: IsolationLevel,
       fn: Func
     ) => ReturnType<Func> // You can use cutom function for wrapping transaction in atomic operation, example: runInTransaction from https://github.com/Aliheym/typeorm-transactional
+    // MicroOrm
+    arrayType?: string[]; //Custom type for indicate of array
   };
 }
 ```
@@ -254,7 +274,7 @@ Available query params:
 ```typescript
 type FilterOperand
 {
-in:string[] // is equal to the conditional of query "WHERE 'attribute_name' IN ('value1', 'value2')"
+  in:string[] // is equal to the conditional of query "WHERE 'attribute_name' IN ('value1', 'value2')"
   nin: string[] // is equal to the conditional of query "WHERE 'attribute_name' NOT IN ('value1', 'value1')"
   eq: string // is equal to the conditional of query "WHERE 'attribute_name' = 'value1'
   ne: string // is equal to the conditional of query "WHERE 'attribute_name' <> 'value1'

libs/json-api/json-api-nestjs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@klerick/json-api-nestjs",
+  "name": "json-api-nestjs",
   "version": "8.0.0",
   "engines": {
     "node": ">= 16.0.0"
@@ -27,10 +27,24 @@
     "jsonapi",
     "json-api",
     "typeorm",
+    "microorm",
     "CRUD"
   ],
   "peerDependencies": {
     "reflect-metadata": "^0.1.13",
-    "tslib": "^2.3.0"
+    "tslib": "^2.3.0",
+    "@mikro-orm/core": "^6.0.0 || ^6.0.0-dev.0",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/swagger": "^7.3.0",
+    "@nestjs/typeorm": "^10.0.0",
+    "@mikro-orm/knex": "^6.0.0",
+    "typeorm": "^0.3.20"
+  },
+  "dependencies": {
+    "@anatine/zod-openapi": "^2.0.0",
+    "zod": "^3.24.0",
+    "zod-validation-error": "^3.4.0",
+    "uuid": "^10.0.0"
   }
 }

libs/json-api/json-api-nestjs/project.json

@@ -21,13 +21,42 @@
         "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
       }
     },
     "nx-release-publish": {
       "options": {
         "packageRoot": "dist/{projectRoot}"
       }
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs json-api-nestjs {args.ver} {args.tag}",
+      "dependsOn": ["build"]
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/json-api/json-api-nestjs/jest.config.ts",
+        "codeCoverage": true,
+        "coverageReporters": ["json-summary"]
+      }
+    },
+    "upload-badge": {
+      "executor": "nx:run-commands",
+      "dependsOn": [
+        {
+          "target": "test"
+        }
+      ],
+      "options": {
+        "commands": ["node tools/scripts/upload-badge.mjs json-api-nestjs"],
+        "cwd": "./",
+        "parallel": false,
+        "outputPath": "{workspaceRoot}/libs/json-api/json-api-nestjs"
+      }
     }
   }
 }