api 5.0.4 → 5.0.6

package/README.md

@@ -7,10 +7,10 @@
 </p>
 
 <p align="center">
-  <a href="https://npm.im/api"><img src="https://img.shields.io/npm/v/api.svg?style=for-the-badge" alt="NPM Version"></a>
-  <a href="https://npm.im/api"><img src="https://img.shields.io/node/v/api.svg?style=for-the-badge" alt="Node Version"></a>
-  <a href="https://npm.im/api"><img src="https://img.shields.io/npm/l/api.svg?style=for-the-badge" alt="MIT License"></a>
-  <a href="https://github.com/readmeio/api"><img src="https://img.shields.io/github/workflow/status/readmeio/api/CI.svg?style=for-the-badge" alt="Build status"></a>
+  <a href="https://npm.im/api"><img src="https://img.shields.io/npm/v/api?style=for-the-badge" alt="NPM Version"></a>
+  <a href="https://npm.im/api"><img src="https://img.shields.io/node/v/api?style=for-the-badge" alt="Node Version"></a>
+  <a href="https://npm.im/api"><img src="https://img.shields.io/npm/l/api?style=for-the-badge" alt="MIT License"></a>
+  <a href="https://github.com/readmeio/api"><img src="https://img.shields.io/github/actions/workflow/status/readmeio/api/ci.yml?branch=main&style=for-the-badge" alt="Build status"></a>
 </p>
 
 - [Installation](https://api.readme.dev/docs/installation)

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

@@ -5,17 +5,17 @@ import type { Operation } from 'oas';
 import type { ClassDeclaration } from 'ts-morph';
 import { Project } from 'ts-morph';
 import CodeGeneratorLanguage from '../language';
-export type TSGeneratorOptions = {
+export interface TSGeneratorOptions {
     outputJS?: boolean;
     compilerTarget?: 'cjs' | 'esm';
-};
-type OperationTypeHousing = {
+}
+interface OperationTypeHousing {
     types: {
         params?: false | Record<'body' | 'formData' | 'metadata', string>;
         responses?: Record<string, string>;
     };
     operation: Operation;
-};
+}
 export default class TSGenerator extends CodeGeneratorLanguage {
     project: Project;
     outputJS: boolean;

package/dist/cli/codegen/languages/typescript.js

@@ -186,15 +186,28 @@ var TSGenerator = /** @class */ (function (_super) {
                 if (Object.keys(this.schemas).length) {
                     this.createSchemasFile();
                     this.createTypesFile();
-                    types = Array.from(this.types.keys());
-                    types.sort();
-                    sdkSource.addExportDeclarations([
-                        {
-                            isTypeOnly: true,
-                            namedExports: types,
-                            moduleSpecifier: './types'
-                        },
-                    ]);
+                    /**
+                     * Export all of our available types so they can be used in SDK implementations. Types are
+                     * exported individually because TS has no way right now of allowing us to do
+                     * `export type * from './types'` on a non-named entry.
+                     *
+                     * Types in the main entry point are only being exported for TS outputs as JS users won't be
+                     * able to use them and it clashes with the default SDK export present.
+                     *
+                     * @see {@link https://github.com/microsoft/TypeScript/issues/37238}
+                     * @see {@link https://github.com/readmeio/api/issues/588}
+                     */
+                    if (!this.outputJS) {
+                        types = Array.from(this.types.keys());
+                        types.sort();
+                        sdkSource.addExportDeclarations([
+                            {
+                                isTypeOnly: true,
+                                namedExports: types,
+                                moduleSpecifier: './types'
+                            },
+                        ]);
+                    }
                 }
                 else {
                     // If we don't have any schemas then we shouldn't import a `types` file that doesn't exist.
@@ -381,7 +394,14 @@ var TSGenerator = /** @class */ (function (_super) {
                 },
             ]
         });
-        sourceFile.addExportAssignment({ isExportEquals: false, expression: 'createSDK' });
+        sourceFile.addExportAssignment({
+            // Because CJS targets have `createSDK` exported with `module.exports`, but the TS type side
+            // of things to work right we need to set this as `export =`. Thankfully `ts-morph` will
+            // 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'
+        });
         return sourceFile;
     };
     /**

package/dist/cli/storage.d.ts

@@ -65,15 +65,15 @@ export default class Storage {
      */
     save(spec: OASDocument): OASDocument;
 }
-export type Lockfile = {
+export interface Lockfile {
     /**
      * The `api.json` schema version. This will only ever change if we introduce breaking changes to
      * this store.
      */
     version: '1.0';
     apis: LockfileAPI[];
-};
-export type LockfileAPI = {
+}
+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>`.
@@ -102,4 +102,4 @@ export type LockfileAPI = {
      * @example 5.0.0
      */
     installerVersion: string;
-};
+}

package/dist/core/index.d.ts

@@ -14,12 +14,12 @@ export interface ConfigOptions {
      */
     timeout?: number;
 }
-export type FetchResponse<status, data> = {
+export interface FetchResponse<status, data> {
     data: data;
     status: status;
     headers: Headers;
     res: Response;
-};
+}
 type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
 export type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
 export { getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };

package/dist/packageInfo.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "api";
-export declare const PACKAGE_VERSION = "5.0.4";
+export declare const PACKAGE_VERSION = "5.0.6";

package/dist/packageInfo.js

@@ -3,4 +3,4 @@ exports.__esModule = 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 = '5.0.4';
+exports.PACKAGE_VERSION = '5.0.6';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "description": "Magical SDK generation from an OpenAPI definition 🪄",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -37,14 +37,14 @@
     "swagger"
   ],
   "dependencies": {
-    "@readme/oas-to-har": "^20.0.0",
-    "@readme/openapi-parser": "^2.2.0",
+    "@readme/oas-to-har": "^20.0.2",
+    "@readme/openapi-parser": "^2.4.0",
     "caseless": "^0.12.0",
     "chalk": "^4.1.2",
-    "commander": "^9.4.0",
+    "commander": "^9.5.0",
     "datauri": "^4.1.0",
     "execa": "^5.1.1",
-    "fetch-har": "^8.1.3",
+    "fetch-har": "^8.1.4",
     "figures": "^3.2.0",
     "find-cache-dir": "^3.3.1",
     "form-data-encoder": "^1.7.2",
@@ -61,18 +61,18 @@
     "lodash.startcase": "^4.4.0",
     "make-dir": "^3.1.0",
     "node-abort-controller": "^3.0.1",
-    "oas": "^20.0.1",
+    "oas": "^20.3.0",
     "ora": "^5.4.1",
-    "prettier": "^2.8.0",
+    "prettier": "^2.8.2",
     "prompts": "^2.4.2",
-    "remove-undefined-objects": "^2.0.1",
+    "remove-undefined-objects": "^2.0.2",
     "semver": "^7.3.8",
-    "ssri": "^10.0.0",
+    "ssri": "^10.0.1",
     "ts-morph": "^17.0.1",
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@readme/oas-examples": "^5.7.1",
+    "@readme/oas-examples": "^5.9.0",
     "@types/caseless": "^0.12.2",
     "@types/chai": "^4.3.4",
     "@types/find-cache-dir": "^3.2.1",
@@ -83,22 +83,22 @@
     "@types/lodash.setwith": "^4.3.7",
     "@types/lodash.startcase": "^4.4.7",
     "@types/mocha": "^10.0.1",
-    "@types/prettier": "^2.7.1",
-    "@types/prompts": "^2.4.1",
+    "@types/prettier": "^2.7.2",
+    "@types/prompts": "^2.4.2",
     "@types/semver": "^7.3.13",
     "@types/sinon-chai": "^3.2.9",
     "@types/ssri": "^7.1.1",
     "@types/validate-npm-package-name": "^4.0.0",
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "fetch-mock": "^9.11.0",
-    "mocha": "^10.0.0",
+    "mocha": "^10.1.0",
     "mock-require": "^3.0.3",
     "nyc": "^15.1.0",
-    "oas-normalize": "^8.1.3",
+    "oas-normalize": "^8.3.1",
     "sinon": "^15.0.0",
     "sinon-chai": "^3.7.0",
-    "type-fest": "^3.3.0",
-    "typescript": "^4.7.4",
+    "type-fest": "^3.5.1",
+    "typescript": "^4.9.4",
     "unique-temp-dir": "^1.0.0"
   },
   "prettier": "@readme/eslint-config/prettier",
@@ -108,5 +108,5 @@
       "test/"
     ]
   },
-  "gitHead": "e566a19f6b6b36cad43b7e4edbe1deb4a6fe8609"
+  "gitHead": "33d0a4e279fd30aa7673b8fdf7bb00399a7c8c4e"
 }

package/src/cli/codegen/languages/typescript.ts

@@ -19,18 +19,18 @@ import CodeGeneratorLanguage from '../language';
 
 import { docblockEscape, formatter, generateTypeName, wordWrap } from './typescript/util';
 
-export type TSGeneratorOptions = {
+export interface TSGeneratorOptions {
   outputJS?: boolean;
   compilerTarget?: 'cjs' | 'esm';
-};
+}
 
-type OperationTypeHousing = {
+interface OperationTypeHousing {
   types: {
     params?: false | Record<'body' | 'formData' | 'metadata', string>;
     responses?: Record<string, string>;
   };
   operation: Operation;
-};
+}
 
 export default class TSGenerator extends CodeGeneratorLanguage {
   project: Project;
@@ -172,22 +172,29 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       this.createSchemasFile();
       this.createTypesFile();
 
-      // Export all of our available types so they can be used in SDK implementations.
-      //
-      // We're exporting all of the types individually because TS has no way right now of allowing
-      // us to do `export type * from './types'` on a non-named entry.
-      //
-      // https://github.com/microsoft/TypeScript/issues/37238
-      const types = Array.from(this.types.keys());
-      types.sort();
-
-      sdkSource.addExportDeclarations([
-        {
-          isTypeOnly: true,
-          namedExports: types,
-          moduleSpecifier: './types',
-        },
-      ]);
+      /**
+       * Export all of our available types so they can be used in SDK implementations. Types are
+       * exported individually because TS has no way right now of allowing us to do
+       * `export type * from './types'` on a non-named entry.
+       *
+       * Types in the main entry point are only being exported for TS outputs as JS users won't be
+       * able to use them and it clashes with the default SDK export present.
+       *
+       * @see {@link https://github.com/microsoft/TypeScript/issues/37238}
+       * @see {@link https://github.com/readmeio/api/issues/588}
+       */
+      if (!this.outputJS) {
+        const types = Array.from(this.types.keys());
+        types.sort();
+
+        sdkSource.addExportDeclarations([
+          {
+            isTypeOnly: true,
+            namedExports: types,
+            moduleSpecifier: './types',
+          },
+        ]);
+      }
     } else {
       // If we don't have any schemas then we shouldn't import a `types` file that doesn't exist.
       sdkSource
@@ -406,7 +413,14 @@ sdk.server('https://eu.api.example.com/v14');`)
       ],
     });
 
-    sourceFile.addExportAssignment({ isExportEquals: false, expression: 'createSDK' });
+    sourceFile.addExportAssignment({
+      // Because CJS targets have `createSDK` exported with `module.exports`, but the TS type side
+      // of things to work right we need to set this as `export =`. Thankfully `ts-morph` will
+      // 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',
+    });
 
     return sourceFile;
   }

package/src/cli/storage.ts

@@ -253,16 +253,16 @@ export default class Storage {
   }
 }
 
-export type Lockfile = {
+export interface Lockfile {
   /**
    * The `api.json` schema version. This will only ever change if we introduce breaking changes to
    * this store.
    */
   version: '1.0';
   apis: LockfileAPI[];
-};
+}
 
-export type LockfileAPI = {
+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>`.
@@ -294,4 +294,4 @@ export type LockfileAPI = {
    * @example 5.0.0
    */
   installerVersion: string;
-};
+}

package/src/core/index.ts

@@ -24,12 +24,12 @@ export interface ConfigOptions {
   timeout?: number;
 }
 
-export type FetchResponse<status, data> = {
+export interface FetchResponse<status, data> {
   data: data;
   status: status;
   headers: Headers;
   res: Response;
-};
+}
 
 // https://stackoverflow.com/a/39495173
 type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N

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 = '5.0.4';
+export const PACKAGE_VERSION = '5.0.6';