@openapi-qraft/plugin 1.8.0

package/dist/lib/open-api/readSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readSchema.js","sourceRoot":"","sources":["../../../src/lib/open-api/readSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAIrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAIzE,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,MAAmD,EACnD,EAAE;IACF,MAAM,KAAK,GAAG,MAAM,YAAY,CAC9B;QACE,KAAK,EAAE;YACL,8BAA8B,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,wCAAwC;SAChG;KACF,EACD,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CACzB,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE;QAC7C,KAAK;QACL,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IAEH,OAAO,MAA2B,CAAC;AACrC,CAAC,CAAC"}

package/dist/lib/writeGeneratorFiles.d.ts

@@ -0,0 +1,6 @@
+import { Ora } from 'ora';
+import { GeneratorFile } from './GeneratorFile.js';
+export declare const writeGeneratorFiles: ({ spinner, fileItems, }: {
+    spinner: Ora;
+    fileItems: GeneratorFile[];
+}) => Promise<void>;

package/dist/lib/writeGeneratorFiles.js

@@ -0,0 +1,51 @@
+import c from 'ansi-colors';
+import fs from 'node:fs';
+export const writeGeneratorFiles = async ({ spinner, fileItems, }) => {
+    await setupDirectories(spinner, fileItems);
+    await writeFiles(spinner, fileItems);
+};
+const setupDirectories = async (spinner, fileItems) => {
+    for (const fileItem of fileItems) {
+        if (!('directory' in fileItem))
+            continue;
+        if (fileItem.clean) {
+            spinner.text = `Cleaning ${c.magenta(fileItem.directory.pathname)}`;
+            try {
+                await fs.promises.rm(fileItem.directory, {
+                    recursive: true,
+                    force: true,
+                });
+            }
+            catch (error) {
+                spinner.fail(c.redBright(`Error occurred during ${c.magenta(fileItem.directory.pathname)} directory cleaning`));
+                throw error;
+            }
+        }
+        try {
+            spinner.text = `Creating directory ${c.magenta(fileItem.directory.pathname)}`;
+            await fs.promises.mkdir(fileItem.directory, { recursive: true });
+        }
+        catch (error) {
+            spinner.fail(c.redBright(`Error occurred during ${c.magenta(fileItem.directory.pathname)} directory creation`));
+            throw error;
+        }
+    }
+};
+const writeFiles = async (spinner, fileItems) => {
+    for (const fileItem of fileItems) {
+        if ('directory' in fileItem)
+            continue;
+        const { file, code } = fileItem;
+        spinner.text = `Writing ${c.magenta(file.pathname)}`;
+        try {
+            await fs.promises.writeFile(file, code, {
+                encoding: 'utf-8',
+            });
+        }
+        catch (error) {
+            spinner.fail(c.redBright(`Error occurred during ${c.magenta(file.pathname)} file writing`));
+            throw error;
+        }
+    }
+};
+//# sourceMappingURL=writeGeneratorFiles.js.map

package/dist/lib/writeGeneratorFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeGeneratorFiles.js","sourceRoot":"","sources":["../../src/lib/writeGeneratorFiles.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,aAAa,CAAC;AAC5B,OAAO,EAAE,MAAM,SAAS,CAAC;AAKzB,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,EACxC,OAAO,EACP,SAAS,GAIV,EAAE,EAAE;IACH,MAAM,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC3C,MAAM,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAY,EAAE,SAA0B,EAAE,EAAE;IAC1E,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC;YAAE,SAAS;QAEzC,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;YAEpE,IAAI,CAAC;gBACH,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE;oBACvC,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,IAAI;iBACZ,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CACV,CAAC,CAAC,SAAS,CACT,yBAAyB,CAAC,CAAC,OAAO,CAChC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAC5B,qBAAqB,CACvB,CACF,CAAC;gBAEF,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,IAAI,CAAC;YACH,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;YAE9E,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CACV,CAAC,CAAC,SAAS,CACT,yBAAyB,CAAC,CAAC,OAAO,CAChC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAC5B,qBAAqB,CACvB,CACF,CAAC;YAEF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,KAAK,EAAE,OAAY,EAAE,SAA0B,EAAE,EAAE;IACpE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,WAAW,IAAI,QAAQ;YAAE,SAAS;QAEtC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAEhC,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAErD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE;gBACtC,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CACV,CAAC,CAAC,SAAS,CACT,yBAAyB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CACjE,CACF,CAAC;YAEF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@openapi-qraft/plugin",
+  "version": "1.8.0",
+  "packageManager": "yarn@4.0.2",
+  "type": "module",
+  "scripts": {
+    "build": "rimraf dist/ && tsc --project tsconfig.build.json",
+    "dev": "yarn build --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./*": "./dist/*.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ]
+    }
+  },
+  "dependencies": {
+    "ansi-colors": "^4.1.3",
+    "camelcase": "^8.0.0",
+    "micromatch": "^4.0.5",
+    "openapi-typescript": "7.0.0-next.7",
+    "ora": "^8.0.1",
+    "yaml": "^2.3.4"
+  },
+  "devDependencies": {
+    "@openapi-qraft/test-fixtures": "~1.0.0",
+    "@types/micromatch": "^4",
+    "@types/node": "^18.19.4",
+    "commander": "^11.1.0",
+    "eslint": "^9.0.0",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.3",
+    "vitest": "^1.4.0"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*",
+    "!src/**/*.test.*",
+    "!src/**/*.spec.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/lib/GeneratorFile.ts

@@ -0,0 +1,5 @@
+import type { URL } from 'node:url';
+
+export type GeneratorFile =
+  | { file: URL; code: string }
+  | { directory: URL; clean: boolean };

package/src/lib/OutputOptions.ts

@@ -0,0 +1,6 @@
+import { URL } from 'node:url';
+
+export interface OutputOptions {
+  dir: URL;
+  clean: boolean;
+}

package/src/lib/QraftCommand.ts

@@ -0,0 +1,192 @@
+import c from 'ansi-colors';
+import { Command } from 'commander';
+import { sep } from 'node:path';
+import process from 'node:process';
+import { pathToFileURL, URL } from 'node:url';
+import ora, { Ora } from 'ora';
+
+import { GeneratorFile } from './GeneratorFile.js';
+import { getDocumentServices } from './open-api/getDocumentServices.js';
+import { Service } from './open-api/getServices.js';
+import { OutputOptions } from './OutputOptions.js';
+import { writeGeneratorFiles } from './writeGeneratorFiles.js';
+
+export class QraftCommand extends Command {
+  constructor() {
+    super();
+
+    this.usage('[input] [options]')
+      .argument(
+        '[input]',
+        'Input OpenAPI Schema file path, URL (json, yml)',
+        null
+      )
+      .requiredOption(
+        '-o, --output-dir <path>',
+        'Output directory for generated services'
+      )
+      .option(
+        '-rm, --clean',
+        'Clean output directory before generating services'
+      )
+      .option(
+        '--filter-services <glob-pattern>',
+        'Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more details.'
+      )
+      .option(
+        '--postfix-services <string>',
+        'Postfix to be added to the generated service name (eg: Service)'
+      )
+      .option(
+        '--service-name-base <endpoint[<index>] | tags>',
+        'Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: "/0/1/2") or `tags` as the base name of the service.',
+        'endpoint[0]'
+      );
+  }
+
+  action(callback: QraftCommandActionCallback): this {
+    return super.action(async (...actionArgs) => {
+      const { version: packageVersion } = await import(
+        '@openapi-qraft/plugin/package.json',
+        {
+          assert: { type: 'json' },
+        }
+      ).then(({ default: packageJSON }) => packageJSON);
+
+      const inputs = actionArgs.filter(
+        (arg) => typeof arg === 'string'
+      ) as string[];
+      const args = actionArgs.find(
+        (arg) => arg && typeof arg === 'object'
+      ) as Record<string, any>;
+
+      if (!args) throw new Error('Arguments object not found');
+
+      if (args.version) {
+        console.info(`v${packageVersion}`);
+        process.exit(0);
+      }
+
+      console.info(`✨ ${c.bold(`OpenAPI Qraft ${packageVersion}`)}`);
+
+      const spinner = ora('Starting the Qraft ⛏︎').start();
+
+      await callback(
+        {
+          inputs,
+          args,
+          spinner,
+          services: await this.#getServices(inputs[0], args),
+          output: {
+            dir: normalizeOutputDirPath(args.outputDir),
+            clean: args.clean,
+          },
+        },
+        async function resolveGeneratorFiles(fileItems) {
+          try {
+            await writeGeneratorFiles({
+              fileItems,
+              spinner,
+            });
+            spinner.succeed(c.green('Qraft has been finished'));
+          } catch (error) {
+            spinner.fail(c.red('Error occurred during generation'));
+
+            if (error instanceof Error) {
+              console.error(c.red(error.message), c.red(error.stack ?? ''));
+            }
+
+            console.error(error);
+            process.exit(1);
+          }
+        }
+      );
+    });
+  }
+
+  async #getServices(input: unknown, args: Record<string, any>) {
+    const cwd = `${process.cwd()}/`;
+
+    const source =
+      input && typeof input === 'string'
+        ? new URL(input, pathToFileURL(cwd))
+        : process.stdin;
+
+    if (source === process.stdin && source.isTTY) {
+      console.error(
+        c.red(
+          'Input file not found or stdin is empty. Please specify `--input` option or pipe OpenAPI Schema to stdin.'
+        )
+      );
+
+      process.exit(1);
+    }
+
+    return await getDocumentServices({
+      output: {
+        postfixServices: args.postfixServices,
+        serviceNameBase: args.serviceNameBase,
+      },
+      servicesGlob: parseServicesFilterOption(args.filterServices),
+      source,
+    });
+  }
+}
+
+/**
+ * Normalize an output directory path by adding trailing slash
+ */
+function normalizeOutputDirPath(outputDir: string): URL {
+  return pathToFileURL(
+    outputDir.endsWith(sep) ? outputDir : `${outputDir}${sep}`
+  );
+}
+
+/**
+ * Parse services filter option to array
+ * @example
+ * ```ts
+ * parseServicesFilterOption('/user/**,/post/**')
+ * ```
+ * @param endpointGlobs
+ */
+function parseServicesFilterOption(
+  endpointGlobs: string
+): string[] | undefined {
+  return endpointGlobs
+    ? endpointGlobs
+        .split(',')
+        .filter((item: unknown): item is string =>
+          Boolean(typeof item === 'string' && item.trim())
+        )
+    : undefined;
+}
+
+export type QraftCommandActionCallback = (
+  options: {
+    /**
+     * Command inputs, e.g. `bin <input> [options]` where `<input>` is the `inputs` item
+     */
+    inputs: string[];
+    /**
+     * Command arguments, e.g. `bin <input> [options]` where `[options]` is the `args`
+     */
+    args: Record<string, any>;
+    /**
+     * Resolve the generator files
+     */
+    /**
+     * Spinner instance
+     */
+    spinner: Ora;
+    /**
+     * OpenAPI services
+     */
+    services: Service[];
+    /**
+     * Output options
+     */
+    output: OutputOptions;
+  },
+  resolve: (files: GeneratorFile[]) => Promise<void>
+) => void | Promise<void>;

package/src/lib/QraftCommandPlugin.ts

@@ -0,0 +1,5 @@
+import { QraftCommand } from './QraftCommand.js';
+
+export interface QraftCommandPlugin {
+  setupCommand(command: QraftCommand): void;
+}

package/src/lib/fileHeader.ts

@@ -0,0 +1,2 @@
+export const fileHeader = `/* generated using @openapi-qraft/cli -- do no edit */
+/* istanbul ignore file */`;

package/src/lib/open-api/OpenAPISchemaType.ts

@@ -0,0 +1,31 @@
+export type OpenAPISchemaType = {
+  paths: {
+    [path: string]: {
+      [method: string]: {
+        tags?: string[];
+        description?: string;
+        summary?: string;
+        operationId?: string;
+        parameters?: Record<string, any>;
+        deprecated?: boolean;
+        requestBody?: {
+          content: {
+            [contentType: string]: {
+              schema: any;
+            };
+          };
+        };
+        responses: {
+          [statusCode in number | 'default']: {
+            description: string;
+            content: {
+              [contentType: string]: {
+                schema: any;
+              };
+            };
+          };
+        };
+      };
+    };
+  };
+};

package/src/lib/open-api/getContent.ts

@@ -0,0 +1,26 @@
+const BASIC_MEDIA_TYPES = [
+  'application/json-patch+json',
+  'application/json',
+  'application/x-www-form-urlencoded',
+  'text/json',
+  'text/plain',
+  'multipart/form-data',
+  'multipart/mixed',
+  'multipart/related',
+  'multipart/batch',
+];
+
+export const getContentMediaType = (content: {
+  [contentType: string]: { schema: unknown };
+}) => {
+  const basicMediaTypeWithSchema = Object.keys(content)
+    .filter((mediaType) => {
+      const cleanMediaType = mediaType.split(';')[0].trim();
+      return BASIC_MEDIA_TYPES.includes(cleanMediaType);
+    })
+    .find((mediaType) => content[mediaType]?.schema);
+
+  if (basicMediaTypeWithSchema) return basicMediaTypeWithSchema;
+
+  return Object.keys(content).find((mediaType) => content[mediaType]?.schema);
+};

package/src/lib/open-api/getDocumentServices.ts

@@ -0,0 +1,19 @@
+import type { Readable } from 'node:stream';
+import type { URL } from 'node:url';
+import type { OpenAPI3 } from 'openapi-typescript';
+
+import { getServices, ServiceOutputOptions } from './getServices.js';
+import { readSchema } from './readSchema.js';
+
+export const getDocumentServices = async ({
+  source,
+  servicesGlob,
+  output,
+}: {
+  source: string | URL | OpenAPI3 | Readable | Buffer;
+  servicesGlob: string[] | undefined;
+  output: ServiceOutputOptions;
+}) => {
+  const schema = await readSchema(source);
+  return getServices(schema, output, servicesGlob);
+};

package/src/lib/open-api/getOperationName.ts

@@ -0,0 +1,28 @@
+import camelCase from 'camelcase';
+
+/**
+ * Convert the input value to a correct operation (method) classname.
+ * This will use the operation ID - if available - and otherwise fallback
+ * on a generated name from the URL
+ */
+export const getOperationName = (
+  url: string,
+  method: string,
+  operationId?: string
+): string => {
+  if (operationId) {
+    return camelCase(
+      operationId
+        .replace(/^[^a-zA-Z]+/g, '')
+        .replace(/[^\w-]+/g, '-')
+        .trim()
+    );
+  }
+
+  const urlWithoutPlaceholders = url
+    .replace(/[^/]*?{api-version}.*?\//g, '')
+    .replace(/{(.*?)}/g, '')
+    .replace(/\//g, '-');
+
+  return camelCase(`${method}-${urlWithoutPlaceholders}`);
+};

package/src/lib/open-api/getServiceName.ts

@@ -0,0 +1,14 @@
+import camelCase from 'camelcase';
+
+/**
+ * Convert the input value to the correct service name. This converts
+ * the input string to PascalCase.
+ */
+export const getServiceName = (value: string): string => {
+  const clean = value
+    .replace(/^[^a-zA-Z]+/g, '')
+    .replace(/[^\w-]+/g, '-')
+    .trim();
+
+  return camelCase(clean, { pascalCase: true });
+};

package/src/lib/open-api/getServiceNamesByOperationEndpoint.ts

@@ -0,0 +1,70 @@
+import { getServiceName } from './getServiceName.js';
+
+export type ServiceBaseNameByEndpointOption = `endpoint[${number}]`;
+
+export const getServiceNamesByOperationEndpoint = (
+  endpoint: string,
+  format: ServiceBaseNameByEndpointOption,
+  fallbackBaseName: string
+): [string] => {
+  return [
+    getServiceName(
+      getServiceBaseNameByOperationEndpoint(endpoint, format) ??
+        fallbackBaseName
+    ),
+  ];
+};
+
+export const getServiceBaseNameByOperationEndpoint = (
+  endpoint: string,
+  format: ServiceBaseNameByEndpointOption
+): string | undefined => {
+  const endpointParts = endpoint.split('/').filter(Boolean);
+
+  for (
+    let endpointIndex = getEndpointPartIndex(format);
+    endpointIndex >= 0;
+    endpointIndex--
+  ) {
+    const endpointPart = endpointParts[endpointIndex];
+    if (endpointPart) return endpointPart;
+  }
+};
+
+export const getEndpointPartIndex = (
+  endpointOption: ServiceBaseNameByEndpointOption
+) => {
+  const startBracketString = 'endpoint[';
+
+  const endpointIndexStart = endpointOption.indexOf(startBracketString);
+
+  if (endpointIndexStart === -1)
+    throw new Error(
+      `Expected endpoint to start with '${startBracketString}' but got: '${endpointOption}'`
+    );
+
+  const endBracketString = ']';
+  const endpointIndexEnd = endpointOption.indexOf(
+    endBracketString,
+    endpointIndexStart
+  );
+
+  if (endpointIndexEnd === -1)
+    throw new Error(
+      `Expected endpoint to end with '${endBracketString}' but got: '${endpointOption}'`
+    );
+
+  const endpointIndex = parseInt(
+    endpointOption.slice(
+      endpointIndexStart + startBracketString.length,
+      endpointIndexEnd
+    )
+  );
+
+  if (!isFinite(endpointIndex))
+    throw new Error(
+      `Expected endpoint index to be a number but got: '${endpointOption}'`
+    );
+
+  return endpointIndex;
+};

package/src/lib/open-api/getServiceNamesByOperationTags.ts

@@ -0,0 +1,15 @@
+import { getServiceName } from './getServiceName.js';
+
+export const getServiceNamesByOperationTags = (
+  tags: (string | number | null | undefined)[] | undefined,
+  fallbackBaseName: string
+): string[] => {
+  const filteredTags = tags
+    ?.filter((tag): tag is string => typeof tag === 'string')
+    .map(getServiceName)
+    .filter(Boolean);
+
+  return filteredTags?.length
+    ? filteredTags
+    : [getServiceName(fallbackBaseName)];
+};