api 6.1.0 → 7.0.0-alpha.0

package/dist/cli/commands/index.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    install: import("commander").Command;
-};
-export default _default;

package/dist/cli/commands/index.js

@@ -1,9 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var install_1 = __importDefault(require("./install"));
-exports["default"] = {
-    install: install_1["default"]
-};

package/dist/cli/commands/install.d.ts

@@ -1,3 +0,0 @@
-import { Command } from 'commander';
-declare const cmd: Command;
-export default cmd;

package/dist/cli/commands/install.js

@@ -1,236 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var commander_1 = require("commander");
-var figures_1 = __importDefault(require("figures"));
-var oas_1 = __importDefault(require("oas"));
-var ora_1 = __importDefault(require("ora"));
-var fetcher_1 = __importDefault(require("../../fetcher"));
-var codegen_1 = __importDefault(require("../codegen"));
-var prompt_1 = __importDefault(require("../lib/prompt"));
-var logger_1 = __importDefault(require("../logger"));
-var storage_1 = __importDefault(require("../storage"));
-// @todo log logs to `.api/.logs` and have `.logs` ignored
-var cmd = new commander_1.Command();
-cmd
-    .name('install')
-    .description('install an API SDK into your codebase')
-    .argument('<uri>', 'an API to install')
-    .option('-i, --identifier <identifier>', 'API identifier (eg. `@api/petstore`)')
-    .addOption(new commander_1.Option('-l, --lang <language>', 'SDK language').choices([
-    'js',
-    'js-cjs',
-    'js-esm',
-    'ts',
-]))
-    .addOption(new commander_1.Option('-y, --yes', 'Automatically answer "yes" to any prompts printed'))
-    .action(function (uri, options) { return __awaiter(void 0, void 0, void 0, function () {
-    var language, identifier, spinner, storage, oas, generator, sdkSource, err_1;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                if (!options.lang) return [3 /*break*/, 1];
-                language = options.lang;
-                return [3 /*break*/, 3];
-            case 1: return [4 /*yield*/, (0, prompt_1["default"])({
-                    type: 'select',
-                    name: 'value',
-                    message: 'What language would you like to generate an SDK for?',
-                    choices: [
-                        { title: 'TypeScript', value: 'ts' },
-                        { title: 'JavaScript', value: 'js' },
-                    ],
-                    initial: 1
-                })];
-            case 2:
-                (language = (_a.sent()).value);
-                _a.label = 3;
-            case 3:
-                if (!(language === 'js')) return [3 /*break*/, 5];
-                return [4 /*yield*/, (0, prompt_1["default"])({
-                        type: 'select',
-                        name: 'value',
-                        message: 'How are your project imports and exports structured?',
-                        choices: [
-                            { title: 'CommonJS', description: 'require/exports', value: 'cjs' },
-                            { title: 'ECMAScript Modules', description: 'import/export', value: 'esm' },
-                        ],
-                        initial: 0,
-                        format: function (sel) { return (sel === 'cjs' ? 'js-cjs' : 'js-esm'); }
-                    })];
-            case 4:
-                (language = (_a.sent()).value);
-                _a.label = 5;
-            case 5:
-                // @todo let them know that we're going to be creating a `.api/ directory
-                // @todo detect if they have a gitigore and .npmignore and if .api woudl be ignored by that
-                // @todo don't support swagger files without upconverting them
-                if (storage_1["default"].isInLockFile({ source: uri })) {
-                    // @todo
-                    // logger(`It looks like you already have this API installed. Would you like to update it?`);
-                }
-                if (!options.identifier) return [3 /*break*/, 6];
-                // `Storage.isIdentifierValid` will throw an exception if an identifier is invalid.
-                if (storage_1["default"].isIdentifierValid(options.identifier)) {
-                    identifier = options.identifier;
-                }
-                return [3 /*break*/, 9];
-            case 6:
-                if (!fetcher_1["default"].isAPIRegistryUUID(uri)) return [3 /*break*/, 7];
-                identifier = fetcher_1["default"].getProjectPrefixFromRegistryUUID(uri);
-                return [3 /*break*/, 9];
-            case 7: return [4 /*yield*/, (0, prompt_1["default"])({
-                    type: 'text',
-                    name: 'value',
-                    message: 'What would you like to identify this API as? This will be how you import the SDK. (e.g. entering `petstore` would result in `@api/petstore`)',
-                    validate: function (value) {
-                        if (!value) {
-                            return false;
-                        }
-                        try {
-                            return storage_1["default"].isIdentifierValid(value, true);
-                        }
-                        catch (err) {
-                            return err.message;
-                        }
-                    }
-                })];
-            case 8:
-                (identifier = (_a.sent()).value);
-                _a.label = 9;
-            case 9:
-                if (!identifier) {
-                    (0, logger_1["default"])('You must tell us what you would like to identify this API as in order to install it.', true);
-                    process.exit(1);
-                }
-                spinner = (0, ora_1["default"])('Fetching your API').start();
-                storage = new storage_1["default"](uri, identifier);
-                return [4 /*yield*/, storage
-                        .load()
-                        .then(function (res) {
-                        spinner.succeed(spinner.text);
-                        return res;
-                    })
-                        .then(oas_1["default"].init)["catch"](function (err) {
-                        // @todo cleanup installed files
-                        spinner.fail(spinner.text);
-                        (0, logger_1["default"])(err.message, true);
-                        process.exit(1);
-                    })];
-            case 10:
-                oas = _a.sent();
-                // @todo look for a prettier config and if we find one ask them if we should use it
-                spinner = (0, ora_1["default"])('Generating your SDK').start();
-                generator = (0, codegen_1["default"])(language, oas, './openapi.json', identifier);
-                return [4 /*yield*/, generator
-                        .generator()
-                        .then(function (res) {
-                        spinner.succeed(spinner.text);
-                        return res;
-                    })["catch"](function (err) {
-                        // @todo cleanup installed files
-                        spinner.fail(spinner.text);
-                        (0, logger_1["default"])(err.message, true);
-                        process.exit(1);
-                    })];
-            case 11:
-                sdkSource = _a.sent();
-                spinner = (0, ora_1["default"])('Saving your SDK into your codebase').start();
-                return [4 /*yield*/, storage
-                        .saveSourceFiles(sdkSource)
-                        .then(function () {
-                        spinner.succeed(spinner.text);
-                    })["catch"](function (err) {
-                        // @todo cleanup installed files
-                        spinner.fail(spinner.text);
-                        (0, logger_1["default"])(err.message, true);
-                        process.exit(1);
-                    })];
-            case 12:
-                _a.sent();
-                if (!generator.hasRequiredPackages()) return [3 /*break*/, 18];
-                (0, logger_1["default"])("".concat(figures_1["default"].warning, " This generator requires some packages to be installed alongside it:"));
-                Object.entries(generator.requiredPackages).forEach(function (_a) {
-                    var pkg = _a[0], pkgInfo = _a[1];
-                    (0, logger_1["default"])("  ".concat(figures_1["default"].pointerSmall, " ").concat(pkg, ": ").concat(pkgInfo.reason, " ").concat(pkgInfo.url));
-                });
-                if (!!options.yes) return [3 /*break*/, 14];
-                return [4 /*yield*/, (0, prompt_1["default"])({
-                        type: 'confirm',
-                        name: 'value',
-                        message: 'OK to proceed with package installation?',
-                        initial: true
-                    }).then(function (_a) {
-                        var value = _a.value;
-                        if (!value) {
-                            // @todo cleanup installed files
-                            (0, logger_1["default"])('Installation cancelled.', true);
-                            process.exit(1);
-                        }
-                    })];
-            case 13:
-                _a.sent();
-                _a.label = 14;
-            case 14:
-                spinner = (0, ora_1["default"])('Installing required packages').start();
-                _a.label = 15;
-            case 15:
-                _a.trys.push([15, 17, , 18]);
-                return [4 /*yield*/, generator.installer(storage)];
-            case 16:
-                _a.sent();
-                spinner.succeed(spinner.text);
-                return [3 /*break*/, 18];
-            case 17:
-                err_1 = _a.sent();
-                // @todo cleanup installed files
-                spinner.fail(spinner.text);
-                (0, logger_1["default"])(err_1.message, true);
-                process.exit(1);
-                return [3 /*break*/, 18];
-            case 18:
-                (0, logger_1["default"])('🚀 All done!');
-                return [2 /*return*/];
-        }
-    });
-}); })
-    .addHelpText('after', "\nExamples:\n  $ api install @developers/v2.0#nysezql0wwo236\n  $ api install https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json\n  $ api install ./petstore.json");
-exports["default"] = cmd;

package/dist/cli/lib/prompt.d.ts

@@ -1,9 +0,0 @@
-import prompts from 'prompts';
-/**
- * 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`
- * import that we use.
- *
- * @see {@link https://github.com/terkelg/prompts/issues/252}
- */
-export default function promptTerminal<T extends string = string>(question: prompts.PromptObject<T>, options?: prompts.Options): Promise<prompts.Answers<T>>;

package/dist/cli/lib/prompt.js

@@ -1,81 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var prompts_1 = __importDefault(require("prompts"));
-/**
- * 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`
- * import that we use.
- *
- * @see {@link https://github.com/terkelg/prompts/issues/252}
- */
-function promptTerminal(question, options) {
-    return __awaiter(this, void 0, void 0, function () {
-        var enableTerminalCursor, onState;
-        return __generator(this, function (_a) {
-            enableTerminalCursor = function () {
-                process.stdout.write('\x1B[?25h');
-            };
-            onState = function (state) {
-                if (state.aborted) {
-                    // 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);
-                }
-            };
-            return [2 /*return*/, (0, prompts_1["default"])(__assign(__assign({}, question), { onState: onState }), options)];
-        });
-    });
-}
-exports["default"] = promptTerminal;

package/dist/cli/logger.d.ts

@@ -1 +0,0 @@
-export default function logger(log: string, error?: boolean): void;

package/dist/cli/logger.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-/* eslint-disable no-console */
-var chalk_1 = __importDefault(require("chalk"));
-function logger(log, error) {
-    if (error) {
-        console.error(chalk_1["default"].red(log));
-    }
-    else {
-        console.log(log);
-    }
-}
-exports["default"] = logger;

package/dist/cli/storage.d.ts

@@ -1,105 +0,0 @@
-import type { OASDocument } from 'oas/dist/rmoas.types';
-import Fetcher from '../fetcher';
-export default class Storage {
-    static dir: string;
-    static lockfile: false | Lockfile;
-    /**
-     * This is the original source that the file came from (relative/absolute file path, URL, ReadMe
-     * registry UUID, etc.).
-     */
-    source: string;
-    identifier: string;
-    fetcher: Fetcher;
-    constructor(source: string, identifier?: string);
-    static getLockfilePath(): string;
-    static getAPIsDir(): string;
-    static setStorageDir(dir?: string): void;
-    /**
-     * Reset the state of the entire storage system.
-     *
-     * This will completely destroy the contents of the `.api/` directory!
-     */
-    static reset(): Promise<void>;
-    static getDefaultLockfile(): Lockfile;
-    static generateIntegrityHash(definition: OASDocument): string;
-    static getLockfile(): Lockfile;
-    static isIdentifierValid(identifier: string, prefixWithAPINamespace?: boolean): boolean;
-    static isInLockFile(search: {
-        identifier?: string;
-        source?: string;
-    }): false | LockfileAPI;
-    setIdentifier(identifier: string): void;
-    /**
-     * Determine if the current spec + identifier we're working with is already in the lockfile.
-     */
-    isInLockfile(): boolean;
-    /**
-     * Retrieve the lockfile record for the current spec + identifier if it exists in the lockfile.
-     */
-    getFromLockfile(): LockfileAPI;
-    getIdentifierStorageDir(): string;
-    getAPIDefinition(): any;
-    saveSourceFiles(files: Record<string, string>): Promise<unknown>;
-    load(): 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
-     *
-     */
-    save(spec: OASDocument): OASDocument;
-}
-export 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';
-}
-export 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.
-     *
-     * @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;
-}