fix: default specs filename on sdk generation; publish showcase specs

AmadeusITGroup · May 22, 2024 · 38a6742 · 38a6742
1 parent d90fbaa
commit 38a6742
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 6 deletions.
diff --git a/packages/@ama-sdk/create/README.md b/packages/@ama-sdk/create/README.md
@@ -44,7 +44,7 @@ npm create @ama-sdk typescript <project-name> -- --package-manager=yarn [...opti
 
 - `--spec-path`: Path to the swagger/open-api specification used to generate the SDK
 - `--spec-package-name`: The npm package name where the spec file can be fetched
-- `--spec-package-path`: The path inside the package where to find the spec file
+- `--spec-package-path`: The path inside the package where to find the spec file. Defaults to _openapi.yml_
 - `--spec-package-version`: The version to target for the npm package where the spec file can be fetched
 - `--spec-package-registry`: The npm registry where the spec file can be fetched
 

diff --git a/packages/@ama-sdk/create/src/index.ts b/packages/@ama-sdk/create/src/index.ts
@@ -2,7 +2,7 @@
 /* eslint-disable no-console */
 
 import { execSync, spawnSync } from 'node:child_process';
-import { dirname, join, parse, relative, resolve } from 'node:path';
+import { dirname, extname, join, parse, relative, resolve } from 'node:path';
 import * as minimist from 'minimist';
 
 const packageManagerEnv = process.env.npm_config_user_agent?.split('/')[0];
@@ -64,6 +64,17 @@ if (argv['spec-path'] && argv['spec-package-name']) {
   console.error('--spec-path cannot be set with --spec-package-name');
   process.exit(-4);
 }
+/* Default path of the specification file inside npm module */
+const DEFAUL_SPEC_FILEPATH_IN_NPM_MODULE = './openapi.yaml';
+/* Name of the specification file copied locally (without extension) */
+const LOCAL_SPEC_FILENAME = 'openapi';
+/* The local file (path) which will be created in case of generation using specs from an npm module */
+let localFilePathToBeCreated: string | undefined;
+
+if (argv['spec-package-name']) {
+  const specPathInNpmPackage = argv['spec-package-path'] || DEFAUL_SPEC_FILEPATH_IN_NPM_MODULE;
+  localFilePathToBeCreated = `./${LOCAL_SPEC_FILENAME}${extname(specPathInNpmPackage)}`;
+}
 
 const commonSchematicArgs = [
   argv.debug !== undefined ? `--debug=${argv.debug as string}` : '--debug=false', // schematics enable debug mode per default when using schematics with relative path
@@ -88,7 +99,8 @@ const run = () => {
   ];
   const coreSchematicArgs = [
     ...commonSchematicArgs,
-    '--spec-path', argv['spec-package-name'] ? './openapi.yml' : isSpecRelativePath ? relative(resolveTargetDirectory, resolve(process.cwd(), argv['spec-path'])) : argv['spec-path']
+    '--spec-path',
+    localFilePathToBeCreated || (isSpecRelativePath ? relative(resolveTargetDirectory, resolve(process.cwd(), argv['spec-path'])) : argv['spec-path'])
   ];
 
   const runner = process.platform === 'win32' ? `${packageManager}.cmd` : packageManager;

diff --git a/packages/@ama-sdk/showcase-sdk/package.json b/packages/@ama-sdk/showcase-sdk/package.json
@@ -1,6 +1,5 @@
 {
   "name": "@ama-sdk/showcase-sdk",
-  "private": true,
   "version": "0.0.0-placeholder",
   "description": "showcase-sdk - SDK",
   "source": "src/index.ts",
@@ -13,6 +12,9 @@
   "esm2015": "esm2015/index.js",
   "types": "index.d.ts",
   "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     "./package.json": {
       "default": "./package.json"

diff --git a/packages/@ama-sdk/showcase-sdk/project.json b/packages/@ama-sdk/showcase-sdk/project.json
@@ -38,5 +38,5 @@
       }
     }
   },
-  "tags": ["private", "showcase"]
+  "tags": ["showcase"]
 }
diff --git a/packages/@ama-sdk/showcase-sdk/readme.md b/packages/@ama-sdk/showcase-sdk/readme.md
@@ -1,6 +1,9 @@
 # Showcase SDK
 
-### Based on Swagger spec 1.0.17
+>Note:
+This package is intended for **testing purposes only**. It is not suitable for production use.
+
+### Based on openapi specs 3.0.2
 
 The SDK contains 2 different parts: