api 6.1.1 → 7.0.0-alpha.1

package/dist/{cli/codegen → codegen}/languages/typescript.js

@@ -73,9 +73,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
-var fs_1 = __importDefault(require("fs"));
-var path_1 = __importDefault(require("path"));
+Object.defineProperty(exports, "__esModule", { value: true });
+var node_fs_1 = __importDefault(require("node:fs"));
+var node_path_1 = __importDefault(require("node:path"));
 var execa_1 = __importDefault(require("execa"));
 var lodash_setwith_1 = __importDefault(require("lodash.setwith"));
 var semver_1 = __importDefault(require("semver"));
@@ -86,8 +86,8 @@ var util_1 = require("./typescript/util");
 var TSGenerator = /** @class */ (function (_super) {
     __extends(TSGenerator, _super);
     function TSGenerator(spec, specPath, identifier, opts) {
-        if (opts === void 0) { opts = {}; }
         var _this = this;
+        if (opts === void 0) { opts = {}; }
         var options = __assign({ outputJS: false, compilerTarget: 'cjs' }, opts);
         if (!options.outputJS) {
             // TypeScript compilation will always target towards ESM-like imports and exports.
@@ -97,27 +97,27 @@ var TSGenerator = /** @class */ (function (_super) {
         _this.usesHTTPMethodRangeInterface = false;
         _this.requiredPackages = {
             api: {
-                reason: "Required for the `api/dist/core` library that the codegen'd SDK uses for making requests.",
-                url: 'https://npm.im/api'
+                reason: "Required for the `@readme/api-core` library that the codegen'd SDK uses for making requests.",
+                url: 'https://npm.im/api',
             },
-            'json-schema-to-ts@beta': {
+            'json-schema-to-ts': {
                 reason: 'Required for TypeScript type handling.',
-                url: 'https://npm.im/json-schema-to-ts'
+                url: 'https://npm.im/json-schema-to-ts',
             },
             oas: {
-                reason: 'Used within `api/dist/core` and is also loaded for TypeScript types.',
-                url: 'https://npm.im/oas'
-            }
+                reason: 'Used within `@readme/api-core` and is also loaded for TypeScript types.',
+                url: 'https://npm.im/oas',
+            },
         };
         _this.project = new ts_morph_1.Project({
             manipulationSettings: {
                 indentationText: ts_morph_1.IndentationText.TwoSpaces,
-                quoteKind: ts_morph_1.QuoteKind.Single
+                quoteKind: ts_morph_1.QuoteKind.Single,
             },
             compilerOptions: __assign({ 
                 // If we're exporting a TypeScript SDK then we don't need to pollute the codegen directory
                 // with unnecessary declaration `.d.ts` files.
-                declaration: options.outputJS, outDir: 'dist', resolveJsonModule: true, target: options.compilerTarget === 'cjs' ? ts_morph_1.ScriptTarget.ES5 : ts_morph_1.ScriptTarget.ES2020 }, (options.compilerTarget === 'cjs' ? { esModuleInterop: true } : {}))
+                declaration: options.outputJS, outDir: 'dist', resolveJsonModule: true, target: options.compilerTarget === 'cjs' ? ts_morph_1.ScriptTarget.ES5 : ts_morph_1.ScriptTarget.ES2020 }, (options.compilerTarget === 'cjs' ? { esModuleInterop: true } : {})),
         });
         _this.compilerTarget = options.compilerTarget;
         _this.outputJS = options.outputJS;
@@ -134,27 +134,27 @@ var TSGenerator = /** @class */ (function (_super) {
                     case 0:
                         installDir = storage.getIdentifierStorageDir();
                         info = this.spec.getDefinition().info;
-                        pkgVersion = semver_1["default"].coerce(info.version);
+                        pkgVersion = semver_1.default.coerce(info.version);
                         if (!pkgVersion) {
                             // If the version that's in `info.version` isn't compatible with semver NPM won't be able to
                             // handle it properly so we need to fallback to something it can.
-                            pkgVersion = semver_1["default"].coerce('0.0.0');
+                            pkgVersion = semver_1.default.coerce('0.0.0');
                         }
                         pkg = {
                             name: "@api/".concat(storage.identifier),
                             version: pkgVersion.version,
                             main: "./index.".concat(this.outputJS ? 'js' : 'ts'),
-                            types: './index.d.ts'
+                            types: './index.d.ts', // Types are always present regardless if you're getting compiled JS.
                         };
-                        fs_1["default"].writeFileSync(path_1["default"].join(installDir, 'package.json'), JSON.stringify(pkg, null, 2));
+                        node_fs_1.default.writeFileSync(node_path_1.default.join(installDir, 'package.json'), JSON.stringify(pkg, null, 2));
                         npmInstall = ['install', '--save', opts.dryRun ? '--dry-run' : ''].filter(Boolean);
                         // This will install packages required for the SDK within its installed directory in `.apis/`.
-                        return [4 /*yield*/, (0, execa_1["default"])('npm', __spreadArray(__spreadArray([], npmInstall, true), Object.keys(this.requiredPackages), true).filter(Boolean), {
-                                cwd: installDir
+                        return [4 /*yield*/, (0, execa_1.default)('npm', __spreadArray(__spreadArray([], npmInstall, true), Object.keys(this.requiredPackages), true).filter(Boolean), {
+                                cwd: installDir,
                             }).then(function (res) {
                                 if (opts.dryRun) {
-                                    (opts.logger ? opts.logger : logger_1["default"])(res.command);
-                                    (opts.logger ? opts.logger : logger_1["default"])(res.stdout);
+                                    (opts.logger ? opts.logger : logger_1.default)(res.command);
+                                    (opts.logger ? opts.logger : logger_1.default)(res.stdout);
                                 }
                             })];
                     case 1:
@@ -163,15 +163,16 @@ var TSGenerator = /** @class */ (function (_super) {
                         // This will install the installed SDK as a dependency within the current working directory,
                         // adding `@api/<sdk identifier>` as a dependency there so you can load it with
                         // `require('@api/<sdk identifier>)`.
-                        return [2 /*return*/, (0, execa_1["default"])('npm', __spreadArray(__spreadArray([], npmInstall, true), [installDir], false).filter(Boolean))
+                        return [2 /*return*/, (0, execa_1.default)('npm', __spreadArray(__spreadArray([], npmInstall, true), [installDir], false).filter(Boolean))
                                 .then(function (res) {
                                 if (opts.dryRun) {
-                                    (opts.logger ? opts.logger : logger_1["default"])(res.command);
-                                    (opts.logger ? opts.logger : logger_1["default"])(res.stdout);
+                                    (opts.logger ? opts.logger : logger_1.default)(res.command);
+                                    (opts.logger ? opts.logger : logger_1.default)(res.stdout);
                                 }
-                            })["catch"](function (err) {
+                            })
+                                .catch(function (err) {
                                 if (opts.dryRun) {
-                                    (opts.logger ? opts.logger : logger_1["default"])(err.message);
+                                    (opts.logger ? opts.logger : logger_1.default)(err.message);
                                     return;
                                 }
                                 throw err;
@@ -185,10 +186,11 @@ var TSGenerator = /** @class */ (function (_super) {
      *
      */
     TSGenerator.prototype.generator = function () {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
             var sdkSource, types;
             var _this = this;
-            return __generator(this, function (_a) {
+            return __generator(this, function (_c) {
                 sdkSource = this.createSourceFile();
                 if (Object.keys(this.schemas).length) {
                     this.createSchemasFile();
@@ -211,25 +213,23 @@ var TSGenerator = /** @class */ (function (_super) {
                             {
                                 isTypeOnly: true,
                                 namedExports: types,
-                                moduleSpecifier: './types'
+                                moduleSpecifier: './types',
                             },
                         ]);
                     }
                 }
                 else {
                     // If we don't have any schemas then we shouldn't import a `types` file that doesn't exist.
-                    sdkSource
+                    (_a = sdkSource
                         .getImportDeclarations()
-                        .find(function (id) { return id.getText() === "import type * as types from './types';"; })
-                        .remove();
+                        .find(function (id) { return id.getText() === "import type * as types from './types';"; })) === null || _a === void 0 ? void 0 : _a.remove();
                 }
                 // If this SDK doesn't use the `HTTPMethodRange` interface for handling `2XX` response status
                 // codes then we should remove it from being imported.
                 if (!this.usesHTTPMethodRangeInterface) {
-                    sdkSource
+                    (_b = sdkSource
                         .getImportDeclarations()
-                        .find(function (id) { return id.getText().includes('HTTPMethodRange'); })
-                        .replaceWithText("import type { ConfigOptions, FetchResponse } from 'api/dist/core'");
+                        .find(function (id) { return id.getText().includes('HTTPMethodRange'); })) === null || _b === void 0 ? void 0 : _b.replaceWithText("import type { ConfigOptions, FetchResponse } from '@readme/api-core';");
                 }
                 if (this.outputJS) {
                     return [2 /*return*/, this.project
@@ -237,7 +237,7 @@ var TSGenerator = /** @class */ (function (_super) {
                             .getFiles()
                             .map(function (sourceFile) {
                             var _a;
-                            var file = path_1["default"].basename(sourceFile.filePath);
+                            var file = node_path_1.default.basename(sourceFile.filePath);
                             if (file === 'schemas.js' || file === 'types.js') {
                                 // If we're generating a JS SDK then we don't need to generate these two files as the
                                 // user will have `.d.ts` files for them instead.
@@ -276,7 +276,7 @@ var TSGenerator = /** @class */ (function (_super) {
                         .map(function (sourceFile) {
                         var _a;
                         return (_a = {},
-                            _a[path_1["default"].basename(sourceFile.filePath)] = sourceFile.text,
+                            _a[node_path_1.default.basename(sourceFile.filePath)] = sourceFile.text,
                             _a);
                     }), true).reduce(function (prev, next) { return Object.assign(prev, next); })];
             });
@@ -296,10 +296,10 @@ var TSGenerator = /** @class */ (function (_super) {
             {
                 // `HTTPMethodRange` will be conditionally removed later if it ends up not being used.
                 defaultImport: 'type { ConfigOptions, FetchResponse, HTTPMethodRange }',
-                moduleSpecifier: 'api/dist/core'
+                moduleSpecifier: '@readme/api-core',
             },
             { defaultImport: 'Oas', moduleSpecifier: 'oas' },
-            { defaultImport: 'APICore', moduleSpecifier: 'api/dist/core' },
+            { defaultImport: 'APICore', moduleSpecifier: '@readme/api-core' },
             { defaultImport: 'definition', moduleSpecifier: this.specPath },
         ]);
         // @todo add TOS, License, info.* to a docblock at the top of the SDK.
@@ -308,14 +308,14 @@ var TSGenerator = /** @class */ (function (_super) {
             properties: [
                 { name: 'spec', type: 'Oas' },
                 { name: 'core', type: 'APICore' },
-            ]
+            ],
         });
         this.sdk.addConstructor({
             statements: function (writer) {
                 writer.writeLine('this.spec = Oas.init(definition);');
                 writer.write('this.core = new APICore(this.spec, ').quote(_this.userAgent).write(');');
                 return writer;
-            }
+            },
         });
         // Add our core API methods for controlling auth, servers, and various configurable abilities.
         this.sdk.addMethods([
@@ -332,11 +332,11 @@ var TSGenerator = /** @class */ (function (_super) {
                             { tagName: 'param', text: 'config Object of supported SDK options and toggles.' },
                             {
                                 tagName: 'param',
-                                text: (0, util_1.wordWrap)('config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.')
+                                text: (0, util_1.wordWrap)('config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.'),
                             },
-                        ]
+                        ],
                     },
-                ]
+                ],
             },
             {
                 name: 'auth',
@@ -356,11 +356,11 @@ var TSGenerator = /** @class */ (function (_super) {
                             { tagName: 'see', text: '{@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}' },
                             {
                                 tagName: 'param',
-                                text: 'values Your auth credentials for the API; can specify up to two strings or numbers.'
+                                text: 'values Your auth credentials for the API; can specify up to two strings or numbers.',
                             },
-                        ]
+                        ],
                     },
-                ]
+                ],
             },
             {
                 name: 'server',
@@ -377,9 +377,9 @@ var TSGenerator = /** @class */ (function (_super) {
                         tags: [
                             { tagName: 'param', text: 'url Server URL' },
                             { tagName: 'param', text: 'variables An object of variables to replace into the server URL.' },
-                        ]
+                        ],
                     },
-                ]
+                ],
             },
         ]);
         // Add all available operation ID accessors into the SDK.
@@ -397,9 +397,9 @@ var TSGenerator = /** @class */ (function (_super) {
                         // `ts-morph` doesn't have any way to cleanly create an IFEE.
                         writer.writeLine('(() => { return new SDK(); })()');
                         return writer;
-                    }
+                    },
                 },
-            ]
+            ],
         });
         sourceFile.addExportAssignment({
             // Because CJS targets have `createSDK` exported with `module.exports`, but the TS type side
@@ -407,7 +407,7 @@ var TSGenerator = /** @class */ (function (_super) {
             // handle this accordingly and still create our JS file with `module.exports` and not
             // `export =` -- only TS types will have this export style.
             isExportEquals: this.compilerTarget === 'cjs' && this.outputJS,
-            expression: 'createSDK'
+            expression: 'createSDK',
         });
         return sourceFile;
     };
@@ -444,9 +444,9 @@ var TSGenerator = /** @class */ (function (_super) {
                             str = str.replace(/"::convert::([a-zA-Z_$\\d]*)"/g, '$1');
                             writer.writeLine("".concat(str, " as const"));
                             return writer;
-                        }
+                        },
                     },
-                ]
+                ],
             });
         });
         sourceFile.addStatements("export { ".concat(Array.from(sortedSchemas.keys()).join(', '), " }"));
@@ -507,7 +507,7 @@ var TSGenerator = /** @class */ (function (_super) {
             if (summary && description) {
                 docblock = TSGenerator.addTagToDocblock(docblock, {
                     tagName: 'summary',
-                    text: (0, util_1.docblockEscape)((0, util_1.wordWrap)(summary))
+                    text: (0, util_1.docblockEscape)((0, util_1.wordWrap)(summary)),
                 });
             }
         }
@@ -522,7 +522,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 parameters.body = {
                     name: 'body',
                     type: paramTypes.body ? paramTypes.body : paramTypes.formData,
-                    hasQuestionToken: hasOptionalBody
+                    hasQuestionToken: hasOptionalBody,
                 };
             }
             if (paramTypes.metadata) {
@@ -530,7 +530,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 parameters.metadata = {
                     name: 'metadata',
                     type: paramTypes.metadata,
-                    hasQuestionToken: hasOptionalMetadata
+                    hasQuestionToken: hasOptionalMetadata,
                 };
             }
         }
@@ -552,7 +552,7 @@ var TSGenerator = /** @class */ (function (_super) {
                     if (Number(statusPrefix) >= 4) {
                         docblock = TSGenerator.addTagToDocblock(docblock, {
                             tagName: 'throws',
-                            text: "FetchError<".concat(status, ", ").concat(responseType, ">").concat(responseDescription ? (0, util_1.docblockEscape)((0, util_1.wordWrap)(" ".concat(responseDescription))) : '')
+                            text: "FetchError<".concat(status, ", ").concat(responseType, ">").concat(responseDescription ? (0, util_1.docblockEscape)((0, util_1.wordWrap)(" ".concat(responseDescription))) : ''),
                         });
                         return false;
                     }
@@ -564,7 +564,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 if (Number(status) >= 400) {
                     docblock = TSGenerator.addTagToDocblock(docblock, {
                         tagName: 'throws',
-                        text: "FetchError<".concat(status, ", ").concat(responseType, ">").concat(responseDescription ? (0, util_1.docblockEscape)((0, util_1.wordWrap)(" ".concat(responseDescription))) : '')
+                        text: "FetchError<".concat(status, ", ").concat(responseType, ">").concat(responseDescription ? (0, util_1.docblockEscape)((0, util_1.wordWrap)(" ".concat(responseDescription))) : ''),
                     });
                     return false;
                 }
@@ -584,7 +584,7 @@ var TSGenerator = /** @class */ (function (_super) {
             // we should only add a docblock to the first overload we create because IDE Intellisense will
             // always use that and adding a docblock to all three will bloat the SDK with unused and
             // unsurfaced method documentation.
-            docs: shouldAddAltTypedOverloads ? null : Object.keys(docblock).length ? [docblock] : null,
+            docs: shouldAddAltTypedOverloads ? undefined : Object.keys(docblock).length ? [docblock] : undefined,
             statements: function (writer) {
                 /**
                  * @example return this.core.fetch('/pet/findByStatus', 'get', body, metadata);
@@ -609,7 +609,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 }
                 fetchStmt.write(');');
                 return fetchStmt;
-            }
+            },
         });
         // If we have both body and metadata parameters but only body is optional we need to create
         // a couple function overloads as Typescript doesn't let us have an optional method parameter
@@ -622,18 +622,18 @@ var TSGenerator = /** @class */ (function (_super) {
                     __assign(__assign({}, parameters.metadata), { hasQuestionToken: false }),
                 ],
                 returnType: returnType,
-                docs: Object.keys(docblock).length ? [docblock] : null
+                docs: Object.keys(docblock).length ? [docblock] : undefined,
             });
             // Create an overload that just has a single `metadata` parameter.
             operationIdAccessor.addOverload({
                 parameters: [__assign({}, parameters.metadata)],
-                returnType: returnType
+                returnType: returnType,
             });
             // Create an overload that has both `body` and `metadata` parameters as optional. Even though
             // our `metadata` parameter is actually required for this operation this is the only way we're
             // able to have an optional `body` parameter be present before `metadata`.
             //
-            // Thankfully our core fetch work in `api/dist/core` is able to do the proper determination to
+            // Thankfully our core fetch work in `@readme/api-core` is able to do the proper determination to
             // see if what the user is supplying is `metadata` or `body` content when they supply one or
             // both.
             operationIdAccessor.addParameters([
@@ -670,14 +670,14 @@ var TSGenerator = /** @class */ (function (_super) {
                 var operationId = operation.getOperationId({
                     // This `camelCase` option will clean up any weird characters that might be present in
                     // the `operationId` so as we don't break TS compilation with an invalid method accessor.
-                    camelCase: true
+                    camelCase: true,
                 });
                 operations[operationId] = {
                     types: {
                         params: _this.prepareParameterTypesForOperation(operation, operationId),
-                        responses: _this.prepareResponseTypesForOperation(operation, operationId)
+                        responses: _this.prepareResponseTypesForOperation(operation, operationId),
                     },
-                    operation: operation
+                    operation: operation,
                 };
             });
         });
@@ -686,7 +686,7 @@ var TSGenerator = /** @class */ (function (_super) {
         }
         return {
             operations: operations,
-            methods: methods
+            methods: methods,
         };
     };
     /**
@@ -703,13 +703,13 @@ var TSGenerator = /** @class */ (function (_super) {
             transformer: function (s) {
                 // As our schemas are dereferenced in the `oas` library we don't want to pollute our
                 // codegen'd schemas file with duplicate schemas.
-                if ('x-readme-ref-name' in s) {
+                if ('x-readme-ref-name' in s && typeof s['x-readme-ref-name'] !== 'undefined') {
                     var typeName = (0, util_1.generateTypeName)(s['x-readme-ref-name']);
                     _this.addSchemaToExport(s, typeName, typeName);
                     return "::convert::".concat(typeName);
                 }
                 return s;
-            }
+            },
         });
         if (!schemas || !schemas.length) {
             return false;
@@ -760,13 +760,13 @@ var TSGenerator = /** @class */ (function (_super) {
                 transformer: function (s) {
                     // As our schemas are dereferenced in the `oas` library we don't want to pollute our
                     // codegen'd schemas file with duplicate schemas.
-                    if ('x-readme-ref-name' in s) {
+                    if ('x-readme-ref-name' in s && typeof s['x-readme-ref-name'] !== 'undefined') {
                         var typeName = (0, util_1.generateTypeName)(s['x-readme-ref-name']);
                         _this.addSchemaToExport(s, typeName, "".concat(typeName));
                         return "::convert::".concat(typeName);
                     }
                     return s;
-                }
+                },
             });
             if (!schema) {
                 return false;
@@ -798,7 +798,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 // `types.d.ts`.
                 _b[status] = {
                     type: "types.".concat(typeName),
-                    description: description
+                    description: description,
                 },
                 _b;
         })
@@ -813,9 +813,9 @@ var TSGenerator = /** @class */ (function (_super) {
         if (this.types.has(typeName)) {
             return;
         }
-        (0, lodash_setwith_1["default"])(this.schemas, pointer, schema, Object);
+        (0, lodash_setwith_1.default)(this.schemas, pointer, schema, Object);
         this.types.set(typeName, "FromSchema<typeof schemas.".concat(pointer, ">"));
     };
     return TSGenerator;
-}(language_1["default"]));
-exports["default"] = TSGenerator;
+}(language_1.default));
+exports.default = TSGenerator;

package/dist/{cli/commands → commands}/index.js

@@ -2,8 +2,8 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var install_1 = __importDefault(require("./install"));
-exports["default"] = {
-    install: install_1["default"]
+exports.default = {
+    install: install_1.default,
 };