@ama-openapi/create 0.0.0-placeholder

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@ama-openapi/create",
+  "version": "0.0.0-placeholder",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Create a new OpenApi Specification project",
+  "keywords": [
+    "create"
+  ],
+  "bin": "./src/index.js",
+  "scripts": {
+    "nx": "nx",
+    "ng": "yarn nx",
+    "compile": "tsc -b tsconfig.build.json",
+    "build": "yarn nx build ama-openapi-create",
+    "copy:templates": "cpy 'templates/**' dist/templates/",
+    "postbuild": "cpy 'package.json' 'dist' && patch-package-json-main"
+  },
+  "peerDependencies": {
+    "@o3r/telemetry": "workspace:~",
+    "type-fest": "^4.30.1"
+  },
+  "peerDependenciesMeta": {
+    "@o3r/telemetry": {
+      "optional": true
+    },
+    "type-fest": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@ama-openapi/core": "workspace:~",
+    "ejs": "~3.1.9",
+    "globby": "^11.1.0",
+    "tslib": "^2.6.2",
+    "yargs": "~18.0.0"
+  },
+  "devDependencies": {
+    "@angular-devkit/schematics": "~20.3.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
+    "@nx/eslint": "~21.6.0",
+    "@nx/eslint-plugin": "~21.6.0",
+    "@nx/jest": "~21.6.0",
+    "@nx/js": "~21.6.0",
+    "@o3r/build-helpers": "workspace:~",
+    "@o3r/eslint-config": "workspace:~",
+    "@o3r/eslint-plugin": "workspace:~",
+    "@o3r/telemetry": "workspace:~",
+    "@o3r/test-helpers": "workspace:~",
+    "@schematics/angular": "~20.3.0",
+    "@stylistic/eslint-plugin": "~5.5.0",
+    "@types/ejs": "^3.1.2",
+    "@types/jest": "~29.5.2",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "~22.18.0",
+    "@types/pid-from-port": "^1.1.0",
+    "@types/semver": "^7.3.13",
+    "@types/yargs": "~17.0.33",
+    "@typescript-eslint/parser": "~8.46.0",
+    "angular-eslint": "~20.4.0",
+    "cpy-cli": "^6.0.0",
+    "eslint": "~9.38.0",
+    "eslint-import-resolver-node": "~0.3.9",
+    "eslint-import-resolver-typescript": "~4.4.0",
+    "eslint-plugin-import": "~2.32.0",
+    "eslint-plugin-import-newlines": "~1.4.0",
+    "eslint-plugin-jest": "~29.0.0",
+    "eslint-plugin-jsdoc": "~54.7.0",
+    "eslint-plugin-prefer-arrow": "~1.2.3",
+    "eslint-plugin-unicorn": "~60.0.0",
+    "eslint-plugin-unused-imports": "~4.3.0",
+    "globals": "^16.0.0",
+    "jest": "~29.7.0",
+    "jest-junit": "~16.0.0",
+    "jest-util": "~29.7.0",
+    "jsonc-eslint-parser": "~2.4.0",
+    "nx": "~21.6.0",
+    "pid-from-port": "^1.1.3",
+    "rimraf": "^6.0.1",
+    "rxjs": "^7.8.1",
+    "semver": "^7.5.2",
+    "ts-jest": "~29.4.0",
+    "type-fest": "^4.30.1",
+    "typescript": "~5.9.2",
+    "typescript-eslint": "~8.46.0"
+  },
+  "generatorDependencies": {
+    "@redocly/openapi-core": "~2.8.0"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.17.0 || ^24.0.0",
+    "yarn": ">=2.0.0 <5.0.0",
+    "npm": ">=4"
+  }
+}

package/src/generate-template.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Options for template generation
+ */
+export interface CreateOptions {
+    /** Target directory */
+    target: string;
+    /** Path to external models */
+    externalModelPath: string;
+    /** Version of the generator */
+    version: string;
+    /** Name of the package/artifact */
+    packageName: string;
+}
+/**
+ * Generate Template files
+ * @param options
+ */
+export declare const generateTemplate: (options: CreateOptions) => Promise<void[]>;

package/src/generate-template.js

@@ -0,0 +1,43 @@
+"use strict";
+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 ejs_1 = require("ejs");
+const globby_1 = require("globby");
+const TEMPLATE_EXTENSION = '.template';
+/**
+ * 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 templatesDirectory = (0, node_path_1.resolve)(__dirname, '..', 'templates');
+    const regExpExtension = new RegExp(`\\${TEMPLATE_EXTENSION}$`);
+    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,
+            redoclyVersion: generatorDependencies['@redocly/openapi-core'],
+            standardGitignoreNode: await (await fetch('https://www.toptal.com/developers/gitignore/api/node')).text()
+        }, { async: true });
+        return {
+            templatePath,
+            content
+        };
+    })
+        .map(async (file) => {
+        const { templatePath, content } = await file;
+        const outputPath = (0, node_path_1.resolve)(options.target, templatePath.replace(regExpExtension, ''));
+        try {
+            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);
+};
+exports.generateTemplate = generateTemplate;

package/src/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/src/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const core_1 = require("@ama-openapi/core");
+const yargs = require("yargs");
+const helpers_1 = require("yargs/helpers");
+const generate_template_1 = require("./generate-template");
+void (async () => {
+    const version = JSON.parse(await node_fs_1.promises.readFile((0, node_path_1.resolve)(__dirname, '..', 'package.json'), { encoding: 'utf8' })).version;
+    await yargs((0, helpers_1.hideBin)(process.argv))
+        .option('target', {
+        alias: 't',
+        type: 'string',
+        description: 'Target directory to generate the files into',
+        default: process.cwd()
+    })
+        .command('design <name>', 'Name of the artifact / package to generate', (y) => {
+        return y.positional('name', {
+            type: 'string',
+            demandOption: true,
+            describe: 'Name of the artifact / package to generate'
+        });
+    }, async (argv) => {
+        const options = {
+            target: argv.target,
+            externalModelPath: core_1.OUTPUT_DIRECTORY,
+            version,
+            packageName: argv.name
+        };
+        await (0, generate_template_1.generateTemplate)(options);
+    })
+        .version(version)
+        .alias('h', 'help')
+        .alias('v', 'version')
+        .parse();
+})();

package/templates/.gitignore.template

@@ -0,0 +1,4 @@
+<%= standardGitignoreNode %>
+
+# Ignore external models
+/<%= externalModelPath %>

package/templates/.vscode/extensions.json.template

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "42Crunch.vscode-openapi",
+    "stoplight.spectral"
+  ]
+}

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

@@ -0,0 +1,9 @@
+{
+  "editor.defaultFormatter": "42Crunch.vscode-openapi",
+  "files.readonlyFromPermissions": true,
+  "files.readonlyInclude": {
+    "**/.cache/**": true,
+    "**/node_modules/**": true,
+    "**/<%= externalModelPath %>/**/*.{json,yaml,yml}": true
+  }
+}

package/templates/apis/example.v1.yaml.template

@@ -0,0 +1,28 @@
+openapi: 3.0.0
+info:
+  title: My first OpenApi Model
+  version: '1.0'
+  description: Example of an OpenAPI specification
+
+servers:
+  - url: 'https://{environment}.my-api.com'
+    variables:
+      environment:
+        enum:
+          - 'dev'
+          - 'prd'
+        default: 'prd'
+        description: Software environment
+security: []
+paths:
+  '/v1/example':
+    get:
+      summary: Retrieve an example.
+      tags:
+        - ExampleTag
+      operationId: example-tag
+      responses:
+        '200':
+          $ref: '../responses/ExampleResponse.v1.yaml'
+      description: |-
+        Example endpoint description.

package/templates/models/ExampleModel.v1.yaml.template

@@ -0,0 +1,8 @@
+title: Example
+description: |-
+  Example model for demonstration purposes.
+type: object
+properties:
+  field:
+    type: string
+    description: Sample data field

package/templates/openapi.manifest.yaml.template

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

package/templates/package.json.template

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://raw.githubusercontent.com/AmadeusITGroup/otter/refs/heads/feature/open-api/packages/@ama-openapi/core/schemas/manifest.schema.json",
+  "name": "<%= packageName %>",
+  "preferUnplugged": true,
+  "version": "0.0.0-placeholder",
+  "description": "My Specification description",
+  "main": "bundle/specification.yaml",
+  "files": [
+    "bundle",
+    "models"
+  ],
+  "readme": "README.md",
+  "scripts": {
+    "build": "redocly bundle",
+    "retrieve-externals": "ama-openapi install",
+    "postinstall": "ama-openapi install"
+  },
+  "dependencies": {
+    "@ama-openapi/cli": "~<%= version %>"
+  },
+  "devDependencies": {
+    "@ama-openapi/redocly-plugin": "~<%= version %>",
+    "@redocly/cli": "<%= redoclyVersion %>"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./models/*": "./models/*",
+    "./bundle/*": "./bundle/*",
+    ".": {
+      "module": "./bundle/specification.yaml",
+      "default": "./bundle/specification.yaml"
+    }
+  }
+}

package/templates/redocly.yaml.template

@@ -0,0 +1,11 @@
+extends:
+  - recommended
+
+plugins:
+  - '@ama-openapi/redocly-plugin'
+
+apis:
+  example@v1:
+    root: apis/example.v1.yaml
+    output: bundle/specification.yaml
+prepare-publish

package/templates/renovate.json.template

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

package/templates/responses/ExampleResponse.v1.yaml.template

@@ -0,0 +1,9 @@
+description: |-
+  Example response model for demonstration purposes.
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        data:
+          $ref: '../models/ExampleModel.v1.yaml'