api 6.1.0 → 7.0.0-alpha.0

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/package.json

@@ -1,19 +1,18 @@
 {
   "name": "api",
-  "version": "6.1.0",
+  "version": "7.0.0-alpha.0",
   "description": "Magical SDK generation from an OpenAPI definition 🪄",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "bin": {
     "api": "./bin/api"
   },
   "scripts": {
     "build": "tsc",
     "debug:bin": "node -r ts-node/register src/bin.ts",
+    "lint:types": "tsc --noEmit",
     "prebuild": "rm -rf dist/; npm run version",
     "prepack": "npm run build",
-    "test": "jest --coverage $(find test -name '*.test.ts' -not -path '*/smoketest.test.ts')",
-    "test:smoke": "npx jest test/cli/codegen/languages/typescript/smoketest.test.ts",
+    "test": "vitest run --coverage",
+    "test:smoke": "vitest --config=vitest-smoketest.config.ts ",
     "version": "node -p \"'// This file is automatically updated by the build script.\\nexport const PACKAGE_NAME = \\'' + require('./package.json').name + '\\';\\nexport const PACKAGE_VERSION = \\'' + require('./package.json').version + '\\';'\" > src/packageInfo.ts; git add src/packageInfo.ts"
   },
   "repository": {
@@ -28,7 +27,7 @@
   "author": "Jon Ursenbach <jon@readme.io>",
   "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "keywords": [
     "api",
@@ -37,65 +36,46 @@
     "swagger"
   ],
   "dependencies": {
-    "@readme/oas-to-har": "^20.0.2",
     "@readme/openapi-parser": "^2.4.0",
-    "caseless": "^0.12.0",
     "chalk": "^4.1.2",
-    "commander": "^10.0.0",
-    "datauri": "^4.1.0",
+    "commander": "^11.0.0",
     "execa": "^5.1.1",
-    "fetch-har": "^8.1.5",
     "figures": "^3.2.0",
-    "find-cache-dir": "^3.3.1",
-    "form-data-encoder": "^1.7.2",
-    "formdata-node": "^4.3.2",
-    "get-stream": "^6.0.1",
-    "isomorphic-fetch": "^3.0.0",
     "js-yaml": "^4.1.0",
-    "json-schema-to-ts": "^2.6.2-beta.0",
-    "json-schema-traverse": "^1.0.0",
+    "json-schema-to-ts": "^2.9.2",
     "lodash.camelcase": "^4.3.0",
     "lodash.deburr": "^4.1.0",
-    "lodash.merge": "^4.6.2",
     "lodash.setwith": "^4.3.2",
     "lodash.startcase": "^4.4.0",
     "make-dir": "^3.1.0",
-    "node-abort-controller": "^3.1.1",
     "oas": "^20.4.0",
     "ora": "^5.4.1",
-    "prettier": "^2.8.3",
     "prompts": "^2.4.2",
-    "remove-undefined-objects": "^2.0.2",
     "semver": "^7.3.8",
     "ssri": "^10.0.1",
     "ts-morph": "^17.0.1",
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@readme/oas-examples": "^5.9.0",
-    "@types/caseless": "^0.12.2",
-    "@types/find-cache-dir": "^3.2.1",
-    "@types/jest": "^29.5.2",
+    "@api/test-utils": "file:../test-utils",
+    "@readme/oas-examples": "^5.12.0",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash.camelcase": "^4.3.7",
     "@types/lodash.deburr": "^4.1.7",
-    "@types/lodash.merge": "^4.6.7",
     "@types/lodash.setwith": "^4.3.7",
     "@types/lodash.startcase": "^4.4.7",
-    "@types/prettier": "^2.7.2",
-    "@types/prompts": "^2.4.2",
-    "@types/semver": "^7.3.13",
+    "@types/prompts": "^2.4.4",
+    "@types/semver": "^7.5.1",
     "@types/ssri": "^7.1.1",
     "@types/validate-npm-package-name": "^4.0.0",
+    "@vitest/coverage-v8": "^0.34.4",
+    "api.core": "file:../core",
     "fetch-mock": "^9.11.0",
-    "jest": "^29.6.1",
-    "jest-extended": "^4.0.0",
     "oas-normalize": "^8.3.2",
-    "ts-jest": "^29.1.1",
-    "type-fest": "^3.5.4",
-    "typescript": "^4.9.5",
-    "unique-temp-dir": "^1.0.0"
+    "type-fest": "^4.3.1",
+    "typescript": "^5.2.2",
+    "unique-temp-dir": "^1.0.0",
+    "vitest": "^0.34.1"
   },
-  "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "244093f2ad00e5ea527420f49bdb541bc2095806"
+  "prettier": "@readme/eslint-config/prettier"
 }

package/src/bin.ts

@@ -1,6 +1,6 @@
 import { Command } from 'commander';
 
-import commands from './cli/commands';
+import commands from './commands';
 import * as pkg from './packageInfo';
 
 (async () => {

package/src/{cli/codegen → codegen}/index.ts

@@ -9,7 +9,7 @@ export default function codegen(
   language: SupportedLanguages,
   spec: Oas,
   specPath: string,
-  identifier: string
+  identifier: string,
 ): CodeGeneratorLanguage {
   switch (language) {
     case 'js':

package/src/{cli/codegen → codegen}/language.ts

@@ -1,7 +1,7 @@
 import type Storage from '../storage';
 import type Oas from 'oas';
 
-import { PACKAGE_NAME, PACKAGE_VERSION } from '../../packageInfo';
+import { PACKAGE_NAME, PACKAGE_VERSION } from '../packageInfo';
 
 export interface InstallerOptions {
   /**
@@ -25,11 +25,12 @@ export default abstract class CodeGeneratorLanguage {
 
   userAgent: string;
 
-  requiredPackages: Record<string, { reason: string; url: string }>;
+  requiredPackages!: Record<string, { reason: string; url: string }>;
 
   constructor(spec: Oas, specPath: string, identifier: string) {
     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
@@ -49,7 +50,7 @@ export default abstract class CodeGeneratorLanguage {
      */
     if (JSON.stringify(spec.api).includes('"$ref":"#/')) {
       throw new Error(
-        'Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.'
+        'Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.',
       );
     }
   }

package/src/{cli/codegen → codegen}/languages/typescript/util.ts

@@ -1,7 +1,6 @@
 import camelCase from 'lodash.camelcase';
 import deburr from 'lodash.deburr';
 import startCase from 'lodash.startcase';
-import { format as prettier } from 'prettier';
 
 /**
  * This is a mix of reserved JS words and keywords in TypeScript that might be reserved or
@@ -100,14 +99,6 @@ const RESERVED_WORDS = [
   'window',
 ];
 
-export function formatter(content: string) {
-  return prettier(content, {
-    parser: 'typescript',
-    printWidth: 100,
-    singleQuote: true,
-  });
-}
-
 /**
  * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
  */
@@ -132,7 +123,7 @@ export function docblockEscape(str: string) {
  * @license MIT
  * @see {@link https://github.com/bcherny/json-schema-to-typescript}
  */
-export function toSafeString(str: string) {
+function toSafeString(str: string) {
   // identifiers in javaScript/ts:
   // First character: a-zA-Z | _ | $
   // Rest: a-zA-Z | _ | $ | 0-9

package/src/{cli/codegen → codegen}/languages/typescript.ts

@@ -3,6 +3,7 @@ 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 { SemVer } from 'semver';
 import type {
   ClassDeclaration,
   JSDocStructure,
@@ -12,8 +13,8 @@ import type {
 } from 'ts-morph';
 import type { PackageJson } from 'type-fest';
 
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 
 import execa from 'execa';
 import setWith from 'lodash.setwith';
@@ -23,7 +24,7 @@ import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationK
 import logger from '../../logger';
 import CodeGeneratorLanguage from '../language';
 
-import { docblockEscape, formatter, generateTypeName, wordWrap } from './typescript/util';
+import { docblockEscape, generateTypeName, wordWrap } from './typescript/util';
 
 export interface TSGeneratorOptions {
   compilerTarget?: 'cjs' | 'esm';
@@ -53,20 +54,18 @@ export default class TSGenerator extends CodeGeneratorLanguage {
 
   types: Map<string, string>;
 
-  files: Record<string, string>;
-
-  sdk: ClassDeclaration;
+  sdk!: ClassDeclaration;
 
   schemas: Record<
     string,
     // Operation-level type
     | {
-        body?: any;
-        metadata?: any;
-        response?: Record<string, any>;
+        body?: unknown;
+        metadata?: unknown;
+        response?: Record<string, unknown>;
       }
     // Wholesale collection of `$ref` pointer types
-    | Record<string, any>
+    | Record<string, unknown>
   >;
 
   usesHTTPMethodRangeInterface = false;
@@ -87,15 +86,15 @@ export default class TSGenerator extends CodeGeneratorLanguage {
 
     this.requiredPackages = {
       api: {
-        reason: "Required for the `api/dist/core` library that the codegen'd SDK uses for making requests.",
+        reason: "Required for the `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',
       },
       oas: {
-        reason: 'Used within `api/dist/core` and is also loaded for TypeScript types.',
+        reason: 'Used within `api.core` and is also loaded for TypeScript types.',
         url: 'https://npm.im/oas',
       },
     };
@@ -138,7 +137,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
     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.coerce('0.0.0');
+      pkgVersion = semver.coerce('0.0.0') as SemVer;
     }
 
     const pkg: PackageJson = {
@@ -221,7 +220,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       sdkSource
         .getImportDeclarations()
         .find(id => id.getText() === "import type * as types from './types';")
-        .remove();
+        ?.remove();
     }
 
     // If this SDK doesn't use the `HTTPMethodRange` interface for handling `2XX` response status
@@ -230,7 +229,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       sdkSource
         .getImportDeclarations()
         .find(id => id.getText().includes('HTTPMethodRange'))
-        .replaceWithText("import type { ConfigOptions, FetchResponse } from 'api/dist/core'");
+        ?.replaceWithText("import type { ConfigOptions, FetchResponse } from 'api.core';");
     }
 
     if (this.outputJS) {
@@ -245,7 +244,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
             return {};
           }
 
-          let code = formatter(sourceFile.text);
+          let code = sourceFile.text;
           if (file === 'index.js' && this.compilerTarget === 'cjs') {
             /**
              * There's an annoying quirk with `ts-morph` where if we're exporting a default export
@@ -271,7 +270,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
 
     return [
       ...this.project.getSourceFiles().map(sourceFile => ({
-        [sourceFile.getBaseName()]: formatter(sourceFile.getFullText()),
+        [sourceFile.getBaseName()]: sourceFile.getFullText(),
       })),
 
       // Because we're returning the raw source files for TS generation we also need to separately
@@ -281,7 +280,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
         .emitToMemory({ emitOnlyDtsFiles: true })
         .getFiles()
         .map(sourceFile => ({
-          [path.basename(sourceFile.filePath)]: formatter(sourceFile.text),
+          [path.basename(sourceFile.filePath)]: sourceFile.text,
         })),
     ].reduce((prev, next) => Object.assign(prev, next));
   }
@@ -301,10 +300,10 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       {
         // `HTTPMethodRange` will be conditionally removed later if it ends up not being used.
         defaultImport: 'type { ConfigOptions, FetchResponse, HTTPMethodRange }',
-        moduleSpecifier: 'api/dist/core',
+        moduleSpecifier: 'api.core',
       },
       { defaultImport: 'Oas', moduleSpecifier: 'oas' },
-      { defaultImport: 'APICore', moduleSpecifier: 'api/dist/core' },
+      { defaultImport: 'APICore', moduleSpecifier: 'api.core' },
       { defaultImport: 'definition', moduleSpecifier: this.specPath },
     ]);
 
@@ -340,7 +339,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
               {
                 tagName: 'param',
                 text: wordWrap(
-                  'config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.'
+                  'config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.',
                 ),
               },
             ],
@@ -370,7 +369,7 @@ sdk.auth('username', 'password');
 sdk.auth('myBearerToken');
 
 @example <caption>API Keys</caption>
-sdk.auth('myApiKey');`)
+sdk.auth('myApiKey');`),
               ),
             tags: [
               { tagName: 'see', text: '{@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}' },
@@ -403,7 +402,7 @@ sdk.server('https://{region}.api.example.com/{basePath}', {
 });
 
 @example <caption>Fully qualified server URL</caption>
-sdk.server('https://eu.api.example.com/v14');`)
+sdk.server('https://eu.api.example.com/v14');`),
               ),
             tags: [
               { tagName: 'param', text: 'url Server URL' },
@@ -536,7 +535,7 @@ sdk.server('https://eu.api.example.com/v14');`)
     operation: Operation,
     operationId: string,
     paramTypes?: OperationTypeHousing['types']['params'],
-    responseTypes?: OperationTypeHousing['types']['responses']
+    responseTypes?: OperationTypeHousing['types']['responses'],
   ) {
     let docblock: OptionalKind<JSDocStructure> = {};
     const summary = operation.getSummary();
@@ -566,10 +565,10 @@ sdk.server('https://eu.api.example.com/v14');`)
 
     let hasOptionalBody = false;
     let hasOptionalMetadata = false;
-    const parameters: {
-      body?: OptionalKind<ParameterDeclarationStructure>;
-      metadata?: OptionalKind<ParameterDeclarationStructure>;
-    } = {};
+    const parameters = {} as {
+      body: OptionalKind<ParameterDeclarationStructure>;
+      metadata: OptionalKind<ParameterDeclarationStructure>;
+    };
 
     if (paramTypes) {
       // If an operation has a request body payload it will only ever have `body` or `formData`,
@@ -656,7 +655,7 @@ sdk.server('https://eu.api.example.com/v14');`)
       // 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: writer => {
         /**
          * @example return this.core.fetch('/pet/findByStatus', 'get', body, metadata);
@@ -676,7 +675,7 @@ sdk.server('https://eu.api.example.com/v14');`)
             }
 
             fetchStmt.write(arg.name);
-            if (totalParams > 1 && i !== totalParams) {
+            if (i !== totalParams - 1) {
               fetchStmt.write(', ');
             }
           });
@@ -698,7 +697,7 @@ sdk.server('https://eu.api.example.com/v14');`)
           { ...parameters.metadata, hasQuestionToken: false },
         ],
         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.
@@ -711,7 +710,7 @@ sdk.server('https://eu.api.example.com/v14');`)
       // 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 `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([
@@ -739,13 +738,13 @@ sdk.server('https://eu.api.example.com/v14');`)
    */
   loadOperationsAndMethods() {
     const operations: Record</* operationId */ string, OperationTypeHousing> = {};
-    const methods = new Set();
+    const methods = new Set<HttpMethods>();
 
     // Prepare all of the schemas that we need to process for every operation within this API
     // definition.
     Object.entries(this.spec.getPaths()).forEach(([, ops]) => {
-      Object.entries(ops).forEach(([method, operation]: [HttpMethods, Operation]) => {
-        methods.add(method);
+      Object.entries(ops).forEach(([method, operation]: [string, Operation]) => {
+        methods.add(method as HttpMethods);
 
         const operationId = operation.getOperationId({
           // This `camelCase` option will clean up any weird characters that might be present in
@@ -786,7 +785,7 @@ sdk.server('https://eu.api.example.com/v14');`)
       transformer: (s: SchemaObject) => {
         // 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') {
           const typeName = generateTypeName(s['x-readme-ref-name']);
           this.addSchemaToExport(s, typeName, typeName);
 
@@ -806,7 +805,7 @@ sdk.server('https://eu.api.example.com/v14');`)
       .reduce((prev, next) => Object.assign(prev, next));
 
     return Object.entries(res)
-      .map(([paramType, schema]: [string, string | unknown]) => {
+      .map(([paramType, schema]: [string, string | SchemaObject]) => {
         let typeName;
 
         if (typeof schema === 'string' && schema.startsWith('::convert::')) {
@@ -815,7 +814,7 @@ sdk.server('https://eu.api.example.com/v14');`)
           typeName = schema.replace('::convert::', '');
         } else {
           typeName = generateTypeName(operationId, paramType, 'param');
-          this.addSchemaToExport(schema, typeName, `${generateTypeName(operationId)}.${paramType}`);
+          this.addSchemaToExport(schema as SchemaObject, typeName, `${generateTypeName(operationId)}.${paramType}`);
         }
 
         return {
@@ -844,7 +843,7 @@ sdk.server('https://eu.api.example.com/v14');`)
           transformer: (s: SchemaObject) => {
             // 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') {
               const typeName = generateTypeName(s['x-readme-ref-name']);
               this.addSchemaToExport(s, typeName, `${typeName}`);
 
@@ -900,7 +899,7 @@ sdk.server('https://eu.api.example.com/v14');`)
    * Add a given schema into our schema dataset that we'll be be exporting as types.
    *
    */
-  addSchemaToExport(schema: any, typeName: string, pointer: string) {
+  addSchemaToExport(schema: SchemaObject, typeName: string, pointer: string) {
     if (this.types.has(typeName)) {
       return;
     }

package/src/{cli/commands → commands}/install.ts

@@ -5,8 +5,8 @@ import figures from 'figures';
 import Oas from 'oas';
 import ora from 'ora';
 
-import Fetcher from '../../fetcher';
 import codegen from '../codegen';
+import Fetcher from '../fetcher';
 import promptTerminal from '../lib/prompt';
 import logger from '../logger';
 import Storage from '../storage';
@@ -24,7 +24,7 @@ cmd
       'js-cjs',
       'js-esm',
       'ts',
-    ])
+    ]),
   )
   .addOption(new Option('-y, --yes', 'Automatically answer "yes" to any prompts printed'))
   .action(async (uri: string, options: { identifier?: string; lang: string; yes?: boolean }) => {
@@ -188,7 +188,7 @@ cmd
 Examples:
   $ api install @developers/v2.0#nysezql0wwo236
   $ api install https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
-  $ api install ./petstore.json`
+  $ api install ./petstore.json`,
   );
 
 export default cmd;

package/src/fetcher.ts

@@ -1,10 +1,9 @@
 import type { OASDocument } from 'oas/dist/rmoas.types';
 
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 
 import OpenAPIParser from '@readme/openapi-parser';
-import 'isomorphic-fetch';
 import yaml from 'js-yaml';
 
 export default class Fetcher {
@@ -14,7 +13,6 @@ export default class Fetcher {
    * @example @petstore/v1.0#n6kvf10vakpemvplx
    * @example @petstore#n6kvf10vakpemvplx
    */
-  // eslint-disable-next-line unicorn/no-unsafe-regex
   static registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
 
   constructor(uri: string | OASDocument) {
@@ -53,13 +51,13 @@ export default class Fetcher {
       return undefined;
     }
 
-    return matches.groups.project;
+    return matches.groups?.project;
   }
 
   async load() {
     if (typeof this.uri !== 'string') {
       throw new TypeError(
-        "Something disastrous occurred and a non-string URI was supplied to the Fetcher library. This shouldn't have happened!"
+        "Something disastrous occurred and a non-string URI was supplied to the Fetcher library. This shouldn't have happened!",
       );
     }
 
@@ -103,7 +101,7 @@ export default class Fetcher {
 
     if (!fs.existsSync(file)) {
       throw new Error(
-        `Sorry, we were unable to load an API definition from ${file}. Please either supply a URL or a path on your filesystem.`
+        `Sorry, we were unable to load an API definition from ${file}. Please either supply a URL or a path on your filesystem.`,
       );
     }
 
@@ -116,7 +114,7 @@ export default class Fetcher {
     });
   }
 
-  static validate(json: any) {
+  static validate(json: OASDocument) {
     if (json.swagger) {
       throw new Error('Sorry, this module only supports OpenAPI definitions.');
     }

package/src/{cli/lib → lib}/prompt.ts

@@ -9,7 +9,7 @@ import prompts from 'prompts';
  */
 export default async function promptTerminal<T extends string = string>(
   question: prompts.PromptObject<T>,
-  options?: prompts.Options
+  options?: prompts.Options,
 ) {
   const enableTerminalCursor = () => {
     process.stdout.write('\x1B[?25h');

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 = '6.1.0';
+export const PACKAGE_VERSION = '7.0.0-alpha.0';

package/src/{cli/storage.ts → storage.ts}

@@ -1,14 +1,14 @@
 import type { OASDocument } from 'oas/dist/rmoas.types';
 
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 
 import makeDir from 'make-dir';
 import ssri from 'ssri';
 import validateNPMPackageName from 'validate-npm-package-name';
 
-import Fetcher from '../fetcher';
-import { PACKAGE_VERSION } from '../packageInfo';
+import Fetcher from './fetcher';
+import { PACKAGE_VERSION } from './packageInfo';
 
 export default class Storage {
   static dir: string;
@@ -21,7 +21,7 @@ export default class Storage {
    */
   source: string;
 
-  identifier: string;
+  identifier!: string;
 
   fetcher: Fetcher;
 
@@ -31,7 +31,9 @@ export default class Storage {
     this.fetcher = new Fetcher(source);
 
     this.source = source;
-    this.identifier = identifier;
+    if (identifier) {
+      this.identifier = identifier;
+    }
 
     // This should default to false so we have awareness if we've looked at the lockfile yet.
     Storage.lockfile = false;
@@ -116,7 +118,9 @@ export default class Storage {
     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: ${isValidForNPM.errors[0]}`);
+      throw new Error(
+        `Identifier cannot be used for an NPM package: ${isValidForNPM?.errors?.[0] || '[error unavailable]'}`,
+      );
     }
 
     return true;
@@ -269,7 +273,7 @@ export default class Storage {
   }
 }
 
-export interface Lockfile {
+interface Lockfile {
   apis: LockfileAPI[];
 
   /**
@@ -279,7 +283,7 @@ export interface Lockfile {
   version: '1.0';
 }
 
-export interface LockfileAPI {
+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>`.