api 7.0.0-beta.0 → 7.0.0-beta.1

package/dist/commands/uninstall.js

@@ -0,0 +1,72 @@
+import path from 'node:path';
+import chalk from 'chalk';
+import { Command, Option } from 'commander';
+import ora from 'ora';
+import { SupportedLanguages, uninstallerFactory } from '../codegen/factory.js';
+import promptTerminal from '../lib/prompt.js';
+import logger from '../logger.js';
+import Storage from '../storage.js';
+const cmd = new Command();
+cmd
+    .name('uninstall')
+    .description('uninstall an SDK from your codebase')
+    .argument('<identifier>', 'the SDK to uninstall')
+    .addOption(new Option('-y, --yes', 'Automatically answer "yes" to any prompts printed'))
+    .action(async (identifier, options) => {
+    // We don't know if we have `identifier` in the storage system yet, we just need to preload the
+    // system so we can access lockfiles.
+    const storage = new Storage('', SupportedLanguages.JS, identifier);
+    const entry = Storage.getFromLockfile(identifier);
+    if (!entry) {
+        logger(`You do not appear to have ${identifier} installed. You can run \`npx api list\` to see what SDKs are present.`, true);
+        process.exit(1);
+    }
+    storage.setLanguage(entry?.language);
+    storage.setIdentifier(identifier);
+    const directory = path.relative(process.cwd(), storage.getIdentifierStorageDir());
+    if (!options.yes) {
+        await promptTerminal({
+            type: 'confirm',
+            name: 'value',
+            message: `Are you sure you want to uninstall ${chalk.yellow(identifier)}? This will delete the ${chalk.yellow(directory)} directory and potentially any changes you may have made there.`,
+            initial: true,
+        }).then(({ value }) => {
+            if (!value) {
+                process.exit(1);
+            }
+        });
+    }
+    let spinner = ora(`Uninstalling ${chalk.grey(identifier)}`).start();
+    // If we have a known package name for this then we can uninstall it from within cooresponding
+    // package manager.
+    const pkgName = storage.getPackageName();
+    if (pkgName) {
+        const language = storage.getSDKLanguage();
+        await uninstallerFactory(language, storage)
+            .then(() => {
+            spinner.succeed(spinner.text);
+        })
+            .catch(err => {
+            spinner.fail(spinner.text);
+            logger(err.message, true);
+            process.exit(1);
+        });
+    }
+    spinner = ora(`Removing ${chalk.grey(directory)}`).start();
+    await storage
+        .remove()
+        .then(() => {
+        spinner.succeed(spinner.text);
+    })
+        .catch(err => {
+        spinner.fail(spinner.text);
+        logger(err.message, true);
+        process.exit(1);
+    });
+    logger('🚀 All done!');
+})
+    .addHelpText('after', `
+Examples:
+  $ npx api uninstall petstore`);
+export default cmd;
+//# sourceMappingURL=uninstall.js.map

package/dist/commands/uninstall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uninstall.js","sourceRoot":"","sources":["../../src/commands/uninstall.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,OAAO,MAAM,eAAe,CAAC;AAMpC,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;AAC1B,GAAG;KACA,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,qCAAqC,CAAC;KAClD,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;KAChD,SAAS,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,mDAAmD,CAAC,CAAC;KACvF,MAAM,CAAC,KAAK,EAAE,UAAkB,EAAE,OAAgB,EAAE,EAAE;IACrD,+FAA+F;IAC/F,qCAAqC;IACrC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAEnE,MAAM,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAClD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,CACJ,6BAA6B,UAAU,wEAAwE,EAC/G,IAAI,CACL,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAElC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAClF,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;QAChB,MAAM,cAAc,CAAC;YACnB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,sCAAsC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,0BAA0B,KAAK,CAAC,MAAM,CAC3G,SAAS,CACV,iEAAiE;YAClE,OAAO,EAAE,IAAI;SACd,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;QACH,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,OAAO,GAAG,GAAG,CAAC,gBAAgB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IAEpE,8FAA8F;IAC9F,mBAAmB;IACnB,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,IAAI,OAAO,EAAE;QACX,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC;aACxC,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;KACN;IAED,OAAO,GAAG,GAAG,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IAC3D,MAAM,OAAO;SACV,MAAM,EAAE;SACR,IAAI,CAAC,GAAG,EAAE;QACT,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,CAAC,EAAE;QACX,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEL,MAAM,CAAC,cAAc,CAAC,CAAC;AACzB,CAAC,CAAC;KACD,WAAW,CACV,OAAO,EACP;;+BAE2B,CAC5B,CAAC;AAEJ,eAAe,GAAG,CAAC"}

package/dist/lockfileSchema.d.ts

@@ -0,0 +1,125 @@
+import type { FromSchema } from '@readme/api-core/lib';
+declare const lockfileApiSchema: {
+    readonly type: "object";
+    readonly required: readonly ["createdAt", "identifier", "installerVersion", "integrity"];
+    readonly properties: {
+        readonly createdAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "The date that this SDK was installed.";
+            readonly examples: readonly ["2023-10-19T20:35:39.268Z"];
+        };
+        readonly identifier: {
+            readonly type: "string";
+            readonly description: "A unique identifier of the API. This'll be used to do imports on `@api/<identifier>` and also where the SDK code will be located in `.api/apis/<identifier>`";
+            readonly examples: readonly ["petstore"];
+        };
+        readonly installerVersion: {
+            readonly type: "string";
+            readonly description: "The version of `api` that was used to install this SDK.";
+            readonly examples: readonly ["7.0.0"];
+        };
+        readonly integrity: {
+            readonly type: "string";
+            readonly description: "An integrity hash that will be used to determine on `npx api update` calls if the API has changed since the SDK was last generated.";
+            readonly examples: readonly ["sha512-otRF5TLMeDczSJlrmWLNDHLfmXg+C98oa/I/X2WWycwngh+a6WsbnjTbfwKGRU5DFbagOn2qX2SRvtBGOBRVGg=="];
+        };
+        readonly language: {
+            readonly type: "string";
+            readonly description: "The language that this SDK was generated for.";
+            readonly default: "js";
+            readonly enum: "js"[];
+        };
+        readonly private: {
+            readonly type: "boolean";
+            readonly description: "Was this SDK installed as a private, unpublished, package to the filesystem?";
+        };
+        readonly source: {
+            readonly type: "string";
+            readonly description: "The original source that was used to generate the SDK with.";
+            readonly examples: readonly ["https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json", "./petstore.json", "@developers/v2.0#nysezql0wwo236"];
+        };
+        readonly updatedAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "The date that this SDK was last rebuilt or updated.";
+            readonly examples: readonly ["2023-10-19T20:35:39.268Z"];
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const lockfileSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly title: "api storage lockfile";
+    readonly description: "See https://api.readme.dev/docs";
+    readonly type: "object";
+    readonly required: readonly ["apis"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly $schema: {
+            readonly type: "string";
+        };
+        readonly apis: {
+            readonly type: "array";
+            readonly description: "The list of installed APIs";
+            readonly items: {
+                readonly $ref: "#/definitions/api";
+            };
+        };
+    };
+    readonly definitions: {
+        readonly api: {
+            readonly type: "object";
+            readonly required: readonly ["createdAt", "identifier", "installerVersion", "integrity"];
+            readonly properties: {
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The date that this SDK was installed.";
+                    readonly examples: readonly ["2023-10-19T20:35:39.268Z"];
+                };
+                readonly identifier: {
+                    readonly type: "string";
+                    readonly description: "A unique identifier of the API. This'll be used to do imports on `@api/<identifier>` and also where the SDK code will be located in `.api/apis/<identifier>`";
+                    readonly examples: readonly ["petstore"];
+                };
+                readonly installerVersion: {
+                    readonly type: "string";
+                    readonly description: "The version of `api` that was used to install this SDK.";
+                    readonly examples: readonly ["7.0.0"];
+                };
+                readonly integrity: {
+                    readonly type: "string";
+                    readonly description: "An integrity hash that will be used to determine on `npx api update` calls if the API has changed since the SDK was last generated.";
+                    readonly examples: readonly ["sha512-otRF5TLMeDczSJlrmWLNDHLfmXg+C98oa/I/X2WWycwngh+a6WsbnjTbfwKGRU5DFbagOn2qX2SRvtBGOBRVGg=="];
+                };
+                readonly language: {
+                    readonly type: "string";
+                    readonly description: "The language that this SDK was generated for.";
+                    readonly default: "js";
+                    readonly enum: "js"[];
+                };
+                readonly private: {
+                    readonly type: "boolean";
+                    readonly description: "Was this SDK installed as a private, unpublished, package to the filesystem?";
+                };
+                readonly source: {
+                    readonly type: "string";
+                    readonly description: "The original source that was used to generate the SDK with.";
+                    readonly examples: readonly ["https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json", "./petstore.json", "@developers/v2.0#nysezql0wwo236"];
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The date that this SDK was last rebuilt or updated.";
+                    readonly examples: readonly ["2023-10-19T20:35:39.268Z"];
+                };
+            };
+            readonly additionalProperties: false;
+        };
+    };
+};
+export type Lockfile = FromSchema<typeof lockfileSchema>;
+export type LockfileAPI = FromSchema<typeof lockfileApiSchema>;
+export {};
+//# sourceMappingURL=lockfileSchema.d.ts.map

package/dist/lockfileSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockfileSchema.d.ts","sourceRoot":"","sources":["../src/lockfileSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIvD,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsDb,CAAC;AAEX,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AACzD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/lockfileSchema.js

@@ -0,0 +1,78 @@
+import { SupportedLanguages } from './codegen/factory.js';
+const lockfileApiSchema = {
+    type: 'object',
+    required: ['createdAt', 'identifier', 'installerVersion', 'integrity'],
+    properties: {
+        createdAt: {
+            type: 'string',
+            format: 'date-time',
+            description: 'The date that this SDK was installed.',
+            examples: ['2023-10-19T20:35:39.268Z'],
+        },
+        identifier: {
+            type: 'string',
+            description: "A unique identifier of the API. This'll be used to do imports on `@api/<identifier>` and also where the SDK code will be located in `.api/apis/<identifier>`",
+            examples: ['petstore'],
+        },
+        installerVersion: {
+            type: 'string',
+            description: 'The version of `api` that was used to install this SDK.',
+            examples: ['7.0.0'],
+        },
+        integrity: {
+            type: 'string',
+            description: 'An integrity hash that will be used to determine on `npx api update` calls if the API has changed since the SDK was last generated.',
+            examples: ['sha512-otRF5TLMeDczSJlrmWLNDHLfmXg+C98oa/I/X2WWycwngh+a6WsbnjTbfwKGRU5DFbagOn2qX2SRvtBGOBRVGg=='],
+        },
+        language: {
+            type: 'string',
+            description: 'The language that this SDK was generated for.',
+            default: SupportedLanguages.JS,
+            enum: Object.values(SupportedLanguages),
+        },
+        private: {
+            type: 'boolean',
+            description: 'Was this SDK installed as a private, unpublished, package to the filesystem?',
+        },
+        source: {
+            type: 'string',
+            description: 'The original source that was used to generate the SDK with.',
+            examples: [
+                'https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json',
+                './petstore.json',
+                '@developers/v2.0#nysezql0wwo236',
+            ],
+        },
+        updatedAt: {
+            type: 'string',
+            format: 'date-time',
+            description: 'The date that this SDK was last rebuilt or updated.',
+            examples: ['2023-10-19T20:35:39.268Z'],
+        },
+    },
+    additionalProperties: false,
+};
+export const lockfileSchema = {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'api storage lockfile',
+    description: 'See https://api.readme.dev/docs',
+    type: 'object',
+    required: ['apis'],
+    additionalProperties: false,
+    properties: {
+        $schema: {
+            type: 'string',
+        },
+        apis: {
+            type: 'array',
+            description: 'The list of installed APIs',
+            items: {
+                $ref: '#/definitions/api',
+            },
+        },
+    },
+    definitions: {
+        api: lockfileApiSchema,
+    },
+};
+//# sourceMappingURL=lockfileSchema.js.map

package/dist/lockfileSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockfileSchema.js","sourceRoot":"","sources":["../src/lockfileSchema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,CAAC;IACtE,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,uCAAuC;YACpD,QAAQ,EAAE,CAAC,0BAA0B,CAAC;SACvC;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,8JAA8J;YAChK,QAAQ,EAAE,CAAC,UAAU,CAAC;SACvB;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yDAAyD;YACtE,QAAQ,EAAE,CAAC,OAAO,CAAC;SACpB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,qIAAqI;YACvI,QAAQ,EAAE,CAAC,iGAAiG,CAAC;SAC9G;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+CAA+C;YAC5D,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;SACxC;QACD,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,8EAA8E;SAC5F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6DAA6D;YAC1E,QAAQ,EAAE;gBACR,4FAA4F;gBAC5F,iBAAiB;gBACjB,iCAAiC;aAClC;SACF;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,qDAAqD;YAClE,QAAQ,EAAE,CAAC,0BAA0B,CAAC;SACvC;KACF;IACD,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEX,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,yCAAyC;IAClD,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EAAE,iCAAiC;IAC9C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;SACf;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE;gBACL,IAAI,EAAE,mBAAmB;aAC1B;SACF;KACF;IACD,WAAW,EAAE;QACX,GAAG,EAAE,iBAAiB;KACvB;CACO,CAAC"}

package/dist/packageInfo.d.ts

@@ -1,3 +1,3 @@
 export declare const PACKAGE_NAME = "api";
-export declare const PACKAGE_VERSION = "7.0.0-beta.0";
+export declare const PACKAGE_VERSION = "7.0.0-beta.1";
 //# sourceMappingURL=packageInfo.d.ts.map

package/dist/packageInfo.js

@@ -1,4 +1,4 @@
 // This file is automatically updated by the build script.
 export const PACKAGE_NAME = 'api';
-export const PACKAGE_VERSION = '7.0.0-beta.0';
+export const PACKAGE_VERSION = '7.0.0-beta.1';
 //# sourceMappingURL=packageInfo.js.map

package/dist/storage.d.ts

@@ -1,16 +1,31 @@
+import type { SupportedLanguage } from './codegen/factory.js';
+import type { Lockfile } from './lockfileSchema.js';
 import type { OASDocument } from 'oas/rmoas.types';
 import Fetcher from './fetcher.js';
 export default class Storage {
     static dir: string;
     static lockfile: false | Lockfile;
+    fetcher: Fetcher;
     /**
      * This is the original source that the file came from (relative/absolute file path, URL, ReadMe
      * registry UUID, etc.).
+     *
+     * @example  @developers/v2.0#nysezql0wwo236
+     * @example https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
+     * @example ./petstore.json
      */
     source: string;
+    /**
+     * The language that this SDK was generated for.
+     */
+    private language;
+    /**
+     * The identifier that this was installed as.
+     *
+     * @example petstore
+     */
     identifier: string;
-    fetcher: Fetcher;
-    constructor(source: string, identifier?: string);
+    constructor(source: string, language?: SupportedLanguage, identifier?: string);
     static getLockfilePath(): string;
     static getAPIsDir(): string;
     static setStorageDir(dir?: string): void;
@@ -22,12 +37,34 @@ export default class Storage {
     static reset(): Promise<void>;
     static getDefaultLockfile(): Lockfile;
     static generateIntegrityHash(definition: OASDocument): string;
-    static getLockfile(): Lockfile;
+    static getLockfile(): {
+        $schema?: string | undefined;
+        apis: {
+            language?: "js" | undefined;
+            private?: boolean | undefined;
+            source?: string | undefined;
+            updatedAt?: string | undefined;
+            createdAt: string;
+            identifier: string;
+            installerVersion: string;
+            integrity: string;
+        }[];
+    };
     static isIdentifierValid(identifier: string, prefixWithAPINamespace?: boolean): boolean;
     static isInLockFile(search: {
         identifier?: string;
         source?: string;
-    }): false | LockfileAPI;
+    }): false | {
+        language?: "js" | undefined;
+        private?: boolean | undefined;
+        source?: string | undefined;
+        updatedAt?: string | undefined;
+        createdAt: string;
+        identifier: string;
+        installerVersion: string;
+        integrity: string;
+    };
+    setLanguage(language?: SupportedLanguage): void;
     setIdentifier(identifier: string): void;
     /**
      * Determine if the current spec + identifier we're working with is already in the lockfile.
@@ -35,73 +72,51 @@ export default class Storage {
     isInLockfile(): boolean;
     /**
      * Retrieve the lockfile record for the current spec + identifier if it exists in the lockfile.
+     *
+     */
+    getFromLockfile(): {
+        language?: "js" | undefined;
+        private?: boolean | undefined;
+        source?: string | undefined;
+        updatedAt?: string | undefined;
+        createdAt: string;
+        identifier: string;
+        installerVersion: string;
+        integrity: string;
+    } | undefined;
+    /**
+     * Retrieve the lockfile record, if it exists, for a given identifier.
+     *
      */
-    getFromLockfile(): LockfileAPI | undefined;
+    static getFromLockfile(identifier: string): {
+        language?: "js" | undefined;
+        private?: boolean | undefined;
+        source?: string | undefined;
+        updatedAt?: string | undefined;
+        createdAt: string;
+        identifier: string;
+        installerVersion: string;
+        integrity: string;
+    } | undefined;
+    getSDKLanguage(): "js";
+    getPackageName(): string | undefined;
     getIdentifierStorageDir(): string;
+    getAPIDefinitionPath(): string;
     getAPIDefinition(): any;
     saveSourceFiles(files: Record<string, string>): Promise<unknown>;
     load(shouldSave?: boolean): Promise<OASDocument>;
     /**
-     * @example <caption>Storage directory structure</caption>
-     * .api/
-     * ├── api.json             // The `package-lock.json` equivalent that records everything that's
-     * |                        // installed, when it was installed, what the original source was,
-     * |                        // and what version of `api` was used.
-     * └── apis/
-     *     ├── readme/
-     *     |   ├── node_modules/
-     *     │   ├── index.js     // We may offer the option to export a raw TS file for folks who want
-     *     |   |                // that, but for now it'll be a compiled JS file.
-     *     │   ├── index.d.ts   // All types for their SDK, ready to use in an IDE.
-     *     │   |── openapi.json
-     *     │   └── package.json
-     *     └── petstore/
-     *         ├── node_modules/
-     *         ├── index.js
-     *         ├── index.d.ts
-     *         ├── openapi.json
-     *         └── package.json
+     * Initialize a directory in the storage system for this identifier and add it into the lockfile.
+     * This does not create or save the source code for this SDK, that work happens within the
+     * code generation system.
      *
+     * @see {@link https://api.readme.dev/docs/how-it-works#api-directory}
      */
     save(spec: OASDocument): OASDocument;
-}
-interface Lockfile {
-    apis: LockfileAPI[];
     /**
-     * The `api.json` schema version. This will only ever change if we introduce breaking changes to
-     * this store.
-     */
-    version: '1.0';
-}
-interface LockfileAPI {
-    /**
-     * A unique identifier of the API. This'll be used to do requires on `@api/<identifier>` and also
-     * where the SDK code will be located in `.api/apis/<identifier>`.
-     *
-     * @example petstore
-     */
-    identifier: string;
-    /**
-     * The version of `api` that was used to install this SDK.
-     *
-     * @example 5.0.0
-     */
-    installerVersion: string;
-    /**
-     * An integrity hash that will be used to determine on `npx api update` calls if the API has
-     * changed since the SDK was last generated.
-     *
-     * @example sha512-ld+djZk8uRWmzXC+JYla1PTBScg0NjP/8x9vOOKRW+DuJ3NNMRjrpfbY7T77Jgnc87dZZsU49robbQfYe3ukug==
-     */
-    integrity: string;
-    /**
-     * The original source that was used to generate the SDK with.
+     * Delete the stored source code for the given identifier and purge it from the lockfile.
      *
-     * @example https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
-     * @example ./petstore.json
-     * @example @developers/v2.0#nysezql0wwo236
      */
-    source: string;
+    remove(): Promise<void>;
 }
-export {};
 //# sourceMappingURL=storage.d.ts.map

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAQnD,OAAO,OAAO,MAAM,cAAc,CAAC;AAGnC,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC;IAEnB,MAAM,CAAC,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAG,MAAM,CAAC;IAEpB,OAAO,EAAE,OAAO,CAAC;gBAEL,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;IAc/C,MAAM,CAAC,eAAe;IAItB,MAAM,CAAC,UAAU;IAIjB,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,MAAM;IAgBjC;;;;OAIG;WACU,KAAK;IAWlB,MAAM,CAAC,kBAAkB,IAAI,QAAQ;IAOrC,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,WAAW;IAQpD,MAAM,CAAC,WAAW;IAelB,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,sBAAsB,CAAC,EAAE,OAAO;IAkB7E,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAyBpE,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC;;OAEG;IACH,YAAY;IAIZ;;OAEG;IACH,eAAe;IAKf,uBAAuB;IAQvB,gBAAgB;IAMhB,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IA4BvC,IAAI,CAAC,UAAU,GAAE,OAAc;IAUrC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,IAAI,EAAE,WAAW;CA0CvB;AAED,UAAU,QAAQ;IAChB,IAAI,EAAE,WAAW,EAAE,CAAC;IAEpB;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC;CAChB;AAED,UAAU,WAAW;IACnB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAe,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAUnD,OAAO,OAAO,MAAM,cAAc,CAAC;AAGnC,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC;IAEnB,MAAM,CAAC,QAAQ,EAAE,KAAK,GAAG,QAAQ,CAAC;IAElC,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAqB;IAErC;;;;OAIG;IACH,UAAU,EAAG,MAAM,CAAC;gBAER,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,EAAE,UAAU,CAAC,EAAE,MAAM;IAa7E,MAAM,CAAC,eAAe;IAItB,MAAM,CAAC,UAAU;IAIjB,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,MAAM;IAgBjC;;;;OAIG;WACU,KAAK;IAWlB,MAAM,CAAC,kBAAkB,IAAI,QAAQ;IASrC,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,WAAW;IAQpD,MAAM,CAAC,WAAW;;;;;;;;;;;;;IAelB,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,sBAAsB,CAAC,EAAE,OAAO;IAkB7E,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;;IAyBpE,WAAW,CAAC,QAAQ,CAAC,EAAE,iBAAiB;IAWxC,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC;;OAEG;IACH,YAAY;IAIZ;;;OAGG;IACH,eAAe;;;;;;;;;;IAKf;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;IAKzC,cAAc;IAQd,cAAc;IASd,uBAAuB;IAQvB,oBAAoB;IAIpB,gBAAgB;IAMhB,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IA4BvC,IAAI,CAAC,UAAU,GAAE,OAAc;IAUrC;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,WAAW;IAgDtB;;;OAGG;IACG,MAAM;CAkBb"}