@rxap/plugin-open-api 16.0.1-dev.6 → 16.1.0-dev.1

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 16.1.0-dev.1 (2023-10-11)
+
+### Bug Fixes
+
+- only clear source files ([7dddd96](https://gitlab.com/rxap/packages/commit/7dddd96dcaa8be256e5bc6c41a93881ca9ac19ee))
+- peer dependency issue ([ee95415](https://gitlab.com/rxap/packages/commit/ee95415370d9ef2396916d6c25061a0df791034a))
+- remove support for open-api client sdk packages ([0015878](https://gitlab.com/rxap/packages/commit/0015878e53cba42943d37354ef5c7d5f17828fd7))
+- use prefix for directives if defined in project.json ([acaa916](https://gitlab.com/rxap/packages/commit/acaa91657e477221ed6f36c589fe8546bd17f277))
+
+### Features
+
+- add the copy-client-sdk executor ([6742469](https://gitlab.com/rxap/packages/commit/674246926cb882ba6a94c5081e19bca8b74f3a59))
+
+# [16.1.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@16.0.1-dev.6...@rxap/plugin-open-api@16.1.0-dev.0) (2023-10-01)
+
+### Features
+
+- add the copy-client-sdk executor ([6c5c46a](https://gitlab.com/rxap/packages/commit/6c5c46a6d1f8f12d3f0f77117aa6070d7c2507e2))
+
 ## [16.0.1-dev.6](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@16.0.1-dev.5...@rxap/plugin-open-api@16.0.1-dev.6) (2023-09-12)
 
 ### Bug Fixes

package/README.md

@@ -9,6 +9,7 @@
 
 - [Installation](#installation)
 - [Generators](#generators)
+- [Executors](#executors)
 
 # Installation
 
@@ -18,7 +19,7 @@ yarn add @rxap/plugin-open-api
 ```
 **Install peer dependencies:**
 ```bash
-yarn add @nx/devkit@^16.5.0 @rxap/generator-utilities@* @rxap/plugin-library@* @rxap/utilities@* @rxap/workspace-open-api@* @rxap/workspace-ts-morph@* @rxap/workspace-utilities@* tslib@2.6.2 
+yarn add @nx/devkit@^16.5.0 @rxap/generator-utilities@^1.1.0-dev.17 @rxap/node-utilities@^1.1.0-dev.13 @rxap/plugin-library@^16.0.0-dev.35 @rxap/plugin-utilities@^16.1.0-dev.18 @rxap/utilities@^16.0.0-dev.21 @rxap/workspace-open-api@^0.0.2-dev.8 @rxap/workspace-ts-morph@^0.1.0-dev.9 @rxap/workspace-utilities@^0.1.0-dev.21 tslib@2.6.2 
 ```
 # Generators
 
@@ -28,3 +29,19 @@ yarn add @nx/devkit@^16.5.0 @rxap/generator-utilities@* @rxap/plugin-library@* @
 ```bash
 yarn nx g @rxap/plugin-open-api:generate
 ```
+# Executors
+
+## copy-client-sdk
+> copy-client-sdk executor
+
+**project.json**
+```json
+{
+  "targets": {
+    "copy-client-sdk": {
+      "executor": "@rxap/plugin-open-api:copy-client-sdk"
+    }
+  }
+}
+```
+

package/executors.json

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "copy-client-sdk": {
+      "implementation": "./src/executors/copy-client-sdk/executor",
+      "schema": "./src/executors/copy-client-sdk/schema.json",
+      "description": "copy-client-sdk executor"
+    }
+  }
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "16.0.1-dev.6",
+  "version": "16.1.0-dev.1",
   "name": "@rxap/plugin-open-api",
   "license": "GPL-3.0-or-later",
   "dependencies": {
@@ -15,21 +15,21 @@
   },
   "peerDependencies": {
     "@nx/devkit": "^16.5.0",
-    "@rxap/generator-utilities": "*",
-    "@rxap/plugin-library": "*",
-    "@rxap/utilities": "*",
-    "@rxap/workspace-open-api": "*",
-    "@rxap/workspace-ts-morph": "*",
-    "@rxap/workspace-utilities": "*",
+    "@rxap/generator-utilities": "^1.1.0-dev.17",
+    "@rxap/node-utilities": "^1.1.0-dev.13",
+    "@rxap/plugin-library": "^16.0.0-dev.35",
+    "@rxap/plugin-utilities": "^16.1.0-dev.18",
+    "@rxap/utilities": "^16.0.0-dev.21",
+    "@rxap/workspace-open-api": "^0.0.2-dev.8",
+    "@rxap/workspace-ts-morph": "^0.1.0-dev.9",
+    "@rxap/workspace-utilities": "^0.1.0-dev.21",
     "tslib": "2.6.2",
-    "@rxap/generator-ts-morph": "1.0.1-dev.11",
-    "@rxap/json-schema-to-typescript": "16.0.0-dev.13",
-    "@rxap/node-utilities": "1.1.0-dev.9",
-    "@rxap/plugin-angular": "16.1.0-dev.22",
-    "@rxap/plugin-localazy": "16.1.0-dev.11",
-    "@rxap/plugin-nestjs": "16.1.0-dev.20",
-    "@rxap/plugin-utilities": "16.1.0-dev.14",
-    "@rxap/ts-morph": "0.1.0-dev.9"
+    "@rxap/generator-ts-morph": "1.0.1-dev.13",
+    "@rxap/json-schema-to-typescript": "16.0.0-dev.17",
+    "@rxap/plugin-angular": "16.1.0-dev.50",
+    "@rxap/plugin-localazy": "16.1.0-dev.13",
+    "@rxap/plugin-nestjs": "16.1.0-dev.40",
+    "@rxap/ts-morph": "0.1.0-dev.15"
   },
   "author": {
     "name": "Merzough Münker",
@@ -39,6 +39,7 @@
     "url": "https://gitlab.com/rxap/packages/-/issues",
     "email": "incoming+rxap-packages-14898188-issue-@incoming.gitlab.com"
   },
+  "executors": "./executors.json",
   "generators": "./generators.json",
   "homepage": "https:/gitlab.com/rxap/packages/packages/plugin/open-api",
   "keywords": [
@@ -53,27 +54,35 @@
     "packageGroup": [
       {
         "package": "@rxap/generator-utilities",
-        "version": "1.1.0-dev.12"
+        "version": "1.1.0-dev.17"
+      },
+      {
+        "package": "@rxap/node-utilities",
+        "version": "1.1.0-dev.13"
       },
       {
         "package": "@rxap/plugin-library",
-        "version": "16.0.0-dev.24"
+        "version": "16.0.0-dev.35"
+      },
+      {
+        "package": "@rxap/plugin-utilities",
+        "version": "16.1.0-dev.18"
       },
       {
         "package": "@rxap/utilities",
-        "version": "16.0.0-dev.17"
+        "version": "16.0.0-dev.21"
       },
       {
         "package": "@rxap/workspace-open-api",
-        "version": "0.0.2-dev.4"
+        "version": "0.0.2-dev.8"
       },
       {
         "package": "@rxap/workspace-ts-morph",
-        "version": "0.1.0-dev.7"
+        "version": "0.1.0-dev.9"
       },
       {
         "package": "@rxap/workspace-utilities",
-        "version": "0.1.0-dev.12"
+        "version": "0.1.0-dev.21"
       }
     ]
   },
@@ -87,7 +96,7 @@
     "directory": "packages/plugin/open-api"
   },
   "type": "commonjs",
-  "gitHead": "db8e53ef6cfd297abb6f8c4fb54f289f9c971fe4",
+  "gitHead": "cc79abe8b76799cf9e91a91b92e8172b23a74b13",
   "main": "./src/index.js",
   "types": "./src/index.d.ts"
 }

package/src/executors/copy-client-sdk/executor.d.ts

@@ -0,0 +1,5 @@
+import { ExecutorContext } from '@nx/devkit';
+import { CopyClientSdkExecutorSchema } from './schema';
+export default function runExecutor(options: CopyClientSdkExecutorSchema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;

package/src/executors/copy-client-sdk/executor.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_utilities_1 = require("@rxap/node-utilities");
+const plugin_utilities_1 = require("@rxap/plugin-utilities");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const GENERIC_SOURCE_FILE_FOLDER = [
+    'parameters',
+    'responses',
+    'request-bodies',
+    'components',
+];
+const ANGULAR_SOURCE_FILE_FOLDER = [
+    'data-sources',
+    'remote-methods',
+    'directives',
+];
+const NEST_JS_SOURCE_FILE_FOLDER = [
+    'commands',
+];
+function getAngularSourceFileFolder(options) {
+    const copy = [...ANGULAR_SOURCE_FILE_FOLDER];
+    if (options.skipDataSources) {
+        copy.splice(copy.indexOf('data-sources'), 1);
+    }
+    if (options.skipDirectives) {
+        copy.splice(copy.indexOf('directives'), 1);
+    }
+    if (options.skipRemoteMethods) {
+        copy.splice(copy.indexOf('remote-methods'), 1);
+    }
+    return copy;
+}
+function clearOutputDir(options, context) {
+    const projectSourceRoot = (0, plugin_utilities_1.GetProjectSourceRoot)(context);
+    // if the output dir exists
+    if ((0, fs_1.existsSync)((0, path_1.join)(projectSourceRoot, 'lib', options.outputDir))) {
+        // then remove the directory recursively
+        (0, fs_1.rmSync)((0, path_1.join)(projectSourceRoot, 'lib', options.outputDir), {
+            recursive: true,
+            force: true,
+        });
+    }
+    (0, fs_1.mkdirSync)((0, path_1.join)(projectSourceRoot, 'lib', options.outputDir), { recursive: true });
+}
+function copyFolder(options, context, folderName) {
+    const sourceProjectSourceRoot = (0, plugin_utilities_1.GetProjectSourceRoot)(context, options.clientSdkProject);
+    const targetProjectSourceRoot = (0, plugin_utilities_1.GetProjectSourceRoot)(context);
+    const sourceFolderPath = (0, path_1.join)(sourceProjectSourceRoot, 'lib', folderName);
+    const targetFolderPath = (0, path_1.join)(targetProjectSourceRoot, 'lib', options.outputDir, folderName);
+    if (!(0, fs_1.existsSync)(sourceFolderPath)) {
+        console.log(`Skip copy folder '${folderName}' from '${sourceFolderPath}' to '${targetFolderPath}' because the source folder does not exists`);
+    }
+    else {
+        console.log(`Copy folder '${folderName}' from '${sourceFolderPath}' to '${targetFolderPath}'`);
+        (0, node_utilities_1.CopyFolderSync)(sourceFolderPath, targetFolderPath);
+    }
+}
+function runExecutor(options, context) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // the directives have a direct dependency to the remote methods
+        if (options.skipRemoteMethods && !options.skipDirectives) {
+            // if the skip remote methods is set but not the skip directives
+            // then enforce that remote methods are not skipped
+            options.skipRemoteMethods = false;
+        }
+        console.log('Executor ran for CopyClientSdk', options);
+        if (!context.projectsConfigurations.projects[options.clientSdkProject]) {
+            throw new Error(`Could not find project '${options.clientSdkProject}'`);
+        }
+        clearOutputDir(options, context);
+        for (const folderName of GENERIC_SOURCE_FILE_FOLDER) {
+            copyFolder(options, context, folderName);
+        }
+        if (options.angular) {
+            for (const folderName of getAngularSourceFileFolder(options)) {
+                copyFolder(options, context, folderName);
+            }
+        }
+        if (options.nestJs) {
+            for (const folderName of NEST_JS_SOURCE_FILE_FOLDER) {
+                copyFolder(options, context, folderName);
+            }
+        }
+        return {
+            success: true,
+        };
+    });
+}
+exports.default = runExecutor;
+//# sourceMappingURL=executor.js.map

package/src/executors/copy-client-sdk/executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/open-api/src/executors/copy-client-sdk/executor.ts"],"names":[],"mappings":";;;AACA,yDAAsD;AACtD,6DAA8D;AAC9D,2BAIY;AACZ,+BAA4B;AAG5B,MAAM,0BAA0B,GAAG;IACjC,YAAY;IACZ,WAAW;IACX,gBAAgB;IAChB,YAAY;CACb,CAAC;AAEF,MAAM,0BAA0B,GAAG;IACjC,cAAc;IACd,gBAAgB;IAChB,YAAY;CACb,CAAC;AAEF,MAAM,0BAA0B,GAAG;IACjC,UAAU;CACX,CAAC;AAEF,SAAS,0BAA0B,CAAC,OAAoC;IACtE,MAAM,IAAI,GAAG,CAAE,GAAG,0BAA0B,CAAE,CAAC;IAC/C,IAAI,OAAO,CAAC,eAAe,EAAE;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;KAC9C;IACD,IAAI,OAAO,CAAC,cAAc,EAAE;QAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;KAC5C;IACD,IAAI,OAAO,CAAC,iBAAiB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;KAChD;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,cAAc,CAAC,OAAoC,EAAE,OAAwB;IACpF,MAAM,iBAAiB,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;IACxD,2BAA2B;IAC3B,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,iBAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE;QACjE,wCAAwC;QACxC,IAAA,WAAM,EACJ,IAAA,WAAI,EAAC,iBAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE;YACjD,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;KACN;IACD,IAAA,cAAS,EAAC,IAAA,WAAI,EAAC,iBAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,UAAU,CAAC,OAAoC,EAAE,OAAwB,EAAE,UAAkB;IACpG,MAAM,uBAAuB,GAAG,IAAA,uCAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxF,MAAM,uBAAuB,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,uBAAuB,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAC1E,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,uBAAuB,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC7F,IAAI,CAAC,IAAA,eAAU,EAAC,gBAAgB,CAAC,EAAE;QACjC,OAAO,CAAC,GAAG,CACT,qBAAsB,UAAW,WAAY,gBAAiB,SAAU,gBAAiB,6CAA6C,CAAC,CAAC;KAC3I;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,gBAAiB,UAAW,WAAY,gBAAiB,SAAU,gBAAiB,GAAG,CAAC,CAAC;QACrG,IAAA,+BAAc,EAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;KACpD;AACH,CAAC;AAED,SAA8B,WAAW,CACvC,OAAoC,EACpC,OAAwB;;QAGxB,gEAAgE;QAChE,IAAI,OAAO,CAAC,iBAAiB,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YACxD,gEAAgE;YAChE,mDAAmD;YACnD,OAAO,CAAC,iBAAiB,GAAG,KAAK,CAAC;SACnC;QAED,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;QAEvD,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;YACtE,MAAM,IAAI,KAAK,CAAC,2BAA4B,OAAO,CAAC,gBAAiB,GAAG,CAAC,CAAC;SAC3E;QAED,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAEjC,KAAK,MAAM,UAAU,IAAI,0BAA0B,EAAE;YACnD,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1C;QAED,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,KAAK,MAAM,UAAU,IAAI,0BAA0B,CAAC,OAAO,CAAC,EAAE;gBAC5D,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;aAC1C;SACF;QAED,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,KAAK,MAAM,UAAU,IAAI,0BAA0B,EAAE;gBACnD,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;aAC1C;SACF;QAED,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CAAA;AAvCD,8BAuCC"}

package/src/executors/copy-client-sdk/schema.d.ts

@@ -0,0 +1,9 @@
+export interface CopyClientSdkExecutorSchema {
+  clientSdkProject: string;
+  angular?: boolean;
+  nestJs?: boolean;
+  outputDir: string;
+  skipDataSources?: boolean;
+  skipDirectives?: boolean;
+  skipRemoteMethods?: boolean;
+}

package/src/executors/copy-client-sdk/schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "version": 2,
+  "title": "CopyClientSdk executor",
+  "description": "",
+  "type": "object",
+  "properties": {
+    "clientSdkProject": {
+      "type": "string",
+      "description": "The name of the client SDK project to copy"
+    },
+    "angular": {
+      "type": "boolean",
+      "description": "Whether to copy the files for an Angular project"
+    },
+    "nestjs": {
+      "type": "boolean",
+      "description": "Whether to copy the files for a NestJS project"
+    },
+    "outputDir": {
+      "default": "openapi",
+      "type": "string",
+      "description": "The directory to copy the files to"
+    },
+    "skipDirectives": {
+      "type": "boolean",
+      "description": "Whether to skip copying the directives"
+    },
+    "skipDataSources": {
+      "type": "boolean",
+      "description": "Whether to skip copying the data sources"
+    },
+    "skipRemoteMethods": {
+      "type": "boolean",
+      "description": "Whether to skip copying the remote methods"
+    }
+  },
+  "required": [
+    "clientSdkProject"
+  ]
+}