api 7.0.0-beta.0 → 7.0.0-beta.10

package/README.md

@@ -39,8 +39,7 @@ petstore.listPets().then(({ data }) => {
 The ESM syntax is supported as well:
 
 ```js
-import api from 'api';
-const petstore = api('@petstore/v1.0#tl1e4kl1cl8eg8');
+import petstore from '@api/petstore';
 
 petstore.listPets().then(({ data }) => {
   console.log(`My pets name is ${data[0].name}!`);

package/dist/bin.js

@@ -1,6 +1,9 @@
 import { Command } from 'commander';
+import updateNotifier from 'update-notifier';
 import commands from './commands/index.js';
+import logger from './logger.js';
 import * as pkg from './packageInfo.js';
+updateNotifier({ pkg: { name: pkg.PACKAGE_NAME, version: pkg.PACKAGE_VERSION } }).notify();
 (async () => {
     const program = new Command();
     program.name(pkg.PACKAGE_NAME);
@@ -13,6 +16,10 @@ import * as pkg from './packageInfo.js';
     Object.entries(commands).forEach(([, cmd]) => {
         program.addCommand(cmd);
     });
-    await program.parseAsync(process.argv);
+    await program.parseAsync(process.argv).catch(err => {
+        if (err.message)
+            logger(err.message, true);
+        process.exit(1);
+    });
 })();
 //# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -1 +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"}
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAE7C,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AAExC,cAAc,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAE3F,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,KAAK,CAAC,GAAG,CAAC,EAAE;QACjD,IAAI,GAAG,CAAC,OAAO;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC"}

package/dist/codegen/codegenerator.d.ts

@@ -1,31 +1,64 @@
+import type { InstallerOptions } from './factory.js';
 import type Storage from '../storage.js';
 import type Oas from 'oas';
-export interface InstallerOptions {
+export default abstract class CodeGenerator {
+    /** The associated API definition */
+    spec: Oas;
     /**
-     * Will initiate a dry run install process. Used for simulating installations within a unit test.
+     * The path to the API definion (might be a local path, a URL, or an API registry identifier)
+     * @example https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
+     * @example @petstore/v1.0#n6kvf10vakpemvplx
+     * @example ./petstore.json
      */
-    dryRun?: boolean;
+    specPath: string;
     /**
-     * Used for stubbing out the logger that we use within the installation process so it can be
-     * easily introspected without having to mock out `console.*`.
+     * The user-specified identifier for the SDK,
+     * used as the directory name in the `.api/apis` directory
+     * where the SDK source code is located.
      */
-    logger?: (msg: string) => void;
-}
-export default abstract class CodeGenerator {
-    spec: Oas;
-    specPath: string;
     identifier: string;
+    /** The user agent which is set for all outgoing fetch requests */
     userAgent: string;
+    /**
+     * The license associated with the SDK.
+     * This is extrapolated from the API definition file.
+     */
+    spdxLicense?: string;
+    /**
+     * Contact info for the API and/or SDK author in case users need support.
+     * This is extrapolated from the API definition file.
+     */
+    apiContact: {
+        name?: string;
+        url?: string;
+    };
+    /**
+     * An object containing any downstream packages that are required
+     * for building/executing the SDK.
+     */
     requiredPackages: Record<string, {
-        dependencyType: 'production' | 'development';
+        dependencyType: 'development' | 'production';
         reason: string;
         url?: string;
         version: string;
     }>;
+    /**
+     * An example code snippet that a user can run to get started with the SDK.
+     */
+    exampleCodeSnippet?: string | false;
     constructor(spec: Oas, specPath: string, identifier: string);
     abstract generate(): Promise<Record<string, string>>;
     abstract install(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    /**
+     * It would be better if this were an abstract function but TS/JS doesn't have support for that so
+     * we instead have to rely on throwing a `TypeError` if it's not been implemented instead of a
+     * build-time error.
+     *
+     * @see {@link https://github.com/microsoft/TypeScript/issues/34516}
+     */
+    static uninstall(storage: Storage, opts?: InstallerOptions): Promise<void>;
     abstract compile(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    abstract getExampleCodeSnippet(): Promise<string | false>;
     hasRequiredPackages(): boolean;
 }
 //# sourceMappingURL=codegenerator.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"codegenerator.d.ts","sourceRoot":"","sources":["../../src/codegen/codegenerator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAO3B,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,aAAa;IACzC,oCAAoC;IACpC,IAAI,EAAE,GAAG,CAAC;IAEV;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAM;IAEjD;;;OAGG;IACH,gBAAgB,EAAG,MAAM,CACvB,MAAM,EACN;QACE,cAAc,EAAE,aAAa,GAAG,YAAY,CAAC;QAC7C,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CACF,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;gBAExB,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAgE3D,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;;;;;;OAMG;WAEU,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhF,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1E,QAAQ,CAAC,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;IAEzD,mBAAmB;CAGpB"}

package/dist/codegen/codegenerator.js

@@ -1,10 +1,42 @@
+import { findLicense } from 'license';
 import { PACKAGE_NAME, PACKAGE_VERSION } from '../packageInfo.js';
 export default class CodeGenerator {
+    /** The associated API definition */
     spec;
+    /**
+     * The path to the API definion (might be a local path, a URL, or an API registry identifier)
+     * @example https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
+     * @example @petstore/v1.0#n6kvf10vakpemvplx
+     * @example ./petstore.json
+     */
     specPath;
+    /**
+     * The user-specified identifier for the SDK,
+     * used as the directory name in the `.api/apis` directory
+     * where the SDK source code is located.
+     */
     identifier;
+    /** The user agent which is set for all outgoing fetch requests */
     userAgent;
+    /**
+     * The license associated with the SDK.
+     * This is extrapolated from the API definition file.
+     */
+    spdxLicense;
+    /**
+     * Contact info for the API and/or SDK author in case users need support.
+     * This is extrapolated from the API definition file.
+     */
+    apiContact = {};
+    /**
+     * An object containing any downstream packages that are required
+     * for building/executing the SDK.
+     */
     requiredPackages;
+    /**
+     * An example code snippet that a user can run to get started with the SDK.
+     */
+    exampleCodeSnippet;
     constructor(spec, specPath, identifier) {
         this.spec = spec;
         this.specPath = specPath;
@@ -27,6 +59,51 @@ export default class CodeGenerator {
         if (JSON.stringify(spec.api).includes('"$ref":"#/')) {
             throw new Error('Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.');
         }
+        const infoObject = this.spec.api.info;
+        if (infoObject?.license?.name || infoObject?.license?.identifier) {
+            let spdxLicense;
+            if (infoObject?.license?.identifier) {
+                spdxLicense = infoObject?.license?.identifier;
+            }
+            else {
+                // Though `name` is required by the OpenAPI specification but most people seem to use `name`
+                // instead `identifier` for their licensing identifier so if they've done this we should
+                // try to make the license name recognizable by the `license` package. For example this'll
+                // change "Apache 2.0" to the SPDX-recognized "Apache-2.0".
+                spdxLicense = infoObject?.license?.name.replace(/ /g, '-');
+            }
+            // If the license they've got has too many matches we shouldn't try to pick a license because
+            // we'll run the risk of licensing it under a license they didn't intend.
+            if (findLicense(spdxLicense).length === 1) {
+                this.spdxLicense = spdxLicense;
+            }
+        }
+        if (infoObject?.contact) {
+            if (infoObject.contact?.name || infoObject.contact?.email) {
+                if (infoObject.contact?.name && infoObject.contact?.email) {
+                    this.apiContact.name = `${infoObject.contact.name} <${infoObject.contact.email}>`;
+                }
+                else {
+                    this.apiContact.name = infoObject.contact.email
+                        ? `<${infoObject.contact.email}>`
+                        : (infoObject.contact.name ?? undefined);
+                }
+            }
+            if (infoObject.contact?.url) {
+                this.apiContact.url = infoObject.contact.url;
+            }
+        }
+    }
+    /**
+     * It would be better if this were an abstract function but TS/JS doesn't have support for that so
+     * we instead have to rely on throwing a `TypeError` if it's not been implemented instead of a
+     * build-time error.
+     *
+     * @see {@link https://github.com/microsoft/TypeScript/issues/34516}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async uninstall(storage, opts) {
+        throw new TypeError('The uninstallation step for this language has not been implemented');
     }
     hasRequiredPackages() {
         return Boolean(Object.keys(this.requiredPackages));

package/dist/codegen/codegenerator.js.map

@@ -1 +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"}
+{"version":3,"file":"codegenerator.js","sourceRoot":"","sources":["../../src/codegen/codegenerator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE,MAAM,CAAC,OAAO,OAAgB,aAAa;IACzC,oCAAoC;IACpC,IAAI,CAAM;IAEV;;;;;OAKG;IACH,QAAQ,CAAS;IAEjB;;;;OAIG;IACH,UAAU,CAAS;IAEnB,kEAAkE;IAClE,SAAS,CAAS;IAElB;;;OAGG;IACH,WAAW,CAAU;IAErB;;;OAGG;IACH,UAAU,GAAoC,EAAE,CAAC;IAEjD;;;OAGG;IACH,gBAAgB,CAQd;IAEF;;OAEG;IACH,kBAAkB,CAAkB;IAEpC,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,CAAC;YACpD,MAAM,IAAI,KAAK,CACb,yHAAyH,CAC1H,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAA8B,CAAC;QAChE,IAAI,UAAU,EAAE,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;YACjE,IAAI,WAAW,CAAC;YAChB,IAAI,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;gBACpC,WAAW,GAAG,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,4FAA4F;gBAC5F,wFAAwF;gBACxF,0FAA0F;gBAC1F,2DAA2D;gBAC3D,WAAW,GAAG,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC7D,CAAC;YAED,6FAA6F;YAC7F,yEAAyE;YACzE,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YACjC,CAAC;QACH,CAAC;QAED,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;YACxB,IAAI,UAAU,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;gBAC1D,IAAI,UAAU,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;oBAC1D,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;gBACpF,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK;wBAC7C,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,GAAG;wBACjC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;YAED,IAAI,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;gBAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAMD;;;;;;OAMG;IACH,6DAA6D;IAC7D,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAgB,EAAE,IAAuB;QAC9D,MAAM,IAAI,SAAS,CAAC,oEAAoE,CAAC,CAAC;IAC5F,CAAC;IAMD,mBAAmB;QACjB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACrD,CAAC;CACF"}

package/dist/codegen/factory.d.ts

@@ -1,7 +1,23 @@
 import type CodeGenerator from './codegenerator.js';
+import type Storage from '../storage.js';
 import type Oas from 'oas';
-export declare enum SupportedLanguages {
-    JS = "js"
+export declare const SupportedLanguages: {
+    readonly JS: "js";
+};
+type ObjectValues<T> = T[keyof T];
+export type SupportedLanguage = ObjectValues<typeof SupportedLanguages>;
+export interface InstallerOptions {
+    /**
+     * Will initiate a dry run install process. Used for simulating installations within a unit test.
+     */
+    dryRun?: boolean;
+    /**
+     * Used for stubbing out the logger that we use within the installation process so it can be
+     * easily introspected without having to mock out `console.*`.
+     */
+    logger?: (msg: string) => void;
 }
-export default function codegenFactory(language: SupportedLanguages, spec: Oas, specPath: string, identifier: string): CodeGenerator;
+export declare function codegenFactory(language: SupportedLanguage, spec: Oas, specPath: string, identifier: string): CodeGenerator;
+export declare function uninstallerFactory(language: SupportedLanguage, storage: Storage, opts?: InstallerOptions): Promise<void>;
+export {};
 //# sourceMappingURL=factory.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/codegen/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAI3B,eAAO,MAAM,kBAAkB;;CAErB,CAAC;AAEX,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAElC,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAExE,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,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,iBAAiB,EAC3B,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,aAAa,CAQf;AAED,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,EAAE,OAAO,EAChB,IAAI,GAAE,gBAAqB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAQf"}

package/dist/codegen/factory.js

@@ -1,9 +1,8 @@
 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) {
+export const SupportedLanguages = {
+    JS: 'js',
+};
+export function codegenFactory(language, spec, specPath, identifier) {
     switch (language) {
         case SupportedLanguages.JS:
             return new TSGenerator(spec, specPath, identifier);
@@ -11,4 +10,12 @@ export default function codegenFactory(language, spec, specPath, identifier) {
             throw new TypeError(`Unsupported language supplied: ${language}`);
     }
 }
+export function uninstallerFactory(language, storage, opts = {}) {
+    switch (language) {
+        case SupportedLanguages.JS:
+            return TSGenerator.uninstall(storage, opts);
+        default:
+            throw new TypeError(`Unsupported language supplied: ${language}`);
+    }
+}
 //# sourceMappingURL=factory.js.map

package/dist/codegen/factory.js.map

@@ -1 +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"}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/codegen/factory.ts"],"names":[],"mappings":"AAIA,OAAO,WAAW,MAAM,iCAAiC,CAAC;AAE1D,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,EAAE,EAAE,IAAI;CACA,CAAC;AAmBX,MAAM,UAAU,cAAc,CAC5B,QAA2B,EAC3B,IAAS,EACT,QAAgB,EAChB,UAAkB;IAElB,QAAQ,QAAQ,EAAE,CAAC;QACjB,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;IACtE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,QAA2B,EAC3B,OAAgB,EAChB,OAAyB,EAAE;IAE3B,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,kBAAkB,CAAC,EAAE;YACxB,OAAO,WAAW,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAE9C;YACE,MAAM,IAAI,SAAS,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;AACH,CAAC"}

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

@@ -1,8 +1,8 @@
-import type Storage from '../../../storage.js';
-import type { InstallerOptions } from '../../codegenerator.js';
+import type { InstallerOptions } from '../../factory.js';
 import type Oas from 'oas';
-import type { ClassDeclaration } from 'ts-morph';
+import type { ClassDeclaration, SourceFile } from 'ts-morph';
 import { Project } from 'ts-morph';
+import Storage from '../../../storage.js';
 import CodeGenerator from '../../codegenerator.js';
 export default class TSGenerator extends CodeGenerator {
     #private;
@@ -17,6 +17,7 @@ export default class TSGenerator extends CodeGenerator {
     usesHTTPMethodRangeInterface: boolean;
     constructor(spec: Oas, specPath: string, identifier: string);
     install(storage: Storage, opts?: InstallerOptions): Promise<void>;
+    static uninstall(storage: Storage, opts?: InstallerOptions): Promise<void>;
     /**
      * Compile the TS code we generated into JS for use in CJS and ESM environments.
      *
@@ -29,21 +30,54 @@ export default class TSGenerator extends CodeGenerator {
     generate(): Promise<{
         [x: string]: string;
     }>;
+    getExampleCodeSnippet(): Promise<string | false>;
+    /**
+     * Create our main `index.ts` file that will be the entrypoint for our SDK.
+     * This file will be used to export the SDK and any types that are generated.
+     *
+     */
+    private createIndexSource;
     /**
      * Create our main SDK source file.
      *
      */
     private createSDKSource;
+    /**
+     * Create an IIFE export of our SDK in the SDK source file so users can do
+     * `import sdk from '<package>'` and have a ready-to-go instance of their SDK -- eliminating them
+     * having to create an instance with `new SDK()`.
+     *
+     * This will also fill our a JSDoc heading on the IIFE we're creating based on various pieces of
+     * data that may be present in the OpenAPI definition `info` object.
+     *
+     * Additionally if a license in `info.license` is recognized by the SPDX we'll also create a
+     * `LICENSE` file in for their generated SDK. We're only supporting SPDX-recognized licenses for
+     * this because we otherwise have no idea what the license represents and we should be extremely
+     * cautious around assuming intent with software licensing.
+     *
+     * @see {@link https://spdx.org/licenses/}
+     */
+    createSDKExport(sourceFile: SourceFile): SourceFile;
+    /**
+     * Creates a `.gitignore` file to prevent the `dist/` directory from being tracked.
+     *
+     */
+    createGitIgnore(): SourceFile;
     /**
      * Create the `tsconfig.json` file that will allow this SDK to be compiled for use.
      *
      */
-    createTSConfig(): import("ts-morph").SourceFile;
+    createTSConfig(): SourceFile;
     /**
      * Create the `package.json` file that will ultimately make this SDK available to use.
      *
      */
-    createPackageJSON(): import("ts-morph").SourceFile;
+    createPackageJSON(): SourceFile;
+    /**
+     * Create a placeholder `README.md` file in the repository, with information on how to use/administer the SDK.
+     *
+     */
+    createREADME(): Promise<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.

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

@@ -1 +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;IAiDrD,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;IA8DzB;;;;;;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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/codegen/languages/typescript/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAK3B,OAAO,KAAK,EACV,gBAAgB,EAMhB,UAAU,EACX,MAAM,UAAU,CAAC;AAYlB,OAAO,EAAmB,OAAO,EAAoD,MAAM,UAAU,CAAC;AAKtG,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,aAAa,MAAM,wBAAwB,CAAC;AA0DnD,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,EAGJ;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;IAiDrD,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;WA2B9D,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWpF;;;OAGG;IAEG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc3E;;;OAGG;IACG,QAAQ;;;IAuDR,qBAAqB;IAiB3B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAazB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAgIvB;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,UAAU,EAAE,UAAU;IA4GtC;;;OAGG;IACH,eAAe;IAYf;;;OAGG;IACH,cAAc;IAmBd;;;OAGG;IACH,iBAAiB;IAoFjB;;;OAGG;IACG,YAAY;IAsClB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAgEzB;;;;;;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"}