Merge pull request #98 from klerick/nestjs-json-api-97

Try to adopt for MicroOrm

Author: klerick

.e2e-micro.env

@@ -0,0 +1,2 @@
+DB_LOGGING=0
+ORM_TYPE=microorm

.e2e.env

@@ -1 +1,2 @@
 DB_LOGGING=0
+ORM_TYPE=typeorm

.env

@@ -3,7 +3,8 @@ DB_LOGGING=1
 
 DB_USERNAME="postgres"
 DB_PASSWORD="postgres"
-DB_NAME="json-api-db"
+#DB_NAME="json-api-db"
+DB_NAME="postgres"
 DB_PORT=5432
 DB_TYPE=postgres
 
@@ -12,3 +13,7 @@ DB_TYPE=postgres
 #DB_NAME="example_new"
 #DB_PORT=3306
 #DB_TYPE=mysql
+
+
+ORM_TYPE=microorm
+#ORM_TYPE=typeorm

.github/workflows/ci.yml

@@ -30,11 +30,11 @@ jobs:
       - name: Test
         env:
           NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
-        run: npx nx affected -t test --parallel=3 --exclude='json-api-front,json-api-server,json-api-server-e2e,json-shared-type,database,@nestjs-json-api/source,type-for-rpc'
+        run: npx nx affected -t test --parallel=3 --exclude='json-api-front,json-api-server,json-api-server-e2e,json-shared-type,microorm-database,typeorm-database,@nestjs-json-api/source,type-for-rpc'
       - name: Build
         env:
           NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
-        run: npx nx affected -t build --exclude='json-api-front,json-api-server,json-api-server-e2e,json-shared-type,database,@nestjs-json-api/source,type-for-rpc'
+        run: npx nx affected -t build --exclude='json-api-front,json-api-server,json-api-server-e2e,json-shared-type,microorm-database,typeorm-database,@nestjs-json-api/source,type-for-rpc'
       - name: Save cached .nx
         id: cache-dependencies-save
         uses: actions/cache/save@v4
@@ -85,6 +85,7 @@ jobs:
       - run: npm run typeorm migration:run
       - run: npm run seed:run
       - run: npx nx affected -t e2e --parallel=1
+      - run: npx nx affected -t e2e-micro --parallel=1
       - name: Save cached .nx
         id: cache-dependencies-save
         uses: actions/cache/save@v4

.test.env

@@ -0,0 +1,2 @@
+NODE_OPTIONS=--experimental-vm-modules --disable-warning=ExperimentalWarning
+DB_LOGGING=0

.verdaccio/config.yml

@@ -0,0 +1,28 @@
+# path to a directory with all packages
+storage: ../tmp/local-registry/storage
+
+# a list of other known repositories we can talk to
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+    maxage: 60m
+
+packages:
+  '**':
+    # give all users (including non-authenticated users) full access
+    # because it is a local registry
+    access: $all
+    publish: $all
+    unpublish: $all
+
+    # if package is not available locally, proxy requests to npm registry
+    proxy: npmjs
+
+# log settings
+log:
+  type: stdout
+  format: pretty
+  level: warn
+
+publish:
+  allow_offline: true # set offline to true to allow publish offline

README.md

@@ -1,17 +1,24 @@
 <p align="center">
-  Json API plugins for 
-  <a href="http://nestjs.com/" target="blank">NestJS</a>
-  framework 
+<a href="http://nestjs.com/" target="blank">NestJS</a> JSON API & JSON RPC Suite
 </p>
+
 <p>
-   Tools to implement JSON API, such as, end point, query params, body params, validation and transformation response.
+   This monorepo contains a set of several libraries designed to simplify the development of server and client applications using NestJS. These tools help you work with two popular protocols:
 </p>
 
-- *[json-api-nestjs](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs)* - plugin for create CRUD overs JSON API
-- *[json-api-nestjs-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs-sdk)* - tool for client, call api over *json-api-nestjs*
-- *[nestjs-json-rpc](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc)* - plugin for create RPC server using [JSON-RPC](https://www.jsonrpc.org/)
-- *[nestjs-json-rpc-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc-sdk)* - tool for client, call RPC server *nestjs-json-rpc*
-- *json-api-nestjs-acl* - tool for acl over *json-api-nestjs*(coming soon...)
+
+- **[JSON:API](https://jsonapi.org/)** – A specification for building RESTful APIs with standardized request and response formats.
+ 
+ > **[json-api-nestjs](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs)** - This package enables you to quickly set up a server API that adheres to the JSON:API specification, handling standard CRUD operations for your resources.</br> 
+ > **[json-api-nestjs-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs-sdk)** - tool for client, call api over *json-api-nestjs* 
+
+
+- **[JSON-RPC](https://www.jsonrpc.org/)** – A protocol for remote procedure calls using JSON.
+
+> **[nestjs-json-rpc](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc)** - Use this package to implement remote procedure call (RPC) functionality in your NestJS applications, enabling efficient inter-service communication.</br>
+> **[nestjs-json-rpc-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc-sdk)** - This tool offers a straightforward way to call remote procedures from your client-side code, ensuring smooth communication with your JSON-RPC server.
+
+- **ACL tools** - tool for acl over *json-api-nestjs*(coming soon...)
 ## Installation
 
 ```bash
@@ -24,7 +31,7 @@ $ npm run seed:run
 
 ```bash
 # dev server
-$ npm run demo:json-api
+$ nx run json-api-server:serve:development
 
 ```
 ## License

apps/json-api-server-e2e/project.json

@@ -16,6 +16,17 @@
         "passWithNoTests": true,
         "parallel": 1
       }
+    },
+    "e2e-micro": {
+      "executor": "@nx/jest:jest",
+      "outputs": [
+        "{workspaceRoot}/coverage/{e2eProjectRoot}"
+      ],
+      "options": {
+        "jestConfig": "apps/json-api-server-e2e/jest.config.ts",
+        "passWithNoTests": true,
+        "parallel": 1
+      }
     }
   }
 }

apps/json-api-server-e2e/src/json-api/json-api-sdk/atomic-sdk.spec.ts

@@ -1,6 +1,12 @@
 import { INestApplication } from '@nestjs/common';
-import { FilterOperand, JsonSdkPromise } from 'json-api-nestjs-sdk';
-import { Addresses, CommentKind, Comments, Roles, Users } from 'database';
+import { FilterOperand, JsonSdkPromise } from '@klerick/json-api-nestjs-sdk';
+import {
+  Addresses,
+  CommentKind,
+  Comments,
+  Roles,
+  Users,
+} from '@nestjs-json-api/typeorm-database';
 import { faker } from '@faker-js/faker';
 import { getUser } from '../utils/data-utils';
 import { run, creatSdk } from '../utils/run-application';

apps/json-api-server-e2e/src/json-api/json-api-sdk/check-common-decorator.spec.ts

@@ -1,7 +1,7 @@
 import { INestApplication } from '@nestjs/common';
-import { FilterOperand, JsonSdkPromise } from 'json-api-nestjs-sdk';
+import { FilterOperand, JsonSdkPromise } from '@klerick/json-api-nestjs-sdk';
 import { AxiosError } from 'axios';
-import { Users } from 'database';
+import { Users } from '@nestjs-json-api/typeorm-database';
 
 import { run, creatSdk } from '../utils/run-application';