Merge pull request #191 from hey-api/fix/options-experimental

fix(api): add experimental flag
hey-api · Mar 30, 2024 · 1def4fa · 1def4fa
2 parents 3921a57 + a2f521e
commit 1def4fa
Show file tree

Hide file tree

Showing 54 changed files with 4,779 additions and 2 deletions.
diff --git a/.changeset/strange-colts-smell.md b/.changeset/strange-colts-smell.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix(api): add experimental flag
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,6 +32,9 @@ jobs:
       - name: Run linter
         run: npm run lint
 
+      - name: Run type check
+        run: npm run typecheck
+
       - name: Run unit tests
         run: npm run test
 

diff --git a/src/index.ts b/src/index.ts
@@ -100,6 +100,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         base,
         debug = false,
         enums = false,
+        experimental = false,
         exportCore = true,
         exportModels = true,
         exportSchemas = true,
@@ -148,6 +149,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         client,
         debug,
         enums,
+        experimental,
         exportCore,
         exportModels,
         exportSchemas,

diff --git a/src/openApi/__tests__/index.spec.ts b/src/openApi/__tests__/index.spec.ts
@@ -11,7 +11,9 @@ describe('parse', () => {
 
     const options: Parameters<typeof parse>[1] = {
         client: 'fetch',
+        debug: false,
         enums: 'javascript',
+        experimental: false,
         exportCore: true,
         exportModels: true,
         exportSchemas: true,

diff --git a/src/openApi/v2/parser/__tests__/getServices.spec.ts b/src/openApi/v2/parser/__tests__/getServices.spec.ts
@@ -6,7 +6,9 @@ describe('getServices', () => {
     it('should create a unnamed service if tags are empty', () => {
         const options: Parameters<typeof getServices>[1] = {
             client: 'fetch',
+            debug: false,
             enums: false,
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/openApi/v3/parser/__tests__/getServices.spec.ts b/src/openApi/v3/parser/__tests__/getServices.spec.ts
@@ -6,7 +6,9 @@ describe('getServices', () => {
     it('should create a unnamed service if tags are empty', () => {
         const options: Parameters<typeof getServices>[1] = {
             client: 'fetch',
+            debug: false,
             enums: false,
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/templates/partials/dataDestructure.hbs b/src/templates/partials/dataDestructure.hbs
@@ -13,8 +13,17 @@ const {
 {{~#notEquals @root.$config.serviceResponse 'generics'~}}
 {{~#if parameters~}}
 const {
+{{#if @root.$config.experimental}}
+query,
+{{/if}}
 {{#each parameters}}
+{{#if @root.$config.experimental}}
+{{#notEquals in 'query'}}
 {{{name}}}{{#if default}} = {{{default}}}{{/if}},
+{{/notEquals}}
+{{else}}
+{{{name}}}{{#if default}} = {{{default}}}{{/if}},
+{{/if}}
 {{/each}}
 } = data;
 {{/if}}

diff --git a/src/types/config.ts b/src/types/config.ts
@@ -18,6 +18,11 @@ export interface UserConfig {
      * @default false
      */
     enums?: 'javascript' | 'typescript' | false;
+    /**
+     * Generate an experimental build?
+     * @default false
+     */
+    experimental?: boolean;
     /**
      * Generate core client classes?
      * @default true

diff --git a/src/utils/__tests__/handlebars.spec.ts b/src/utils/__tests__/handlebars.spec.ts
@@ -8,7 +8,9 @@ describe('registerHandlebarHelpers', () => {
         registerHandlebarHelpers(
             {
                 client: 'fetch',
+                debug: false,
                 enums: 'javascript',
+                experimental: false,
                 exportCore: true,
                 exportModels: true,
                 exportSchemas: true,
@@ -60,7 +62,9 @@ describe('registerHandlebarTemplates', () => {
         const templates = registerHandlebarTemplates(
             {
                 client: 'fetch',
+                debug: false,
                 enums: 'javascript',
+                experimental: false,
                 exportCore: true,
                 exportModels: true,
                 exportSchemas: true,

diff --git a/src/utils/handlebars.ts b/src/utils/handlebars.ts
@@ -101,7 +101,24 @@ const modelImports = (model: Service, path: string) => {
     return `import type { ${model.imports.join(',')} } from '${path}';`;
 };
 
-const dataParameters = (parameters: OperationParameter[]) => {
+const dataParameters = (config: Config, parameters: OperationParameter[]) => {
+    if (config.experimental) {
+        let output = parameters
+            .filter(parameter => parameter.default !== undefined)
+            .map(parameter => {
+                const key = parameter.prop;
+                const value = parameter.name;
+                if (key === value || escapeName(key) === key) {
+                    return `${key}: ${parameter.default}`;
+                }
+                return `'${key}': ${parameter.default}`;
+            });
+        if (parameters.every(parameter => parameter.in === 'query')) {
+            output = [...output, '...query'];
+        }
+        return output.join(', ');
+    }
+
     const output = parameters.map(parameter => {
         const key = parameter.prop;
         const value = parameter.name;
@@ -132,6 +149,12 @@ const operationDataType = (config: Config, service: Service) => {
             const name = nameOperationDataType(operation.name);
             return `export type ${name} = {
                 ${sortByName(operation.parameters)
+                    .filter(parameter => {
+                        if (!config.experimental) {
+                            return true;
+                        }
+                        return parameter.in !== 'query';
+                    })
                     .map(parameter => {
                         let comment: string[] = [];
                         if (parameter.description) {
@@ -143,6 +166,26 @@ const operationDataType = (config: Config, service: Service) => {
                         ].join('\n');
                     })
                     .join('\n')}
+                ${
+                    config.experimental
+                        ? `
+                query${operation.parametersQuery.every(parameter => !parameter.isRequired) ? '?' : ''}: {
+                    ${sortByName(operation.parametersQuery)
+                        .map(parameter => {
+                            let comment: string[] = [];
+                            if (parameter.description) {
+                                comment = ['/**', ` * ${escapeComment(parameter.description)}`, ' */'];
+                            }
+                            return [
+                                ...comment,
+                                `${parameter.name + isRequired(parameter)}: ${partialType({ $config: config, ...parameter })}`,
+                            ].join('\n');
+                        })
+                        .join('\n')}
+                }
+                `
+                        : ''
+                }
             }`;
         });
     return output.join('\n');
@@ -151,7 +194,11 @@ const operationDataType = (config: Config, service: Service) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export const registerHandlebarHelpers = (config: Config, client: Client): void => {
     Handlebars.registerHelper('camelCase', camelCase);
-    Handlebars.registerHelper('dataParameters', dataParameters);
+
+    Handlebars.registerHelper('dataParameters', function (parameters: OperationParameter[]) {
+        return dataParameters(config, parameters);
+    });
+
     Handlebars.registerHelper('enumKey', enumKey);
     Handlebars.registerHelper('enumName', enumName);
     Handlebars.registerHelper('enumUnionType', enumUnionType);

diff --git a/src/utils/write/__tests__/class.spec.ts b/src/utils/write/__tests__/class.spec.ts
@@ -18,7 +18,9 @@ describe('writeClientClass', () => {
 
         await writeClientClass(client, mockTemplates, './dist', {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/client.spec.ts b/src/utils/write/__tests__/client.spec.ts
@@ -18,7 +18,9 @@ describe('writeClient', () => {
 
         await writeClient(client, mockTemplates, {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/core.spec.ts b/src/utils/write/__tests__/core.spec.ts
@@ -24,7 +24,9 @@ describe('writeClientCore', () => {
 
         const config: Parameters<typeof writeClientCore>[3] = {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,
@@ -64,7 +66,9 @@ describe('writeClientCore', () => {
 
         const config: Parameters<typeof writeClientCore>[3] = {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,
@@ -104,7 +108,9 @@ describe('writeClientCore', () => {
         const config: Parameters<typeof writeClientCore>[3] = {
             base: 'foo',
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/index.spec.ts b/src/utils/write/__tests__/index.spec.ts
@@ -19,7 +19,9 @@ describe('writeClientIndex', () => {
 
         await writeClientIndex(client, mockTemplates, '/', {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/models.spec.ts b/src/utils/write/__tests__/models.spec.ts
@@ -38,7 +38,9 @@ describe('writeClientModels', () => {
 
         await writeClientModels(client, mockTemplates, '/', {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/schemas.spec.ts b/src/utils/write/__tests__/schemas.spec.ts
@@ -38,7 +38,9 @@ describe('writeClientSchemas', () => {
 
         await writeClientSchemas(client, mockTemplates, '/', {
             client: 'fetch',
+            debug: false,
             enums: 'javascript',
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/src/utils/write/__tests__/services.spec.ts b/src/utils/write/__tests__/services.spec.ts
@@ -26,7 +26,9 @@ describe('writeClientServices', () => {
 
         await writeClientServices(client, mockTemplates, '/', {
             client: 'fetch',
+            debug: false,
             enums: false,
+            experimental: false,
             exportCore: true,
             exportModels: true,
             exportSchemas: true,

diff --git a/test/__snapshots__/v3_experimental/core/ApiError.ts.snap b/test/__snapshots__/v3_experimental/core/ApiError.ts.snap
@@ -0,0 +1,21 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+
+export class ApiError extends Error {
+    public readonly url: string;
+    public readonly status: number;
+    public readonly statusText: string;
+    public readonly body: unknown;
+    public readonly request: ApiRequestOptions;
+
+    constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
+        super(message);
+
+        this.name = 'ApiError';
+        this.url = response.url;
+        this.status = response.status;
+        this.statusText = response.statusText;
+        this.body = response.body;
+        this.request = request;
+    }
+}
diff --git a/test/__snapshots__/v3_experimental/core/ApiRequestOptions.ts.snap b/test/__snapshots__/v3_experimental/core/ApiRequestOptions.ts.snap
@@ -0,0 +1,13 @@
+export type ApiRequestOptions = {
+    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+    readonly url: string;
+    readonly path?: Record<string, unknown>;
+    readonly cookies?: Record<string, unknown>;
+    readonly headers?: Record<string, unknown>;
+    readonly query?: Record<string, unknown>;
+    readonly formData?: Record<string, unknown>;
+    readonly body?: any;
+    readonly mediaType?: string;
+    readonly responseHeader?: string;
+    readonly errors?: Record<number, string>;
+};
diff --git a/test/__snapshots__/v3_experimental/core/ApiResult.ts.snap b/test/__snapshots__/v3_experimental/core/ApiResult.ts.snap
@@ -0,0 +1,7 @@
+export type ApiResult<TData = any> = {
+    readonly body: TData;
+    readonly ok: boolean;
+    readonly status: number;
+    readonly statusText: string;
+    readonly url: string;
+};