@remkoj/optimizely-cms-api 5.1.5 → 6.0.0-pre10

package/dist/client/{models/BooleanProperty.js → 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 });

package/dist/client-config.d.ts

@@ -0,0 +1,5 @@
+import type { ClientOptions, Config } from './client/client';
+import { type CmsIntegrationApiOptions } from "./config";
+type CreateConfig<T extends ClientOptions = ClientOptions> = (config?: Config<ClientOptions & T>, apiConfig?: CmsIntegrationApiOptions) => Config<Required<ClientOptions> & T>;
+export declare const createClientConfig: CreateConfig;
+export {};

package/dist/client-config.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClientConfig = void 0;
+const config_1 = require("./config");
+const getaccesstoken_1 = require("./getaccesstoken");
+const createClientConfig = (config, apiConfig) => {
+    const envConfig = apiConfig || (0, config_1.readPartialEnvConfig)();
+    const baseUrl = config?.baseUrl && !config.baseUrl.startsWith('/') ? new URL(config.baseUrl) : envConfig?.base ? new URL(config?.baseUrl ?? '/', envConfig.base) : undefined;
+    // If we don't have a valid base URL just return the config as given
+    if (!baseUrl)
+        return { ...config };
+    if (!baseUrl.pathname.endsWith('/'))
+        baseUrl.pathname = baseUrl.pathname + '/';
+    if (envConfig.debug)
+        process.stdout.write(`⚪ [CMS API] Creating API-Client for ${baseUrl.href} as ${envConfig.actAs ?? envConfig.clientId}\n`);
+    const authBaseUrl = baseUrl.hostname === 'api.cms.optimizely.com' ?
+        new URL("/", baseUrl) :
+        baseUrl;
+    let clientToken = undefined;
+    const newClientConfig = {
+        security: [{
+                in: 'header',
+                name: 'Authorization',
+                scheme: 'bearer',
+                type: 'apiKey'
+            }],
+        auth: async (auth) => {
+            if (auth.type !== 'apiKey' || auth.scheme !== 'bearer') {
+                if (envConfig.debug)
+                    console.error(`❌ [CMS API] Unsupported auth model`, auth);
+                return undefined;
+            }
+            if (typeof (clientToken) !== 'string' || clientToken.length == 0) {
+                try {
+                    const token = await (0, getaccesstoken_1.getAccessToken)(envConfig, authBaseUrl.href);
+                    clientToken = token;
+                    if (envConfig.debug)
+                        console.log(`🔑 [CMS API] Using new token`);
+                }
+                catch (error) {
+                    if (envConfig.debug)
+                        console.error(`❌ [CMS API] Error while resolving the Access Token`, error);
+                    clientToken = undefined;
+                }
+            }
+            else if (envConfig.debug)
+                console.log(`🔑 [CMS API] Using previously generated token`);
+            return clientToken;
+        },
+        ...config,
+        baseUrl: baseUrl.href,
+    };
+    return newClientConfig;
+};
+exports.createClientConfig = createClientConfig;

package/dist/config.d.ts

@@ -1,6 +1,6 @@
 import { OptiCmsVersion } from './types';
 export type CmsIntegrationApiOptions = {
-    base: URL;
+    base?: URL;
     clientId?: string;
     clientSecret?: string;
     actAs?: string;
@@ -10,4 +10,7 @@ export type CmsIntegrationApiOptions = {
      */
     cmsVersion?: OptiCmsVersion;
 };
-export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;
+type ClientCredentials = 'clientId' | 'clientSecret' | 'cmsVersion';
+export declare function readPartialEnvConfig(): CmsIntegrationApiOptions;
+export declare function readEnvConfig(): Omit<CmsIntegrationApiOptions, ClientCredentials> & Pick<Required<CmsIntegrationApiOptions>, ClientCredentials>;
+export {};

package/dist/config.js

@@ -1,29 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
-const OpenAPI_1 = require("./client/core/OpenAPI");
+exports.readPartialEnvConfig = readPartialEnvConfig;
+exports.readEnvConfig = readEnvConfig;
 const types_1 = require("./types");
-function getCmsIntegrationApiConfigFromEnvironment() {
-    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL', 'https://example.cms.optimizely.com');
-    const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
-    const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
+function readPartialEnvConfig() {
+    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL');
+    const clientId = getOptional('OPTIMIZELY_CMS_CLIENT_ID');
+    const clientSecret = getOptional('OPTIMIZELY_CMS_CLIENT_SECRET');
     const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');
     const debug = getOptional('OPTIMIZELY_DEBUG', "0") == "1";
-    const cmsVersion = getSelection('OPTIMIZELY_CMS_SCHEMA', [types_1.OptiCmsVersion.CMS12, types_1.OptiCmsVersion.CMS13], types_1.OptiCmsVersion.CMS13);
-    let baseUrl;
-    try {
-        const cmsUrlAdjusted = cmsUrl.includes("://") ? cmsUrl : 'https://' + cmsUrl;
-        baseUrl = new URL(OpenAPI_1.OpenAPI.BASE, cmsUrlAdjusted);
-        if (cmsVersion == types_1.OptiCmsVersion.CMS12)
-            baseUrl.pathname = baseUrl.pathname.replace('preview2', 'preview1');
-    }
-    catch (e) {
-        throw new Error("Invalid Optimizely CMS URL provided");
+    const cmsVersion = getSelection('OPTIMIZELY_CMS_SCHEMA', [types_1.OptiCmsVersion.CMS12, types_1.OptiCmsVersion.CMS13, types_1.OptiCmsVersion.CMSSAAS], types_1.OptiCmsVersion.CMSSAAS);
+    // Determine the base, if set by the config
+    let base;
+    if (cmsUrl) {
+        try {
+            base = new URL(cmsUrl.includes("://") ? cmsUrl : 'https://' + cmsUrl);
+        }
+        catch (e) {
+            throw new Error("Invalid Optimizely CMS URL provided");
+        }
     }
     if (debug)
-        console.log(`[Optimizely CMS API] Connecting to ${baseUrl} as ${clientId}`);
+        console.log(`[Optimizely CMS API] Connecting to ${base || 'CMS API HOST'} as ${clientId ?? 'Anonymous'}`);
     return {
-        base: baseUrl,
+        base,
         clientId,
         clientSecret,
         actAs,
@@ -31,6 +31,14 @@ function getCmsIntegrationApiConfigFromEnvironment() {
         cmsVersion
     };
 }
+function readEnvConfig() {
+    const partialConfig = readPartialEnvConfig();
+    if (!partialConfig.clientId)
+        throw new Error("The Client ID (OPTIMIZELY_CMS_CLIENT_ID) is a required environment variable");
+    if (!partialConfig.clientSecret)
+        throw new Error("The Client Secret (OPTIMIZELY_CMS_CLIENT_SECRET) is a required environment variable");
+    return partialConfig;
+}
 function getOptional(variable, defaultValue) {
     const envValue = process.env[variable];
     if (!envValue || envValue == "")

package/dist/getaccesstoken.d.ts

@@ -1,3 +1,3 @@
 import { type CmsIntegrationApiOptions } from "./config";
-export declare function getAccessToken(config?: CmsIntegrationApiOptions): Promise<string>;
+export declare function getAccessToken(config?: CmsIntegrationApiOptions, baseUrl?: string): Promise<string>;
 export default getAccessToken;

package/dist/getaccesstoken.js

@@ -2,23 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAccessToken = getAccessToken;
 const config_1 = require("./config");
-const OpenAPI_1 = require("./client/core/OpenAPI");
-const types_1 = require("./types");
 function isErrorResponse(response) {
     return typeof (response.error) == 'string';
 }
-async function getAccessToken(config) {
-    const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-    let authUrl = new URL(`${OpenAPI_1.OpenAPI.BASE}/oauth/token`, options.base).href;
+async function getAccessToken(config, baseUrl) {
+    const options = config ?? (0, config_1.readEnvConfig)();
+    const authUrl = new URL(`oauth/token`, baseUrl ?? options.base ?? 'https://api.cms.optimizely.com/').href;
     const headers = new Headers();
-    if (options.cmsVersion == types_1.OptiCmsVersion.CMS12)
-        authUrl = authUrl.replace('preview2', 'preview1');
-    headers.append('Authorization', `Basic ${base64Encode(`${options.clientId}:${options.clientSecret}`)}`);
+    if (!options.clientId || !options.clientSecret) {
+        if (options.debug)
+            console.log(`❌ [CMS API] Skipping authentication due to missing clientId or clientSecret`);
+        return '';
+    }
+    headers.append('Authorization', `Basic ${base64Encode(`${options.clientId ?? ''}:${options.clientSecret ?? ''}`)}`);
     headers.append('Content-Type', 'application/x-www-form-urlencoded');
     headers.append('Connection', 'close');
     if (options.debug) {
         console.log(`⚪ [CMS API] Using authentication endpoint: ${authUrl}`);
-        console.log(`⚪ [CMS API] Retrieving new credentials for ${options.clientId}, acting as ${options.actAs ?? options.clientId ?? '-'}`);
+        console.log(`⚪ [CMS API] Retrieving new credentials for ${options.clientId ?? '-'}${options.actAs ? ", acting as " + options.actAs : ""}`);
     }
     const body = new URLSearchParams();
     body.append("grant_type", "client_credentials");

package/dist/index.d.ts

@@ -1,13 +1,14 @@
 export * from './config';
-export * as IntegrationApi from './client';
-export { CmsIntegrationApiClient as CoreClient } from './client';
-export { ApiClient } from './api-client';
-export { ApiClient as CmsIntegrationApiClient } from './api-client';
+export * as IntegrationApi from './client/types.gen';
+export * as Preview2IntegrationApi from './instance.client/types.gen';
+export { ApiClient, ApiError, ApiClient as CoreClient, type ApiClientStatic, type CmsIntegrationApiClient } from './api-client';
 export { OptiCmsVersion } from "./types";
 import { type CmsIntegrationApiOptions } from './config';
-import { ApiClient as CmsIntegrationApiClient } from './api-client';
-export type ApiClientInstance = InstanceType<typeof CmsIntegrationApiClient>;
+import { type CmsIntegrationApiClient } from './api-client';
+export { readEnvConfig } from './config';
+export type ApiClientInstance = CmsIntegrationApiClient;
 export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;
+export declare function isClientInstance(value?: object): value is CmsIntegrationApiClient;
 export declare enum ContentRoots {
     /**
      * The Global root node of the Content Tree

package/dist/index.js

@@ -36,21 +36,28 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeKeys = exports.ContentRoots = exports.OptiCmsVersion = exports.CmsIntegrationApiClient = exports.ApiClient = exports.CoreClient = exports.IntegrationApi = void 0;
+exports.ContentTypeKeys = exports.ContentRoots = exports.readEnvConfig = exports.OptiCmsVersion = exports.CoreClient = exports.ApiError = exports.ApiClient = exports.Preview2IntegrationApi = exports.IntegrationApi = void 0;
 exports.createClient = createClient;
+exports.isClientInstance = isClientInstance;
 __exportStar(require("./config"), exports);
-exports.IntegrationApi = __importStar(require("./client"));
-var client_1 = require("./client");
-Object.defineProperty(exports, "CoreClient", { enumerable: true, get: function () { return client_1.CmsIntegrationApiClient; } });
+exports.IntegrationApi = __importStar(require("./client/types.gen"));
+exports.Preview2IntegrationApi = __importStar(require("./instance.client/types.gen"));
 var api_client_1 = require("./api-client");
 Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
-var api_client_2 = require("./api-client");
-Object.defineProperty(exports, "CmsIntegrationApiClient", { enumerable: true, get: function () { return api_client_2.ApiClient; } });
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return api_client_1.ApiError; } });
+Object.defineProperty(exports, "CoreClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "OptiCmsVersion", { enumerable: true, get: function () { return types_1.OptiCmsVersion; } });
-const api_client_3 = require("./api-client");
+const api_client_2 = require("./api-client");
+var config_1 = require("./config");
+Object.defineProperty(exports, "readEnvConfig", { enumerable: true, get: function () { return config_1.readEnvConfig; } });
 function createClient(config) {
-    return new api_client_3.ApiClient(config);
+    return new api_client_2.ApiClient(config);
+}
+function isClientInstance(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    return typeof value['getInstanceInfo'] === 'function';
 }
 var ContentRoots;
 (function (ContentRoots) {

package/dist/instance.client/client/client.gen.d.ts

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

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

@@ -0,0 +1,208 @@
+"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 = await _fetch(request);
+        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 'json':
+                case 'text':
+                    data = await response[parseAs]();
+                    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;
+            },
+            url,
+        });
+    };
+    return {
+        buildUrl: utils_gen_2.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/instance.client/client/index.d.ts

@@ -0,0 +1,8 @@
+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, OptionsLegacyParser, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
+export { createConfig, mergeHeaders } from './utils.gen';

package/dist/instance.client/client/index.js

@@ -0,0 +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.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/instance.client/client/types.gen.d.ts

@@ -0,0 +1,124 @@
+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 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+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>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    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;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    request: Request;
+    response: Response;
+}>;
+export interface ClientOptions {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+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, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
+export interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+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'> & 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<unknown, TResponseStyle, ThrowOnError>, 'body' | 'headers' | 'url'> & TData : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'> : TData extends {
+    headers?: any;
+} ? OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'> : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> & TData;
+export {};

package/dist/{client/models/BinaryProperty.js → instance.client/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 });