@remkoj/optimizely-cms-api 6.0.0-pre8 → 6.0.0-rc.1

package/LICENSE

@@ -1,13 +1,13 @@
- Copyright 2023 Remko Jantzen
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
+ Copyright 2023 Remko Jantzen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
    limitations under the License.

package/README.md

@@ -1,7 +1,11 @@
+# Optimizely CMS - Integration API Client <!-- omit in toc -->
+
+> [!WARNING]
+> There'll be an update of Optimizely SaaS CMS that is incompatible with all SDK versions prior to 5.1.6. If you don't upgrade, you will see empty pages (main website) and "Component not found" messages (preview).
+
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
 ![Static Badge](https://img.shields.io/badge/Optimizely-Content_Management_System-blue?cacheSeconds=7200)
 
-# Optimizely CMS - Integration API Client <!-- omit in toc -->
 A Javascript client for the Integration API provided by the Optimizely CMS. It wraps the [Optimizely CMS SaaS Core REST API](https://docs.developers.optimizely.com/content-management-system/v1.0.0-SaaS-Core/reference/introduction-to-the-cms-content-api).
 
 ## Installation
@@ -17,13 +21,12 @@ import createClient, { ContentRoots } from '@remkoj/optimizely-cms-integration-a
 
 // Create an instance of the client
 const client = createClient({
-    base: "https://example.com",
     clientId: "apiClientID",
     clientSecret: "apiClientSecret"
 });
 
 // Start using client
-client.content.contentListItems(ContentRoots.SystemRoot).then(response => {
+client.preview2ContentList(ContentRoots.SystemRoot).then(response => {
     const items = response.items
     items?.map(item => {
         // Do something with the item
@@ -38,8 +41,7 @@ The configuration object for the `createClient()` method is optional, if it is o
 The following configuration options are available for 
 | Environment variable | Configuration key | Required | Usage |
 | --- | --- | --- | --- |
-| OPTIMIZELY_CMS_URL | base | yes | The URL where the CMS is available |
+| OPTIMIZELY_CMS_URL | base | no | Sets the URL of the Optimizely CMS instance |
 | OPTIMIZELY_CMS_CLIENT_ID | clientId | yes | The API Client ID, as configured within the CMS |
 | OPTIMIZELY_CMS_CLIENT_SECRET | clientSecret | yes | The API Client Secret as generated by the CMS when creating the client |
 | OPTIMIZELY_CMS_USER_ID | actAs | no | The username of the CMS user to impersonate |
-| OPTIMIZELY_CMS_SCHEMA | cmsVersion | no | Override the target Optimizely CMS Version:<br/><br/>`OPTI-CMS-12`: Optimizely CMS 12, With [CMS Service Preview 1](https://nuget.optimizely.com/package/?id=Optimizely.Cms.Preview1.Service) installed and working.<br/><br/>`OPTI-CMS-13`: Optimizely SaaS CMS / CMS 13<br/><br/>**Default:** SaaS CMS / CMS 13 |

package/dist/api-client.d.ts

@@ -1,8 +1,7 @@
 import * as Operations from './client/sdk.gen';
+import { createClient, type RequestResult, type ResponseStyle } from './client/client';
 import { type CmsIntegrationApiOptions } from "./config";
 import { type InstanceApiVersionInfo, OptiCmsVersion } from "./types";
-import { createClient, type RequestResult, type ResponseStyle } from './client/client';
-import type { CreateClientConfig } from './client/client.gen';
 type OperationsType = {
     -readonly [KT in keyof typeof Operations]: (typeof Operations)[KT];
 };
@@ -24,24 +23,28 @@ export type ClassWithMixin<TBase extends BaseClass, Mixin> = OmitConstructor<TBa
 declare class BaseApiClient {
     protected _config: CmsIntegrationApiOptions;
     protected _client: ReturnType<typeof createClient>;
-    private _token;
-    protected getAccessToken(): Promise<string>;
     constructor(config?: CmsIntegrationApiOptions);
     /**
      * Get the runtime configuration of the target CMS version.
      *
      * If this differs from the cmsVersion the client may not work fully or not
      * at all.
+     *
+     * @deprecated  This is based on the OPTIMIZELY_CMS_SCHEMA environment that is ignored by API client
      */
     get runtimeCmsVersion(): OptiCmsVersion;
     /**
      * The URL of the CMS instance
      */
-    get cmsUrl(): URL;
+    get cmsUrl(): URL | undefined;
     /**
      * Marker to indicate if the client has debugging enabled
      */
     get debug(): boolean;
+    /**
+     * Detect the API Version from the URL, returning the runtime version. When
+     * this version differs from the `apiVersion` property errors can be expected.
+     */
     get version(): string;
     /**
      * The API version for which this client was build
@@ -58,7 +61,7 @@ declare class BaseApiClient {
      */
     getInstanceInfo(): Promise<InstanceApiVersionInfo>;
     getOpenApiSpec(): Promise<any>;
-    protected createClientConfig: CreateClientConfig;
+    getSchemaItemBase(): URL | undefined;
 }
 export declare class ApiError extends Error {
     protected _ctx: {

package/dist/api-client.js

@@ -38,11 +38,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClient = exports.ApiError = void 0;
 const Operations = __importStar(require("./client/sdk.gen"));
+const client_1 = require("./client/client");
 const config_1 = require("./config");
 const types_1 = require("./types");
-const client_1 = require("./client/client");
+const client_config_1 = require("./client-config");
 const version_json_1 = __importDefault(require("./version.json"));
-const getaccesstoken_1 = require("./getaccesstoken");
 function applyOperations(Base) {
     // Create the new class
     class NewClass extends Base {
@@ -51,7 +51,7 @@ function applyOperations(Base) {
         }
     }
     // Bind the operations
-    Object.getOwnPropertyNames(Operations).filter(isApiClientFunction).forEach((propName) => {
+    Object.getOwnPropertyNames(Operations).filter(isApiClientFunction).forEach(propName => {
         async function wrapper(args) {
             const operationArgs = {
                 throwOnError: false,
@@ -71,56 +71,52 @@ function applyOperations(Base) {
     // Return the new class
     return NewClass;
 }
-function isApiClientFunction(propName) {
-    return typeof (Operations[propName]) == 'function';
+function createIsFunctionValidator(baseType) {
+    return (propName) => {
+        return typeof (baseType[propName]) == 'function';
+    };
 }
+const isApiClientFunction = createIsFunctionValidator(Operations);
 class BaseApiClient {
     _config;
     _client;
-    _token;
-    getAccessToken() {
-        if (!this._token)
-            this._token = (0, getaccesstoken_1.getAccessToken)(this._config);
-        return this._token;
-    }
     constructor(config) {
-        // Prepare config
-        const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-        options.base = new URL("/_cms/preview2", options.base);
-        if (options.cmsVersion == types_1.OptiCmsVersion.CMS12)
-            options.base.pathname = options.base.pathname.replace('preview2', 'preview1');
         // Store instance variables
-        this._config = options;
-        this._client = (0, client_1.createClient)(this.createClientConfig());
+        this._config = config ?? (0, config_1.readEnvConfig)();
+        this._client = (0, client_1.createClient)((0, client_config_1.createClientConfig)((0, client_1.createConfig)({
+            baseUrl: 'https://api.cms.optimizely.com/preview3',
+        }), this._config));
         // Configure Client
-        this._client.interceptors.request.use(async (request) => {
-            const token = await this.getAccessToken();
-            request.headers.set('Authorization', 'Bearer ' + token);
-            if (this._config.debug) {
-                console.log(`🔍 Sending ${request.method} request to ${request.url}`);
-            }
-            return request;
-        });
-        if (this._config.debug)
+        if (this._config.debug) {
+            this._client.interceptors.request.use(async (request) => {
+                console.log(`🔍 [CMS API] Sending ${request.method} request to ${request.url}`);
+                return request;
+            });
             this._client.interceptors.response.use((response, request) => {
-                console.log(`✨ Received response ${response.status} ${response.statusText} of type ${response.headers.get('Content-Type') ?? 'unknown'} for ${request.url}`);
+                console.log(`✨ [CMS API] Received response ${response.status} ${response.statusText} of type ${response.headers.get('Content-Type') ?? 'unknown'} for ${request.url}`);
                 return response;
             });
+        }
     }
     /**
      * Get the runtime configuration of the target CMS version.
      *
      * If this differs from the cmsVersion the client may not work fully or not
      * at all.
+     *
+     * @deprecated  This is based on the OPTIMIZELY_CMS_SCHEMA environment that is ignored by API client
      */
     get runtimeCmsVersion() {
-        return this._config.cmsVersion ?? types_1.OptiCmsVersion.CMS13;
+        return this._config.cmsVersion ?? types_1.OptiCmsVersion.CMSSAAS;
     }
     /**
      * The URL of the CMS instance
      */
     get cmsUrl() {
-        return this._config.base;
+        if (this._config.base)
+            return this._config.base;
+        const baseUrl = this._client.getConfig().baseUrl;
+        return baseUrl ? new URL(baseUrl) : undefined;
     }
     /**
      * Marker to indicate if the client has debugging enabled
@@ -128,8 +124,14 @@ class BaseApiClient {
     get debug() {
         return this._config.debug ?? false;
     }
+    /**
+     * Detect the API Version from the URL, returning the runtime version. When
+     * this version differs from the `apiVersion` property errors can be expected.
+     */
     get version() {
-        return this._config.cmsVersion == types_1.OptiCmsVersion.CMS12 ? 'preview1' : 'preview2';
+        const baseUrl = this._client.getConfig().baseUrl;
+        const detectedVersion = baseUrl?.match(/^https{0,1}:\/\/.+?\/(_cms\/){0,1}([a-z0-9\.]+)(\/|$)/)?.at(2);
+        return detectedVersion || "";
     }
     /**
      * The API version for which this client was build
@@ -152,24 +154,27 @@ class BaseApiClient {
         const result = await this._client.get({
             url: '/info'
         });
-        if (result.data)
-            return result.data;
+        if (result.data) {
+            const data = result.data;
+            data.baseUrl = this._client.getConfig().baseUrl;
+            return data;
+        }
         throw new ApiError(result);
     }
     async getOpenApiSpec() {
         const result = await this._client.get({
-            url: '/docs/content-openapi.json'
+            url: '/docs/content-openapi.json',
         });
         if (result.data)
             return result.data;
         throw new ApiError(result);
     }
-    createClientConfig = (override) => {
-        return {
-            ...override,
-            baseUrl: this._config.base.href
-        };
-    };
+    getSchemaItemBase() {
+        let baseUrl = this._client.getConfig().baseUrl;
+        if (typeof (baseUrl) === 'string' && !baseUrl.endsWith('/'))
+            baseUrl = baseUrl + '/';
+        return baseUrl ? new URL(baseUrl) : undefined;
+    }
 }
 class ApiError extends Error {
     _ctx;

package/dist/client/client/{client.d.ts → client.gen.d.ts}

@@ -1,2 +1,2 @@
-import type { Client, Config } from './types';
+import type { Client, Config } from './types.gen';
 export declare const createClient: (config?: Config) => Client;

package/dist/client/client/client.gen.js

@@ -0,0 +1,239 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = void 0;
+const serverSentEvents_gen_1 = require("../core/serverSentEvents.gen");
+const utils_gen_1 = require("../core/utils.gen");
+const utils_gen_2 = require("./utils.gen");
+const createClient = (config = {}) => {
+    let _config = (0, utils_gen_2.mergeConfigs)((0, utils_gen_2.createConfig)(), config);
+    const getConfig = () => ({ ..._config });
+    const setConfig = (config) => {
+        _config = (0, utils_gen_2.mergeConfigs)(_config, config);
+        return getConfig();
+    };
+    const interceptors = (0, utils_gen_2.createInterceptors)();
+    const beforeRequest = async (options) => {
+        const opts = {
+            ..._config,
+            ...options,
+            fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
+            headers: (0, utils_gen_2.mergeHeaders)(_config.headers, options.headers),
+            serializedBody: undefined,
+        };
+        if (opts.security) {
+            await (0, utils_gen_2.setAuthParams)({
+                ...opts,
+                security: opts.security,
+            });
+        }
+        if (opts.requestValidator) {
+            await opts.requestValidator(opts);
+        }
+        if (opts.body !== undefined && opts.bodySerializer) {
+            opts.serializedBody = opts.bodySerializer(opts.body);
+        }
+        // remove Content-Type header if body is empty to avoid sending invalid requests
+        if (opts.body === undefined || opts.serializedBody === '') {
+            opts.headers.delete('Content-Type');
+        }
+        const url = (0, utils_gen_2.buildUrl)(opts);
+        return { opts, url };
+    };
+    const request = async (options) => {
+        // @ts-expect-error
+        const { opts, url } = await beforeRequest(options);
+        const requestInit = {
+            redirect: 'follow',
+            ...opts,
+            body: (0, utils_gen_1.getValidRequestBody)(opts),
+        };
+        let request = new Request(url, requestInit);
+        for (const fn of interceptors.request.fns) {
+            if (fn) {
+                request = await fn(request, opts);
+            }
+        }
+        // fetch must be assigned here, otherwise it would throw the error:
+        // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+        const _fetch = opts.fetch;
+        let response;
+        try {
+            response = await _fetch(request);
+        }
+        catch (error) {
+            // Handle fetch exceptions (AbortError, network errors, etc.)
+            let finalError = error;
+            for (const fn of interceptors.error.fns) {
+                if (fn) {
+                    finalError = (await fn(error, undefined, request, opts));
+                }
+            }
+            finalError = finalError || {};
+            if (opts.throwOnError) {
+                throw finalError;
+            }
+            // Return error response
+            return opts.responseStyle === 'data'
+                ? undefined
+                : {
+                    error: finalError,
+                    request,
+                    response: undefined,
+                };
+        }
+        for (const fn of interceptors.response.fns) {
+            if (fn) {
+                response = await fn(response, request, opts);
+            }
+        }
+        const result = {
+            request,
+            response,
+        };
+        if (response.ok) {
+            const parseAs = (opts.parseAs === 'auto'
+                ? (0, utils_gen_2.getParseAs)(response.headers.get('Content-Type'))
+                : opts.parseAs) ?? 'json';
+            if (response.status === 204 || response.headers.get('Content-Length') === '0') {
+                let emptyData;
+                switch (parseAs) {
+                    case 'arrayBuffer':
+                    case 'blob':
+                    case 'text':
+                        emptyData = await response[parseAs]();
+                        break;
+                    case 'formData':
+                        emptyData = new FormData();
+                        break;
+                    case 'stream':
+                        emptyData = response.body;
+                        break;
+                    case 'json':
+                    default:
+                        emptyData = {};
+                        break;
+                }
+                return opts.responseStyle === 'data'
+                    ? emptyData
+                    : {
+                        data: emptyData,
+                        ...result,
+                    };
+            }
+            let data;
+            switch (parseAs) {
+                case 'arrayBuffer':
+                case 'blob':
+                case 'formData':
+                case 'text':
+                    data = await response[parseAs]();
+                    break;
+                case 'json': {
+                    // Some servers return 200 with no Content-Length and empty body.
+                    // response.json() would throw; read as text and parse if non-empty.
+                    const text = await response.text();
+                    data = text ? JSON.parse(text) : {};
+                    break;
+                }
+                case 'stream':
+                    return opts.responseStyle === 'data'
+                        ? response.body
+                        : {
+                            data: response.body,
+                            ...result,
+                        };
+            }
+            if (parseAs === 'json') {
+                if (opts.responseValidator) {
+                    await opts.responseValidator(data);
+                }
+                if (opts.responseTransformer) {
+                    data = await opts.responseTransformer(data);
+                }
+            }
+            return opts.responseStyle === 'data'
+                ? data
+                : {
+                    data,
+                    ...result,
+                };
+        }
+        const textError = await response.text();
+        let jsonError;
+        try {
+            jsonError = JSON.parse(textError);
+        }
+        catch {
+            // noop
+        }
+        const error = jsonError ?? textError;
+        let finalError = error;
+        for (const fn of interceptors.error.fns) {
+            if (fn) {
+                finalError = (await fn(error, response, request, opts));
+            }
+        }
+        finalError = finalError || {};
+        if (opts.throwOnError) {
+            throw finalError;
+        }
+        // TODO: we probably want to return error and improve types
+        return opts.responseStyle === 'data'
+            ? undefined
+            : {
+                error: finalError,
+                ...result,
+            };
+    };
+    const makeMethodFn = (method) => (options) => request({ ...options, method });
+    const makeSseFn = (method) => async (options) => {
+        const { opts, url } = await beforeRequest(options);
+        return (0, serverSentEvents_gen_1.createSseClient)({
+            ...opts,
+            body: opts.body,
+            headers: opts.headers,
+            method,
+            onRequest: async (url, init) => {
+                let request = new Request(url, init);
+                for (const fn of interceptors.request.fns) {
+                    if (fn) {
+                        request = await fn(request, opts);
+                    }
+                }
+                return request;
+            },
+            serializedBody: (0, utils_gen_1.getValidRequestBody)(opts),
+            url,
+        });
+    };
+    const _buildUrl = (options) => (0, utils_gen_2.buildUrl)({ ..._config, ...options });
+    return {
+        buildUrl: _buildUrl,
+        connect: makeMethodFn('CONNECT'),
+        delete: makeMethodFn('DELETE'),
+        get: makeMethodFn('GET'),
+        getConfig,
+        head: makeMethodFn('HEAD'),
+        interceptors,
+        options: makeMethodFn('OPTIONS'),
+        patch: makeMethodFn('PATCH'),
+        post: makeMethodFn('POST'),
+        put: makeMethodFn('PUT'),
+        request,
+        setConfig,
+        sse: {
+            connect: makeSseFn('CONNECT'),
+            delete: makeSseFn('DELETE'),
+            get: makeSseFn('GET'),
+            head: makeSseFn('HEAD'),
+            options: makeSseFn('OPTIONS'),
+            patch: makeSseFn('PATCH'),
+            post: makeSseFn('POST'),
+            put: makeSseFn('PUT'),
+            trace: makeSseFn('TRACE'),
+        },
+        trace: makeMethodFn('TRACE'),
+    };
+};
+exports.createClient = createClient;

package/dist/client/client/index.d.ts

@@ -1,7 +1,8 @@
-export type { Auth } from '../core/auth';
-export type { QuerySerializerOptions } from '../core/bodySerializer';
-export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer';
-export { buildClientParams } from '../core/params';
-export { createClient } from './client';
-export type { Client, ClientOptions, Config, CreateClientConfig, Options, OptionsLegacyParser, RequestOptions, RequestResult, ResponseStyle, TDataShape, } from './types';
-export { createConfig, mergeHeaders } from './utils';
+export type { Auth } from '../core/auth.gen';
+export type { QuerySerializerOptions } from '../core/bodySerializer.gen';
+export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen';
+export { buildClientParams } from '../core/params.gen';
+export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
+export { createClient } from './client.gen';
+export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
+export { createConfig, mergeHeaders } from './utils.gen';

package/dist/client/client/index.js

@@ -1,14 +1,17 @@
 "use strict";
+// This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeHeaders = exports.createConfig = exports.createClient = exports.buildClientParams = exports.urlSearchParamsBodySerializer = exports.jsonBodySerializer = exports.formDataBodySerializer = void 0;
-var bodySerializer_1 = require("../core/bodySerializer");
-Object.defineProperty(exports, "formDataBodySerializer", { enumerable: true, get: function () { return bodySerializer_1.formDataBodySerializer; } });
-Object.defineProperty(exports, "jsonBodySerializer", { enumerable: true, get: function () { return bodySerializer_1.jsonBodySerializer; } });
-Object.defineProperty(exports, "urlSearchParamsBodySerializer", { enumerable: true, get: function () { return bodySerializer_1.urlSearchParamsBodySerializer; } });
-var params_1 = require("../core/params");
-Object.defineProperty(exports, "buildClientParams", { enumerable: true, get: function () { return params_1.buildClientParams; } });
-var client_1 = require("./client");
-Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return utils_1.createConfig; } });
-Object.defineProperty(exports, "mergeHeaders", { enumerable: true, get: function () { return utils_1.mergeHeaders; } });
+exports.mergeHeaders = exports.createConfig = exports.createClient = exports.serializeQueryKeyValue = exports.buildClientParams = exports.urlSearchParamsBodySerializer = exports.jsonBodySerializer = exports.formDataBodySerializer = void 0;
+var bodySerializer_gen_1 = require("../core/bodySerializer.gen");
+Object.defineProperty(exports, "formDataBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.formDataBodySerializer; } });
+Object.defineProperty(exports, "jsonBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.jsonBodySerializer; } });
+Object.defineProperty(exports, "urlSearchParamsBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.urlSearchParamsBodySerializer; } });
+var params_gen_1 = require("../core/params.gen");
+Object.defineProperty(exports, "buildClientParams", { enumerable: true, get: function () { return params_gen_1.buildClientParams; } });
+var queryKeySerializer_gen_1 = require("../core/queryKeySerializer.gen");
+Object.defineProperty(exports, "serializeQueryKeyValue", { enumerable: true, get: function () { return queryKeySerializer_gen_1.serializeQueryKeyValue; } });
+var client_gen_1 = require("./client.gen");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_gen_1.createClient; } });
+var utils_gen_1 = require("./utils.gen");
+Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return utils_gen_1.createConfig; } });
+Object.defineProperty(exports, "mergeHeaders", { enumerable: true, get: function () { return utils_gen_1.mergeHeaders; } });

package/dist/client/client/{types.d.ts → types.gen.d.ts}

@@ -1,6 +1,7 @@
-import type { Auth } from '../core/auth';
-import type { Client as CoreClient, Config as CoreConfig } from '../core/types';
-import type { Middleware } from './utils';
+import type { Auth } from '../core/auth.gen';
+import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen';
+import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
+import type { Middleware } from './utils.gen';
 export type ResponseStyle = 'data' | 'fields';
 export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
     /**
@@ -13,7 +14,7 @@ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<Re
      *
      * @default globalThis.fetch
      */
-    fetch?: (request: Request) => ReturnType<typeof fetch>;
+    fetch?: typeof fetch;
     /**
      * Please don't use the Fetch client for Next.js applications. The `next`
      * options won't have any effect.
@@ -43,10 +44,10 @@ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<Re
      */
     throwOnError?: T['throwOnError'];
 }
-export interface RequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
     responseStyle: TResponseStyle;
     throwOnError: ThrowOnError;
-}> {
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
     /**
      * Any body that you want to add to your request.
      *
@@ -61,6 +62,9 @@ export interface RequestOptions<TResponseStyle extends ResponseStyle = 'fields',
     security?: ReadonlyArray<Auth>;
     url: Url;
 }
+export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    serializedBody?: string;
+}
 export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
     data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
     request: Request;
@@ -80,16 +84,17 @@ export interface ClientOptions {
     responseStyle?: ResponseStyle;
     throwOnError?: boolean;
 }
-type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
-type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
 type BuildUrlFn = <TData extends {
     body?: unknown;
     path?: Record<string, unknown>;
     query?: Record<string, unknown>;
     url: string;
-}>(options: Pick<TData, 'url'> & Options<TData>) => string;
-export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn> & {
-    interceptors: Middleware<Request, Response, unknown, RequestOptions>;
+}>(options: TData & Options<TData>) => string;
+export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
 };
 /**
  * The `createClientConfig()` function will be called on client initialization
@@ -108,12 +113,5 @@ export interface TDataShape {
     url: string;
 }
 type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
-export type OptionsLegacyParser<TData = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = TData extends {
-    body?: any;
-} ? TData extends {
-    headers?: any;
-} ? OmitKeys<RequestOptions<TResponseStyle, ThrowOnError>, 'body' | 'headers' | 'url'> & TData : OmitKeys<RequestOptions<TResponseStyle, ThrowOnError>, 'body' | 'url'> & TData & Pick<RequestOptions<TResponseStyle, ThrowOnError>, 'headers'> : TData extends {
-    headers?: any;
-} ? OmitKeys<RequestOptions<TResponseStyle, ThrowOnError>, 'headers' | 'url'> & TData & Pick<RequestOptions<TResponseStyle, ThrowOnError>, 'body'> : OmitKeys<RequestOptions<TResponseStyle, ThrowOnError>, 'url'> & TData;
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 export {};

package/dist/client/{core/types.js → client/types.gen.js}

@@ -1,2 +1,3 @@
 "use strict";
+// This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });