api 7.0.0-alpha.1 → 7.0.0-alpha.3

package/dist/lib/prompt.js

@@ -1,56 +1,9 @@
 "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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var prompts_1 = __importDefault(require("prompts"));
+const 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`
@@ -58,24 +11,19 @@ var prompts_1 = __importDefault(require("prompts"));
  *
  * @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)];
-        });
-    });
+async function promptTerminal(question, 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();
+            process.stdout.write('\n');
+            process.exit(1);
+        }
+    };
+    return (0, prompts_1.default)({ ...question, onState }, options);
 }
 exports.default = promptTerminal;

package/dist/logger.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable no-console */
-var chalk_1 = __importDefault(require("chalk"));
+const chalk_1 = __importDefault(require("chalk"));
 function logger(log, error) {
     if (error) {
         console.error(chalk_1.default.red(log));

package/dist/packageInfo.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "api";
-export declare const PACKAGE_VERSION = "7.0.0-alpha.1";
+export declare const PACKAGE_VERSION = "7.0.0-alpha.3";

package/dist/packageInfo.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PACKAGE_VERSION = exports.PACKAGE_NAME = void 0;
 // This file is automatically updated by the build script.
 exports.PACKAGE_NAME = 'api';
-exports.PACKAGE_VERSION = '7.0.0-alpha.1';
+exports.PACKAGE_VERSION = '7.0.0-alpha.3';

package/dist/storage.d.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/dist/rmoas.types';
+import type { OASDocument } from 'oas/rmoas.types';
 import Fetcher from './fetcher';
 export default class Storage {
     static dir: string;

package/dist/storage.js

@@ -1,53 +1,26 @@
 "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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var node_fs_1 = __importDefault(require("node:fs"));
-var node_path_1 = __importDefault(require("node:path"));
-var make_dir_1 = __importDefault(require("make-dir"));
-var ssri_1 = __importDefault(require("ssri"));
-var validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
-var fetcher_1 = __importDefault(require("./fetcher"));
-var packageInfo_1 = require("./packageInfo");
-var Storage = /** @class */ (function () {
-    function Storage(source, identifier) {
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const make_dir_1 = __importDefault(require("make-dir"));
+const ssri_1 = __importDefault(require("ssri"));
+const validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
+const fetcher_1 = __importDefault(require("./fetcher"));
+const packageInfo_1 = require("./packageInfo");
+class Storage {
+    static dir;
+    static lockfile;
+    /**
+     * This is the original source that the file came from (relative/absolute file path, URL, ReadMe
+     * registry UUID, etc.).
+     */
+    source;
+    identifier;
+    fetcher;
+    constructor(source, identifier) {
         Storage.setStorageDir();
         this.fetcher = new fetcher_1.default(source);
         this.source = source;
@@ -57,13 +30,13 @@ var Storage = /** @class */ (function () {
         // This should default to false so we have awareness if we've looked at the lockfile yet.
         Storage.lockfile = false;
     }
-    Storage.getLockfilePath = function () {
+    static getLockfilePath() {
         return node_path_1.default.join(Storage.dir, 'api.json');
-    };
-    Storage.getAPIsDir = function () {
+    }
+    static getAPIsDir() {
         return node_path_1.default.join(Storage.dir, 'apis');
-    };
-    Storage.setStorageDir = function (dir) {
+    }
+    static setStorageDir(dir) {
         if (dir) {
             Storage.dir = dir;
             return;
@@ -75,148 +48,122 @@ var Storage = /** @class */ (function () {
         }
         Storage.dir = make_dir_1.default.sync(node_path_1.default.join(process.cwd(), '.api'));
         make_dir_1.default.sync(Storage.getAPIsDir());
-    };
+    }
     /**
      * Reset the state of the entire storage system.
      *
      * This will completely destroy the contents of the `.api/` directory!
      */
-    Storage.reset = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!Storage.getLockfilePath()) return [3 /*break*/, 2];
-                        return [4 /*yield*/, node_fs_1.default.promises.writeFile(Storage.getLockfilePath(), JSON.stringify(Storage.getDefaultLockfile(), null, 2))];
-                    case 1:
-                        _a.sent();
-                        _a.label = 2;
-                    case 2:
-                        if (!Storage.getAPIsDir()) return [3 /*break*/, 5];
-                        return [4 /*yield*/, node_fs_1.default.promises.rm(Storage.getAPIsDir(), { recursive: true })];
-                    case 3:
-                        _a.sent();
-                        return [4 /*yield*/, node_fs_1.default.promises.mkdir(Storage.getAPIsDir(), { recursive: true })];
-                    case 4:
-                        _a.sent();
-                        _a.label = 5;
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    Storage.getDefaultLockfile = function () {
+    static async reset() {
+        if (Storage.getLockfilePath()) {
+            await node_fs_1.default.promises.writeFile(Storage.getLockfilePath(), JSON.stringify(Storage.getDefaultLockfile(), null, 2));
+        }
+        if (Storage.getAPIsDir()) {
+            await node_fs_1.default.promises.rm(Storage.getAPIsDir(), { recursive: true });
+            await node_fs_1.default.promises.mkdir(Storage.getAPIsDir(), { recursive: true });
+        }
+    }
+    static getDefaultLockfile() {
         return {
             version: '1.0',
             apis: [],
         };
-    };
-    Storage.generateIntegrityHash = function (definition) {
+    }
+    static generateIntegrityHash(definition) {
         return ssri_1.default
             .fromData(JSON.stringify(definition), {
             algorithms: ['sha512'],
         })
             .toString();
-    };
-    Storage.getLockfile = function () {
+    }
+    static getLockfile() {
         if (typeof Storage.lockfile === 'object') {
             return Storage.lockfile;
         }
         if (node_fs_1.default.existsSync(Storage.getLockfilePath())) {
-            var file = node_fs_1.default.readFileSync(Storage.getLockfilePath(), 'utf8');
+            const file = node_fs_1.default.readFileSync(Storage.getLockfilePath(), 'utf8');
             Storage.lockfile = JSON.parse(file);
         }
         else {
             Storage.lockfile = Storage.getDefaultLockfile();
         }
         return Storage.lockfile;
-    };
-    Storage.isIdentifierValid = function (identifier, prefixWithAPINamespace) {
-        var _a;
+    }
+    static isIdentifierValid(identifier, prefixWithAPINamespace) {
         // Is this identifier already in storage?
-        if (Storage.isInLockFile({ identifier: identifier })) {
-            throw new Error("\"".concat(identifier, "\" is already taken in your `.api/` directory. Please try another identifier."));
+        if (Storage.isInLockFile({ identifier })) {
+            throw new Error(`"${identifier}" is already taken in your \`.api/\` directory. Please try another identifier.`);
         }
-        var isValidForNPM = (0, validate_npm_package_name_1.default)(prefixWithAPINamespace ? "@api/".concat(identifier) : identifier);
+        const isValidForNPM = (0, validate_npm_package_name_1.default)(prefixWithAPINamespace ? `@api/${identifier}` : identifier);
         if (!isValidForNPM.validForNewPackages) {
             // `prompts` doesn't support surfacing multiple errors in a `validate` call so we can only
             // surface the first to the user.
-            throw new Error("Identifier cannot be used for an NPM package: ".concat(((_a = isValidForNPM === null || isValidForNPM === void 0 ? void 0 : isValidForNPM.errors) === null || _a === void 0 ? void 0 : _a[0]) || '[error unavailable]'));
+            throw new Error(`Identifier cannot be used for an NPM package: ${isValidForNPM?.errors?.[0] || '[error unavailable]'}`);
         }
         return true;
-    };
-    Storage.isInLockFile = function (search) {
+    }
+    static isInLockFile(search) {
         // Because this method may run before we initialize a new storage object we should make sure
         // that we have a storage directory present.
         Storage.setStorageDir();
         if (!search.identifier && !search.source) {
             throw new TypeError('An `identifier` or `source` must be supplied to this method to search in the lockfile.');
         }
-        var lockfile = Storage.getLockfile();
+        const lockfile = Storage.getLockfile();
         if (typeof lockfile !== 'object' || lockfile === null || !lockfile.apis) {
             return false;
         }
-        var res = lockfile.apis.find(function (a) {
+        const res = lockfile.apis.find(a => {
             if (search.identifier) {
                 return a.identifier === search.identifier;
             }
             return a.source === search.source;
         });
         return res === undefined ? false : res;
-    };
-    Storage.prototype.setIdentifier = function (identifier) {
+    }
+    setIdentifier(identifier) {
         this.identifier = identifier;
-    };
+    }
     /**
      * Determine if the current spec + identifier we're working with is already in the lockfile.
      */
-    Storage.prototype.isInLockfile = function () {
+    isInLockfile() {
         return Boolean(this.getFromLockfile());
-    };
+    }
     /**
      * Retrieve the lockfile record for the current spec + identifier if it exists in the lockfile.
      */
-    Storage.prototype.getFromLockfile = function () {
-        var _this = this;
-        var lockfile = Storage.getLockfile();
-        return lockfile.apis.find(function (a) { return a.identifier === _this.identifier; });
-    };
-    Storage.prototype.getIdentifierStorageDir = function () {
+    getFromLockfile() {
+        const lockfile = Storage.getLockfile();
+        return lockfile.apis.find(a => a.identifier === this.identifier);
+    }
+    getIdentifierStorageDir() {
         if (!this.isInLockfile()) {
-            throw new Error("".concat(this.source, " has not been saved to storage yet and must do so before being retrieved."));
+            throw new Error(`${this.source} has not been saved to storage yet and must do so before being retrieved.`);
         }
         return node_path_1.default.join(Storage.getAPIsDir(), this.identifier);
-    };
-    Storage.prototype.getAPIDefinition = function () {
-        var file = node_fs_1.default.readFileSync(node_path_1.default.join(this.getIdentifierStorageDir(), 'openapi.json'), 'utf8');
+    }
+    getAPIDefinition() {
+        const file = node_fs_1.default.readFileSync(node_path_1.default.join(this.getIdentifierStorageDir(), 'openapi.json'), 'utf8');
         return JSON.parse(file);
-    };
-    Storage.prototype.saveSourceFiles = function (files) {
-        var _this = this;
+    }
+    saveSourceFiles(files) {
         if (!this.isInLockfile()) {
-            throw new Error("".concat(this.source, " has not been saved to storage yet and must do so before being retrieved."));
+            throw new Error(`${this.source} has not been saved to storage yet and must do so before being retrieved.`);
         }
-        return new Promise(function (resolve) {
-            var savedSource = [];
-            Object.entries(files).forEach(function (_a) {
-                var fileName = _a[0], contents = _a[1];
-                var sourceFilePath = node_path_1.default.join(_this.getIdentifierStorageDir(), fileName);
+        return new Promise(resolve => {
+            const savedSource = [];
+            Object.entries(files).forEach(([fileName, contents]) => {
+                const sourceFilePath = node_path_1.default.join(this.getIdentifierStorageDir(), fileName);
                 node_fs_1.default.writeFileSync(sourceFilePath, contents);
                 savedSource.push(sourceFilePath);
             });
             resolve(savedSource);
         });
-    };
-    Storage.prototype.load = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var _this = this;
-            return __generator(this, function (_a) {
-                return [2 /*return*/, this.fetcher.load().then(function (spec) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
-                        return [2 /*return*/, this.save(spec)];
-                    }); }); })];
-            });
-        });
-    };
+    }
+    async load() {
+        return this.fetcher.load().then(async (spec) => this.save(spec));
+    }
     /**
      * @example <caption>Storage directory structure</caption>
      * .api/
@@ -239,7 +186,7 @@ var Storage = /** @class */ (function () {
      *         └── package.json
      *
      */
-    Storage.prototype.save = function (spec) {
+    save(spec) {
         if (!this.identifier) {
             throw new TypeError('An identifier must be set before saving the API definition into storage.');
         }
@@ -254,8 +201,8 @@ var Storage = /** @class */ (function () {
         if (!this.isInLockfile()) {
             // This API doesn't exist within our storage system yet so we need to record it in the
             // lockfile.
-            var identifierStorageDir = node_path_1.default.join(Storage.getAPIsDir(), this.identifier);
-            var saved = JSON.stringify(spec, null, 2);
+            const identifierStorageDir = node_path_1.default.join(Storage.getAPIsDir(), this.identifier);
+            const saved = JSON.stringify(spec, null, 2);
             // Create the `.api/apis/<identifier>` directory where we'll be storing this API definition
             // and eventually its codegen'd SDK.
             if (!node_fs_1.default.existsSync(identifierStorageDir)) {
@@ -274,7 +221,6 @@ var Storage = /** @class */ (function () {
             // Is this the same spec that we already have? Should we update it? // @todo
         }
         return spec;
-    };
-    return Storage;
-}());
+    }
+}
 exports.default = Storage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-alpha.3",
   "description": "Magical SDK generation from an OpenAPI definition 🪄",
   "bin": {
     "api": "./bin/api"
@@ -47,8 +47,8 @@
     "lodash.deburr": "^4.1.0",
     "lodash.setwith": "^4.3.2",
     "lodash.startcase": "^4.4.0",
-    "make-dir": "^3.1.0",
-    "oas": "^20.4.0",
+    "make-dir": "^4.0.0",
+    "oas": "^22.0.0",
     "ora": "^5.4.1",
     "prompts": "^2.4.2",
     "semver": "^7.3.8",
@@ -57,8 +57,8 @@
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@api/test-utils": "file:../test-utils",
-    "@readme/api-core": "file:../core",
+    "@api/test-utils": "^7.0.0-alpha.2",
+    "@readme/api-core": "^7.0.0-alpha.3",
     "@readme/oas-examples": "^5.12.0",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash.camelcase": "^4.3.7",
@@ -71,11 +71,12 @@
     "@types/validate-npm-package-name": "^4.0.0",
     "@vitest/coverage-v8": "^0.34.4",
     "fetch-mock": "^9.11.0",
-    "oas-normalize": "^8.3.2",
+    "oas-normalize": "^11.0.0",
     "type-fest": "^4.3.1",
     "typescript": "^5.2.2",
     "unique-temp-dir": "^1.0.0",
-    "vitest": "^0.34.1"
+    "vitest": "^0.34.5"
   },
-  "prettier": "@readme/eslint-config/prettier"
+  "prettier": "@readme/eslint-config/prettier",
+  "gitHead": "39b966c3f1bdc283e3f4d0e2d50484cfbc7a49a1"
 }

package/src/codegen/languages/typescript.ts

@@ -1,8 +1,8 @@
 import type Storage from '../../storage';
 import type { InstallerOptions } from '../language';
 import type Oas from 'oas';
-import type { Operation } from 'oas';
-import type { HttpMethods, SchemaObject } from 'oas/dist/rmoas.types';
+import type Operation from 'oas/operation';
+import type { HttpMethods, SchemaObject } from 'oas/rmoas.types';
 import type { SemVer } from 'semver';
 import type {
   ClassDeclaration,

package/src/fetcher.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/dist/rmoas.types';
+import type { OASDocument } from 'oas/rmoas.types';
 
 import fs from 'node:fs';
 import path from 'node:path';

package/src/packageInfo.ts

@@ -1,3 +1,3 @@
 // This file is automatically updated by the build script.
 export const PACKAGE_NAME = 'api';
-export const PACKAGE_VERSION = '7.0.0-alpha.1';
+export const PACKAGE_VERSION = '7.0.0-alpha.3';

package/src/storage.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/dist/rmoas.types';
+import type { OASDocument } from 'oas/rmoas.types';
 
 import fs from 'node:fs';
 import path from 'node:path';

package/tsconfig.json

@@ -5,8 +5,10 @@
     "declaration": true,
     "esModuleInterop": true,
     "lib": ["DOM", "DOM.Iterable", "ES2020"],
+    "module": "NodeNext",
     "noImplicitAny": true,
     "outDir": "dist/",
+    "skipLibCheck": true,
     "strict": true,
     "useUnknownInCatchVariables": false
   },