@remkoj/hey-api-wrapper 6.0.0-rc.2

package/AGENTS.md

@@ -0,0 +1,6 @@
+# @remkoj/hey-api-wrapper — usage
+
+Internal package. Not intended for direct use.
+
+Consumed by `@remkoj/optimizely-cms-api` to wrap a `@hey-api`-generated SDK into
+a single client object. Do not import this package directly in application code.

package/README.md

@@ -0,0 +1 @@
+# hey-api-wrapper

package/dist/index.d.ts

@@ -0,0 +1,152 @@
+export type { OperationsList } from './types';
+import type { ApiClientConfig, ApiClientFunctions, ClassWithMixin, OperationsList } from './types';
+/**
+ * Mixin factory that extends an {@link ApiClient} subclass with one method per
+ * hey-api operation. Each generated method calls the matching operation,
+ * injecting the instance's network client and `throwOnError: false`, throws an
+ * {@link ApiError} when the operation reports an error, and otherwise returns
+ * the response `data` (falling back to the full result).
+ *
+ * @param Base The {@link ApiClient} subclass to extend.
+ * @param Operations Map of hey-api operation functions to bind as methods.
+ * @returns A new class combining `Base` with the bound operation methods.
+ *
+ * @example
+ * ```typescript
+ * import * as SdkOps from './client/sdk.gen';
+ * import { createClient } from '@hey-api/client-fetch';
+ *
+ * class MyCmsApiClient extends withOperations(ApiClient, SdkOps) {
+ *   constructor(config: ApiClientConfig, client: ReturnType<typeof createClient>) {
+ *     super(config, client);
+ *   }
+ * }
+ *
+ * const api = new MyCmsApiClient({ debug: true }, createClient({ baseUrl: 'https://cms.example.com' }));
+ * const result = await api.listContent({ query: { pageSize: 10 } });
+ * ```
+ */
+export declare function withOperations<TBase extends ApiClientStatic, TOperations extends OperationsList>(Base: TBase, Operations: TOperations): ClassWithMixin<TBase, ApiClientFunctions<TOperations>>;
+/**
+ * Minimal network client contract required by {@link ApiClient}: a client
+ * exposing request and response interceptor registration (as provided by
+ * `@hey-api/client-fetch`).
+ */
+export type ApiClientNetworkClient = {
+    interceptors: {
+        request: {
+            use: (interceptor: (request: Request) => Request | Promise<Request>) => number;
+        };
+        response: {
+            use: (interceptor: (response: Response, request: Request) => Response | Promise<Response>) => number;
+        };
+    };
+};
+/**
+ * The static (constructor) side of an {@link ApiClient} subclass. Used as the
+ * `Base` constraint for {@link withOperations} so a concrete client class can be
+ * passed despite its narrowed constructor signature.
+ *
+ * @typeParam C Configuration type, extending {@link ApiClientConfig}.
+ * @typeParam NC Network client type, extending {@link ApiClientNetworkClient}.
+ */
+export type ApiClientStatic<C extends ApiClientConfig = ApiClientConfig, NC extends ApiClientNetworkClient = ApiClientNetworkClient> = {
+    new (...args: any[]): ApiClient<C, NC>;
+};
+/**
+ * Abstract base for hey-api backed clients. Holds the immutable configuration
+ * and network client, and—when `debug` is enabled—installs request/response
+ * logging interceptors. Operation methods are added by {@link withOperations}.
+ *
+ * @typeParam C Configuration type, extending {@link ApiClientConfig}.
+ * @typeParam NC Network client type, extending {@link ApiClientNetworkClient}.
+ */
+export declare abstract class ApiClient<C extends ApiClientConfig = ApiClientConfig, NC extends ApiClientNetworkClient = ApiClientNetworkClient> {
+    /**
+     * Immutable configuration snapshot for this client instance.
+     * Accessible to subclasses only.
+     */
+    protected readonly _config: Readonly<C>;
+    /**
+     * The `@hey-api` network client bound to this instance.
+     * Injected into every operation call. Accessible to subclasses only.
+     */
+    protected readonly _client: NC;
+    /** Whether debug logging is enabled for this client. */
+    get debug(): boolean;
+    /** The configured client name, or `'API Client'` when unset. */
+    get name(): string;
+    /** The underlying network client used to perform operations. */
+    get client(): NC;
+    /**
+     * @param config Immutable client configuration.
+     * @param client Network client used to perform operations; receives logging interceptors when `config.debug` is set.
+     */
+    constructor(config: C, client: NC);
+    /**
+     * Type guard for a hey-api error result (an object carrying `error`,
+     * `request` and `response`).
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is an error response.
+     */
+    protected isErrorResponse(toTest?: unknown): toTest is {
+        error: unknown;
+        request: Request;
+        response: Response;
+    };
+    /**
+     * Type guard for a hey-api success result (an object carrying `data`,
+     * `request` and `response`).
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is a data response.
+     */
+    protected isDataResponse<RT = unknown>(toTest?: unknown): toTest is {
+        data: RT & {};
+        request: Request;
+        response: Response;
+    };
+    /**
+     * Type guard for a non-null object.
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is a non-null object.
+     */
+    protected isObject(toTest?: unknown): toTest is Record<string | number | symbol, unknown>;
+}
+/**
+ * Error thrown when an API operation returns an error result. Wraps the
+ * originating error payload together with the HTTP request and response for
+ * inspection.
+ */
+export declare class ApiError extends Error {
+    /** Raw error context captured from the failed operation: the error payload and the originating HTTP request and response. */
+    protected _ctx: {
+        error?: unknown;
+        request?: Request;
+        response?: Response;
+    };
+    /**
+     * @param data The operation error context: the error payload plus the HTTP request and response. A string error is used verbatim as the message; otherwise the message is derived from the response status.
+     */
+    constructor(data: {
+        error?: unknown;
+        request?: Request;
+        response?: Response;
+    });
+    /** The error payload returned by the operation. */
+    get data(): unknown;
+    /**
+     * @deprecated Use {@link data} instead.
+     */
+    get body(): unknown;
+    /** The HTTP request that produced the error. */
+    get request(): unknown;
+    /** The HTTP response that produced the error. */
+    get response(): unknown;
+    /** The HTTP status code of the response. */
+    get status(): number;
+    /** The HTTP status text of the response. */
+    get statusText(): string;
+}

package/dist/index.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = exports.ApiClient = void 0;
+exports.withOperations = withOperations;
+/**
+ * Mixin factory that extends an {@link ApiClient} subclass with one method per
+ * hey-api operation. Each generated method calls the matching operation,
+ * injecting the instance's network client and `throwOnError: false`, throws an
+ * {@link ApiError} when the operation reports an error, and otherwise returns
+ * the response `data` (falling back to the full result).
+ *
+ * @param Base The {@link ApiClient} subclass to extend.
+ * @param Operations Map of hey-api operation functions to bind as methods.
+ * @returns A new class combining `Base` with the bound operation methods.
+ *
+ * @example
+ * ```typescript
+ * import * as SdkOps from './client/sdk.gen';
+ * import { createClient } from '@hey-api/client-fetch';
+ *
+ * class MyCmsApiClient extends withOperations(ApiClient, SdkOps) {
+ *   constructor(config: ApiClientConfig, client: ReturnType<typeof createClient>) {
+ *     super(config, client);
+ *   }
+ * }
+ *
+ * const api = new MyCmsApiClient({ debug: true }, createClient({ baseUrl: 'https://cms.example.com' }));
+ * const result = await api.listContent({ query: { pageSize: 10 } });
+ * ```
+ */
+function withOperations(Base, Operations) {
+    //@ts-expect-error A mixin requires an ...any[] argument, but our concrete class has
+    // specified 
+    class NewClass extends Base {
+        constructor(...args) {
+            super(...args);
+        }
+    }
+    // Create guard for this list of Operations
+    const isApiClientFunction = createIsFunctionValidator(Operations);
+    // Bind the operations
+    ;
+    Object.getOwnPropertyNames(Operations).filter(isApiClientFunction).forEach(propName => {
+        async function wrapper(...args) {
+            const operationArgs = [...args];
+            operationArgs[0] = {
+                throwOnError: false,
+                ...args,
+                client: this._client
+            };
+            //@ts-expect-error TypeScript can't check this as TOperations is dynamic
+            const result = await Operations[propName](...operationArgs);
+            if (result.error)
+                throw new ApiError(result);
+            return result.data ? result.data : result;
+        }
+        //@ts-expect-error TypeScript doesn't understand that we're creating an expected function
+        NewClass.prototype[propName] = wrapper;
+    });
+    // Return the new class
+    return NewClass;
+}
+/**
+ * Builds a type guard that reports whether a property name refers to a function
+ * on the given operations map, narrowing it to `keyof T`.
+ *
+ * @param baseType The operations map to test property names against.
+ * @returns A predicate that is `true` for keys whose value is a function.
+ */
+function createIsFunctionValidator(baseType) {
+    return (propName) => {
+        return typeof (baseType[propName]) == 'function';
+    };
+}
+/**
+ * Abstract base for hey-api backed clients. Holds the immutable configuration
+ * and network client, and—when `debug` is enabled—installs request/response
+ * logging interceptors. Operation methods are added by {@link withOperations}.
+ *
+ * @typeParam C Configuration type, extending {@link ApiClientConfig}.
+ * @typeParam NC Network client type, extending {@link ApiClientNetworkClient}.
+ */
+class ApiClient {
+    /**
+     * Immutable configuration snapshot for this client instance.
+     * Accessible to subclasses only.
+     */
+    _config;
+    /**
+     * The `@hey-api` network client bound to this instance.
+     * Injected into every operation call. Accessible to subclasses only.
+     */
+    _client;
+    /** Whether debug logging is enabled for this client. */
+    get debug() {
+        return this._config.debug ?? false;
+    }
+    /** The configured client name, or `'API Client'` when unset. */
+    get name() {
+        return this._config.name ?? 'API Client';
+    }
+    /** The underlying network client used to perform operations. */
+    get client() {
+        return this._client;
+    }
+    /**
+     * @param config Immutable client configuration.
+     * @param client Network client used to perform operations; receives logging interceptors when `config.debug` is set.
+     */
+    constructor(config, client) {
+        this._config = config;
+        this._client = client;
+        if (this._config.debug) {
+            const name = this._config.name ?? 'API Client';
+            this._client.interceptors.request.use(async (request) => {
+                console.log(`🔍 [${name}] Sending ${request.method} request to ${request.url}`);
+                return request;
+            });
+            this._client.interceptors.response.use((response, request) => {
+                console.log(`✨ [CMS API] Received response ${response.status} ${response.statusText} of type ${response.headers.get('Content-Type') ?? 'unknown'} for ${request.url}`);
+                return response;
+            });
+        }
+    }
+    /**
+     * Type guard for a hey-api error result (an object carrying `error`,
+     * `request` and `response`).
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is an error response.
+     */
+    isErrorResponse(toTest) {
+        if (!this.isObject(toTest))
+            return false;
+        return toTest.error && toTest.request && toTest.response ? true : false;
+    }
+    /**
+     * Type guard for a hey-api success result (an object carrying `data`,
+     * `request` and `response`).
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is a data response.
+     */
+    isDataResponse(toTest) {
+        if (!this.isObject(toTest))
+            return false;
+        return toTest.data && toTest.request && toTest.response ? true : false;
+    }
+    /**
+     * Type guard for a non-null object.
+     *
+     * @param toTest The value to inspect.
+     * @returns `true` when `toTest` is a non-null object.
+     */
+    isObject(toTest) {
+        return typeof toTest === 'object' && toTest !== null;
+    }
+}
+exports.ApiClient = ApiClient;
+/**
+ * Error thrown when an API operation returns an error result. Wraps the
+ * originating error payload together with the HTTP request and response for
+ * inspection.
+ */
+class ApiError extends Error {
+    /** Raw error context captured from the failed operation: the error payload and the originating HTTP request and response. */
+    _ctx;
+    /**
+     * @param data The operation error context: the error payload plus the HTTP request and response. A string error is used verbatim as the message; otherwise the message is derived from the response status.
+     */
+    constructor(data) {
+        if (typeof data.error == 'string')
+            super(data.error);
+        else
+            super(`Optimizely CMS API Error: ${data.response?.status ?? 500} ${data.response?.statusText ?? 'Unknown error'}`);
+        this._ctx = data;
+    }
+    /** The error payload returned by the operation. */
+    get data() {
+        return this._ctx.error;
+    }
+    /**
+     * @deprecated Use {@link data} instead.
+     */
+    get body() {
+        return this._ctx.error;
+    }
+    /** The HTTP request that produced the error. */
+    get request() {
+        return this._ctx.request;
+    }
+    /** The HTTP response that produced the error. */
+    get response() {
+        return this._ctx.response;
+    }
+    /** The HTTP status code of the response. */
+    get status() {
+        return this._ctx.response?.status ?? 500;
+    }
+    /** The HTTP status text of the response. */
+    get statusText() {
+        return this._ctx.response?.statusText ?? 'Unknown error';
+    }
+}
+exports.ApiError = ApiError;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA8BA,wCAsCC;AAhED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,cAAc,CAAoE,IAAW,EAAE,UAAuB;IAEpI,oFAAoF;IACpF,aAAa;IACb,MAAM,QAAS,SAAQ,IAA6C;QAClE,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACjB,CAAC;KACF;IAED,2CAA2C;IAC3C,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,UAAU,CAAC,CAAC;IAElE,sBAAsB;IACtB,CAAC;IAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAA8B,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAEnH,KAAK,UAAU,OAAO,CAAkB,GAAG,IAAW;YAEpD,MAAM,aAAa,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YAChC,aAAa,CAAC,CAAC,CAAC,GAAG;gBACjB,YAAY,EAAE,KAAK;gBACnB,GAAG,IAAI;gBACP,MAAM,EAAE,IAAI,CAAC,OAAO;aACrB,CAAA;YAED,wEAAwE;YACxE,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAG,aAAa,CAAC,CAAA;YAC3D,IAAI,MAAM,CAAC,KAAK;gBACd,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QAC5C,CAAC;QAED,yFAAyF;QACzF,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,uBAAuB;IACvB,OAAO,QAA6E,CAAA;AACtF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,yBAAyB,CAA2B,QAAW;IACtE,OAAO,CAAC,QAA8B,EAAuB,EAAE;QAC7D,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAmB,CAAC,CAAC,IAAI,UAAU,CAAA;IAC7D,CAAC,CAAA;AACH,CAAC;AA8BD;;;;;;;GAOG;AACH,MAAsB,SAAS;IAK7B;;;OAGG;IACgB,OAAO,CAAc;IAExC;;;OAGG;IACgB,OAAO,CAAK;IAE/B,wDAAwD;IACxD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IACrC,CAAC;IAED,gEAAgE;IAChE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC;IAC3C,CAAC;IAED,gEAAgE;IAChE,IAAW,MAAM;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,YAAmB,MAAS,EAAE,MAAU;QACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;gBACtD,OAAO,CAAC,GAAG,CAAC,OAAQ,IAAK,aAAa,OAAO,CAAC,MAAM,eAAe,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;gBACjF,OAAO,OAAO,CAAA;YAChB,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;gBAC3D,OAAO,CAAC,GAAG,CAAC,iCAAiC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,YAAY,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,QAAQ,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;gBACtK,OAAO,QAAQ,CAAA;YACjB,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACO,eAAe,CAAC,MAAgB;QAExC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,OAAO,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1E,CAAC;IAED;;;;;;OAMG;IACO,cAAc,CAAe,MAAgB;QAErD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,OAAO,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,MAAgB;QAEjC,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAA;IACtD,CAAC;CACF;AA5FD,8BA4FC;AAED;;;;GAIG;AACH,MAAa,QAAS,SAAQ,KAAK;IACjC,6HAA6H;IACnH,IAAI,CAA6D;IAE3E;;OAEG;IACH,YAAY,IAAiE;QAC3E,IAAI,OAAO,IAAI,CAAC,KAAK,IAAI,QAAQ;YAC/B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;;YAEjB,KAAK,CAAC,6BAA6B,IAAI,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,UAAU,IAAI,eAAe,EAAE,CAAC,CAAA;QACpH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,mDAAmD;IACnD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAA;IACxB,CAAC;IAED,gDAAgD;IAChD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;IAC1B,CAAC;IAED,iDAAiD;IACjD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAA;IAC3B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAA;IAC1C,CAAC;IAED,4CAA4C;IAC5C,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,IAAI,eAAe,CAAA;IAC1D,CAAC;CACF;AA9CD,4BA8CC"}

package/dist/types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Utility function to extract all functions from a dictionary. This is typically used
+ * with the hey-api sdk.
+ *
+ * @typeparam Operations The hey-api SDK module shape (e.g. `typeof import('./client/sdk.gen')`).
+ *
+ * **Example:**
+ * ```
+ * import * as apiFunctions from './client/sdk.gen';
+ * type ApiOperations = OperationsList<typeof apiFunctions>;
+ * ```
+ */
+export type OperationsList<Operations extends Record<string, unknown> = Record<string, unknown>> = {
+    -readonly [KT in keyof Operations as Operations[KT] extends (...args: unknown[]) => unknown ? (KT extends string ? KT : never) : never]: Operations[KT];
+};
+/**
+ * Normalizes an operation's return type: a hey-api result
+ * (`Promise<{ data?, request, response }>`) is reduced to `Promise<TData>`;
+ * any other return type is left unchanged.
+ */
+type OperationReturnType<Op extends (...args: unknown[]) => unknown> = ReturnType<Op> extends Promise<{
+    data?: infer TData;
+}> ? Promise<TData> : ReturnType<Op>;
+/**
+ * Convert the extracted SDK functions to the normalized client
+ * functions that can be used.
+ *
+ * @typeparam L An {@link OperationsList} — the map of hey-api operation functions to convert.
+ *
+ * **Example:**
+ * ```
+ * import * as apiFunctions from './client/sdk.gen';
+ * type ApiOperations = OperationsList<typeof apiFunctions>;
+ * type ClientFunctions = ApiClientFunctions<ApiOperations>;
+ * ```
+ */
+export type ApiClientFunctions<L extends Record<string, (...args: unknown[]) => unknown>> = {
+    readonly [KT in keyof L]: (...args: Parameters<L[KT]>) => OperationReturnType<L[KT]>;
+};
+/** Any class (constructable) type. */
+export type ClassDefinition = {
+    new (...args: any[]): any;
+};
+/** The keys of `T` whose values are not constructors. */
+type NonConstructorKeys<T> = ({
+    [P in keyof T]: T[P] extends new () => object ? never : P;
+})[keyof T];
+/** `TBase` with its construct signature removed, leaving only static members. */
+type OmitConstructor<TBase extends ClassDefinition> = Pick<TBase, NonConstructorKeys<TBase>>;
+/**
+ * Produces the concrete derived-class type that results from applying a mixin
+ * to a base class. The constructor signature matches `TBase`; the instance type
+ * is `InstanceType<TBase> & Mixin`.
+ *
+ * @typeparam TBase The base class being extended (must be constructable).
+ * @typeparam Mixin The mixin object type whose members are merged into the instance.
+ *
+ * **Example:**
+ * ```typescript
+ * type CmsApiClientClass = ClassWithMixin<typeof ApiClient, ApiClientFunctions<CmsOperations>>;
+ * ```
+ */
+export type ClassWithMixin<TBase extends ClassDefinition, Mixin> = OmitConstructor<TBase> & {
+    new (...args: ConstructorParameters<TBase>): InstanceType<TBase> & Mixin;
+};
+/** Base configuration accepted by every {@link ApiClient}. */
+export type ApiClientConfig = {
+    /** Enables request/response logging interceptors when `true`. */
+    debug?: boolean;
+    /** Optional display name used in log output; defaults to `'API Client'`. */
+    name?: string;
+};
+export {};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@remkoj/hey-api-wrapper",
+  "displayName": "Wrap an Hey-API generated SDK into a single client object",
+  "description": "A compatibility package that wraps an Hey-API generated SDK into a single client object, providing a more convenient interface for users.",
+  "version": "6.0.0-rc.2",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remkoj/optimizely-dxp-clients.git",
+    "directory": "packages/hey-api-wrapper"
+  },
+  "bugs": "https://github.com/remkoj/optimizely-dxp-clients/issues",
+  "homepage": "https://github.com/remkoj/optimizely-dxp-clients/blob/main/packages/hey-api-wrapper/README.md",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist",
+    "./AGENTS.md"
+  ],
+  "scripts": {
+    "clean": "npx --yes rimraf -g ./dist ./*.tsbuildinfo",
+    "prepare": "tsc --build",
+    "watch": "tsc --watch",
+    "recompile": "yarn clean && tsc --build --force"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "tslib": "^2.8.1"
+  }
+}