api 6.1.1 → 7.0.0-alpha.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022 ReadMe
+Copyright © 2023 ReadMe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the “Software”), to deal in

package/README.md

@@ -36,18 +36,6 @@ petstore.listPets().then(({ data }) => {
 });
 ```
 
-Or you can use it dynamically (though you won't have fancy TypeScript types to help you out!):
-
-```js
-const petstore = require('api')(
-  'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json',
-);
-
-petstore.listPets().then(({ data }) => {
-  console.log(`My pets name is ${data[0].name}!`);
-});
-```
-
 The ESM syntax is supported as well:
 
 ```js

package/dist/bin.js

@@ -61,9 +61,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var commander_1 = require("commander");
-var commands_1 = __importDefault(require("./cli/commands"));
+var commands_1 = __importDefault(require("./commands"));
 var pkg = __importStar(require("./packageInfo"));
 (function () { return __awaiter(void 0, void 0, void 0, function () {
     var program;
@@ -78,7 +78,7 @@ var pkg = __importStar(require("./packageInfo"));
                  * programatically doing it like this because it's cleaner for us to let Commander manage option
                  * and argument parsing within this file than having each command  manage that itself.
                  */
-                Object.entries(commands_1["default"]).forEach(function (_a) {
+                Object.entries(commands_1.default).forEach(function (_a) {
                     var cmd = _a[1];
                     program.addCommand(cmd);
                 });

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

@@ -2,7 +2,7 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var typescript_1 = __importDefault(require("./languages/typescript"));
 function codegen(language, spec, specPath, identifier) {
     switch (language) {
@@ -11,13 +11,13 @@ function codegen(language, spec, specPath, identifier) {
         case 'js-cjs':
         case 'js-esm':
         case 'ts':
-            return new typescript_1["default"](spec, specPath, identifier, {
+            return new typescript_1.default(spec, specPath, identifier, {
                 outputJS: ['js-cjs', 'js-esm'].includes(language),
                 // TS will always generate with ESM-like exports.
-                compilerTarget: language === 'js-cjs' ? 'cjs' : 'esm'
+                compilerTarget: language === 'js-cjs' ? 'cjs' : 'esm',
             });
         default:
             throw new TypeError("Unsupported language supplied: ".concat(language));
     }
 }
-exports["default"] = codegen;
+exports.default = codegen;

package/dist/{cli/codegen → codegen}/language.js

@@ -1,10 +1,11 @@
 "use strict";
-exports.__esModule = true;
-var packageInfo_1 = require("../../packageInfo");
+Object.defineProperty(exports, "__esModule", { value: true });
+var packageInfo_1 = require("../packageInfo");
 var CodeGeneratorLanguage = /** @class */ (function () {
     function CodeGeneratorLanguage(spec, specPath, identifier) {
         this.spec = spec;
         this.specPath = specPath;
+        this.identifier = identifier;
         // User agents should be contextual to the spec in question and the version of `api` that was
         // used to generate the SDK. For example, this'll look like `petstore/1.0.0 (api/4.2.0)` for
         // a `petstore` spec installed on api@4.2.0.
@@ -29,4 +30,4 @@ var CodeGeneratorLanguage = /** @class */ (function () {
     };
     return CodeGeneratorLanguage;
 }());
-exports["default"] = CodeGeneratorLanguage;
+exports.default = CodeGeneratorLanguage;

package/dist/codegen/languages/typescript/util.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
+ */
+export declare function wordWrap(str: string, max?: number): string;
+/**
+ * Safely escape some string characters that may break a docblock.
+ *
+ */
+export declare function docblockEscape(str: string): string;
+export declare function generateTypeName(...parts: string[]): string;

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

@@ -2,8 +2,8 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
-exports.generateTypeName = exports.toSafeString = exports.docblockEscape = exports.wordWrap = void 0;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTypeName = exports.docblockEscape = exports.wordWrap = void 0;
 var lodash_camelcase_1 = __importDefault(require("lodash.camelcase"));
 var lodash_deburr_1 = __importDefault(require("lodash.deburr"));
 var lodash_startcase_1 = __importDefault(require("lodash.startcase"));
@@ -132,7 +132,7 @@ function toSafeString(str) {
     // First character: a-zA-Z | _ | $
     // Rest: a-zA-Z | _ | $ | 0-9
     // remove accents, umlauts, ... by their basic latin letters
-    return ((0, lodash_deburr_1["default"])(str)
+    return ((0, lodash_deburr_1.default)(str)
         // if the string starts with a number, prefix it with character that typescript can accept
         // https://github.com/bcherny/json-schema-to-typescript/issues/489
         .replace(/^(\d){1}/, '$$1')
@@ -149,7 +149,6 @@ function toSafeString(str) {
         // remove remaining whitespace
         .replace(/\s/g, ''));
 }
-exports.toSafeString = toSafeString;
 function generateTypeName() {
     var parts = [];
     for (var _i = 0; _i < arguments.length; _i++) {
@@ -161,12 +160,12 @@ function generateTypeName() {
     if (parts.length > 1) {
         var last = parts[parts.length - 1];
         if (last.match(/^(\d)XX$/)) {
-            str = (0, lodash_startcase_1["default"])((0, lodash_camelcase_1["default"])(parts.slice(0, -1).join(' ')));
+            str = (0, lodash_startcase_1.default)((0, lodash_camelcase_1.default)(parts.slice(0, -1).join(' ')));
             str += " ".concat(last);
         }
     }
     if (!str) {
-        str = (0, lodash_startcase_1["default"])((0, lodash_camelcase_1["default"])(parts.join(' ')));
+        str = (0, lodash_startcase_1.default)((0, lodash_camelcase_1.default)(parts.join(' ')));
     }
     if (RESERVED_WORDS.includes(str.toLowerCase())) {
         str = "$".concat(str);

package/dist/{cli/codegen → codegen}/languages/typescript.d.ts

@@ -2,6 +2,7 @@ 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 { ClassDeclaration, JSDocStructure, JSDocTagStructure, OptionalKind } from 'ts-morph';
 import { Project } from 'ts-morph';
 import CodeGeneratorLanguage from '../language';
@@ -24,13 +25,12 @@ export default class TSGenerator extends CodeGeneratorLanguage {
     outputJS: boolean;
     compilerTarget: 'cjs' | 'esm';
     types: Map<string, string>;
-    files: Record<string, string>;
     sdk: ClassDeclaration;
     schemas: Record<string, {
-        body?: any;
-        metadata?: any;
-        response?: Record<string, any>;
-    } | Record<string, any>>;
+        body?: unknown;
+        metadata?: unknown;
+        response?: Record<string, unknown>;
+    } | Record<string, unknown>>;
     usesHTTPMethodRangeInterface: boolean;
     constructor(spec: Oas, specPath: string, identifier: string, opts?: TSGeneratorOptions);
     installer(storage: Storage, opts?: InstallerOptions): Promise<void>;
@@ -66,10 +66,10 @@ export default class TSGenerator extends CodeGeneratorLanguage {
      */
     static addTagToDocblock(docblock: OptionalKind<JSDocStructure>, tag: OptionalKind<JSDocTagStructure>): {
         tags: OptionalKind<JSDocTagStructure>[];
-        description?: string | import("ts-morph").WriterFunction;
-        leadingTrivia?: string | import("ts-morph").WriterFunction | (string | import("ts-morph").WriterFunction)[];
-        trailingTrivia?: string | import("ts-morph").WriterFunction | (string | import("ts-morph").WriterFunction)[];
-        kind?: import("ts-morph").StructureKind.JSDoc;
+        description?: string | import("ts-morph").WriterFunction | undefined;
+        leadingTrivia?: string | import("ts-morph").WriterFunction | (string | import("ts-morph").WriterFunction)[] | undefined;
+        trailingTrivia?: string | import("ts-morph").WriterFunction | (string | import("ts-morph").WriterFunction)[] | undefined;
+        kind?: import("ts-morph").StructureKind.JSDoc | undefined;
     };
     /**
      * Create operation accessors on the SDK.
@@ -84,7 +84,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
      */
     loadOperationsAndMethods(): {
         operations: Record<string, OperationTypeHousing>;
-        methods: Set<unknown>;
+        methods: Set<HttpMethods>;
     };
     /**
      * Compile the parameter (path, query, cookie, and header) schemas for an API operation into
@@ -101,11 +101,11 @@ export default class TSGenerator extends CodeGeneratorLanguage {
             type: string;
             description: any;
         };
-    };
+    } | undefined;
     /**
      * Add a given schema into our schema dataset that we'll be be exporting as types.
      *
      */
-    addSchemaToExport(schema: any, typeName: string, pointer: string): void;
+    addSchemaToExport(schema: SchemaObject, typeName: string, pointer: string): void;
 }
 export {};