api 7.0.0-alpha.3 → 7.0.0-alpha.6

package/bin/api.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env NODE_OPTIONS=--no-warnings node
+import '../dist/bin.js';

package/dist/bin.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}

package/dist/bin.js

@@ -1,36 +1,8 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const commands_1 = __importDefault(require("./commands"));
-const pkg = __importStar(require("./packageInfo"));
+import { Command } from 'commander';
+import commands from './commands/index.js';
+import * as pkg from './packageInfo.js';
 (async () => {
-    const program = new commander_1.Command();
+    const program = new Command();
     program.name(pkg.PACKAGE_NAME);
     program.version(pkg.PACKAGE_VERSION);
     /**
@@ -38,8 +10,9 @@ const pkg = __importStar(require("./packageInfo"));
      * programatically doing it like this because it's cleaner for us to let Commander manage option
      * and argument parsing within this file than having each command  manage that itself.
      */
-    Object.entries(commands_1.default).forEach(([, cmd]) => {
+    Object.entries(commands).forEach(([, cmd]) => {
         program.addCommand(cmd);
     });
     await program.parseAsync(process.argv);
 })();
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AAExC,CAAC,KAAK,IAAI,EAAE;IACV,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC/B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAErC;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAoB,EAAE,EAAE;QAC9D,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC,CAAC,EAAE,CAAC"}

package/dist/codegen/{language.d.ts → codegenerator.d.ts}

@@ -1,4 +1,4 @@
-import type Storage from '../storage';
+import type Storage from '../storage.js';
 import type Oas from 'oas';
 export interface InstallerOptions {
     /**
@@ -11,17 +11,21 @@ export interface InstallerOptions {
      */
     logger?: (msg: string) => void;
 }
-export default abstract class CodeGeneratorLanguage {
+export default abstract class CodeGenerator {
     spec: Oas;
     specPath: string;
     identifier: string;
     userAgent: string;
     requiredPackages: Record<string, {
+        dependencyType: 'production' | 'development';
         reason: string;
-        url: string;
+        url?: string;
+        version: string;
     }>;
     constructor(spec: Oas, specPath: string, identifier: string);
-    abstract generator(): Promise<Record<string, string>>;
-    abstract installer(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    abstract generate(): Promise<Record<string, string>>;
+    abstract install(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    abstract compile(storage: Storage, opts?: InstallerOptions): Promise<void>;
     hasRequiredPackages(): boolean;
 }
+//# sourceMappingURL=codegenerator.d.ts.map

package/dist/codegen/codegenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegenerator.d.ts","sourceRoot":"","sources":["../../src/codegen/codegenerator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAI3B,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,aAAa;IACzC,IAAI,EAAE,GAAG,CAAC;IAEV,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAG,MAAM,CACvB,MAAM,EACN;QACE,cAAc,EAAE,YAAY,GAAG,aAAa,CAAC;QAC7C,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CACF,CAAC;gBAEU,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IA4B3D,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEpD,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1E,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1E,mBAAmB;CAGpB"}

package/dist/codegen/{language.js → codegenerator.js}

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const packageInfo_1 = require("../packageInfo");
-class CodeGeneratorLanguage {
+import { PACKAGE_NAME, PACKAGE_VERSION } from '../packageInfo.js';
+export default class CodeGenerator {
     spec;
     specPath;
     identifier;
@@ -15,7 +13,7 @@ class CodeGeneratorLanguage {
         // used to generate the SDK. For example, this'll look like `petstore/1.0.0 (api/4.2.0)` for
         // a `petstore` spec installed on api@4.2.0.
         const info = spec.getDefinition().info;
-        this.userAgent = `${identifier}/${info.version} (${packageInfo_1.PACKAGE_NAME}/${packageInfo_1.PACKAGE_VERSION})`;
+        this.userAgent = `${identifier}/${info.version} (${PACKAGE_NAME}/${PACKAGE_VERSION})`;
         /**
          * This check is barbaric but there are a number of issues with how the `transformer` work we
          * have in `oas` and in `.getParametersAsJSONSchema()` and `.getResponseAsJSONSchema()` that
@@ -34,4 +32,4 @@ class CodeGeneratorLanguage {
         return Boolean(Object.keys(this.requiredPackages));
     }
 }
-exports.default = CodeGeneratorLanguage;
+//# sourceMappingURL=codegenerator.js.map

package/dist/codegen/codegenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegenerator.js","sourceRoot":"","sources":["../../src/codegen/codegenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAelE,MAAM,CAAC,OAAO,OAAgB,aAAa;IACzC,IAAI,CAAM;IAEV,QAAQ,CAAS;IAEjB,UAAU,CAAS;IAEnB,SAAS,CAAS;IAElB,gBAAgB,CAQd;IAEF,YAAY,IAAS,EAAE,QAAgB,EAAE,UAAkB;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,6FAA6F;QAC7F,4FAA4F;QAC5F,4CAA4C;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,GAAG,UAAU,IAAI,IAAI,CAAC,OAAO,KAAK,YAAY,IAAI,eAAe,GAAG,CAAC;QAEtF;;;;;;;;;WASG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACnD,MAAM,IAAI,KAAK,CACb,yHAAyH,CAC1H,CAAC;SACH;IACH,CAAC;IAQD,mBAAmB;QACjB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrD,CAAC;CACF"}

package/dist/codegen/factory.d.ts

@@ -0,0 +1,7 @@
+import type CodeGenerator from './codegenerator.js';
+import type Oas from 'oas';
+export declare enum SupportedLanguages {
+    JS = "js"
+}
+export default function codegenFactory(language: SupportedLanguages, spec: Oas, specPath: string, identifier: string): CodeGenerator;
+//# sourceMappingURL=factory.d.ts.map

package/dist/codegen/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/codegen/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAI3B,oBAAY,kBAAkB;IAC5B,EAAE,OAAO;CACV;AAED,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,QAAQ,EAAE,kBAAkB,EAC5B,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,aAAa,CAQf"}

package/dist/codegen/factory.js

@@ -0,0 +1,14 @@
+import TSGenerator from './languages/typescript/index.js';
+export var SupportedLanguages;
+(function (SupportedLanguages) {
+    SupportedLanguages["JS"] = "js";
+})(SupportedLanguages || (SupportedLanguages = {}));
+export default function codegenFactory(language, spec, specPath, identifier) {
+    switch (language) {
+        case SupportedLanguages.JS:
+            return new TSGenerator(spec, specPath, identifier);
+        default:
+            throw new TypeError(`Unsupported language supplied: ${language}`);
+    }
+}
+//# sourceMappingURL=factory.js.map

package/dist/codegen/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/codegen/factory.ts"],"names":[],"mappings":"AAGA,OAAO,WAAW,MAAM,iCAAiC,CAAC;AAE1D,MAAM,CAAN,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,+BAAS,CAAA;AACX,CAAC,EAFW,kBAAkB,KAAlB,kBAAkB,QAE7B;AAED,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,QAA4B,EAC5B,IAAS,EACT,QAAgB,EAChB,UAAkB;IAElB,QAAQ,QAAQ,EAAE;QAChB,KAAK,kBAAkB,CAAC,EAAE;YACxB,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAErD;YACE,MAAM,IAAI,SAAS,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;KACrE;AACH,CAAC"}

package/dist/codegen/languages/typescript/index.d.ts

@@ -0,0 +1,90 @@
+import type Storage from '../../../storage.js';
+import type { InstallerOptions } from '../../codegenerator.js';
+import type Oas from 'oas';
+import type { ClassDeclaration } from 'ts-morph';
+import { Project } from 'ts-morph';
+import CodeGenerator from '../../codegenerator.js';
+export default class TSGenerator extends CodeGenerator {
+    #private;
+    project: Project;
+    types: Map<string, string>;
+    sdk: ClassDeclaration;
+    schemas: Record<string, {
+        body?: unknown;
+        metadata?: unknown;
+        response?: Record<string, unknown>;
+    } | Record<string, unknown>>;
+    usesHTTPMethodRangeInterface: boolean;
+    constructor(spec: Oas, specPath: string, identifier: string);
+    install(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    /**
+     * Compile the TS code we generated into JS for use in CJS and ESM environments.
+     *
+     */
+    compile(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    /**
+     * Generate the current OpenAPI definition into a TypeScript library.
+     *
+     */
+    generate(): Promise<{
+        [x: string]: string;
+    }>;
+    /**
+     * Create our main SDK source file.
+     *
+     */
+    private createSDKSource;
+    /**
+     * Create the `tsconfig.json` file that will allow this SDK to be compiled for use.
+     *
+     */
+    createTSConfig(): import("ts-morph").SourceFile;
+    /**
+     * Create the `package.json` file that will ultimately make this SDK available to use.
+     *
+     */
+    createPackageJSON(): import("ts-morph").SourceFile;
+    /**
+     * Create our main schemas file. This is where all of the JSON Schema that our TypeScript typing
+     * infrastructure sources its data from. Without this there are no types.
+     *
+     */
+    private createSchemasFile;
+    /**
+     * Create our main types file. This sources its data from the JSON Schema `schemas.ts` file and
+     * will re-export types to be used in TypeScript implementations and IDE intellisense. This
+     * typing work is functional with the `json-schema-to-ts` library.
+     *
+     * @see {@link https://npm.im/json-schema-to-ts}
+     */
+    private createTypesFile;
+    /**
+     * Create operation accessors on the SDK.
+     *
+     */
+    private createOperationAccessor;
+    /**
+     * Scour through the current OpenAPI definition and compile a store of every operation, along
+     * with every HTTP method that's in use, and their available TypeScript types that we can use,
+     * along with every HTTP method that's in use.
+     *
+     */
+    private loadOperationsAndMethods;
+    /**
+     * Compile the parameter (path, query, cookie, and header) schemas for an API operation into
+     * usable TypeScript types.
+     *
+     */
+    private prepareParameterTypesForOperation;
+    /**
+     * Compile the response schemas for an API operation into usable TypeScript types.
+     *
+     */
+    private prepareResponseTypesForOperation;
+    /**
+     * Add a given schema into our schema dataset that we'll be be exporting as types.
+     *
+     */
+    private addSchemaToExport;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/codegen/languages/typescript/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/codegen/languages/typescript/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,qBAAqB,CAAC;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAI3B,OAAO,KAAK,EACV,gBAAgB,EAMjB,MAAM,UAAU,CAAC;AAUlB,OAAO,EAAmB,OAAO,EAAoD,MAAM,UAAU,CAAC;AAGtG,OAAO,aAAa,MAAM,wBAAwB,CAAC;AAiCnD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,aAAa;;IACpD,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE3B,GAAG,EAAG,gBAAgB,CAAC;IAEvB,OAAO,EAAE,MAAM,CACb,MAAM,EAEJ;QACE,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,GAED,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC1B,CAAC;IAEF,4BAA4B,UAAS;gBAEzB,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAsDrD,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3E;;;OAGG;IAEG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB3E;;;OAGG;IACG,QAAQ;;;IAqDd;;;OAGG;IACH,OAAO,CAAC,eAAe;IAuJvB;;;OAGG;IACH,cAAc;IAgBd;;;OAGG;IACH,iBAAiB;IAwEjB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAyDzB;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAevB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAuM/B;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAoChC;;;;OAIG;IACH,OAAO,CAAC,iCAAiC;IAiDzC;;;OAGG;IACH,OAAO,CAAC,gCAAgC;IAiExC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CAsB1B"}