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

package/dist/lib/prompt.js

@@ -1,4 +1,5 @@
 import prompts from 'prompts';
+import isCI from './isCI.js';
 /**
  * The `prompts` library doesn't always interpret CTRL+C and release the terminal back to the user
  * so we need handle this ourselves. This function is just a simple overload of the main `prompts`
@@ -6,19 +7,43 @@ import prompts from 'prompts';
  *
  * @see {@link https://github.com/terkelg/prompts/issues/252}
  */
-export default async function promptTerminal(question, options) {
+export default async function promptTerminal(questions, options) {
     const enableTerminalCursor = () => {
         process.stdout.write('\x1B[?25h');
     };
-    const onState = (state) => {
-        if (state.aborted) {
-            // If we don't re-enable the terminal cursor before exiting the program, the cursor will
-            // remain hidden.
-            enableTerminalCursor();
+    /**
+     * The CTRL+C handler discussed above.
+     * @see {@link https://github.com/terkelg/prompts#optionsoncancel}
+     */
+    const onCancel = () => {
+        // If we don't re-enable the terminal cursor before exiting the program, the cursor will
+        // remain hidden.
+        enableTerminalCursor();
+        process.stdout.write('\n');
+        process.exit(1);
+    };
+    /**
+     * Runs a check before every prompt renders to make sure that
+     * prompt is not being run in a CI environment.
+     */
+    function onRender() {
+        if (isCI()) {
             process.stdout.write('\n');
+            process.stdout.write('Yikes! Looks like we were about to prompt you for something in a CI environment. Are you missing an argument?');
+            process.stdout.write('\n\n');
+            process.stdout.write('Try running `api <command> --help` to get more information.');
+            process.stdout.write('\n\n');
             process.exit(1);
         }
-    };
-    return prompts({ ...question, onState }, options);
+    }
+    if (Array.isArray(questions)) {
+        // eslint-disable-next-line no-param-reassign
+        questions = questions.map(question => ({ onRender, ...question }));
+    }
+    else {
+        // eslint-disable-next-line no-param-reassign
+        questions.onRender = onRender;
+    }
+    return prompts(questions, { onCancel, ...options });
 }
 //# sourceMappingURL=prompt.js.map

package/dist/lib/prompt.js.map

@@ -1 +1 @@
-{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../src/lib/prompt.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,cAAc,CAC1C,QAAiC,EACjC,OAAyB;IAEzB,MAAM,oBAAoB,GAAG,GAAG,EAAE;QAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,KAA2B,EAAE,EAAE;QAC9C,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,wFAAwF;YACxF,iBAAiB;YACjB,oBAAoB,EAAE,CAAC;YACvB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;IACH,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC"}
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../src/lib/prompt.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,cAAc,CAC1C,SAA8D,EAC9D,OAAyB;IAEzB,MAAM,oBAAoB,GAAG,GAAG,EAAE;QAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,wFAAwF;QACxF,iBAAiB;QACjB,oBAAoB,EAAE,CAAC;QACvB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC;IAEF;;;OAGG;IACH,SAAS,QAAQ;QACf,IAAI,IAAI,EAAE,EAAE,CAAC;YACX,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,+GAA+G,CAChH,CAAC;YACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC,CAAC;YACpF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,6CAA6C;QAC7C,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;SAAM,CAAC;QACN,6CAA6C;QAC7C,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED,OAAO,OAAO,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AACtD,CAAC"}

package/dist/lib/suggestedOperations.d.ts

@@ -0,0 +1,31 @@
+import type Oas from 'oas';
+import type { Operation } from 'oas/operation';
+/**
+ * Return a list of suggested and "good first issue" types of endpoints that we can build a post-SDK
+ * code generation code snippet around to demo the power of `api`.
+ *
+ * The criteria for a suggested endpoint are the following:
+ *  - GET request
+ *  - Has no required query or body parameters
+ *  - Endpoint has not been deprecated
+ *
+ * @param oas
+ */
+export declare function getSuggestedOperation(oas: Oas): false | Operation;
+/**
+ * Generate an example code snippet for a given (suggested) operation. We'll show this to users
+ * post-codegeneration so they can see how to use the SDK we created for them.
+ *
+ * We're intentionally using `httpsnippet-client-api` and not `@readme/oas-to-snippet` here,
+ * which would handle HAR and snippet generation, because don't need the entire `oas-to-snippet`
+ * and `@readme/httpsnippet` libraries for what we're doing here.
+ *
+ * All we want to do is generate a very simple code example for `api` snippets and as we're
+ * controlling which kinds of endpoints we're generating these for the HAR dataset we're working
+ * with is a mostly fully known object.
+ *
+ */
+export declare function buildCodeSnippetForOperation(oas: Oas, operation: Operation, opts: {
+    identifier: string;
+}): Promise<string | false>;
+//# sourceMappingURL=suggestedOperations.d.ts.map

package/dist/lib/suggestedOperations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestedOperations.d.ts","sourceRoot":"","sources":["../../src/lib/suggestedOperations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAM/C;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,qBAgC7C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,2BA2D9G"}

package/dist/lib/suggestedOperations.js

@@ -0,0 +1,108 @@
+import APICore from '@readme/api-core';
+import apiSnippetPlugin from 'httpsnippet-client-api';
+import { Webhook } from 'oas/operation';
+/**
+ * Return a list of suggested and "good first issue" types of endpoints that we can build a post-SDK
+ * code generation code snippet around to demo the power of `api`.
+ *
+ * The criteria for a suggested endpoint are the following:
+ *  - GET request
+ *  - Has no required query or body parameters
+ *  - Endpoint has not been deprecated
+ *
+ * @param oas
+ */
+export function getSuggestedOperation(oas) {
+    const suggested = [];
+    Object.values(oas.getPaths()).forEach(path => {
+        Object.values(path).forEach(operation => {
+            // We don't really support webhooks with this library so if this operation is one we shouldn't
+            // return it as a recommended operation.
+            if (operation instanceof Webhook) {
+                return;
+            }
+            if (operation.isDeprecated()) {
+                return;
+            }
+            if (operation.method.toLowerCase() === 'get') {
+                const hasRequiredParameters = operation.hasRequiredParameters();
+                const hasRequiredRequestBody = operation.hasRequiredRequestBody();
+                // If the criteria matches, push it into a recommended array
+                if (!hasRequiredParameters && !hasRequiredRequestBody) {
+                    suggested.push(operation);
+                }
+            }
+        });
+    });
+    if (suggested.length) {
+        return suggested[0];
+    }
+    return false;
+}
+/**
+ * Generate an example code snippet for a given (suggested) operation. We'll show this to users
+ * post-codegeneration so they can see how to use the SDK we created for them.
+ *
+ * We're intentionally using `httpsnippet-client-api` and not `@readme/oas-to-snippet` here,
+ * which would handle HAR and snippet generation, because don't need the entire `oas-to-snippet`
+ * and `@readme/httpsnippet` libraries for what we're doing here.
+ *
+ * All we want to do is generate a very simple code example for `api` snippets and as we're
+ * controlling which kinds of endpoints we're generating these for the HAR dataset we're working
+ * with is a mostly fully known object.
+ *
+ */
+export async function buildCodeSnippetForOperation(oas, operation, opts) {
+    const core = new APICore();
+    core.setSpec(oas);
+    // If this endpoint has authentication on it then we should try to flesh out some placeholder
+    // values in the `.auth()` SDK method for them so they can see how to use auth.
+    let auth = {};
+    const hasAuth = !!operation.getSecurity()?.length;
+    if (hasAuth) {
+        operation.getSecurityWithTypes().forEach(schemes => {
+            if (!schemes)
+                return;
+            schemes.filter(Boolean).forEach(scheme => {
+                if (!scheme)
+                    return;
+                // eslint-disable-next-line no-underscore-dangle
+                const schemeName = scheme.security._key;
+                if (scheme?.type === 'Basic') {
+                    auth[schemeName] = { user: 'username', pass: 'password' };
+                }
+                else {
+                    auth[schemeName] = 'token';
+                }
+            });
+        });
+        auth = oas.getAuth(auth);
+    }
+    const har = core.getHARForRequest(operation, {}, auth)?.log?.entries?.[0]?.request;
+    if (!har) {
+        return false;
+    }
+    const snippet = apiSnippetPlugin.client.convert({
+        ...har,
+        cookiesObj: har.cookies.reduce((acc, { name, value }) => ({ ...acc, [name]: value }), {}),
+        fullUrl: har.url,
+        headersObj: har.headers.reduce((acc, { name, value }) => ({ ...acc, [name]: value }), {}),
+        postData: {
+            mimeType: 'application/json',
+            text: '',
+        },
+        queryObj: har.queryString.reduce((acc, { name, value }) => ({ ...acc, [name]: value }), {}),
+        url: har.url,
+        // These aren't used in `httpsnippet-client-api` so we don't need to bother hooking them up.
+        allHeaders: {},
+        uriObj: {},
+    }, {
+        api: {
+            definition: oas.getDefinition(),
+            identifier: opts.identifier,
+            registryURI: opts.identifier,
+        },
+    });
+    return snippet;
+}
+//# sourceMappingURL=suggestedOperations.js.map

package/dist/lib/suggestedOperations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestedOperations.js","sourceRoot":"","sources":["../../src/lib/suggestedOperations.ts"],"names":[],"mappings":"AAIA,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC5C,MAAM,SAAS,GAAgB,EAAE,CAAC;IAElC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC3C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACtC,8FAA8F;YAC9F,wCAAwC;YACxC,IAAI,SAAS,YAAY,OAAO,EAAE,CAAC;gBACjC,OAAO;YACT,CAAC;YAED,IAAI,SAAS,CAAC,YAAY,EAAE,EAAE,CAAC;gBAC7B,OAAO;YACT,CAAC;YAED,IAAI,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE,CAAC;gBAC7C,MAAM,qBAAqB,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;gBAChE,MAAM,sBAAsB,GAAG,SAAS,CAAC,sBAAsB,EAAE,CAAC;gBAElE,4DAA4D;gBAC5D,IAAI,CAAC,qBAAqB,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBACtD,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,GAAQ,EAAE,SAAoB,EAAE,IAA4B;IAC7G,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElB,6FAA6F;IAC7F,+EAA+E;IAC/E,IAAI,IAAI,GAAe,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC;IAClD,IAAI,OAAO,EAAE,CAAC;QACZ,SAAS,CAAC,oBAAoB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACjD,IAAI,CAAC,OAAO;gBAAE,OAAO;YACrB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACvC,IAAI,CAAC,MAAM;oBAAE,OAAO;gBAEpB,gDAAgD;gBAChD,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACxC,IAAI,MAAM,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC7B,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;gBAC5D,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;gBAC7B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAe,CAAC;IACzC,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC;IACnF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAC7C;QACE,GAAG,GAAG;QACN,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QACzF,OAAO,EAAE,GAAG,CAAC,GAAG;QAChB,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QACzF,QAAQ,EAAE;YACR,QAAQ,EAAE,kBAAkB;YAC5B,IAAI,EAAE,EAAE;SACT;QACD,QAAQ,EAAE,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3F,GAAG,EAAE,GAAG,CAAC,GAAG;QAEZ,4FAA4F;QAC5F,UAAU,EAAE,EAAW;QACvB,MAAM,EAAE,EAAW;KACpB,EACD;QACE,GAAG,EAAE;YACH,UAAU,EAAE,GAAG,CAAC,aAAa,EAAE;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,UAAU;SAC7B;KACF,CACF,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/lockfileSchema.d.ts

@@ -0,0 +1,125 @@
+import type { FromSchema } from '@readme/api-core/types';
+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,wBAAwB,CAAC;AAIzD,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/logger.d.ts

@@ -1,2 +1,4 @@
+import type { Options as OraOptions } from 'ora';
 export default function logger(log: string, error?: boolean): void;
+export declare function oraOptions(): OraOptions;
 //# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,QAM1D"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,KAAK,CAAC;AAIjD,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,QAM1D;AAED,wBAAgB,UAAU,eAKzB"}

package/dist/logger.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import chalk from 'chalk';
 export default function logger(log, error) {
     if (error) {
@@ -8,4 +7,9 @@ export default function logger(log, error) {
         console.log(log);
     }
 }
+export function oraOptions() {
+    // Disables spinner in tests so it doesn't pollute test output
+    const opts = { isSilent: process.env.NODE_ENV === 'test' };
+    return opts;
+}
 //# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,GAAW,EAAE,KAAe;IACzD,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;KAC/B;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KAClB;AACH,CAAC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,GAAW,EAAE,KAAe;IACzD,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,8DAA8D;IAC9D,MAAM,IAAI,GAAe,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;IAEvE,OAAO,IAAI,CAAC;AACd,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.10";
 //# sourceMappingURL=packageInfo.d.ts.map

package/dist/packageInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageInfo.d.ts","sourceRoot":"","sources":["../src/packageInfo.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,YAAY,QAAQ,CAAC;AAClC,eAAO,MAAM,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"packageInfo.d.ts","sourceRoot":"","sources":["../src/packageInfo.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,YAAY,QAAQ,CAAC;AAClC,eAAO,MAAM,eAAe,kBAAkB,CAAC"}

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.10';
 //# sourceMappingURL=packageInfo.js.map

package/dist/packageInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageInfo.js","sourceRoot":"","sources":["../src/packageInfo.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAClC,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC"}
+{"version":3,"file":"packageInfo.js","sourceRoot":"","sources":["../src/packageInfo.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAClC,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC"}