Merge pull request #74 from klerick/create-esm-module

build(json-api-nestjs): Create hyprid npm package

Author: klerick

.eslintrc.json

@@ -8,7 +8,7 @@
           "error",
           {
             "enforceBuildableLibDependency": true,
-            "allow": [],
+            "allow": ["json-shared-type", "shared-utils"],
             "depConstraints": [
               {
                 "sourceTag": "*",

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 on:
   pull_request:
     branches:
-      - main
+      - master
     types:
       - opened
       - synchronize
@@ -18,7 +18,7 @@ jobs:
       # This line is needed for nx affected to work when CI is running on a PR
       - run: git branch --track main origin/master
       - name: Test and build
-        run: npx nx affected -t lint test build --parallel=3 --exclude='json-api-front,json-api-server,json-api-server-e2e,shared-utils,json-shared-type,database'
+        run: npx nx affected -t test build --parallel=3 --exclude='json-api-front,json-api-server,json-api-server-e2e,json-shared-type,database,@nestjs-json-api/source'
       - name: Cache npm dependencies
         id: cache-dependencies-save
         uses: actions/cache/save@v4

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

@@ -5,17 +5,51 @@
   "projectType": "library",
   "targets": {
     "build": {
+      "executor": "nx:run-commands",
+      "dependsOn": [
+        {
+          "target": "build-mjs"
+        },
+        {
+          "target": "build-cjs"
+        }
+      ],
+      "options": {
+        "outputPath": "dist/libs/json-api/json-api-nestjs",
+        "commands": [
+          "node tools/scripts/preparation-hybrid-npm-package.mjs json-api-nestjs",
+          "node tools/scripts/preparation-npm-package.mjs json-api-nestjs"
+        ],
+        "cwd": "./",
+        "parallel": false
+      }
+    },
+    "build-cjs": {
       "executor": "@nx/js:tsc",
       "outputs": ["{options.outputPath}"],
       "options": {
-        "outputPath": "dist/libs/json-api/json-api-nestjs",
+        "outputPath": "dist/libs/json-api/json-api-nestjs/cjs",
+        "main": "libs/json-api/json-api-nestjs/src/index.ts",
         "tsConfig": "libs/json-api/json-api-nestjs/tsconfig.lib.json",
-        "packageJson": "libs/json-api/json-api-nestjs/package.json",
+        "assets": ["libs/json-api/json-api-nestjs/README.md"],
+        "external": "none",
+        "updateBuildableProjectDepsInPackageJson": true,
+        "buildableProjectDepsInPackageJsonType": "peerDependencies",
+        "generateExportsField": true
+      }
+    },
+    "build-mjs": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/json-api/json-api-nestjs/mjs",
         "main": "libs/json-api/json-api-nestjs/src/index.ts",
-        "assets": ["libs/json-api/json-api-nestjs/*.md"],
+        "tsConfig": "libs/json-api/json-api-nestjs/tsconfig-mjs.lib.json",
+        "assets": ["libs/json-api/json-api-nestjs/README.md"],
         "external": "none",
         "updateBuildableProjectDepsInPackageJson": true,
-        "buildableProjectDepsInPackageJsonType": "peerDependencies"
+        "buildableProjectDepsInPackageJsonType": "peerDependencies",
+        "generateExportsField": true
       }
     },
     "publish": {

libs/json-api/json-api-nestjs/src/lib/helper/bind-controller.ts

@@ -42,7 +42,7 @@ export function bindController(
       if (!allowMethod.includes(name)) continue;
     }
 
-    if (!controller.prototype.hasOwnProperty(name)) {
+    if (!Object.prototype.hasOwnProperty.call(controller, name)) {
       // need uniq descriptor for correct work swagger
       Reflect.defineProperty(controller.prototype, name, {
         value: function (

libs/json-api/json-api-nestjs/src/lib/helper/create-controller.ts

@@ -27,7 +27,9 @@ export function createController(
   const entityName =
     entity instanceof Function ? entity.name : entity.options.name;
 
-  if (!JsonBaseController.isPrototypeOf(controllerClass)) {
+  if (
+    !Object.prototype.isPrototypeOf.call(JsonBaseController, controllerClass)
+  ) {
     throw new Error(
       `Controller "${controller?.name}" should be inherited of "JsonBaseController"`
     );

libs/json-api/json-api-nestjs/tsconfig-mjs.lib.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": ["node"],
+    "module": "es2015",
+    "target": "ES2022",
+    "removeComments": false,
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

tools/scripts/preparation-hybrid-npm-package.mjs

@@ -60,15 +60,17 @@ mjsJson.exports['.'] = {
   es2015: mjsJson.es2015,
   default: mjsJson.es2015,
 }
-
-mjsJson.exports[angularModule] = {
-  types: './mjs/src/json-api-nestjs-sdk.module.d.ts',
-  node: addTypeToPath(angularPath, 'cjs'),
-  require: addTypeToPath(angularPath, 'cjs'),
-  es2015: addTypeToPath(angularPath),
-  default: addTypeToPath(angularPath),
+if (mjsJson.namne === 'json-api-nestjs-sdk') {
+  mjsJson.exports[angularModule] = {
+    types: './mjs/src/json-api-nestjs-sdk.module.d.ts',
+    node: addTypeToPath(angularPath, 'cjs'),
+    require: addTypeToPath(angularPath, 'cjs'),
+    es2015: addTypeToPath(angularPath),
+    default: addTypeToPath(angularPath),
+  }
 }
 
+
 writeFileSync(`package.json`, JSON.stringify(mjsJson, null, 2));
 writeFileSync(
   'README.md',