@storyblok/management-api-client 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/client.mjs

@@ -1,14 +1,16 @@
-import { createConfig } from "./generated/shared/client/utils.gen.mjs";
-import { createClient } from "./generated/shared/client/client.gen.mjs";
-import "./generated/shared/client/index.mjs";
+import { createConfig } from "./generated/mapi/client/utils.gen.mjs";
+import { createClient } from "./generated/mapi/client/client.gen.mjs";
+import "./generated/mapi/client/index.mjs";
 import { ClientError } from "./error.mjs";
 import { createThrottleManager } from "./utils/rate-limit.mjs";
+import { querySerializer } from "./utils/query-serializer.mjs";
 import { createAssetFoldersResource } from "./resources/asset-folders.mjs";
 import { createAssetsResource } from "./resources/assets.mjs";
 import { createComponentFoldersResource } from "./resources/component-folders.mjs";
 import { createComponentsResource } from "./resources/components.mjs";
 import { createDatasourceEntriesResource } from "./resources/datasource-entries.mjs";
 import { createDatasourcesResource } from "./resources/datasources.mjs";
+import { createExperimentsResource } from "./resources/experiments.mjs";
 import { createInternalTagsResource } from "./resources/internal-tags.mjs";
 import { createPresetsResource } from "./resources/presets.mjs";
 import { createSpacesResource } from "./resources/spaces.mjs";
@@ -45,6 +47,7 @@ const createManagementApiClientBase = (config) => {
 			...authHeader ? { Authorization: authHeader } : {},
 			...headers
 		},
+		querySerializer,
 		throwOnError,
 		kyOptions: {
 			throwHttpErrors: true,
@@ -58,11 +61,7 @@ const createManagementApiClientBase = (config) => {
 		data: error
 	}));
 	function wrapRequest(fn, _throwOnError) {
-		return throttleManager.execute(async () => {
-			const result = await fn();
-			throttleManager.adaptToResponse(result.response);
-			return result;
-		});
+		return throttleManager.execute(() => fn());
 	}
 	const deps = {
 		client,
@@ -154,9 +153,9 @@ function buildResources(deps, client) {
 		assetFolders: createAssetFoldersResource(deps),
 		assets: createAssetsResource(deps),
 		componentFolders: createComponentFoldersResource(deps),
-		components: createComponentsResource(deps),
 		datasourceEntries: createDatasourceEntriesResource(deps),
 		datasources: createDatasourcesResource(deps),
+		experiments: createExperimentsResource(deps),
 		delete: httpDelete,
 		get: httpGet,
 		patch: httpPatch,
@@ -176,6 +175,7 @@ const createManagementApiClient = (config) => {
 	const { deps, resources } = createManagementApiClientBase(config);
 	const self = {
 		...resources,
+		components: createComponentsResource(deps),
 		stories: createStoriesResource(deps),
 		withTypes() {
 			return self;

package/dist/client.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"client.mjs","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { Client, ResolvedRequestOptions, RetryOptions } from './generated/shared/client';\nimport type { Middleware } from './generated/shared/client/utils.gen';\nimport { createClient, createConfig } from './generated/shared/client';\nimport { getManagementBaseUrl } from '@storyblok/region-helper';\nimport type { Region } from '@storyblok/region-helper';\nimport type { Block as Component } from '@storyblok/schema';\nimport { ClientError } from './error';\nimport type { RateLimitConfig } from './utils/rate-limit';\nimport { createThrottleManager } from './utils/rate-limit';\nimport { createAssetFoldersResource } from './resources/asset-folders';\nimport { createAssetsResource } from './resources/assets';\nimport { createComponentFoldersResource } from './resources/component-folders';\nimport { createComponentsResource } from './resources/components';\nimport { createDatasourceEntriesResource } from './resources/datasource-entries';\nimport { createDatasourcesResource } from './resources/datasources';\nimport { createInternalTagsResource } from './resources/internal-tags';\nimport { createPresetsResource } from './resources/presets';\nimport { createSpacesResource } from './resources/spaces';\nimport { createStoriesResource } from './resources/stories';\nimport { createUsersResource } from './resources/users';\n\n// ---------------------------------------------------------------------------\n// Client types (co-located with runtime)\n// ---------------------------------------------------------------------------\n\nexport type ApiResponse<T, ThrowOnError extends boolean = false> =\n  ThrowOnError extends true\n    ? { data: T; error?: never; response: Response; request: Request }\n    : | { data: T; error: undefined; response: Response; request: Request }\n      | { data: undefined; error: ClientError; response: Response; request: Request };\n\nexport interface RequestConfigOverrides {\n  throwOnError?: boolean;\n}\n\n/**\n * Arbitrary options forwarded to the underlying `fetch()` call.\n *\n * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and\n * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)\n * are both supported.\n *\n * @example\n * ```ts\n * client.stories.get(123, {\n *   fetchOptions: {\n *     cache: 'no-store',\n *     next: { revalidate: 60 },\n *   },\n * })\n * ```\n */\nexport type FetchOptions = Record<string, unknown>;\n\nexport interface HttpRequestOptions {\n  query?: Record<string, unknown>;\n  body?: unknown;\n  headers?: Record<string, string>;\n  signal?: AbortSignal;\n  throwOnError?: RequestConfigOverrides['throwOnError'];\n  fetchOptions?: FetchOptions;\n}\n\n/**\n * Dependencies injected into every resource factory.\n */\nexport interface MapiResourceDeps<DefaultThrowOnError extends boolean = false> {\n  client: Client;\n  spaceId?: number;\n  wrapRequest: <TData, ThrowOnError extends boolean = DefaultThrowOnError>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;\n}\n\ntype TokenConfig =\n  | {\n    /** Personal access token for authentication. */\n    personalAccessToken: string;\n    oauthToken?: never;\n  }\n  | {\n    personalAccessToken?: never;\n    /** OAuth bearer token for authentication. */\n    oauthToken: string;\n  }\n  | {\n    personalAccessToken?: undefined;\n    oauthToken?: undefined;\n  };\n\nexport type ManagementApiClientConfig<\n  ThrowOnError extends boolean = false,\n> = TokenConfig & {\n  /**\n   * The Storyblok space ID. Used as the default for space-scoped endpoints.\n   * You can also override it per request via `path.space_id`.\n   */\n  spaceId?: number;\n  /**\n   * Storyblok region. Determines the base URL.\n   * @default 'eu'\n   */\n  region?: Region;\n  /**\n   * Override the base URL entirely (e.g. for testing).\n   */\n  baseUrl?: string;\n  /**\n   * Additional request headers.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Throw on HTTP errors instead of returning them.\n   * @default false\n   */\n  throwOnError?: ThrowOnError;\n  /**\n   * Retry configuration for failed requests.\n   */\n  retry?: RetryOptions;\n  /**\n   * Request timeout in milliseconds.\n   * @default 30_000\n   */\n  timeout?: number;\n  /**\n   * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.\n   *\n   * - `undefined` (default): single bucket at maxConcurrency: 6.\n   * - `number`: fixed max concurrent requests per second.\n   * - `{ maxConcurrency?: number; adaptToServerHeaders?: boolean }`: full config.\n   * - `false`: disable rate limiting entirely.\n   */\n  rateLimit?: RateLimitConfig | number | false;\n};\n\n// ---------------------------------------------------------------------------\n// Client factory\n// ---------------------------------------------------------------------------\n\nfunction getAuthorizationHeader(config: ManagementApiClientConfig<boolean>): string | undefined {\n  if (config.personalAccessToken) {\n    return config.personalAccessToken;\n  }\n  if (config.oauthToken) {\n    return config.oauthToken.startsWith('Bearer ')\n      ? config.oauthToken\n      : `Bearer ${config.oauthToken}`;\n  }\n  return undefined;\n}\n\nconst createManagementApiClientBase = <DefaultThrowOnError extends boolean = false>(\n  config: ManagementApiClientConfig<DefaultThrowOnError>,\n): {\n  deps: MapiResourceDeps<DefaultThrowOnError>;\n  resources: Omit<ReturnType<typeof buildResources<DefaultThrowOnError>>, never>;\n} => {\n  const {\n    spaceId,\n    region = 'eu',\n    baseUrl,\n    headers = {},\n    throwOnError = false,\n    retry = {\n      limit: 12,\n      backoffLimit: 20_000,\n      methods: ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'],\n      statusCodes: [429],\n    },\n    timeout = 30_000,\n    rateLimit,\n  } = config;\n\n  const throttleManager = createThrottleManager(rateLimit ?? {});\n  const authHeader = getAuthorizationHeader(config);\n\n  const client: Client = createClient(\n    createConfig({\n      baseUrl: baseUrl || getManagementBaseUrl(region),\n      headers: {\n        ...(authHeader ? { Authorization: authHeader } : {}),\n        ...headers,\n      },\n      throwOnError,\n      kyOptions: {\n        throwHttpErrors: true,\n        timeout,\n        retry,\n      },\n    }),\n  );\n\n  client.interceptors.error.use(\n    (error: unknown, response: Response) =>\n      new ClientError(response?.statusText || 'API request failed', {\n        status: response?.status ?? 0,\n        statusText: response?.statusText ?? '',\n        data: error,\n      }),\n  );\n\n  function wrapRequest<TData, CurrentThrowOnError extends boolean = DefaultThrowOnError>(\n    fn: () => Promise<unknown>,\n    _throwOnError?: CurrentThrowOnError,\n  ): Promise<ApiResponse<TData, CurrentThrowOnError>> {\n    return throttleManager.execute(async () => {\n      const result = await fn() as ApiResponse<TData, CurrentThrowOnError>;\n      throttleManager.adaptToResponse((result as { response: Response }).response);\n      return result;\n    }) as Promise<ApiResponse<TData, CurrentThrowOnError>>;\n  }\n\n  const deps: MapiResourceDeps<DefaultThrowOnError> = { client, spaceId, wrapRequest };\n  return { deps, resources: buildResources(deps, client) };\n};\n\nfunction buildResources<DefaultThrowOnError extends boolean = false>(\n  deps: MapiResourceDeps<DefaultThrowOnError>,\n  client: Client,\n) {\n  /**\n   * Escape hatch: send a GET request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpGet = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.get({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a POST request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPost = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.post({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PUT request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPut = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.put({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PATCH request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPatch = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.patch({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a DELETE request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpDelete = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.delete({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  return {\n    assetFolders: createAssetFoldersResource(deps),\n    assets: createAssetsResource(deps),\n    componentFolders: createComponentFoldersResource(deps),\n    components: createComponentsResource(deps),\n    datasourceEntries: createDatasourceEntriesResource(deps),\n    datasources: createDatasourcesResource(deps),\n    delete: httpDelete,\n    get: httpGet,\n    patch: httpPatch,\n    interceptors: client.interceptors as Middleware<Request, Response, unknown, ResolvedRequestOptions>,\n    internalTags: createInternalTagsResource(deps),\n    post: httpPost,\n    presets: createPresetsResource(deps),\n    put: httpPut,\n    spaces: createSpacesResource(deps),\n    users: createUsersResource<DefaultThrowOnError>({ client, wrapRequest: deps.wrapRequest }),\n  };\n}\n\ntype StoryblokTypesConfig = { components: Component } | { blocks: Component };\n\ntype ResolveComponents<T extends StoryblokTypesConfig> =\n  T extends { components: infer C extends Component } ? C\n    : T extends { blocks: infer B extends Component } ? B\n      : never;\n\n/**\n * The return type of `createManagementApiClient`, parameterised by `TComponents` so that\n * `.stories` methods can narrow story content types without touching the runtime object.\n */\nexport type ManagementApiClient<\n  TComponents extends Component = Component,\n  DefaultThrowOnError extends boolean = false,\n> = ReturnType<typeof buildResources<DefaultThrowOnError>> & {\n  stories: ReturnType<typeof createStoriesResource<TComponents, DefaultThrowOnError>>;\n  /**\n   * Returns the same client instance cast to a version that narrows story content\n   * to the provided component types. No runtime cost — type parameter is erased.\n   *\n   * Accepts either `{ components: ... }` or `{ blocks: ... }` — the latter matches the\n   * `Schema` type produced by `@storyblok/schema`'s `InferSchema`.\n   *\n   * @example\n   * ```ts\n   * import type { Schema } from './schema';\n   *\n   * const client = createManagementApiClient({ personalAccessToken: '...' })\n   *   .withTypes<Schema>();\n   * ```\n   */\n  withTypes: <T extends StoryblokTypesConfig>() => ManagementApiClient<ResolveComponents<T>, DefaultThrowOnError>;\n};\n\nexport const createManagementApiClient = <\n  DefaultThrowOnError extends boolean = false,\n>(\n  config: ManagementApiClientConfig<DefaultThrowOnError>,\n): ManagementApiClient<Component, DefaultThrowOnError> => {\n  const { deps, resources } = createManagementApiClientBase(config);\n  const self: ManagementApiClient<Component, DefaultThrowOnError> = {\n    ...resources,\n    stories: createStoriesResource<Component, DefaultThrowOnError>(deps),\n    withTypes<T extends StoryblokTypesConfig>() {\n      return self as unknown as ManagementApiClient<ResolveComponents<T>, DefaultThrowOnError>;\n    },\n  };\n  return self;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA0IA,SAAS,uBAAuB,QAAgE;AAC9F,KAAI,OAAO,oBACT,QAAO,OAAO;AAEhB,KAAI,OAAO,WACT,QAAO,OAAO,WAAW,WAAW,UAAU,GAC1C,OAAO,aACP,UAAU,OAAO;;AAKzB,MAAM,iCACJ,WAIG;CACH,MAAM,EACJ,SACA,SAAS,MACT,SACA,UAAU,EAAE,EACZ,eAAe,OACf,QAAQ;EACN,OAAO;EACP,cAAc;EACd,SAAS;GAAC;GAAO;GAAQ;GAAO;GAAU;GAAS;GAAQ;GAAW;GAAQ;EAC9E,aAAa,CAAC,IAAI;EACnB,EACD,UAAU,KACV,cACE;CAEJ,MAAM,kBAAkB,sBAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,aAAa,uBAAuB,OAAO;CAEjD,MAAM,SAAiB,aACrB,aAAa;EACX,SAAS,WAAW,qBAAqB,OAAO;EAChD,SAAS;GACP,GAAI,aAAa,EAAE,eAAe,YAAY,GAAG,EAAE;GACnD,GAAG;GACJ;EACD;EACA,WAAW;GACT,iBAAiB;GACjB;GACA;GACD;EACF,CAAC,CACH;AAED,QAAO,aAAa,MAAM,KACvB,OAAgB,aACf,IAAI,YAAY,UAAU,cAAc,sBAAsB;EAC5D,QAAQ,UAAU,UAAU;EAC5B,YAAY,UAAU,cAAc;EACpC,MAAM;EACP,CAAC,CACL;CAED,SAAS,YACP,IACA,eACkD;AAClD,SAAO,gBAAgB,QAAQ,YAAY;GACzC,MAAM,SAAS,MAAM,IAAI;AACzB,mBAAgB,gBAAiB,OAAkC,SAAS;AAC5E,UAAO;IACP;;CAGJ,MAAM,OAA8C;EAAE;EAAQ;EAAS;EAAa;AACpF,QAAO;EAAE;EAAM,WAAW,eAAe,MAAM,OAAO;EAAE;;AAG1D,SAAS,eACP,MACA,QACA;;;;;CAKA,MAAM,WACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,YACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,KAAK;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CAClI;;;;;;CAOH,MAAM,WACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,aACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,MAAM;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACnI;;;;;;CAOH,MAAM,cACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,OAAO;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACpI;;AAGH,QAAO;EACL,cAAc,2BAA2B,KAAK;EAC9C,QAAQ,qBAAqB,KAAK;EAClC,kBAAkB,+BAA+B,KAAK;EACtD,YAAY,yBAAyB,KAAK;EAC1C,mBAAmB,gCAAgC,KAAK;EACxD,aAAa,0BAA0B,KAAK;EAC5C,QAAQ;EACR,KAAK;EACL,OAAO;EACP,cAAc,OAAO;EACrB,cAAc,2BAA2B,KAAK;EAC9C,MAAM;EACN,SAAS,sBAAsB,KAAK;EACpC,KAAK;EACL,QAAQ,qBAAqB,KAAK;EAClC,OAAO,oBAAyC;GAAE;GAAQ,aAAa,KAAK;GAAa,CAAC;EAC3F;;AAqCH,MAAa,6BAGX,WACwD;CACxD,MAAM,EAAE,MAAM,cAAc,8BAA8B,OAAO;CACjE,MAAM,OAA4D;EAChE,GAAG;EACH,SAAS,sBAAsD,KAAK;EACpE,YAA4C;AAC1C,UAAO;;EAEV;AACD,QAAO"}
+{"version":3,"file":"client.mjs","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { Client, ResolvedRequestOptions, RetryOptions } from './generated/mapi/client';\nimport type { Middleware } from './generated/mapi/client/utils.gen';\nimport { createClient, createConfig } from './generated/mapi/client';\nimport { getManagementBaseUrl } from '@storyblok/region-helper';\nimport type { Region } from '@storyblok/region-helper';\nimport type { Block as Component } from './generated/types/block';\nimport { ClientError } from './error';\nimport type { RateLimitConfig } from './utils/rate-limit';\nimport { createThrottleManager } from './utils/rate-limit';\nimport { querySerializer } from './utils/query-serializer';\nimport { createAssetFoldersResource } from './resources/asset-folders';\nimport { createAssetsResource } from './resources/assets';\nimport { createComponentFoldersResource } from './resources/component-folders';\nimport { createComponentsResource } from './resources/components';\nimport { createDatasourceEntriesResource } from './resources/datasource-entries';\nimport { createDatasourcesResource } from './resources/datasources';\nimport { createExperimentsResource } from './resources/experiments';\nimport { createInternalTagsResource } from './resources/internal-tags';\nimport { createPresetsResource } from './resources/presets';\nimport { createSpacesResource } from './resources/spaces';\nimport { createStoriesResource } from './resources/stories';\nimport { createUsersResource } from './resources/users';\n\n// ---------------------------------------------------------------------------\n// Client types (co-located with runtime)\n// ---------------------------------------------------------------------------\n\nexport type ApiResponse<T, ThrowOnError extends boolean = false> =\n  ThrowOnError extends true\n    ? { data: T; error?: never; response: Response; request: Request }\n    : | { data: T; error: undefined; response: Response; request: Request }\n      | { data: undefined; error: ClientError; response: Response; request: Request };\n\nexport interface RequestConfigOverrides {\n  throwOnError?: boolean;\n}\n\n/**\n * Arbitrary options forwarded to the underlying `fetch()` call.\n *\n * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and\n * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)\n * are both supported.\n *\n * @example\n * ```ts\n * client.stories.get(123, {\n *   fetchOptions: {\n *     cache: 'no-store',\n *     next: { revalidate: 60 },\n *   },\n * })\n * ```\n */\nexport type FetchOptions = Record<string, unknown>;\n\nexport interface HttpRequestOptions {\n  query?: Record<string, unknown>;\n  body?: unknown;\n  headers?: Record<string, string>;\n  signal?: AbortSignal;\n  throwOnError?: RequestConfigOverrides['throwOnError'];\n  fetchOptions?: FetchOptions;\n}\n\n/**\n * Dependencies injected into every resource factory.\n */\nexport interface MapiResourceDeps<DefaultThrowOnError extends boolean = false> {\n  client: Client;\n  spaceId?: number;\n  wrapRequest: <TData, ThrowOnError extends boolean = DefaultThrowOnError>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;\n}\n\ntype TokenConfig =\n  | {\n    /** Personal access token for authentication. */\n    personalAccessToken: string;\n    oauthToken?: never;\n  }\n  | {\n    personalAccessToken?: never;\n    /** OAuth bearer token for authentication. */\n    oauthToken: string;\n  }\n  | {\n    personalAccessToken?: undefined;\n    oauthToken?: undefined;\n  };\n\nexport type ManagementApiClientConfig<\n  ThrowOnError extends boolean = false,\n> = TokenConfig & {\n  /**\n   * The Storyblok space ID. Used as the default for space-scoped endpoints.\n   * You can also override it per request via `path.space_id`.\n   */\n  spaceId?: number;\n  /**\n   * Storyblok region. Determines the base URL.\n   * @default 'eu'\n   */\n  region?: Region;\n  /**\n   * Override the base URL entirely (e.g. for testing).\n   */\n  baseUrl?: string;\n  /**\n   * Additional request headers.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Throw on HTTP errors instead of returning them.\n   * @default false\n   */\n  throwOnError?: ThrowOnError;\n  /**\n   * Retry configuration for failed requests.\n   */\n  retry?: RetryOptions;\n  /**\n   * Request timeout in milliseconds.\n   * @default 30_000\n   */\n  timeout?: number;\n  /**\n   * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.\n   *\n   * - `undefined` (default): single bucket at maxConcurrency: 6.\n   * - `number`: fixed max concurrent requests per second.\n   * - `{ maxConcurrency?: number; adaptToServerHeaders?: boolean }`: full config.\n   * - `false`: disable rate limiting entirely.\n   */\n  rateLimit?: RateLimitConfig | number | false;\n};\n\n// ---------------------------------------------------------------------------\n// Client factory\n// ---------------------------------------------------------------------------\n\nfunction getAuthorizationHeader(config: ManagementApiClientConfig<boolean>): string | undefined {\n  if (config.personalAccessToken) {\n    return config.personalAccessToken;\n  }\n  if (config.oauthToken) {\n    return config.oauthToken.startsWith('Bearer ')\n      ? config.oauthToken\n      : `Bearer ${config.oauthToken}`;\n  }\n  return undefined;\n}\n\nconst createManagementApiClientBase = <DefaultThrowOnError extends boolean = false>(\n  config: ManagementApiClientConfig<DefaultThrowOnError>,\n): {\n  deps: MapiResourceDeps<DefaultThrowOnError>;\n  resources: Omit<ReturnType<typeof buildResources<DefaultThrowOnError>>, never>;\n} => {\n  const {\n    spaceId,\n    region = 'eu',\n    baseUrl,\n    headers = {},\n    throwOnError = false,\n    retry = {\n      limit: 12,\n      backoffLimit: 20_000,\n      methods: ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'],\n      statusCodes: [429],\n    },\n    timeout = 30_000,\n    rateLimit,\n  } = config;\n\n  const throttleManager = createThrottleManager(rateLimit ?? {});\n  const authHeader = getAuthorizationHeader(config);\n\n  const client: Client = createClient(\n    createConfig({\n      baseUrl: baseUrl || getManagementBaseUrl(region),\n      headers: {\n        ...(authHeader ? { Authorization: authHeader } : {}),\n        ...headers,\n      },\n      // Default serializer throws on nested objects; MAPI needs `filter_query`\n      // serialized as a nested hash (`filter_query[field][op]=value`).\n      querySerializer,\n      throwOnError,\n      kyOptions: {\n        throwHttpErrors: true,\n        timeout,\n        retry,\n      },\n    }),\n  );\n\n  client.interceptors.error.use(\n    (error: unknown, response: Response) =>\n      new ClientError(response?.statusText || 'API request failed', {\n        status: response?.status ?? 0,\n        statusText: response?.statusText ?? '',\n        data: error,\n      }),\n  );\n\n  function wrapRequest<TData, CurrentThrowOnError extends boolean = DefaultThrowOnError>(\n    fn: () => Promise<unknown>,\n    _throwOnError?: CurrentThrowOnError,\n  ): Promise<ApiResponse<TData, CurrentThrowOnError>> {\n    return throttleManager.execute(\n      () => fn() as Promise<ApiResponse<TData, CurrentThrowOnError>>,\n    );\n  }\n\n  const deps: MapiResourceDeps<DefaultThrowOnError> = { client, spaceId, wrapRequest };\n  return { deps, resources: buildResources(deps, client) };\n};\n\nfunction buildResources<DefaultThrowOnError extends boolean = false>(\n  deps: MapiResourceDeps<DefaultThrowOnError>,\n  client: Client,\n) {\n  /**\n   * Escape hatch: send a GET request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpGet = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.get({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a POST request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPost = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.post({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PUT request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPut = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.put({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PATCH request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPatch = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.patch({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a DELETE request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpDelete = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData, DefaultThrowOnError>> => {\n    const { fetchOptions, ...rest } = options;\n    return deps.wrapRequest<TData>(() =>\n      client.delete({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  return {\n    assetFolders: createAssetFoldersResource(deps),\n    assets: createAssetsResource(deps),\n    componentFolders: createComponentFoldersResource(deps),\n    datasourceEntries: createDatasourceEntriesResource(deps),\n    datasources: createDatasourcesResource(deps),\n    experiments: createExperimentsResource(deps),\n    delete: httpDelete,\n    get: httpGet,\n    patch: httpPatch,\n    interceptors: client.interceptors as Middleware<Request, Response, unknown, ResolvedRequestOptions>,\n    internalTags: createInternalTagsResource(deps),\n    post: httpPost,\n    presets: createPresetsResource(deps),\n    put: httpPut,\n    spaces: createSpacesResource(deps),\n    users: createUsersResource<DefaultThrowOnError>({ client, wrapRequest: deps.wrapRequest }),\n  };\n}\n\ntype StoryblokTypesConfig = { components: Component } | { blocks: Component };\n\ntype ResolveComponents<T extends StoryblokTypesConfig> =\n  T extends { components: infer C extends Component } ? C\n    : T extends { blocks: infer B extends Component } ? B\n      : never;\n\n/**\n * The return type of `createManagementApiClient`, parameterised by `TComponents` so that\n * `.stories` methods can narrow story content types without touching the runtime object.\n */\nexport type ManagementApiClient<\n  TComponents extends Component = Component,\n  DefaultThrowOnError extends boolean = false,\n> = ReturnType<typeof buildResources<DefaultThrowOnError>> & {\n  components: ReturnType<typeof createComponentsResource<TComponents, DefaultThrowOnError>>;\n  stories: ReturnType<typeof createStoriesResource<TComponents, DefaultThrowOnError>>;\n  /**\n   * Returns the same client instance cast to a version that narrows story content\n   * to the provided component types. No runtime cost — type parameter is erased.\n   *\n   * Accepts either `{ components: ... }` or `{ blocks: ... }` — the latter matches the\n   * `Schema` type produced by `@storyblok/schema`'s `InferSchema`.\n   *\n   * @example\n   * ```ts\n   * import type { Schema } from './schema';\n   *\n   * const client = createManagementApiClient({ personalAccessToken: '...' })\n   *   .withTypes<Schema>();\n   * ```\n   */\n  withTypes: <T extends StoryblokTypesConfig>() => ManagementApiClient<ResolveComponents<T>, DefaultThrowOnError>;\n};\n\nexport const createManagementApiClient = <\n  DefaultThrowOnError extends boolean = false,\n>(\n  config: ManagementApiClientConfig<DefaultThrowOnError>,\n): ManagementApiClient<Component, DefaultThrowOnError> => {\n  const { deps, resources } = createManagementApiClientBase(config);\n  const self: ManagementApiClient<Component, DefaultThrowOnError> = {\n    ...resources,\n    components: createComponentsResource<Component, DefaultThrowOnError>(deps),\n    stories: createStoriesResource<Component, DefaultThrowOnError>(deps),\n    withTypes<T extends StoryblokTypesConfig>() {\n      return self as unknown as ManagementApiClient<ResolveComponents<T>, DefaultThrowOnError>;\n    },\n  };\n  return self;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4IA,SAAS,uBAAuB,QAAgE;AAC9F,KAAI,OAAO,oBACT,QAAO,OAAO;AAEhB,KAAI,OAAO,WACT,QAAO,OAAO,WAAW,WAAW,UAAU,GAC1C,OAAO,aACP,UAAU,OAAO;;AAKzB,MAAM,iCACJ,WAIG;CACH,MAAM,EACJ,SACA,SAAS,MACT,SACA,UAAU,EAAE,EACZ,eAAe,OACf,QAAQ;EACN,OAAO;EACP,cAAc;EACd,SAAS;GAAC;GAAO;GAAQ;GAAO;GAAU;GAAS;GAAQ;GAAW;GAAQ;EAC9E,aAAa,CAAC,IAAI;EACnB,EACD,UAAU,KACV,cACE;CAEJ,MAAM,kBAAkB,sBAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,aAAa,uBAAuB,OAAO;CAEjD,MAAM,SAAiB,aACrB,aAAa;EACX,SAAS,WAAW,qBAAqB,OAAO;EAChD,SAAS;GACP,GAAI,aAAa,EAAE,eAAe,YAAY,GAAG,EAAE;GACnD,GAAG;GACJ;EAGD;EACA;EACA,WAAW;GACT,iBAAiB;GACjB;GACA;GACD;EACF,CAAC,CACH;AAED,QAAO,aAAa,MAAM,KACvB,OAAgB,aACf,IAAI,YAAY,UAAU,cAAc,sBAAsB;EAC5D,QAAQ,UAAU,UAAU;EAC5B,YAAY,UAAU,cAAc;EACpC,MAAM;EACP,CAAC,CACL;CAED,SAAS,YACP,IACA,eACkD;AAClD,SAAO,gBAAgB,cACf,IAAI,CACX;;CAGH,MAAM,OAA8C;EAAE;EAAQ;EAAS;EAAa;AACpF,QAAO;EAAE;EAAM,WAAW,eAAe,MAAM,OAAO;EAAE;;AAG1D,SAAS,eACP,MACA,QACA;;;;;CAKA,MAAM,WACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,YACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,KAAK;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CAClI;;;;;;CAOH,MAAM,WACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,aACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,MAAM;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACnI;;;;;;CAOH,MAAM,cACJ,MACA,UAA8B,EAAE,KACqB;EACrD,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,KAAK,kBACV,OAAO,OAAO;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACpI;;AAGH,QAAO;EACL,cAAc,2BAA2B,KAAK;EAC9C,QAAQ,qBAAqB,KAAK;EAClC,kBAAkB,+BAA+B,KAAK;EACtD,mBAAmB,gCAAgC,KAAK;EACxD,aAAa,0BAA0B,KAAK;EAC5C,aAAa,0BAA0B,KAAK;EAC5C,QAAQ;EACR,KAAK;EACL,OAAO;EACP,cAAc,OAAO;EACrB,cAAc,2BAA2B,KAAK;EAC9C,MAAM;EACN,SAAS,sBAAsB,KAAK;EACpC,KAAK;EACL,QAAQ,qBAAqB,KAAK;EAClC,OAAO,oBAAyC;GAAE;GAAQ,aAAa,KAAK;GAAa,CAAC;EAC3F;;AAsCH,MAAa,6BAGX,WACwD;CACxD,MAAM,EAAE,MAAM,cAAc,8BAA8B,OAAO;CACjE,MAAM,OAA4D;EAChE,GAAG;EACH,YAAY,yBAAyD,KAAK;EAC1E,SAAS,sBAAsD,KAAK;EACpE,YAA4C;AAC1C,UAAO;;EAEV;AACD,QAAO"}

package/dist/generated/mapi/_internal.gen.d.cts

@@ -0,0 +1,541 @@
+//#region src/generated/mapi/_internal.gen.d.ts
+type ComponentCreate = {
+  /**
+   * Name of the component
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string;
+  /**
+   * Component description
+   */
+  description?: string;
+  /**
+   * Preview template HTML
+   */
+  preview_tmpl?: string;
+  /**
+   * Component image URL
+   */
+  image?: string;
+  /**
+   * Field used for preview
+   */
+  preview_field?: string;
+  /**
+   * Whether this component can be used as a root component
+   */
+  is_root?: boolean;
+  /**
+   * Whether this component can be nested inside other components
+   */
+  is_nestable?: boolean;
+  /**
+   * Default preset ID
+   */
+  preset_id?: number;
+  /**
+   * UUID
+   */
+  component_group_uuid?: string;
+  /**
+   * Component color for UI display
+   */
+  color?: string;
+  /**
+   * Component icon name
+   */
+  icon?: string;
+  /**
+   * Asset preview URL for content type
+   */
+  content_type_asset_preview?: string;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<number>;
+  /**
+   * Component field schema definition
+   */
+  schema?: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Human-readable field name
+       */
+      display_name?: string;
+      /**
+       * Whether this field is required
+       */
+      required?: boolean;
+      /**
+       * Whether this field is translatable
+       */
+      translatable?: boolean;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
+    };
+  };
+  /**
+   * Component metadata
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+type ComponentUpdate = {
+  /**
+   * Name of the component
+   */
+  name?: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string;
+  /**
+   * Component description
+   */
+  description?: string;
+  /**
+   * Preview template HTML
+   */
+  preview_tmpl?: string;
+  /**
+   * Component image URL
+   */
+  image?: string;
+  /**
+   * Field used for preview
+   */
+  preview_field?: string;
+  /**
+   * Whether this component can be used as a root component
+   */
+  is_root?: boolean;
+  /**
+   * Whether this component can be nested inside other components
+   */
+  is_nestable?: boolean;
+  /**
+   * Default preset ID
+   */
+  preset_id?: number;
+  /**
+   * UUID
+   */
+  component_group_uuid?: string;
+  /**
+   * Component color for UI display
+   */
+  color?: string;
+  /**
+   * Component icon name
+   */
+  icon?: string;
+  /**
+   * Asset preview URL for content type
+   */
+  content_type_asset_preview?: string;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<number>;
+  /**
+   * Component field schema definition
+   */
+  schema?: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Human-readable field name
+       */
+      display_name?: string;
+      /**
+       * Whether this field is required
+       */
+      required?: boolean;
+      /**
+       * Whether this field is translatable
+       */
+      translatable?: boolean;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
+    };
+  };
+  /**
+   * Component metadata
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+type MapiStory = {
+  name: string;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number | null;
+  group_id: string;
+  alternates: Array<Alternate>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  deleted_at: string | null;
+  sort_by_date: string | null;
+  tag_list: Array<string>;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  readonly id: number;
+  /**
+   * Unique UUID identifier for the discussion.
+   */
+  readonly uuid: string;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  published: boolean | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  path: string | null;
+  full_slug: string;
+  /**
+   * The default root
+   */
+  default_root: string | null;
+  disble_fe_editor: boolean;
+  disable_fe_editor: boolean;
+  /**
+   * Parent story object (for nested stories).
+   */
+  parent: {
+    id?: number;
+    uuid?: string;
+    name?: string;
+    slug?: string;
+    disble_fe_editor?: boolean;
+  } | null;
+  /**
+   * true if the story is defined as the startpage for its parent folder.
+   */
+  is_startpage: boolean;
+  unpublished_changes: boolean | null;
+  /**
+   * Custom metadata for the story
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Base version ID(common ancestor) for the story, used for three-way merge operations)
+   */
+  base_version_id?: number | null;
+  /**
+   * Main version ID, current version in main
+   */
+  main_version_id?: number | null;
+  /**
+   * Current version ID, current version in release or main
+   */
+  current_version_id?: number | null;
+  imported_at: string | null;
+  /**
+   * Preview token for the story.
+   */
+  preview_token: {
+    token: string;
+    timestamp: string;
+  };
+  pinned: boolean;
+  /**
+   * List of breadcrumbs for the story.
+   */
+  breadcrumbs: Array<Breadcrumb>;
+  publish_at: string | null;
+  expire_at: string | null;
+  first_published_at: string | null;
+  last_author: {
+    id?: number;
+    userid: string;
+    friendly_name: string;
+    avatar?: string;
+  } | null;
+  last_author_id: number | null;
+  /**
+   * List of user IDs this story belongs to (read-only, set automatically via workflow or workflow stage changes)
+   */
+  user_ids: Array<number>;
+  /**
+   * Space role IDs (read-only, set automatically via workflow or workflow stage changes)
+   */
+  space_role_ids: Array<number>;
+  /**
+   * List of translated slugs for the story
+   */
+  translated_slugs: Array<StoryTranslatedSlug>;
+  /**
+   * List of translated versions of this story
+   */
+  translated_stories: Array<{
+    /**
+     * First published time for this translation
+     */
+    first_published_at: string;
+    /**
+     * published time
+     */
+    published_at: string;
+    /**
+     * Language code for this translation
+     */
+    lang: string;
+    /**
+     * Whether this translation has unpublished changes
+     */
+    unpublished_changes: boolean;
+  }>;
+  /**
+   * List of localized paths for the story.
+   */
+  localized_paths: Array<StoryLocalizedPath>;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  can_not_view: boolean | null;
+  is_scheduled: boolean | null;
+  scheduled_dates: string | null;
+  /**
+   * List of ideas associated with this story.
+   */
+  ideas: Array<{
+    /**
+     * Idea ID
+     */
+    id: string;
+    /**
+     * Idea name
+     */
+    name: string;
+    /**
+     * Author ID
+     */
+    author_id: number;
+    /**
+     * Whether idea is private
+     */
+    is_private: boolean;
+  }>;
+  /**
+   * Workflow stage information (only included when show_stage is true)
+   */
+  stage?: Stage | null;
+  /**
+   * List of user IDs
+   */
+  favourite_for_user_ids: Array<number>;
+  /**
+   * Variant type (null for regular stories, 'experiment' for A/B test variants).
+   */
+  variant_type?: string | null;
+  /**
+   * IDs of experiments this story participates in (only included on show, not index).
+   */
+  experiment_ids?: Array<number>;
+};
+type StoryCreate = {
+  name?: string;
+  disble_fe_editor?: boolean;
+  disable_fe_editor?: boolean;
+  /**
+   * The default root
+   */
+  default_root?: string | null;
+  is_folder?: boolean;
+  group_id?: string;
+  path?: string | null;
+  slug?: string;
+  is_startpage?: boolean;
+  /**
+   * ID of the parent folder. Can be null or 0 for root-level stories.
+   */
+  parent_id?: number | null;
+  sort_by_date?: string | null;
+  meta_data?: {
+    [key: string]: unknown;
+  } | null;
+  publish_at?: string | null;
+  expire_at?: string | null;
+  first_published_at?: string | null;
+  pinned?: boolean;
+  position?: number;
+  tag_list?: Array<string>;
+  base_version_id?: number | null;
+  /**
+   * Array of translated slug attributes for creating or updating translated slugs.
+   */
+  translated_slugs_attributes?: Array<{
+    /**
+     * ID of the translated slug (required for updates, omit for new records)
+     */
+    id?: number;
+    /**
+     * The slug for this translated slug (required)
+     */
+    slug?: string;
+    /**
+     * The name for this translated slug
+     */
+    name?: string | null;
+    /**
+     * The language code for this translation
+     */
+    lang?: string;
+    /**
+     * Set to true to mark this translated slug for deletion when the story is saved
+     */
+    _destroy?: boolean | null;
+  }> | null;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component
+   */
+  content?: {
+    [key: string]: unknown;
+  };
+};
+type StoryUpdate = StoryCreate;
+type Alternate = {
+  id: number;
+  name: string;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number;
+};
+type Breadcrumb = {
+  /**
+   * Breadcrumb ID
+   */
+  id: number;
+  /**
+   * Name of the breadcrumb
+   */
+  name: string;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number | null;
+  /**
+   * Disable frontend editor (legacy typo field). Deprecated: use disable_fe_editor instead of disble_fe_editor.
+   */
+  disble_fe_editor: boolean;
+  /**
+   * Disable frontend editor
+   */
+  disable_fe_editor: boolean;
+  /**
+   * Path of the breadcrumb
+   */
+  path: string | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  /**
+   * List of translated slugs for the breadcrumb
+   */
+  translated_slugs: Array<StoryTranslatedSlug>;
+};
+type StoryTranslatedSlug = {
+  /**
+   * id
+   */
+  id: number;
+  /**
+   * The name for this translated slug
+   */
+  name: string | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  published: boolean | null;
+};
+type StoryLocalizedPath = {
+  /**
+   * The localized path
+   */
+  path: string;
+  /**
+   * The translated name
+   */
+  name: string | null;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  /**
+   * Published status or date
+   */
+  published: boolean | string | null;
+  /**
+   * The translated slug (only present when folders are used).
+   */
+  translated_slug?: string;
+};
+type Stage = {
+  /**
+   * The workflow ID
+   */
+  workflow_id: number | null;
+  /**
+   * The workflow stage ID
+   */
+  workflow_stage_id: number;
+  /**
+   * The story ID
+   */
+  story_id: number;
+  /**
+   * The due date for this workflow stage
+   */
+  due_date: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+};
+//#endregion
+export { ComponentCreate, ComponentUpdate, MapiStory, StoryCreate, StoryUpdate };
+//# sourceMappingURL=_internal.gen.d.cts.map