@hey-api/openapi-ts 0.28.0 → 0.29.1

package/README.md

@@ -189,6 +189,7 @@ $ openapi-ts --help
     --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     --useDateType <value>     Output Date instead of string for the format "date-time" in the models (default: false)
+    --useLegacyEnums          Generate Typescript enum definitions (default: false)
     -h, --help                display help for command
 ```
 

package/bin/index.js

@@ -36,6 +36,7 @@ const params = program
     .option('--request <value>', 'Path to custom request file')
     .option('--write', 'Write files to disk? (used for testing)')
     .option('--no-write', 'Skip writing files to disk (used for testing)')
+    .option('--useLegacyEnums', 'Generate Typescript enum definitions')
     .parse(process.argv)
     .opts();
 

package/dist/node/index.d.ts

@@ -1,101 +1,3 @@
-interface Enum {
-    'x-enum-description'?: string;
-    'x-enum-varname'?: string;
-    description?: string;
-    value: string | number;
-}
-interface OperationError {
-    code: number;
-    description: string;
-}
-interface OperationParameter extends Model {
-    in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie';
-    prop: string;
-    mediaType: string | null;
-}
-interface OperationParameters extends Pick<Model, '$refs' | 'imports'> {
-    parameters: OperationParameter[];
-    parametersBody: OperationParameter | null;
-    parametersCookie: OperationParameter[];
-    parametersForm: OperationParameter[];
-    parametersHeader: OperationParameter[];
-    parametersPath: OperationParameter[];
-    parametersQuery: OperationParameter[];
-}
-interface OperationResponse extends Model {
-    in: 'response' | 'header';
-    code: number;
-}
-interface Operation extends OperationParameters {
-    deprecated: boolean;
-    description: string | null;
-    errors: OperationError[];
-    method: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT';
-    /**
-     * Method name. Methods contain the request logic.
-     */
-    name: string;
-    path: string;
-    responseHeader: string | null;
-    results: OperationResponse[];
-    /**
-     * Service name, might be without postfix. This will be used to name the
-     * exported class.
-     */
-    service: string;
-    summary: string | null;
-}
-interface Schema {
-    exclusiveMaximum?: boolean;
-    exclusiveMinimum?: boolean;
-    format?: 'binary' | 'boolean' | 'byte' | 'date-time' | 'date' | 'double' | 'float' | 'int32' | 'int64' | 'password' | 'string';
-    isDefinition: boolean;
-    isNullable: boolean;
-    isReadOnly: boolean;
-    isRequired: boolean;
-    maximum?: number;
-    maxItems?: number;
-    maxLength?: number;
-    maxProperties?: number;
-    minimum?: number;
-    minItems?: number;
-    minLength?: number;
-    minProperties?: number;
-    multipleOf?: number;
-    pattern?: string;
-    uniqueItems?: boolean;
-}
-interface Model extends Schema {
-    /**
-     * **Experimental.** Contains list of original refs so they can be used
-     * to access the schema from anywhere instead of relying on string name.
-     * This allows us to do things like detect type of ref.
-     */
-    $refs: string[];
-    base: string;
-    default?: string;
-    deprecated?: boolean;
-    description: string | null;
-    enum: Enum[];
-    enums: Model[];
-    export: 'all-of' | 'any-of' | 'array' | 'const' | 'dictionary' | 'enum' | 'generic' | 'interface' | 'one-of' | 'reference';
-    imports: string[];
-    link: Model | null;
-    name: string;
-    properties: Model[];
-    template: string | null;
-    type: string;
-}
-interface Service extends Pick<Model, '$refs' | 'imports' | 'name'> {
-    operations: Operation[];
-}
-interface Client {
-    models: Model[];
-    server: string;
-    services: Service[];
-    version: string;
-}
-
 interface UserConfig {
     /**
      * Manually set base in OpenAPI config instead of inferring from server value
@@ -187,6 +89,11 @@ interface UserConfig {
      * @default true
      */
     useOptions?: boolean;
+    /**
+     * Generate Typescript enum definitions
+     * @default false
+     */
+    useLegacyEnums?: boolean;
     /**
      * Write the files to disk (true or false)
      * @default true
@@ -194,6 +101,105 @@ interface UserConfig {
     write?: boolean;
 }
 
+interface Enum {
+    'x-enum-description'?: string;
+    'x-enum-varname'?: string;
+    description?: string;
+    value: string | number;
+}
+interface OperationError {
+    code: number;
+    description: string;
+}
+interface OperationParameter extends Model {
+    in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie';
+    prop: string;
+    mediaType: string | null;
+}
+interface OperationParameters extends Pick<Model, '$refs' | 'imports'> {
+    parameters: OperationParameter[];
+    parametersBody: OperationParameter | null;
+    parametersCookie: OperationParameter[];
+    parametersForm: OperationParameter[];
+    parametersHeader: OperationParameter[];
+    parametersPath: OperationParameter[];
+    parametersQuery: OperationParameter[];
+}
+interface OperationResponse extends Model {
+    in: 'response' | 'header';
+    code: number;
+}
+interface Operation extends OperationParameters {
+    deprecated: boolean;
+    description: string | null;
+    errors: OperationError[];
+    method: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT';
+    /**
+     * Method name. Methods contain the request logic.
+     */
+    name: string;
+    path: string;
+    responseHeader: string | null;
+    results: OperationResponse[];
+    /**
+     * Service name, might be without postfix. This will be used to name the
+     * exported class.
+     */
+    service: string;
+    summary: string | null;
+}
+interface Schema {
+    exclusiveMaximum?: boolean;
+    exclusiveMinimum?: boolean;
+    format?: 'binary' | 'boolean' | 'byte' | 'date-time' | 'date' | 'double' | 'float' | 'int32' | 'int64' | 'password' | 'string';
+    isDefinition: boolean;
+    isNullable: boolean;
+    isReadOnly: boolean;
+    isRequired: boolean;
+    maximum?: number;
+    maxItems?: number;
+    maxLength?: number;
+    maxProperties?: number;
+    minimum?: number;
+    minItems?: number;
+    minLength?: number;
+    minProperties?: number;
+    multipleOf?: number;
+    pattern?: string;
+    uniqueItems?: boolean;
+}
+interface Model extends Schema {
+    /**
+     * **Experimental.** Contains list of original refs so they can be used
+     * to access the schema from anywhere instead of relying on string name.
+     * This allows us to do things like detect type of ref.
+     */
+    $refs: string[];
+    base: string;
+    default?: string;
+    deprecated?: boolean;
+    description: string | null;
+    enum: Enum[];
+    enums: Model[];
+    export: 'all-of' | 'any-of' | 'array' | 'const' | 'dictionary' | 'enum' | 'generic' | 'interface' | 'one-of' | 'reference';
+    imports: string[];
+    link: Model | null;
+    name: string;
+    properties: Model[];
+    template: string | null;
+    type: string;
+}
+interface Service extends Pick<Model, '$refs' | 'imports' | 'name'> {
+    operations: Operation[];
+}
+
+interface Client {
+    models: Model[];
+    server: string;
+    services: Service[];
+    version: string;
+}
+
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
  * given language it will generate the client, including the typed models, validation schemas,