api 7.0.0-alpha.6 → 7.0.0-beta.1

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

@@ -1,984 +0,0 @@
-import type Storage from '../../../storage.js';
-import type { InstallerOptions } from '../../codegenerator.js';
-import type Oas from 'oas';
-import type Operation from 'oas/operation';
-import type { HttpMethods, SchemaObject } from 'oas/rmoas.types';
-import type { SemVer } from 'semver';
-import type {
-  ClassDeclaration,
-  Directory,
-  JSDocStructure,
-  JSDocTagStructure,
-  OptionalKind,
-  ParameterDeclarationStructure,
-} from 'ts-morph';
-import type { Options } from 'tsup';
-import type { JsonObject, PackageJson, TsConfigJson } from 'type-fest';
-
-import path from 'node:path';
-
-import corePkg from '@readme/api-core/package.json' assert { type: 'json' };
-import execa from 'execa';
-import setWith from 'lodash.setwith';
-import semver from 'semver';
-import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationKind } from 'ts-morph';
-
-import logger from '../../../logger.js';
-import CodeGenerator from '../../codegenerator.js';
-
-import { docblockEscape, generateTypeName, wordWrap } from './util.js';
-
-interface OperationTypeHousing {
-  operation: Operation;
-  types: {
-    params?: false | Record<'body' | 'formData' | 'metadata', string>;
-    responses?: Record<
-      string | number,
-      {
-        description?: string;
-        type: string;
-      }
-    >;
-  };
-}
-
-/**
- * This is the conversion prefix that we add to all `$ref` pointers we find in generated JSON
- * Schema.
- *
- * Because the pointer name is a string we want to have it reference the schema constant we're
- * adding into the codegen'd schema file. As there's no way, not even using `eval()` in this case,
- * to convert a string to a constant we're prefixing them with this so we can later remove it and
- * rewrite the value to a literal. eg. `'Pet'` becomes `Pet`.
- *
- * And because our TypeScript type name generator properly ignores `:`, this is safe to prepend to
- * all generated type names.
- */
-const REF_PLACEHOLDER = '::convert::';
-const REF_PLACEHOLDER_REGEX = /"::convert::([a-zA-Z_$\\d]*)"/g;
-
-export default class TSGenerator extends CodeGenerator {
-  project: Project;
-
-  types: Map<string, string>;
-
-  sdk!: ClassDeclaration;
-
-  schemas: Record<
-    string,
-    // Operation-level type
-    | {
-        body?: unknown;
-        metadata?: unknown;
-        response?: Record<string, unknown>;
-      }
-    // Wholesale collection of `$ref` pointer types
-    | Record<string, unknown>
-  >;
-
-  usesHTTPMethodRangeInterface = false;
-
-  constructor(spec: Oas, specPath: string, identifier: string) {
-    super(spec, specPath, identifier);
-
-    this.requiredPackages = {
-      '@readme/api-core': {
-        dependencyType: 'production',
-        reason: "The core magic of your codegen'd SDK and is what is used for making requests.",
-        url: 'https://npm.im/api',
-        version:
-          // When running unit tests we're installing `@readme/api-core` but because that package
-          // source lives in this repository NPM will throw a gnarly "Cannot set properties of null
-          // (setting 'dev')" workspace error message because we're creating a funky circular
-          // dependency.
-          process.env.NODE_ENV === 'test'
-            ? `file:${path.relative(__dirname, path.dirname(require.resolve('@readme/api-core/package.json')))}`
-            : corePkg.version,
-      },
-      'json-schema-to-ts': {
-        dependencyType: 'production',
-        reason: 'Required for TypeScript type handling.',
-        url: 'https://npm.im/json-schema-to-ts',
-        version: '^2.9.2',
-      },
-      tsup: {
-        dependencyType: 'development',
-        reason: "Used for compiling your codegen'd SDK into code that can be used in JS environments.",
-        url: 'https://tsup.egoist.dev/',
-        version: '^7.2.0',
-      },
-      typescript: {
-        dependencyType: 'development',
-        reason: 'Required for `tsup`.',
-        version: '^5.2.2',
-      },
-    };
-
-    this.project = new Project({
-      compilerOptions: {
-        outDir: 'dist',
-        resolveJsonModule: true,
-        target: ScriptTarget.ES2022,
-      },
-      manipulationSettings: {
-        indentationText: IndentationText.TwoSpaces,
-        quoteKind: QuoteKind.Single,
-      },
-      useInMemoryFileSystem: true,
-    });
-
-    this.types = new Map();
-    this.schemas = {};
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  async install(storage: Storage, opts: InstallerOptions = {}): Promise<void> {
-    const installDir = storage.getIdentifierStorageDir();
-
-    const npmInstall = ['install', '--save', opts.dryRun ? '--dry-run' : ''].filter(Boolean);
-
-    // 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>)`.
-    await execa('npm', [...npmInstall, installDir].filter(Boolean))
-      .then(res => {
-        if (opts.dryRun) {
-          (opts.logger ? opts.logger : logger)(res.command);
-          (opts.logger ? opts.logger : logger)(res.stdout);
-        }
-      })
-      .catch(err => {
-        // If `npm install` throws this error it always happens **after** our dependencies have been
-        // installed and is an annoying quirk that sometimes occurs when installing a package within
-        // our workspace as we're creating a circular dependency on `@readme/api-core`.
-        if (
-          process.env.NODE_ENV === 'test' &&
-          err.message.includes("npm ERR! Cannot set properties of null (setting 'dev')")
-        ) {
-          (opts.logger ? opts.logger : logger)("npm threw an error but we're ignoring it");
-          return;
-        }
-
-        if (opts.dryRun) {
-          (opts.logger ? opts.logger : logger)(err.message);
-          return;
-        }
-
-        throw err;
-      });
-  }
-
-  /**
-   * Compile the TS code we generated into JS for use in CJS and ESM environments.
-   *
-   */
-  // eslint-disable-next-line class-methods-use-this
-  async compile(storage: Storage, opts: InstallerOptions = {}): Promise<void> {
-    const installDir = storage.getIdentifierStorageDir();
-
-    await execa('npx', ['tsup'], {
-      cwd: installDir,
-    })
-      .then(res => {
-        if (opts.dryRun) {
-          (opts.logger ? opts.logger : logger)(res.command);
-          (opts.logger ? opts.logger : logger)(res.stdout);
-        }
-      })
-      .catch(err => {
-        if (opts.dryRun) {
-          (opts.logger ? opts.logger : logger)(err.message);
-          return;
-        }
-
-        throw err;
-      });
-  }
-
-  /**
-   * Generate the current OpenAPI definition into a TypeScript library.
-   *
-   */
-  async generate() {
-    const srcDirectory = this.project.createDirectory('src');
-    const sdkSource = this.createSDKSource(srcDirectory);
-
-    this.createPackageJSON();
-    this.createTSConfig();
-
-    if (Object.keys(this.schemas).length) {
-      this.createSchemasFile(srcDirectory);
-      this.createTypesFile(srcDirectory);
-    } else {
-      // If we don't have any schemas then we shouldn't import a `types` file that doesn't exist.
-      sdkSource
-        .getImportDeclarations()
-        .find(id => id.getText() === "import type * as types from './types';")
-        ?.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
-        .getImportDeclarations()
-        .find(id => id.getText().includes('HTTPMethodRange'))
-        ?.replaceWithText("import type { ConfigOptions, FetchResponse } from '@readme/api-core';");
-    }
-
-    return [
-      ...this.project.getSourceFiles().map(sourceFile => {
-        // `getFilePath` will always return a string that contains a preceeding directory separator
-        // however when we're creating these codegen'd files that may cause us to create that file
-        // in the root directory (because it's preceeded by a `/`). We don't want that to happen so
-        // we're slicing off that first character.
-        let filePath = sourceFile.getFilePath().toString();
-        filePath = filePath.substring(1);
-
-        return {
-          [filePath]: sourceFile.getFullText(),
-        };
-      }),
-
-      // Because we're returning the raw source files for TS generation we also need to separately
-      // emit out our declaration files so we can put those into a separate file in the installed
-      // SDK directory.
-      ...this.project
-        .emitToMemory({ emitOnlyDtsFiles: true })
-        .getFiles()
-        .map(sourceFile => ({
-          [path.basename(sourceFile.filePath)]: sourceFile.text,
-        })),
-    ].reduce((prev, next) => Object.assign(prev, next));
-  }
-
-  /**
-   * Create our main SDK source file.
-   *
-   */
-  private createSDKSource(sourceDirectory: Directory) {
-    const { operations } = this.loadOperationsAndMethods();
-
-    const sourceFile = sourceDirectory.createSourceFile('index.ts', '');
-
-    sourceFile.addImportDeclarations([
-      // This import will be automatically removed later if the SDK ends up not having any types.
-      { defaultImport: 'type * as types', moduleSpecifier: './types' },
-      {
-        // `HTTPMethodRange` will be conditionally removed later if it ends up not being used.
-        defaultImport: 'type { ConfigOptions, FetchResponse, HTTPMethodRange }',
-        moduleSpecifier: '@readme/api-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.
-    this.sdk = sourceFile.addClass({
-      name: 'SDK',
-      properties: [{ name: 'core', type: 'APICore' }],
-    });
-
-    this.sdk.addConstructor({
-      statements: writer => {
-        writer.write('this.core = new APICore(definition, ').quote(this.userAgent).write(');');
-        return writer;
-      },
-    });
-
-    // Add our core API methods for controlling auth, servers, and various configurable abilities.
-    this.sdk.addMethods([
-      {
-        name: 'config',
-        parameters: [{ name: 'config', type: 'ConfigOptions' }],
-        statements: writer => writer.writeLine('this.core.setConfig(config);'),
-        docs: [
-          {
-            description: writer =>
-              writer.writeLine(wordWrap('Optionally configure various options that the SDK allows.')),
-            tags: [
-              { tagName: 'param', text: 'config Object of supported SDK options and toggles.' },
-              {
-                tagName: 'param',
-                text: wordWrap(
-                  'config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.',
-                ),
-              },
-            ],
-          },
-        ],
-      },
-      {
-        name: 'auth',
-        parameters: [{ name: '...values', type: 'string[] | number[]' }],
-        statements: writer => {
-          writer.writeLine('this.core.setAuth(...values);');
-          writer.writeLine('return this;');
-          return writer;
-        },
-        docs: [
-          {
-            description: writer =>
-              writer.writeLine(
-                wordWrap(`If the API you're using requires authentication you can supply the required credentials through this method and the library will magically determine how they should be used within your API request.
-
-With the exception of OpenID and MutualTLS, it supports all forms of authentication supported by the OpenAPI specification.
-
-@example <caption>HTTP Basic auth</caption>
-sdk.auth('username', 'password');
-
-@example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
-sdk.auth('myBearerToken');
-
-@example <caption>API Keys</caption>
-sdk.auth('myApiKey');`),
-              ),
-            tags: [
-              { tagName: 'see', text: '{@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}' },
-              { 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.',
-              },
-            ],
-          },
-        ],
-      },
-      {
-        name: 'server',
-        parameters: [
-          { name: 'url', type: 'string' },
-          { name: 'variables', initializer: '{}' },
-        ],
-        statements: writer => writer.writeLine('this.core.setServer(url, variables);'),
-        docs: [
-          {
-            description: writer =>
-              writer.writeLine(
-                wordWrap(`If the API you're using offers alternate server URLs, and server variables, you can tell the SDK which one to use with this method. To use it you can supply either one of the server URLs that are contained within the OpenAPI definition (along with any server variables), or you can pass it a fully qualified URL to use (that may or may not exist within the OpenAPI definition).
-
-@example <caption>Server URL with server variables</caption>
-sdk.server('https://{region}.api.example.com/{basePath}', {
-  name: 'eu',
-  basePath: 'v14',
-});
-
-@example <caption>Fully qualified server URL</caption>
-sdk.server('https://eu.api.example.com/v14');`),
-              ),
-            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.
-    Object.entries(operations).forEach(([operationId, data]: [string, OperationTypeHousing]) => {
-      this.createOperationAccessor(data.operation, operationId, data.types.params, data.types.responses);
-    });
-
-    // Export our SDK into the source file.
-    sourceFile.addVariableStatement({
-      declarationKind: VariableDeclarationKind.Const,
-      declarations: [
-        {
-          name: 'createSDK',
-          initializer: writer => {
-            // `ts-morph` doesn't have any way to cleanly create an IIFE.
-            writer.writeLine('(() => { return new SDK(); })()');
-            return writer;
-          },
-        },
-      ],
-    });
-
-    sourceFile.addExportAssignment({
-      // Because we're exporting `createSDK` as an IIFE constant we need to have it exported as
-      // `export default createSDK`. `addExportAssignment` by default wants it exported as
-      // `export = createSDK`, which will throw TS errors because we may also be exporting types in
-      // the `./types.ts` file.
-      isExportEquals: false,
-      expression: 'createSDK',
-    });
-
-    return sourceFile;
-  }
-
-  /**
-   * Create the `tsconfig.json` file that will allow this SDK to be compiled for use.
-   *
-   */
-  createTSConfig() {
-    const sourceFile = this.project.createSourceFile('tsconfig.json', '');
-
-    const config: TsConfigJson = {
-      compilerOptions: {
-        module: 'NodeNext',
-        resolveJsonModule: true,
-      },
-      include: ['./src/**/*'],
-    };
-
-    sourceFile.addStatements(JSON.stringify(config, null, 2));
-
-    return sourceFile;
-  }
-
-  /**
-   * Create the `package.json` file that will ultimately make this SDK available to use.
-   *
-   */
-  createPackageJSON() {
-    const sourceFile = this.project.createSourceFile('package.json', '');
-
-    const hasTypes = !!Object.keys(this.schemas).length;
-
-    const info = this.spec.getDefinition().info;
-    let pkgVersion = semver.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.coerce('0.0.0') as SemVer;
-    }
-
-    const tsupOptions: Options = {
-      cjsInterop: true,
-      clean: true,
-      dts: true,
-      entry: [
-        './src/index.ts',
-        // If this SDK has schemas and generated types then we should also export those too so
-        // they're available to use.
-        hasTypes ? './src/types.ts' : '',
-      ].filter(Boolean),
-      format: ['esm', 'cjs'],
-      minify: false,
-      shims: true,
-      sourcemap: true,
-      splitting: true,
-    };
-
-    const dependencies = Object.entries(this.requiredPackages)
-      .map(([dep, { dependencyType, version }]) => (dependencyType === 'production' ? { [dep]: version } : {}))
-      .reduce((prev, next) => Object.assign(prev, next));
-
-    const devDependencies = Object.entries(this.requiredPackages)
-      .map(([dep, { dependencyType, version }]) => (dependencyType === 'development' ? { [dep]: version } : {}))
-      .reduce((prev, next) => Object.assign(prev, next));
-
-    const pkg: PackageJson = {
-      name: `@api/${this.identifier}`,
-      version: pkgVersion.version,
-      main: './dist/index.js',
-      types: './dist/index.d.ts',
-      module: './dist/index.mts',
-      exports: {
-        '.': {
-          import: './dist/index.mjs',
-          require: './dist/index.js',
-        },
-        ...(hasTypes
-          ? {
-              './types': {
-                import: './dist/types.d.mts',
-                require: './dist/types.d.ts',
-              },
-            }
-          : {}),
-      },
-      files: ['dist'],
-      scripts: {
-        prepare: 'tsup',
-      },
-      dependencies,
-      devDependencies,
-      tsup: tsupOptions as JsonObject,
-    };
-
-    sourceFile.addStatements(JSON.stringify(pkg, null, 2));
-
-    return sourceFile;
-  }
-
-  /**
-   * Create our main schemas file. This is where all of the JSON Schema that our TypeScript typing
-   * infrastructure sources its data from. Without this there are no types.
-   *
-   */
-  private createSchemasFile(sourceDirectory: Directory) {
-    const sourceFile = sourceDirectory.createSourceFile('schemas.ts', '');
-    const schemasDir = sourceDirectory.createDirectory('schemas');
-
-    const sortedSchemas = new Map(Array.from(Object.entries(this.schemas)).sort());
-
-    Array.from(sortedSchemas).forEach(([schemaName, schema]) => {
-      const schemaFile = schemasDir.createSourceFile(`${schemaName}.ts`);
-
-      // Because we're chunking our schemas into a `schemas/` directory we need to add imports
-      // for these schemas into our main `schemas.ts` file.`
-      sourceFile.addImportDeclaration({
-        defaultImport: schemaName,
-        moduleSpecifier: `./schemas/${schemaName}`,
-      });
-
-      let str = JSON.stringify(schema);
-      const referencedSchemas = str.match(REF_PLACEHOLDER_REGEX)?.map(s => s.replace(REF_PLACEHOLDER_REGEX, '$1'));
-      if (referencedSchemas) {
-        referencedSchemas.sort();
-        referencedSchemas.forEach(ref => {
-          // Because this schema is referenced from another file we need to create an `import`
-          // declaration for it.
-          schemaFile.addImportDeclaration({
-            defaultImport: ref,
-            moduleSpecifier: `./${ref}`,
-          });
-        });
-      }
-
-      // Load the schema into the schema file within the `schemas/` directory.
-      schemaFile.addVariableStatement({
-        declarationKind: VariableDeclarationKind.Const,
-        declarations: [
-          {
-            name: schemaName,
-            initializer: writer => {
-              // We can't have `::convert::<schemaName>` variables within these schema files so we
-              // need to clean them up.
-              str = str.replace(REF_PLACEHOLDER_REGEX, '$1');
-
-              writer.writeLine(`${str} as const`);
-              return writer;
-            },
-          },
-        ],
-      });
-
-      schemaFile.addStatements(`export default ${schemaName}`);
-    });
-
-    // Export all of our schemas from inside the main `schemas.ts` file.
-    sourceFile.addStatements(`export { ${Array.from(sortedSchemas.keys()).join(', ')} }`);
-
-    return sourceFile;
-  }
-
-  /**
-   * Create our main types file. This sources its data from the JSON Schema `schemas.ts` file and
-   * will re-export types to be used in TypeScript implementations and IDE intellisense. This
-   * typing work is functional with the `json-schema-to-ts` library.
-   *
-   * @see {@link https://npm.im/json-schema-to-ts}
-   */
-  private createTypesFile(sourceDirectory: Directory) {
-    const sourceFile = sourceDirectory.createSourceFile('types.ts', '');
-
-    sourceFile.addImportDeclarations([
-      { defaultImport: 'type { FromSchema }', moduleSpecifier: 'json-schema-to-ts' },
-      { defaultImport: '* as schemas', moduleSpecifier: './schemas' },
-    ]);
-
-    Array.from(new Map(Array.from(this.types.entries()).sort())).forEach(([typeName, typeExpression]) => {
-      sourceFile.addTypeAlias({ isExported: true, name: typeName, type: typeExpression });
-    });
-
-    return sourceFile;
-  }
-
-  /**
-   * Create operation accessors on the SDK.
-   *
-   */
-  private createOperationAccessor(
-    operation: Operation,
-    operationId: string,
-    paramTypes?: OperationTypeHousing['types']['params'],
-    responseTypes?: OperationTypeHousing['types']['responses'],
-  ) {
-    let docblock: OptionalKind<JSDocStructure> = {};
-    const summary = operation.getSummary();
-    const description = operation.getDescription();
-    if (summary || description) {
-      // To keep our generated docblocks clean we should only add the `@summary` tag if we've
-      // got both a summary and a description present on the operation, otherwise we can alternate
-      // what we surface the main docblock description.
-      docblock.description = writer => {
-        if (description) {
-          writer.writeLine(docblockEscape(wordWrap(description)));
-        } else if (summary) {
-          writer.writeLine(docblockEscape(wordWrap(summary)));
-        }
-
-        writer.newLineIfLastNot();
-        return writer;
-      };
-
-      if (summary && description) {
-        docblock = TSGenerator.#addTagToDocblock(docblock, {
-          tagName: 'summary',
-          text: docblockEscape(wordWrap(summary)),
-        });
-      }
-    }
-
-    let hasOptionalBody = false;
-    let hasOptionalMetadata = false;
-    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`,
-      // never both, as these are determined upon the media type that's in use.
-      if (paramTypes.body || paramTypes.formData) {
-        hasOptionalBody = !operation.hasRequiredRequestBody();
-
-        parameters.body = {
-          name: 'body',
-          type: paramTypes.body ? paramTypes.body : paramTypes.formData,
-          hasQuestionToken: hasOptionalBody,
-        };
-      }
-
-      if (paramTypes.metadata) {
-        hasOptionalMetadata = !operation.hasRequiredParameters();
-
-        parameters.metadata = {
-          name: 'metadata',
-          type: paramTypes.metadata,
-          hasQuestionToken: hasOptionalMetadata,
-        };
-      }
-    }
-
-    let returnType = 'Promise<FetchResponse<number, unknown>>';
-    if (responseTypes) {
-      const returnTypes = Object.entries(responseTypes)
-        .map(([status, { description: responseDescription, type: responseType }]) => {
-          if (status.toLowerCase() === 'default') {
-            return `FetchResponse<number, ${responseType}>`;
-          } else if (status.length === 3 && status.toUpperCase().endsWith('XX')) {
-            const statusPrefix = status.slice(0, 1);
-            if (!Number.isInteger(Number(statusPrefix))) {
-              // If this matches the `_XX` format, but it isn't `{number}XX` then we can't handle
-              // it and should instead fall back to treating it as an unknown number.
-              return `FetchResponse<number, ${responseType}>`;
-            }
-
-            if (Number(statusPrefix) >= 4) {
-              docblock = TSGenerator.#addTagToDocblock(docblock, {
-                tagName: 'throws',
-                text: `FetchError<${status}, ${responseType}>${
-                  responseDescription ? docblockEscape(wordWrap(` ${responseDescription}`)) : ''
-                }`,
-              });
-
-              return false;
-            }
-
-            this.usesHTTPMethodRangeInterface = true;
-            return `FetchResponse<HTTPMethodRange<${statusPrefix}00, ${statusPrefix}99>, ${responseType}>`;
-          }
-
-          // 400 and 500 status code families are thrown as exceptions so adding them as a possible
-          // return type isn't valid.
-          if (Number(status) >= 400) {
-            docblock = TSGenerator.#addTagToDocblock(docblock, {
-              tagName: 'throws',
-              text: `FetchError<${status}, ${responseType}>${
-                responseDescription ? docblockEscape(wordWrap(` ${responseDescription}`)) : ''
-              }`,
-            });
-
-            return false;
-          }
-
-          return `FetchResponse<${status}, ${responseType}>`;
-        })
-        .filter(Boolean)
-        .join(' | ');
-
-      // If all of our documented responses are for error status codes then all we can document for
-      // anything else that might happen is `unknown`.
-      returnType = `Promise<${returnTypes.length ? returnTypes : 'FetchResponse<number, unknown>'}>`;
-    }
-
-    const shouldAddAltTypedOverloads = Object.keys(parameters).length === 2 && hasOptionalBody && !hasOptionalMetadata;
-    const operationIdAccessor = this.sdk.addMethod({
-      name: operationId,
-      returnType,
-
-      // If we're going to be creating typed method overloads for optional body an metadata handling
-      // 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 ? undefined : Object.keys(docblock).length ? [docblock] : undefined,
-      statements: writer => {
-        /**
-         * @example return this.core.fetch('/pet/findByStatus', 'get', body, metadata);
-         * @example return this.core.fetch('/pet/findByStatus', 'get', metadata);
-         */
-        const fetchStmt = writer
-          .write('return this.core.fetch(')
-          .quote(operation.path)
-          .write(', ')
-          .quote(operation.method);
-
-        const totalParams = Object.keys(parameters).length;
-        if (totalParams) {
-          Object.values(parameters).forEach((arg, i) => {
-            if (i === 0) {
-              fetchStmt.write(', ');
-            }
-
-            fetchStmt.write(arg.name);
-            if (i !== totalParams - 1) {
-              fetchStmt.write(', ');
-            }
-          });
-        }
-
-        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
-    // come before one that's required.
-    if (shouldAddAltTypedOverloads) {
-      // Create an overload that has both `body` and `metadata` parameters as required.
-      operationIdAccessor.addOverload({
-        parameters: [
-          { ...parameters.body, hasQuestionToken: false },
-          { ...parameters.metadata, hasQuestionToken: false },
-        ],
-        returnType,
-        docs: Object.keys(docblock).length ? [docblock] : undefined,
-      });
-
-      // Create an overload that just has a single `metadata` parameter.
-      operationIdAccessor.addOverload({
-        parameters: [{ ...parameters.metadata }],
-        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 `@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([
-        {
-          ...parameters.body,
-          // Overloads have to be the most distilled version of the method so that's why we need to
-          // type `body` as either `body` or `metadata`. If we didn't do this, if `body` was a JSON
-          // Schema type that didn't allow `additionalProperties` then the implementation overload
-          // would throw type errors.
-          type: `${parameters.body.type} | ${parameters.metadata.type}`,
-          hasQuestionToken: true,
-        },
-        { ...parameters.metadata, hasQuestionToken: true },
-      ]);
-    } else {
-      operationIdAccessor.addParameters(Object.values(parameters));
-    }
-  }
-
-  /**
-   * Scour through the current OpenAPI definition and compile a store of every operation, along
-   * with every HTTP method that's in use, and their available TypeScript types that we can use,
-   * along with every HTTP method that's in use.
-   *
-   */
-  private loadOperationsAndMethods() {
-    const operations: Record</* operationId */ string, OperationTypeHousing> = {};
-    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]: [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
-          // the `operationId` so as we don't break TS compilation with an invalid method accessor.
-          camelCase: true,
-        });
-
-        operations[operationId] = {
-          types: {
-            params: this.prepareParameterTypesForOperation(operation, operationId),
-            responses: this.prepareResponseTypesForOperation(operation, operationId),
-          },
-          operation,
-        };
-      });
-    });
-
-    if (!Object.keys(operations).length) {
-      throw new Error('Sorry, this OpenAPI definition does not have any operation paths to generate an SDK for.');
-    }
-
-    return {
-      operations,
-      methods,
-    };
-  }
-
-  /**
-   * Compile the parameter (path, query, cookie, and header) schemas for an API operation into
-   * usable TypeScript types.
-   *
-   */
-  private prepareParameterTypesForOperation(operation: Operation, operationId: string) {
-    const schemas = operation.getParametersAsJSONSchema({
-      includeDiscriminatorMappingRefs: false,
-      mergeIntoBodyAndMetadata: true,
-      retainDeprecatedProperties: true,
-      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 && typeof s['x-readme-ref-name'] !== 'undefined') {
-          const typeName = generateTypeName(s['x-readme-ref-name']);
-          this.addSchemaToExport(s, typeName, typeName);
-
-          return `${REF_PLACEHOLDER}${typeName}` as SchemaObject;
-        }
-
-        return s;
-      },
-    });
-
-    if (!schemas || !schemas.length) {
-      return false;
-    }
-
-    const res = schemas
-      .map(param => ({ [param.type]: param.schema }))
-      .reduce((prev, next) => Object.assign(prev, next));
-
-    return Object.entries(res)
-      .map(([paramType, schema]: [string, string | SchemaObject]) => {
-        let typeName;
-
-        if (typeof schema === 'string' && schema.startsWith(REF_PLACEHOLDER)) {
-          // If this schema is a string and has our conversion prefix then we've already created
-          // a type for it.
-          typeName = schema.replace(REF_PLACEHOLDER, '');
-        } else {
-          typeName = generateTypeName(operationId, paramType, 'param');
-          this.addSchemaToExport(schema as SchemaObject, typeName, `${generateTypeName(operationId)}.${paramType}`);
-        }
-
-        return {
-          // Types are prefixed with `types.` because that's how we're importing them from
-          // `types.d.ts`.
-          [paramType]: `types.${typeName}`,
-        };
-      })
-      .reduce((prev, next) => Object.assign(prev, next), {}) as Record<'body' | 'formData' | 'metadata', string>;
-  }
-
-  /**
-   * Compile the response schemas for an API operation into usable TypeScript types.
-   *
-   */
-  private prepareResponseTypesForOperation(operation: Operation, operationId: string) {
-    const responseStatusCodes = operation.getResponseStatusCodes();
-    if (!responseStatusCodes.length) {
-      return undefined;
-    }
-
-    const schemas = responseStatusCodes
-      .map(status => {
-        const schema = operation.getResponseAsJSONSchema(status, {
-          includeDiscriminatorMappingRefs: false,
-          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 && typeof s['x-readme-ref-name'] !== 'undefined') {
-              const typeName = generateTypeName(s['x-readme-ref-name']);
-              this.addSchemaToExport(s, typeName, `${typeName}`);
-
-              return `${REF_PLACEHOLDER}${typeName}` as SchemaObject;
-            }
-
-            return s;
-          },
-        });
-
-        if (!schema) {
-          return false;
-        }
-
-        return {
-          [status]: schema.shift(),
-        };
-      })
-      .reduce((prev, next) => Object.assign(prev, next));
-
-    const res = Object.entries(schemas)
-      .map(([status, { description, schema }]) => {
-        let typeName;
-
-        if (typeof schema === 'string' && schema.startsWith(REF_PLACEHOLDER)) {
-          // If this schema is a string and has our conversion prefix then we've already created
-          // a type for it.
-          typeName = schema.replace(REF_PLACEHOLDER, '');
-        } else {
-          typeName = generateTypeName(operationId, 'response', status);
-
-          // Because `status` will usually be a number here we need to set the pointer for it
-          // within  an `[]` as if we do `FromSchema<typeof schemas.operation.response.200>`,
-          // TypeScript will throw a compilation error.
-          this.addSchemaToExport(schema, typeName, `${generateTypeName(operationId)}.response['${status}']`);
-        }
-
-        return {
-          // Types are prefixed with `types.` because that's how we're importing them from
-          // `types.d.ts`.
-          [status]: {
-            type: `types.${typeName}`,
-            description,
-          },
-        };
-      })
-      .reduce((prev, next) => Object.assign(prev, next), {});
-
-    return Object.keys(res).length ? res : undefined;
-  }
-
-  /**
-   * Add a given schema into our schema dataset that we'll be be exporting as types.
-   *
-   */
-  private addSchemaToExport(schema: SchemaObject, typeName: string, pointer: string) {
-    if (this.types.has(typeName)) {
-      return;
-    }
-
-    setWith(this.schemas, pointer, schema, Object);
-    this.types.set(typeName, `FromSchema<typeof schemas.${pointer}>`);
-  }
-
-  /**
-   * Add a new JSDoc `@tag` to an existing docblock.
-   *
-   */
-  static #addTagToDocblock(docblock: OptionalKind<JSDocStructure>, tag: OptionalKind<JSDocTagStructure>) {
-    const tags = docblock.tags ?? [];
-    tags.push(tag);
-
-    return {
-      ...docblock,
-      tags,
-    };
-  }
-}