openapi-to-ts/dist/types/types.d.ts

Generate TypeScript types from OpenAPI 3.0 specs.

/**
 * This interface represents the options the
 * openapi-to-ts package accepts to generate
 * TypeScript types based on OpenAPI files.
 */
export interface IOpenAPIToTSOptions {
    /**
     * Append the letter `I` as a prefix to all interface names.
     * @default false
     */
    prefixWithI?: boolean;
}
/**
 * The following OpenAPI 3.0 types are not nearly complete, given that
 * we don't need the complete list to generate proper TypeScript types.
 */
/**
 * The format type of a schema is defined by the `format` keyword, for example, format: byte.
 * This type defines all format types OpenAPI 3.0 allows.
 */
export declare type OpenAPIDataFormats = 'float' | 'double' | 'int32' | 'int64' | 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6';
/**
 * The data type of a schema is defined by the `type` keyword, for example, type: string.
 * This type defines all data types OpenAPI 3.0 allows.
 */
export declare type OpenAPIDataTypes = 'array' | 'string' | 'number' | 'integer' | 'boolean' | 'object';
/**
 * Each of the belows types are constructed differently by openapi-to-ts. This
 * type helps us to differentiate each of them and construct switch statements.
 */
export declare type SchemaObjectType = 'ref' | 'allOf' | 'anyOf' | 'oneOf' | 'enum' | 'array' | 'string' | 'number' | 'boolean' | 'object';
/**
 * This type represents a reference to another schema
 * defined in the OpenAPI file.
 */
export interface IOpenAPIReferenceObject {
    $ref?: string;
}
/**
 * This interface represents an OpenAPI schema object.
 * OpenAPI 3.0 data types are based on an extended subset
 * JSON Schema Specification Wright Draft 00. The data
 * types are described using a schema object.
 */
export interface IOpenAPISchemaObject {
    additionalProperties?: IOpenAPIReferenceObject | IOpenAPISchemaObject | boolean;
    allOf?: Array<IOpenAPIReferenceObject | IOpenAPISchemaObject>;
    anyOf?: Array<IOpenAPIReferenceObject | IOpenAPISchemaObject>;
    description?: string;
    enum?: string[];
    format?: OpenAPIDataFormats;
    items?: IOpenAPIReferenceObject | IOpenAPISchemaObject;
    nullable?: boolean;
    oneOf?: Array<IOpenAPIReferenceObject | IOpenAPISchemaObject>;
    properties?: {
        [key: string]: IOpenAPIReferenceObject | IOpenAPISchemaObject;
    };
    required?: string[];
    title?: string;
    type?: OpenAPIDataTypes;
    [key: string]: any;
}
/**
 * This interface describes the structure of an
 * OpenAPI 3.0 specification file.
 */
export interface IOpenAPISpecFile {
    openapi: string;
    info: {
        title?: string;
        description?: string;
        termsOfService?: string;
        contact?: {
            name?: string;
            url?: string;
            email?: string;
        };
        license?: {
            name?: string;
            url?: string;
        };
        version?: string;
    };
    components?: {
        schemas?: {
            [key: string]: IOpenAPIReferenceObject | IOpenAPISchemaObject;
        };
    };
}
/**
 * Represents a TypeScript property generated by openapi-to-ts.
 * For example, `name: string;`
 */
export interface ITypeScriptProperty {
    /**
     * The name of the property, such as `name`.
     */
    name: string;
    /**
     * If the value is nullable, such as `name: string | null`.
     */
    nullable: boolean;
    /**
     * If the value is optional, such as `name?: string;`.
     */
    optional: boolean;
    /**
     * The value, such as ['string'].
     */
    value: string[];
    /**
     * The type of value, such as `string`.
     */
    valueType: SchemaObjectType;
}
/**
 * Represents a TypeScript interface generated by openapi-to-ts.
 * For example, `interface IFruit { name: string; }`
 */
export interface ITypeScriptInterface {
    /**
     * An optional JSDoc comment.
     */
    comment?: string;
    /**
     * The name of the interface, such as `IFruit`.
     */
    name: string;
    /**
     * The properties of the interface, such as `[{ name: string; }]`.
     */
    properties: ITypeScriptProperty[];
}
/**
 * Represents a TypeScript type generated by openapi-to-ts.
 * For example, `type Fruit = 'apple' | 'bananas';`
 */
export interface ITypeScriptType {
    /**
     * An optional JSDoc comment.
     */
    comment?: string;
    /**
     * The name of the type, such as `Fruit`.
     */
    name: string;
    /**
     * The value, such as ['apple', 'bananas'].
     */
    value: string[];
    /**
     * The type of value, such as `string`.
     */
    valueType: SchemaObjectType;
}