Merge pull request #2310 from hey-api/chore/sdk-params-progress

chore(sdk): initial implementation for custom params

Author: mrlubos

package.json

@@ -63,7 +63,7 @@
     "rollup": "4.31.0",
     "rollup-plugin-dts": "6.1.1",
     "tsup": "8.4.0",
-    "turbo": "2.5.4",
+    "turbo": "2.5.5",
     "typescript": "5.8.3",
     "typescript-eslint": "8.29.1",
     "vitest": "3.1.1"

packages/custom-client/src/core/types.ts

@@ -102,3 +102,17 @@ export interface Config {
    */
   responseValidator?: (data: unknown) => Promise<unknown>;
 }
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};

packages/openapi-ts-tests/test/__snapshots__/2.0.x/body-response-text-plain/core/params.ts

@@ -3,11 +3,21 @@ type Slot = 'body' | 'headers' | 'path' | 'query';
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
       key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If omitted, we use the same value as `key`.
+       */
       map?: string;
     }
   | {
       in: Extract<Slot, 'body'>;
+      /**
+       * Key isn't required for bodies.
+       */
       key?: string;
       map?: string;
     };

packages/openapi-ts-tests/test/__snapshots__/2.0.x/body-response-text-plain/core/types.ts

@@ -102,3 +102,17 @@ export interface Config {
    */
   responseValidator?: (data: unknown) => Promise<unknown>;
 }
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};

packages/openapi-ts-tests/test/__snapshots__/2.0.x/form-data/core/params.ts

@@ -3,11 +3,21 @@ type Slot = 'body' | 'headers' | 'path' | 'query';
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
       key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If omitted, we use the same value as `key`.
+       */
       map?: string;
     }
   | {
       in: Extract<Slot, 'body'>;
+      /**
+       * Key isn't required for bodies.
+       */
       key?: string;
       map?: string;
     };

packages/openapi-ts-tests/test/__snapshots__/2.0.x/form-data/core/types.ts

@@ -102,3 +102,17 @@ export interface Config {
    */
   responseValidator?: (data: unknown) => Promise<unknown>;
 }
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/core/params.ts

@@ -3,11 +3,21 @@ type Slot = 'body' | 'headers' | 'path' | 'query';
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
       key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If omitted, we use the same value as `key`.
+       */
       map?: string;
     }
   | {
       in: Extract<Slot, 'body'>;
+      /**
+       * Key isn't required for bodies.
+       */
       key?: string;
       map?: string;
     };

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/core/types.ts

@@ -102,3 +102,17 @@ export interface Config {
    */
   responseValidator?: (data: unknown) => Promise<unknown>;
 }
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/instance/core/params.ts

@@ -3,11 +3,21 @@ type Slot = 'body' | 'headers' | 'path' | 'query';
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
       key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If omitted, we use the same value as `key`.
+       */
       map?: string;
     }
   | {
       in: Extract<Slot, 'body'>;
+      /**
+       * Key isn't required for bodies.
+       */
       key?: string;
       map?: string;
     };

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/instance/core/types.ts

@@ -102,3 +102,17 @@ export interface Config {
    */
   responseValidator?: (data: unknown) => Promise<unknown>;
 }
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true
+    ? never
+    : K]: T[K];
+};