@ama-sdk/core 10.4.0-prerelease.0 → 10.4.0-prerelease.10

package/README.md

@@ -69,3 +69,15 @@ function petApiFactory() {
 ```
 
 > *Note*: Adding a third-party logging service is optional. If undefined, the fallback is the console logger.
+
+### CLI
+
+This package also comes with CLI scripts that can facilitate the upgrade and publication of an SDK. 
+Use --help on each command for more information
+
+| Script                      | Description                                                                                    |
+|-----------------------------|------------------------------------------------------------------------------------------------|
+| amasdk-clear-index          | Remove the index files that are no longer necessary after the deletion of the associated model |
+| amasdk-files-pack           | Prepare the dist folder for publication                                                        |
+| amasdk-update-spec-from-npm | Update the OpenAPI spec from an NPM package                                                    |
+

package/cjs/fwk/index.js

@@ -11,6 +11,7 @@ _export_star(require("./errors"), exports);
 _export_star(require("./ignore-enum.type"), exports);
 _export_star(require("./logger"), exports);
 _export_star(require("./mocks/index"), exports);
+_export_star(require("./open-api-tools-configuration"), exports);
 _export_star(require("./Reviver"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

package/cjs/fwk/open-api-tools-configuration.js

@@ -0,0 +1,4 @@
+/** Configuration of an Open API generator */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/cli/clear-index.cjs

@@ -4,9 +4,18 @@
  * Remove deleted models' exports
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+const minimist = require("minimist");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
+const argv = minimist(process.argv.slice(2));
+const { help } = argv;
 const baseDir = (0, node_path_1.resolve)(process.cwd(), 'src', 'models', 'base');
+if (help) {
+    console.log(`Remove the index files that are no longer necessary after the deletion of the associated model.
+  Usage: amasdk-clear-index
+  `);
+    process.exit(0);
+}
 void (async () => {
     const models = await node_fs_1.promises.readdir(baseDir);
     const shouldRemoveModels = (await Promise.all(models

package/cli/files-pack.cjs

@@ -12,7 +12,16 @@ const globby = require("globby");
 const argv = minimist(process.argv.slice(2));
 const distFolder = argv.dist || 'dist';
 const baseDir = argv.cwd && path.resolve(process.cwd(), argv.cwd) || process.cwd();
-const { watch, noExports } = argv;
+const { help, watch, noExports } = argv;
+if (help) {
+    console.log(`Prepare the dist folder for publication. This will copy necessary files from src and update the exports in package.json.
+  Usage: amasdk-files-pack [--exports] [--watch]
+
+    --exports    Update the exports in package.json. (Default: true)
+    --watch      Watch for files changes and run the updates
+  `);
+    process.exit(0);
+}
 const files = [
     { glob: 'README.md', cwdForCopy: baseDir },
     { glob: 'LICENSE', cwdForCopy: baseDir },
@@ -66,10 +75,12 @@ void (async () => {
     const copies = files.map(async ({ glob, cwdForCopy }) => {
         return watch ?
             Promise.resolve().then(() => require('chokidar')).then((chokidar) => chokidar.watch(glob, { cwd: baseDir }))
-                .then((watcher) => watcher.on('all', (event, file) => {
+                .then((watcher) => watcher.on('all', async (event, file) => {
                 if (event !== 'unlink' && event !== 'unlinkDir') {
                     copyToDist(file, cwdForCopy);
-                    return updateExports();
+                    if (!noExports) {
+                        await updateExports();
+                    }
                 }
             })) :
             globby.sync(glob)

package/cli/update-spec-from-npm.cjs

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+"use strict";
+/*
+ * Update the OpenAPI spec from an NPM package
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const minimist = require("minimist");
+const node_fs_1 = require("node:fs");
+const node_module_1 = require("node:module");
+const node_path_1 = require("node:path");
+const promises_1 = require("node:fs/promises");
+const argv = minimist(process.argv.slice(2));
+const packageName = argv._[0];
+const { help, output, 'package-path': packagePath, quiet } = argv;
+const openApiConfigDefaultPath = './openapitools.json';
+const supportedExtensions = ['json', 'yaml', 'yml'];
+const noop = () => undefined;
+const logger = quiet ? { error: noop, warn: noop, log: noop, info: noop, debug: noop } : console;
+if (help) {
+    console.log(`This script can be used to update your local spec file from a given locally installed npm package.
+  Usage: amasdk-update-spec-from-npm <package-name> [--package-path] [--output] [--quiet]
+
+    package-name      The full identifier of the npm package (e.g. @my-scope/my-package)
+    --package-path    The relative path inside the npm package where to find the spec file (default: './openapi.yml')
+    --output          The path where the spec file should be copied (default: './openapi.yml')
+    --quiet           Don't log anything
+  `);
+    process.exit(0);
+}
+if (!packageName) {
+    logger.error('Need to provide packageName, use `amasdk-update-spec-from-npm --help` for more information');
+    process.exit(-1);
+}
+void (async () => {
+    let specSourcePath;
+    const appRequire = (0, node_module_1.createRequire)((0, node_path_1.join)(process.cwd(), 'package.json'));
+    const packageJsonPath = appRequire.resolve(`${packageName}/package.json`);
+    if (!packagePath) {
+        const packageJson = JSON.parse(await (0, promises_1.readFile)(packageJsonPath, { encoding: 'utf8' }));
+        const exportMatcher = new RegExp(`openapi\\.(?:${supportedExtensions.join('|')})$`);
+        const matchingExport = packageJson.exports && Object.keys(packageJson.exports).find((exportPath) => exportMatcher.test(exportPath));
+        if (matchingExport) {
+            specSourcePath = appRequire.resolve(`${packageName}/${matchingExport}`);
+        }
+    }
+    else {
+        specSourcePath = packageJsonPath.replace(/package.json$/, packagePath);
+    }
+    if (!specSourcePath || !(0, node_fs_1.existsSync)(specSourcePath)) {
+        logger.error(`Unable to find source spec from ${packageName}, please make sure it is correctly exported in package.json`);
+        process.exit(-2);
+    }
+    let specDestinationPath = output;
+    if (!specDestinationPath) {
+        const specSourceExtension = (0, node_path_1.extname)(specSourcePath);
+        specDestinationPath = `./openapi${specSourceExtension}`;
+        if ((0, node_fs_1.existsSync)(openApiConfigDefaultPath)) {
+            const openApiConfig = JSON.parse(await (0, promises_1.readFile)(openApiConfigDefaultPath, { encoding: 'utf8' }));
+            const generators = Object.values(openApiConfig['generator-cli']?.generators ?? {});
+            if (generators.length === 1 && generators[0].inputSpec && (0, node_path_1.extname)(generators[0].inputSpec) === specSourceExtension) {
+                specDestinationPath = generators[0].inputSpec;
+            }
+        }
+    }
+    logger.info(`Updating spec file from "${specSourcePath}" to "${specDestinationPath}" (CWD: "${process.cwd()}")`);
+    await (0, promises_1.copyFile)(specSourcePath, specDestinationPath);
+})();
+//# sourceMappingURL=update-spec-from-npm.cjs.map

package/cli/update-spec-from-npm.d.cts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=update-spec-from-npm.d.cts.map

package/cli/update-spec-from-npm.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-spec-from-npm.d.cts","sourceRoot":"","sources":["../../cli/update-spec-from-npm.cts"],"names":[],"mappings":""}

package/esm2015/fwk/index.js

@@ -7,4 +7,5 @@ export * from './errors';
 export * from './ignore-enum.type';
 export * from './logger';
 export * from './mocks/index';
+export * from './open-api-tools-configuration';
 export * from './Reviver';

package/esm2015/fwk/open-api-tools-configuration.js

@@ -0,0 +1 @@
+/** Configuration of an Open API generator */ /** Global configuration of Open API Tools */ export { };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-sdk/core",
-  "version": "10.4.0-prerelease.0",
+  "version": "10.4.0-prerelease.10",
   "publishConfig": {
     "access": "public"
   },
@@ -80,7 +80,7 @@
     "@angular-devkit/schematics": "~17.3.0",
     "@angular/cli": "~17.3.0",
     "@angular/common": "~17.3.0",
-    "@o3r/schematics": "^10.4.0-prerelease.0",
+    "@o3r/schematics": "^10.4.0-prerelease.10",
     "@schematics/angular": "~17.3.0",
     "chokidar": "^3.5.2",
     "globby": "^11.1.0",
@@ -126,9 +126,9 @@
     "@angular/core": "~17.3.0",
     "@nx/eslint-plugin": "~18.3.0",
     "@nx/jest": "~18.3.0",
-    "@o3r/build-helpers": "^10.4.0-prerelease.0",
-    "@o3r/eslint-plugin": "^10.4.0-prerelease.0",
-    "@o3r/test-helpers": "^10.4.0-prerelease.0",
+    "@o3r/build-helpers": "^10.4.0-prerelease.10",
+    "@o3r/eslint-plugin": "^10.4.0-prerelease.10",
+    "@o3r/test-helpers": "^10.4.0-prerelease.10",
     "@schematics/angular": "~17.3.0",
     "@stylistic/eslint-plugin-ts": "^1.5.4",
     "@swc/cli": "^0.3.0",
@@ -168,7 +168,8 @@
   "schematics": "./collection.json",
   "bin": {
     "amasdk-clear-index": "./cli/clear-index.cjs",
-    "amasdk-files-pack": "./cli/files-pack.cjs"
+    "amasdk-files-pack": "./cli/files-pack.cjs",
+    "amasdk-update-spec-from-npm": "./cli/update-spec-from-npm.cjs"
   },
   "contributors": [
     {

package/src/fwk/index.d.ts

@@ -7,5 +7,6 @@ export * from './errors';
 export * from './ignore-enum.type';
 export * from './logger';
 export * from './mocks/index';
+export * from './open-api-tools-configuration';
 export * from './Reviver';
 //# sourceMappingURL=index.d.ts.map

package/src/fwk/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fwk/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fwk/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,WAAW,CAAC"}

package/src/fwk/index.js

@@ -7,5 +7,6 @@ export * from './errors';
 export * from './ignore-enum.type';
 export * from './logger';
 export * from './mocks/index';
+export * from './open-api-tools-configuration';
 export * from './Reviver';
 //# sourceMappingURL=index.js.map

package/src/fwk/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fwk/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fwk/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,WAAW,CAAC"}

package/src/fwk/open-api-tools-configuration.d.ts

@@ -0,0 +1,28 @@
+/** Configuration of an Open API generator */
+export interface OpenApiToolsGenerator {
+    /** Location of the OpenAPI spec, as URL or file */
+    inputSpec: string;
+    /** Output path for the generated SDK */
+    output: string;
+    /** Generator to use */
+    generatorName: string;
+    /** Path to configuration file. It can be JSON or YAML */
+    config?: string;
+    /** Sets specified global properties */
+    globalProperty?: string | Record<string, any>;
+}
+/** Global configuration of Open API generators */
+export interface OpenApiToolsGeneratorCli {
+    /** Open API version */
+    version: string;
+    /** Location of the generator JAR file */
+    storageDir?: string;
+    /** Generators configuration */
+    generators: Record<string, OpenApiToolsGenerator>;
+}
+/** Global configuration of Open API Tools */
+export interface OpenApiToolsConfiguration {
+    /** Generators CLI configuration */
+    'generator-cli': OpenApiToolsGeneratorCli;
+}
+//# sourceMappingURL=open-api-tools-configuration.d.ts.map

package/src/fwk/open-api-tools-configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-tools-configuration.d.ts","sourceRoot":"","sources":["../../../src/fwk/open-api-tools-configuration.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,WAAW,qBAAqB;IACpC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/C;AAED,kDAAkD;AAClD,MAAM,WAAW,wBAAwB;IACvC,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACnD;AAED,6CAA6C;AAC7C,MAAM,WAAW,yBAAyB;IACxC,mCAAmC;IAEnC,eAAe,EAAE,wBAAwB,CAAC;CAC3C"}

package/src/fwk/open-api-tools-configuration.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=open-api-tools-configuration.js.map

package/src/fwk/open-api-tools-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-tools-configuration.js","sourceRoot":"","sources":["../../../src/fwk/open-api-tools-configuration.ts"],"names":[],"mappings":""}