@ama-openapi/create 0.0.0-placeholder.1 → 0.0.0-placeholder.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-openapi/create",
-  "version": "0.0.0-placeholder.1",
+  "version": "0.0.0-placeholder.10",
   "publishConfig": {
     "access": "public"
   },
@@ -18,7 +18,7 @@
     "postbuild": "cpy 'package.json' 'dist' && patch-package-json-main"
   },
   "peerDependencies": {
-    "@o3r/telemetry": "~0.0.0",
+    "@o3r/telemetry": "~0.0.0-placeholder.10",
     "type-fest": "^4.30.1"
   },
   "peerDependenciesMeta": {
@@ -30,7 +30,7 @@
     }
   },
   "dependencies": {
-    "@ama-openapi/core": "~0.0.0",
+    "@ama-openapi/core": "~0.0.0-placeholder.10",
     "ejs": "~3.1.9",
     "globby": "^11.1.0",
     "tslib": "^2.6.2",
@@ -43,11 +43,11 @@
     "@nx/eslint-plugin": "~21.6.0",
     "@nx/jest": "~21.6.0",
     "@nx/js": "~21.6.0",
-    "@o3r/build-helpers": "~0.0.0",
-    "@o3r/eslint-config": "~0.0.0",
-    "@o3r/eslint-plugin": "~0.0.0",
-    "@o3r/telemetry": "~0.0.0",
-    "@o3r/test-helpers": "~0.0.0",
+    "@o3r/build-helpers": "~0.0.0-placeholder.10",
+    "@o3r/eslint-config": "~0.0.0-placeholder.10",
+    "@o3r/eslint-plugin": "~0.0.0-placeholder.10",
+    "@o3r/telemetry": "~0.0.0-placeholder.10",
+    "@o3r/test-helpers": "~0.0.0-placeholder.10",
     "@schematics/angular": "~20.3.0",
     "@stylistic/eslint-plugin": "~5.5.0",
     "@types/ejs": "^3.1.2",
@@ -58,9 +58,9 @@
     "@types/semver": "^7.3.13",
     "@types/yargs": "~17.0.33",
     "@typescript-eslint/parser": "~8.46.0",
-    "angular-eslint": "~20.4.0",
+    "angular-eslint": "~20.5.0",
     "cpy-cli": "^6.0.0",
-    "eslint": "~9.38.0",
+    "eslint": "~9.39.0",
     "eslint-import-resolver-node": "~0.3.9",
     "eslint-import-resolver-typescript": "~4.4.0",
     "eslint-plugin-import": "~2.32.0",
@@ -86,7 +86,7 @@
     "typescript-eslint": "~8.46.0"
   },
   "generatorDependencies": {
-    "@redocly/openapi-core": "~2.8.0"
+    "@redocly/openapi-core": "~2.11.0"
   },
   "engines": {
     "node": "^20.19.0 || ^22.17.0 || ^24.0.0",

package/src/generate-template.d.ts

@@ -10,6 +10,8 @@ export interface CreateOptions {
     version: string;
     /** Name of the package/artifact */
     packageName: string;
+    /** Logger */
+    logger: typeof console;
 }
 /**
  * Generate Template files

package/src/generate-template.js

@@ -3,24 +3,53 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateTemplate = void 0;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
+const core_1 = require("@ama-openapi/core");
 const ejs_1 = require("ejs");
 const globby_1 = require("globby");
 const TEMPLATE_EXTENSION = '.template';
+const GIT_IGNORE_IO_URL = 'https://www.toptal.com/developers/gitignore/api/node';
+/**
+ * Retrieve the gitignore content generated by gitignore.io
+ * @param options
+ */
+const getGitIgnoreContent = async (options) => {
+    let standardGitignoreNode = '';
+    try {
+        const gitignoreResponse = await fetch(GIT_IGNORE_IO_URL);
+        if (!gitignoreResponse.ok) {
+            throw new Error(`Non-OK response to ${GIT_IGNORE_IO_URL}`);
+        }
+        standardGitignoreNode = await gitignoreResponse.text();
+    }
+    catch (e) {
+        options.logger.warn('gitignore.io service are not available, a default minimal gitignore will be generated');
+        options.logger.debug(e);
+    }
+    return standardGitignoreNode;
+};
 /**
  * Generate Template files
  * @param options
  */
 const generateTemplate = async (options) => {
-    const { generatorDependencies } = JSON.parse(await node_fs_1.promises.readFile((0, node_path_1.resolve)(__dirname, '..', 'package.json'), { encoding: 'utf8' }));
+    const { generatorDependencies, engines } = JSON.parse(await node_fs_1.promises.readFile((0, node_path_1.resolve)(__dirname, '..', 'package.json'), { encoding: 'utf8' }));
     const templatesDirectory = (0, node_path_1.resolve)(__dirname, '..', 'templates');
     const regExpExtension = new RegExp(`\\${TEMPLATE_EXTENSION}$`);
+    const exportedFiles = [
+        'bundle',
+        'models',
+        ...core_1.DEFAULT_MANIFEST_FILENAMES
+    ];
     const generatedCode = (0, globby_1.sync)('**/*', { cwd: templatesDirectory, dot: true })
         .map(async (templatePath) => {
         const templatePathAbsolute = (0, node_path_1.resolve)(templatesDirectory, templatePath);
         const content = await (0, ejs_1.renderFile)(templatePathAbsolute, {
             ...options,
+            nodeSupportedRange: engines.node,
+            projectFolder: (0, node_path_1.basename)(options.target),
+            exportedFiles,
             redoclyVersion: generatorDependencies['@redocly/openapi-core'],
-            standardGitignoreNode: await (await fetch('https://www.toptal.com/developers/gitignore/api/node')).text()
+            standardGitignoreNode: await getGitIgnoreContent(options)
         }, { async: true });
         return {
             templatePath,
@@ -30,12 +59,10 @@ const generateTemplate = async (options) => {
         .map(async (file) => {
         const { templatePath, content } = await file;
         const outputPath = (0, node_path_1.resolve)(options.target, templatePath.replace(regExpExtension, ''));
-        try {
+        const outputDirectory = (0, node_path_1.dirname)(outputPath);
+        if (!(0, node_fs_1.existsSync)(outputDirectory)) {
             await node_fs_1.promises.mkdir((0, node_path_1.dirname)(outputPath), { recursive: true });
         }
-        catch {
-            // ignore error if folder already exists
-        }
         await node_fs_1.promises.writeFile(outputPath, content, { encoding: 'utf8' });
     });
     return Promise.all(generatedCode);

package/src/index.js

@@ -27,7 +27,8 @@ void (async () => {
             target: argv.target,
             externalModelPath: core_1.OUTPUT_DIRECTORY,
             version,
-            packageName: argv.name
+            packageName: argv.name,
+            logger: console
         };
         await (0, generate_template_1.generateTemplate)(options);
     })

package/templates/.gitignore.template

@@ -1,4 +1,12 @@
-<%= standardGitignoreNode %>
+<% if (standardGitignoreNode) { %>
+<%- standardGitignoreNode %>
+<% } else { %>
+# Dependency directory
+node_modules/
+<% } %>
 
-# Ignore external models
-/<%= externalModelPath %>
+# External models directory
+/<%- externalModelPath %>
+
+# Bundle specifications directory
+/bundle

package/templates/.vscode/settings.json.template

@@ -4,6 +4,9 @@
   "files.readonlyInclude": {
     "**/.cache/**": true,
     "**/node_modules/**": true,
-    "**/<%= externalModelPath %>/**/*.{json,yaml,yml}": true
+    "**/<%- externalModelPath %>/**/*.{json,yaml,yml}": true
+  },
+  "explorer.fileNesting.patterns": {
+    "package.json": "package-lock.json, openapi.manifest.yaml"
   }
 }

package/templates/README.md.template

@@ -0,0 +1,52 @@
+# <%- packageName %>
+
+This package exposes [OpenApi specification](https://swagger.io/specification/) which can be used to use to generate an SDK or be referred in another specification.
+
+## How to work on it
+
+**Requirements:**
+
+- Code editor [Visual Studio Code](https://code.visualstudio.com/) with the recommended extension (proposed on start).
+- [NodeJs](https://nodejs.org/) with a odd [LTS (or latest) version](https://nodejs.org/en/about/previous-releases).
+
+**Setup:**
+
+```shell
+npm install
+```
+
+### Add dependency
+
+```shell
+npm install <artifact_name>
+```
+
+and refer to its models via config in the [manifest](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/MANIFEST_CONFIGURATION.md):
+
+```yaml
+models:
+  <artifact_name>:
+    - models/first-model.yaml
+    - models/second-model.yaml
+```
+
+> [!NOTE]
+> The complete documentation is available on [Dependency concept documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/DEPENDENCY_RESOLUTION_CONCEPT.md).
+
+## Repository structure
+
+The current repository has the following structure:
+
+```text
+<%- projectFolder %>/
+├── .vscode/                  # VsCode options and recommended extension
+├── apis/                     # List of the Apis to bundle in the final specification
+├── models/                   # Models to be referred locally and shared
+├── responses/                # List of responses used in the APIs
+├── .gitignore
+├── openapi.manifest.yaml
+├── package.json
+├── redocly.yaml
+├── README.md
+└── renovate.json
+```

package/templates/openapi.manifest.yaml.template

@@ -1 +1 @@
-# yaml-language-server: $schema=https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/feature/open-api/packages/@ama-openapi/core/schemas/manifest.schema.json
+# yaml-language-server: $schema=https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/feature/openapi-solution/packages/@ama-openapi/core/schemas/manifest.schema.json

package/templates/package.json.template

@@ -1,26 +1,30 @@
 {
-  "$schema": "https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/feature/open-api/packages/@ama-openapi/core/schemas/manifest.schema.json",
-  "name": "<%= packageName %>",
+  "$schema": "https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/feature/openapi-solution/packages/@ama-openapi/core/schemas/manifest.schema.json",
+  "name": "<%- packageName %>",
   "preferUnplugged": true,
-  "version": "0.0.0-placeholder.1",
+  "version": "0.0.0-placeholder",
   "description": "My Specification description",
   "main": "bundle/specification.yaml",
   "files": [
-    "bundle",
-    "models"
+<%-
+  exportedFiles
+    .map((file) => `    "${file}"`)
+    .join(',\n')
+%>
   ],
   "readme": "README.md",
   "scripts": {
     "build": "redocly bundle",
     "retrieve-externals": "ama-openapi install",
+    "watch:retrieve-externals": "ama-openapi watch",
     "postinstall": "ama-openapi install"
   },
   "dependencies": {
-    "@ama-openapi/cli": "~<%= version %>"
+    "@ama-openapi/cli": "~<%- version %>"
   },
   "devDependencies": {
-    "@ama-openapi/redocly-plugin": "~<%= version %>",
-    "@redocly/cli": "<%= redoclyVersion %>"
+    "@ama-openapi/redocly-plugin": "~<%- version %>",
+    "@redocly/cli": "<%- redoclyVersion %>"
   },
   "exports": {
     "./package.json": "./package.json",
@@ -30,5 +34,8 @@
       "module": "./bundle/specification.yaml",
       "default": "./bundle/specification.yaml"
     }
+  },
+  "engines": {
+    "node": "<%- nodeSupportedRange %>"
   }
 }

package/templates/redocly.yaml.template

@@ -8,4 +8,3 @@ apis:
   example@v1:
     root: apis/example.v1.yaml
     output: bundle/specification.yaml
-prepare-publish

package/templates/renovate.json.template

@@ -1,6 +1,6 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "github>AmadeusITGroup/otter//packages/@ama-openapi/core/renovate#<%= version %>"
+    "github>AmadeusITGroup/otter//packages/@ama-openapi/core/renovate#<%- version %>"
   ]
 }