api 6.1.0 → 7.0.0-alpha.0

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

@@ -1,185 +0,0 @@
-"use strict";
-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 = exports.formatter = 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"));
-var prettier_1 = require("prettier");
-/**
- * This is a mix of reserved JS words and keywords in TypeScript that might be reserved or
- * allowable but functionally confusing (like `let any = 'buster';`)
- *
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar}
- */
-var RESERVED_WORDS = [
-    'abstract',
-    'any',
-    'arguments',
-    'as',
-    'async',
-    'await',
-    'boolean',
-    'break',
-    'byte',
-    'case',
-    'catch',
-    'char',
-    'class',
-    'const',
-    'continue',
-    'constructor',
-    'debugger',
-    'default',
-    'delete',
-    'do',
-    'double',
-    'else',
-    'enum',
-    'eval',
-    'export',
-    'extends',
-    'false',
-    'final',
-    'finally',
-    'float',
-    'for',
-    'from',
-    'function',
-    'get',
-    'goto',
-    'if',
-    'implements',
-    'import',
-    'interface',
-    'in',
-    'instanceof',
-    'int',
-    'let',
-    'long',
-    'native',
-    'new',
-    'null',
-    'number',
-    'of',
-    'package',
-    'private',
-    'protected',
-    'public',
-    'module',
-    'namespace',
-    'return',
-    'set',
-    'short',
-    'static',
-    'string',
-    'super',
-    'switch',
-    'synchronized',
-    'this',
-    'throw',
-    'throws',
-    'transient',
-    'true',
-    'try',
-    'type',
-    'typeof',
-    'var',
-    'void',
-    'while',
-    'with',
-    'volatile',
-    'yield',
-    // These aren't reserved keywords but because we maybe codegen'ing an SDK to be used in the
-    // browser it'd be very bad if we overwrote these. This obviously doesn't account for browser APIs
-    // you can access outside of the `Window` API (like `alert()`), but we can add checks for those
-    // later if we need to.
-    'frames',
-    'global',
-    'globalThis',
-    'navigator',
-    'self',
-    'window',
-];
-function formatter(content) {
-    return (0, prettier_1.format)(content, {
-        parser: 'typescript',
-        printWidth: 100,
-        singleQuote: true
-    });
-}
-exports.formatter = formatter;
-/**
- * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
- */
-function wordWrap(str, max) {
-    if (max === void 0) { max = 88; }
-    return str.replace(new RegExp("(?![^\\n]{1,".concat(max, "}$)([^\\n]{1,").concat(max, "})\\s"), 'g'), '$1\n');
-}
-exports.wordWrap = wordWrap;
-/**
- * Safely escape some string characters that may break a docblock.
- *
- */
-function docblockEscape(str) {
-    return str.replace(/\/\*/g, '/\\*').replace(/\*\//g, '*\\/');
-}
-exports.docblockEscape = docblockEscape;
-/**
- * Convert a string that might contain spaces or special characters to one that can safely be used
- * as a TypeScript interface or enum name.
- *
- * This function has been adapted and slighty modified from `json-schema-to-typescript`.
- *
- * @license MIT
- * @see {@link https://github.com/bcherny/json-schema-to-typescript}
- */
-function toSafeString(str) {
-    // identifiers in javaScript/ts:
-    // 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)
-        // 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')
-        // replace chars which are not valid for typescript identifiers with whitespace
-        .replace(/(^\s*[^a-zA-Z_$])|([^a-zA-Z_$\d])/g, ' ')
-        // uppercase leading underscores followed by lowercase
-        .replace(/^_[a-z]/g, function (match) { return match.toUpperCase(); })
-        // remove non-leading underscores followed by lowercase (convert snake_case)
-        .replace(/_[a-z]/g, function (match) { return match.substr(1, match.length).toUpperCase(); })
-        // uppercase letters after digits, dollars
-        .replace(/([\d$]+[a-zA-Z])/g, function (match) { return match.toUpperCase(); })
-        // uppercase first letter after whitespace
-        .replace(/\s+([a-zA-Z])/g, function (match) { return match.toUpperCase().trim(); })
-        // remove remaining whitespace
-        .replace(/\s/g, ''));
-}
-exports.toSafeString = toSafeString;
-function generateTypeName() {
-    var parts = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        parts[_i] = arguments[_i];
-    }
-    var str;
-    // If the end of our string ends with something like `2XX`, the combination of `startCase` and
-    // `camelCase` will transform it into `2Xx`.
-    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 += " ".concat(last);
-        }
-    }
-    if (!str) {
-        str = (0, lodash_startcase_1["default"])((0, lodash_camelcase_1["default"])(parts.join(' ')));
-    }
-    if (RESERVED_WORDS.includes(str.toLowerCase())) {
-        str = "$".concat(str);
-    }
-    return toSafeString(str);
-}
-exports.generateTypeName = generateTypeName;

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

@@ -1,111 +0,0 @@
-import type Storage from '../../storage';
-import type { InstallerOptions } from '../language';
-import type Oas from 'oas';
-import type { Operation } from 'oas';
-import type { ClassDeclaration, JSDocStructure, JSDocTagStructure, OptionalKind } from 'ts-morph';
-import { Project } from 'ts-morph';
-import CodeGeneratorLanguage from '../language';
-export interface TSGeneratorOptions {
-    compilerTarget?: 'cjs' | 'esm';
-    outputJS?: boolean;
-}
-interface OperationTypeHousing {
-    operation: Operation;
-    types: {
-        params?: false | Record<'body' | 'formData' | 'metadata', string>;
-        responses?: Record<string | number, {
-            description?: string;
-            type: string;
-        }>;
-    };
-}
-export default class TSGenerator extends CodeGeneratorLanguage {
-    project: Project;
-    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>>;
-    usesHTTPMethodRangeInterface: boolean;
-    constructor(spec: Oas, specPath: string, identifier: string, opts?: TSGeneratorOptions);
-    installer(storage: Storage, opts?: InstallerOptions): Promise<void>;
-    /**
-     * Compile the current OpenAPI definition into a TypeScript library.
-     *
-     */
-    generator(): Promise<{
-        [x: string]: string;
-    }>;
-    /**
-     * Create our main SDK source file.
-     *
-     */
-    createSourceFile(): import("ts-morph").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.
-     *
-     */
-    createSchemasFile(): import("ts-morph").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}
-     */
-    createTypesFile(): import("ts-morph").SourceFile;
-    /**
-     * Add a new JSDoc `@tag` to an existing docblock.
-     *
-     */
-    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;
-    };
-    /**
-     * Create operation accessors on the SDK.
-     *
-     */
-    createOperationAccessor(operation: Operation, operationId: string, paramTypes?: OperationTypeHousing['types']['params'], responseTypes?: OperationTypeHousing['types']['responses']): void;
-    /**
-     * 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.
-     *
-     */
-    loadOperationsAndMethods(): {
-        operations: Record<string, OperationTypeHousing>;
-        methods: Set<unknown>;
-    };
-    /**
-     * Compile the parameter (path, query, cookie, and header) schemas for an API operation into
-     * usable TypeScript types.
-     *
-     */
-    prepareParameterTypesForOperation(operation: Operation, operationId: string): false | Record<"formData" | "body" | "metadata", string>;
-    /**
-     * Compile the response schemas for an API operation into usable TypeScript types.
-     *
-     */
-    prepareResponseTypesForOperation(operation: Operation, operationId: string): {
-        [x: string]: {
-            type: string;
-            description: any;
-        };
-    };
-    /**
-     * Add a given schema into our schema dataset that we'll be be exporting as types.
-     *
-     */
-    addSchemaToExport(schema: any, typeName: string, pointer: string): void;
-}
-export {};