fix(ama-sdk): support of URL as spec-path input

AmadeusITGroup · Mar 29, 2024 · e669b21 · e669b21
1 parent d5269bc
commit e669b21
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 16 deletions.
diff --git a/packages/@ama-sdk/create/src/index.ts b/packages/@ama-sdk/create/src/index.ts
@@ -73,7 +73,7 @@ const schematicArgs = [
 const resolveTargetDirectory = resolve(process.cwd(), targetDirectory);
 
 const run = () => {
-  const isSpecPathUrl = url.URL.canParse(argv['spec-path']);
+  const isSpecPathUrl = !!argv['spec-path'] && url.URL.canParse(argv['spec-path']);
 
   const runner = process.platform === 'win32' ? `${packageManager}.cmd` : packageManager;
   const steps: { args: string[]; cwd?: string; runner?: string }[] = [

diff --git a/packages/@ama-sdk/schematics/schematics/typescript/core/index.ts b/packages/@ama-sdk/schematics/schematics/typescript/core/index.ts
@@ -12,8 +12,9 @@ import {
   url
 } from '@angular-devkit/schematics';
 import type { Operation, PathObject } from '@ama-sdk/core';
-import { readFileSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 import * as path from 'node:path';
+import { URL } from 'node:url';
 import * as semver from 'semver';
 import * as sway from 'sway';
 
@@ -166,9 +167,31 @@ const getGeneratorOptions = (tree: Tree, context: SchematicContext, options: NgG
  */
 function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKCoreSchematicsSchema): Rule {
 
-  return (tree, context) => {
+  return async (tree, context) => {
     const targetPath = options.directory || '';
     const generatorOptions = getGeneratorOptions(tree, context, options);
+    let isJson = false;
+    let specDefaultPath = path.posix.join(targetPath, 'openapi.json');
+    specDefaultPath = existsSync(specDefaultPath) ? specDefaultPath : path.posix.join(targetPath, 'openapi.yaml');
+    generatorOptions.specPath ||= specDefaultPath;
+
+    const specContent = URL.canParse(generatorOptions.specPath) ? await (await fetch(generatorOptions.specPath)).text() : readFileSync(generatorOptions.specPath, {encoding: 'utf-8'}).toString();
+
+    try {
+      JSON.parse(specContent);
+      isJson = true;
+    } catch (e) {
+      isJson = false;
+    }
+    const defaultFileName = `openapi.${isJson ? 'json' : 'yaml'}`;
+    specDefaultPath = path.posix.join(targetPath, defaultFileName);
+    generatorOptions.specPath = specDefaultPath;
+
+    if (tree.exists(specDefaultPath)) {
+      tree.overwrite(specDefaultPath, specContent);
+    } else {
+      tree.create(specDefaultPath, specContent);
+    }
 
     /**
      * rule to clear previous SDK generation
@@ -182,7 +205,7 @@ function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKCoreSchematic
 
     const generateOperationFinder = async (): Promise<PathObject[]> => {
       const swayOptions = {
-        definition: path.resolve(generatorOptions.specPath!)
+        definition: specDefaultPath
       };
       const swayApi = await sway.create(swayOptions);
       const extraction = swayApi.getPaths().map((obj) => ({
@@ -212,26 +235,19 @@ function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKCoreSchematic
     };
 
     /**
-     * Update local swagger spec file
+     * Update readme version
      */
-    const updateSpec = () => {
+    const updateSpecVersion = () => {
       const readmeFile = path.posix.join(targetPath, 'readme.md');
-      const specContent = readFileSync(generatorOptions.specPath!).toString();
       if (tree.exists(readmeFile)) {
         const specVersion = /version: *([0-9]+\.[0-9]+\.[0-9]+(?:-[^ ]+)?)/.exec(specContent);
 
         if (specVersion) {
           const readmeContent = tree.read(readmeFile)!.toString('utf8');
-          tree.overwrite(readmeFile, readmeContent.replace(/Based on (OpenAPI|Swagger) spec .*/i, `Based on $1 spec ${specVersion[1]}`));
+          tree.overwrite(readmeFile, readmeContent.replace(/Based on OpenAPI spec .*/i, `Based on $1 spec ${specVersion[1]}`));
         }
       }
-
-      if (tree.exists(path.posix.join(targetPath, 'swagger-spec.yaml'))) {
-        tree.overwrite(path.posix.join(targetPath, 'swagger-spec.yaml'), specContent);
-      } else {
-        tree.create(path.posix.join(targetPath, 'swagger-spec.yaml'), specContent);
-      }
-      return () => tree;
+      return tree;
     };
 
     const runGeneratorRule = () => {
@@ -245,7 +261,7 @@ function ngGenerateTypescriptSDKFn(options: NgGenerateTypescriptSDKCoreSchematic
     return chain([
       clearGeneratedCode,
       generateSource,
-      updateSpec,
+      updateSpecVersion,
       runGeneratorRule
     ]);
   };