@storyblok/api-client 0.1.0

package/dist/generated/tags/types.gen.d.mts

@@ -0,0 +1,44 @@
+//#region src/generated/tags/types.gen.d.ts
+type TagCapi = {
+  /**
+   * The name of the tag
+   */
+  name: string;
+  /**
+   * The number of stories tagged with this tag
+   */
+  taggings_count: number;
+};
+type GetAllData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Filter by tag name prefix
+     */
+    starts_with?: string;
+    /**
+     * Version to retrieve
+     */
+    version?: 'published' | 'draft';
+  };
+  url: '/v2/cdn/tags';
+};
+type GetAllResponses = {
+  /**
+   * Array of tags
+   */
+  200: {
+    /**
+     * Array of tag objects
+     */
+    tags: Array<TagCapi>;
+    /**
+     * Cache version Unix timestamp
+     */
+    cv?: number;
+  };
+};
+//#endregion
+export { GetAllData, GetAllResponses, TagCapi };
+//# sourceMappingURL=types.gen.d.mts.map

package/dist/index.cjs

@@ -0,0 +1,155 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
+const require_utils_gen = require('./generated/shared/client/utils.gen.cjs');
+const require_client_gen = require('./generated/shared/client/client.gen.cjs');
+require('./generated/shared/client/index.cjs');
+const require_cache = require('./utils/cache.cjs');
+const require_error = require('./error.cjs');
+const require_rate_limit = require('./utils/rate-limit.cjs');
+const require_request = require('./utils/request.cjs');
+const require_cv = require('./utils/cv.cjs');
+const require_stories = require('./resources/stories.cjs');
+const require_links = require('./resources/links.cjs');
+const require_tags = require('./resources/tags.cjs');
+const require_datasources = require('./resources/datasources.cjs');
+const require_datasource_entries = require('./resources/datasource-entries.cjs');
+const require_spaces = require('./resources/spaces.cjs');
+let _storyblok_region_helper = require("@storyblok/region-helper");
+
+//#region src/index.ts
+const createApiClient = (config) => {
+	const { accessToken, region = "eu", baseUrl, headers = {}, throwOnError = false, cache = {}, inlineRelations = false, retry, timeout = 3e4, rateLimit, fetch: customFetch } = config;
+	const retryOptions = {
+		limit: 3,
+		backoffLimit: 2e4,
+		jitter: true,
+		...retry
+	};
+	const throttleManager = require_rate_limit.createThrottleManager(rateLimit ?? {});
+	const cacheProvider = cache.provider ?? require_cache.createMemoryCacheProvider();
+	const strategy = cache.strategy ? typeof cache.strategy === "string" ? require_cache.createStrategy(cache.strategy) : cache.strategy : require_cache.createStrategy("cache-first");
+	const cacheTtlMs = cache.ttlMs ?? 6e4;
+	const cacheFlush = cache.flush ?? "auto";
+	let currentCv;
+	const client = require_client_gen.createClient(require_utils_gen.createConfig({
+		auth: accessToken,
+		baseUrl: baseUrl || (0, _storyblok_region_helper.getRegionBaseUrl)(region),
+		headers,
+		throwOnError,
+		kyOptions: {
+			throwHttpErrors: true,
+			timeout,
+			retry: retryOptions,
+			...customFetch && { fetch: customFetch }
+		}
+	}));
+	client.interceptors.error.use((error, response) => new require_error.ClientError(response?.statusText || "API request failed", {
+		status: response?.status ?? 0,
+		statusText: response?.statusText ?? "",
+		data: error
+	}));
+	const security = [{
+		in: "query",
+		name: "token",
+		type: "apiKey"
+	}];
+	const updateCv = async (result) => {
+		const nextCv = require_cv.extractCv(result.data);
+		if (nextCv === void 0) return true;
+		if (currentCv !== void 0 && nextCv < currentCv) return false;
+		if (cacheFlush === "auto" && currentCv !== void 0 && currentCv !== nextCv) await cacheProvider.flush();
+		currentCv = nextCv;
+		return true;
+	};
+	const cacheSuccessResult = async (key, result) => {
+		const shouldCacheResult = await updateCv(result);
+		if (result.error === void 0 && shouldCacheResult) await cacheProvider.set(key, {
+			value: result,
+			ttlMs: cacheTtlMs
+		});
+		return result;
+	};
+	const requestNetwork = async (method, path, query, options) => {
+		return client.request({
+			...options,
+			method,
+			query,
+			security,
+			url: path
+		});
+	};
+	/**
+	* Wraps a raw SDK call to cast the `error: unknown` type returned by
+	* generated code to `ClientError` — the error interceptor ensures the
+	* runtime value IS a ClientError.
+	*/
+	const asApiResponse = (p) => p;
+	const requestWithCache = async (method, path, rawQuery, fetchFn) => {
+		const query = currentCv !== void 0 ? require_cv.applyCvToQuery(rawQuery, currentCv) : rawQuery;
+		if (!require_request.shouldUseCache(method, path, rawQuery)) {
+			const networkResult = await fetchFn(query);
+			throttleManager.adaptToResponse(networkResult.response);
+			await updateCv(networkResult);
+			return networkResult;
+		}
+		const key = require_request.createCacheKey(method, path, rawQuery);
+		const cachedResult = (await cacheProvider.get(key))?.value;
+		const loadNetwork = async () => {
+			const result = await fetchFn(query);
+			throttleManager.adaptToResponse(result.response);
+			return cacheSuccessResult(key, result);
+		};
+		return strategy({
+			key,
+			cachedResult,
+			loadNetwork
+		});
+	};
+	const request = async (method, path, options = {}) => {
+		const rawQuery = options.query || {};
+		return requestWithCache(method, path, rawQuery, (query) => {
+			return throttleManager.execute(path, rawQuery, () => requestNetwork(method, path, query, options));
+		});
+	};
+	const getRequest = (path, options = {}) => {
+		return request("GET", path, options);
+	};
+	const resourceDeps = {
+		client,
+		requestWithCache,
+		asApiResponse,
+		throttleManager
+	};
+	const stories = require_stories.createStoriesResource({
+		...resourceDeps,
+		inlineRelations
+	});
+	/**
+	* Flush the in-memory cache and reset the tracked cv.
+	*
+	* Call this explicitly when `cache.flush` is set to `'manual'`, e.g. after
+	* receiving a Storyblok webhook event that signals content has changed.
+	*/
+	const flushCache = async () => {
+		await cacheProvider.flush();
+		currentCv = void 0;
+	};
+	return {
+		datasourceEntries: require_datasource_entries.createDatasourceEntriesResource(resourceDeps),
+		datasources: require_datasources.createDatasourcesResource(resourceDeps),
+		flushCache,
+		get: getRequest,
+		interceptors: client.interceptors,
+		links: require_links.createLinksResource(resourceDeps),
+		spaces: require_spaces.createSpacesResource(resourceDeps),
+		stories,
+		tags: require_tags.createTagsResource(resourceDeps)
+	};
+};
+
+//#endregion
+exports.ClientError = require_error.ClientError;
+exports.createApiClient = createApiClient;
+exports.createThrottle = require_rate_limit.createThrottle;
+exports.parseRateLimitPolicyHeader = require_rate_limit.parseRateLimitPolicyHeader;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["createThrottleManager","createMemoryCacheProvider","createStrategy","createClient","createConfig","ClientError","extractCv","applyCvToQuery","shouldUseCache","createCacheKey","createStoriesResource","createDatasourceEntriesResource","createDatasourcesResource","createLinksResource","createSpacesResource","createTagsResource"],"sources":["../src/index.ts"],"sourcesContent":["import { createClient, createConfig } from './generated/shared/client';\nimport type { StoryCapi } from './generated/stories';\nimport type { CacheProvider, CacheStrategy, CacheStrategyHandler } from './utils/cache';\nimport { createMemoryCacheProvider, createStrategy } from './utils/cache';\nimport { ClientError } from './error';\nimport type { RateLimitConfig } from './utils/rate-limit';\nimport { createThrottleManager } from './utils/rate-limit';\nimport { applyCvToQuery, extractCv } from './utils/cv';\nimport { createCacheKey, shouldUseCache } from './utils/request';\nimport { getRegionBaseUrl, type Region } from '@storyblok/region-helper';\nimport type { RetryOptions } from 'ky';\nimport type { Client } from './generated/shared/client';\nimport type { ApiResponse, HttpRequestMethod, HttpRequestOptions, ResourceDeps } from './types';\nimport { createStoriesResource } from './resources/stories';\nimport { createLinksResource } from './resources/links';\nimport { createTagsResource } from './resources/tags';\nimport { createDatasourcesResource } from './resources/datasources';\nimport { createDatasourceEntriesResource } from './resources/datasource-entries';\nimport { createSpacesResource } from './resources/spaces';\n\ntype Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport type Story = Prettify<StoryCapi>;\nexport { ClientError } from './error';\nexport type { DatasourceEntryCapi as DatasourceEntry } from './generated/datasource_entries/types.gen';\nexport type { DatasourceCapi as Datasource } from './generated/datasources/types.gen';\nexport type { LinkCapi as Link } from './generated/links/types.gen';\nexport type { Middleware } from './generated/shared/client/utils.gen';\nexport type { SpaceCapi as Space } from './generated/spaces/types.gen';\nexport type { ApiResponse, HttpRequestMethod, HttpRequestOptions };\nexport type { CacheProvider, CacheStrategy, CacheStrategyHandler };\nexport type { RateLimitConfig };\nexport type { TagCapi as Tag } from './generated/tags/types.gen';\nexport type { StoryWithInlinedRelations } from './resources/stories';\n\nexport { createThrottle, parseRateLimitPolicyHeader } from './utils/rate-limit';\n\n/**\n * Cache configuration.\n *\n * **Note:** Requests with `version: 'draft'` always bypass the cache regardless\n * of the configured strategy. Only published content is cached.\n */\ninterface CacheConfig {\n  /** Custom cache provider. Defaults to an in-memory LRU cache (1 000 entries). */\n  provider?: CacheProvider;\n  /** Cache strategy for published requests. @default 'cache-first' */\n  strategy?: CacheStrategy | CacheStrategyHandler;\n  /** Time-to-live in milliseconds for cached entries. @default 60_000 */\n  ttlMs?: number;\n  /**\n   * Controls when the cache is flushed on cv change.\n   *\n   * - `'auto'` (default): automatically flush the cache whenever the API returns a new cv value.\n   * - `'manual'`: never auto-flush; call `client.flushCache()` explicitly (e.g. on webhook trigger).\n   */\n  flush?: 'auto' | 'manual';\n}\n\nexport interface ContentApiClientConfig<\n  ThrowOnError extends boolean = false,\n  InlineRelations extends boolean = false,\n> {\n  accessToken: string;\n  region?: Region;\n  baseUrl?: string;\n  headers?: Record<string, string>;\n  throwOnError?: ThrowOnError;\n  cache?: CacheConfig;\n  inlineRelations?: InlineRelations;\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 CDN rate limits.\n   *\n   * - `undefined` (default): auto-detect tier from path + `per_page` query param.\n   * - `number`: fixed max concurrent requests per second (single queue).\n   * - `{ maxConcurrent?: number; adaptToServerHeaders?: boolean }`: full config.\n   * - `false`: disable rate limiting entirely.\n   */\n  rateLimit?: RateLimitConfig | number | false;\n  /**\n   * Custom `fetch` function to use for all requests.\n   * Must be fully compatible with the Fetch API standard.\n   *\n   * Use cases:\n   * - SSR framework fetch wrappers (e.g., Next.js `fetch` with caching)\n   * - Custom instrumentation or logging around requests\n   *\n   * @default globalThis.fetch\n   */\n  fetch?: typeof globalThis.fetch;\n}\n\nexport const createApiClient = <\n  ThrowOnError extends boolean = false,\n  InlineRelations extends boolean = false,\n>(\n  config: ContentApiClientConfig<ThrowOnError, InlineRelations>,\n) => {\n  const {\n    accessToken,\n    region = 'eu',\n    baseUrl,\n    headers = {},\n    throwOnError = false,\n    cache = {},\n    inlineRelations = false,\n    retry,\n    timeout = 30_000,\n    rateLimit,\n    fetch: customFetch,\n  } = config;\n  const retryOptions: RetryOptions = { limit: 3, backoffLimit: 20_000, jitter: true, ...retry };\n  // `rateLimit` defaults to `{}` (auto-detect mode) when not supplied.\n  const throttleManager = createThrottleManager(rateLimit ?? {});\n  const cacheProvider = cache.provider ?? createMemoryCacheProvider();\n  const strategy = cache.strategy\n    ? typeof cache.strategy === 'string'\n      ? createStrategy(cache.strategy)\n      : cache.strategy\n    : createStrategy('cache-first');\n  const cacheTtlMs = cache.ttlMs ?? 60_000;\n  const cacheFlush = cache.flush ?? 'auto';\n  let currentCv: number | undefined;\n\n  const client: Client = createClient(\n    createConfig({\n      auth: accessToken,\n      baseUrl: baseUrl || getRegionBaseUrl(region),\n      headers,\n      throwOnError,\n      kyOptions: {\n        // Enable `throwHttpErrors` to make retry work, even if `throwOnError`\n        // is `false`. The client's error handling will still work because it\n        // catches `HTTPError`.\n        throwHttpErrors: true,\n        timeout,\n        retry: retryOptions,\n        ...(customFetch && { fetch: customFetch }),\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  const security = [\n    {\n      in: 'query' as const,\n      name: 'token',\n      type: 'apiKey' as const,\n    },\n  ];\n\n  const updateCv = async (result: ApiResponse): Promise<boolean> => {\n    const nextCv = extractCv(result.data);\n    if (nextCv === undefined) {\n      return true;\n    }\n\n    // Guard against cv regression: SWR background revalidation may carry a\n    // stale cv from a prior request; never move cv backward.\n    if (currentCv !== undefined && nextCv < currentCv) {\n      return false;\n    }\n\n    if (cacheFlush === 'auto' && currentCv !== undefined && currentCv !== nextCv) {\n      await cacheProvider.flush();\n    }\n\n    currentCv = nextCv;\n    return true;\n  };\n\n  const cacheSuccessResult = async <TResponse extends ApiResponse>(key: string, result: TResponse) => {\n    const shouldCacheResult = await updateCv(result);\n    if (result.error === undefined && shouldCacheResult) {\n      await cacheProvider.set(key, {\n        value: result,\n        ttlMs: cacheTtlMs,\n      });\n    }\n    return result;\n  };\n\n  const requestNetwork = async (\n    method: 'GET',\n    path: string,\n    query: Record<string, unknown>,\n    options: HttpRequestOptions,\n  ): Promise<ApiResponse> => {\n    return client.request<unknown, ClientError, boolean>({\n      ...options,\n      method,\n      query,\n      security,\n      url: path,\n    });\n  };\n\n  /**\n   * Wraps a raw SDK call to cast the `error: unknown` type returned by\n   * generated code to `ClientError` — the error interceptor ensures the\n   * runtime value IS a ClientError.\n   */\n  const asApiResponse = <TData, ThrowOnError extends boolean = false>(\n    p: Promise<unknown>,\n  ): Promise<ApiResponse<TData, ThrowOnError>> => p as unknown as Promise<ApiResponse<TData, ThrowOnError>>;\n\n  const requestWithCache = async <TData = unknown, ThrowOnError extends boolean = false>(\n    method: 'GET',\n    path: string,\n    rawQuery: Record<string, unknown>,\n    fetchFn: (query: Record<string, unknown>) => Promise<ApiResponse<TData, ThrowOnError>>,\n  ): Promise<ApiResponse<TData, ThrowOnError>> => {\n    const query = currentCv !== undefined ? applyCvToQuery(rawQuery, currentCv) : rawQuery;\n    const cacheEnabled = shouldUseCache(method, path, rawQuery);\n\n    if (!cacheEnabled) {\n      const networkResult = await fetchFn(query);\n      throttleManager.adaptToResponse(networkResult.response);\n      await updateCv(networkResult);\n      return networkResult;\n    }\n\n    const key = createCacheKey(method, path, rawQuery);\n    const cachedEntry = await cacheProvider.get<ApiResponse<TData, ThrowOnError>>(key);\n    const cachedResult = cachedEntry?.value;\n\n    const loadNetwork = async () => {\n      const result = await fetchFn(query);\n      throttleManager.adaptToResponse(result.response);\n      return cacheSuccessResult(key, result);\n    };\n\n    return strategy({\n      key,\n      cachedResult,\n      loadNetwork,\n    });\n  };\n\n  const request = async (\n    method: 'GET',\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse> => {\n    const rawQuery = options.query || {};\n\n    return requestWithCache(method, path, rawQuery, (query) => {\n      return throttleManager.execute(path, rawQuery, () => requestNetwork(method, path, query, options));\n    });\n  };\n\n  const getRequest = (\n    path: string,\n    options: HttpRequestOptions = {},\n  ) => {\n    return request('GET', path, options);\n  };\n\n  const resourceDeps: ResourceDeps = {\n    client,\n    requestWithCache,\n    asApiResponse,\n    throttleManager,\n  };\n\n  const stories = createStoriesResource<InlineRelations>({\n    ...resourceDeps,\n    inlineRelations,\n  });\n\n  /**\n   * Flush the in-memory cache and reset the tracked cv.\n   *\n   * Call this explicitly when `cache.flush` is set to `'manual'`, e.g. after\n   * receiving a Storyblok webhook event that signals content has changed.\n   */\n  const flushCache = async (): Promise<void> => {\n    await cacheProvider.flush();\n    currentCv = undefined;\n  };\n\n  return {\n    datasourceEntries: createDatasourceEntriesResource(resourceDeps),\n    datasources: createDatasourcesResource(resourceDeps),\n    flushCache,\n    get: getRequest,\n    interceptors: client.interceptors,\n    links: createLinksResource(resourceDeps),\n    spaces: createSpacesResource(resourceDeps),\n    stories,\n    tags: createTagsResource(resourceDeps),\n  };\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAoGA,MAAa,mBAIX,WACG;CACH,MAAM,EACJ,aACA,SAAS,MACT,SACA,UAAU,EAAE,EACZ,eAAe,OACf,QAAQ,EAAE,EACV,kBAAkB,OAClB,OACA,UAAU,KACV,WACA,OAAO,gBACL;CACJ,MAAM,eAA6B;EAAE,OAAO;EAAG,cAAc;EAAQ,QAAQ;EAAM,GAAG;EAAO;CAE7F,MAAM,kBAAkBA,yCAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,gBAAgB,MAAM,YAAYC,yCAA2B;CACnE,MAAM,WAAW,MAAM,WACnB,OAAO,MAAM,aAAa,WACxBC,6BAAe,MAAM,SAAS,GAC9B,MAAM,WACRA,6BAAe,cAAc;CACjC,MAAM,aAAa,MAAM,SAAS;CAClC,MAAM,aAAa,MAAM,SAAS;CAClC,IAAI;CAEJ,MAAM,SAAiBC,gCACrBC,+BAAa;EACX,MAAM;EACN,SAAS,0DAA4B,OAAO;EAC5C;EACA;EACA,WAAW;GAIT,iBAAiB;GACjB;GACA,OAAO;GACP,GAAI,eAAe,EAAE,OAAO,aAAa;GAC1C;EACF,CAAC,CACH;AAED,QAAO,aAAa,MAAM,KACvB,OAAgB,aACf,IAAIC,0BAAY,UAAU,cAAc,sBAAsB;EAC5D,QAAQ,UAAU,UAAU;EAC5B,YAAY,UAAU,cAAc;EACpC,MAAM;EACP,CAAC,CACL;CAED,MAAM,WAAW,CACf;EACE,IAAI;EACJ,MAAM;EACN,MAAM;EACP,CACF;CAED,MAAM,WAAW,OAAO,WAA0C;EAChE,MAAM,SAASC,qBAAU,OAAO,KAAK;AACrC,MAAI,WAAW,OACb,QAAO;AAKT,MAAI,cAAc,UAAa,SAAS,UACtC,QAAO;AAGT,MAAI,eAAe,UAAU,cAAc,UAAa,cAAc,OACpE,OAAM,cAAc,OAAO;AAG7B,cAAY;AACZ,SAAO;;CAGT,MAAM,qBAAqB,OAAsC,KAAa,WAAsB;EAClG,MAAM,oBAAoB,MAAM,SAAS,OAAO;AAChD,MAAI,OAAO,UAAU,UAAa,kBAChC,OAAM,cAAc,IAAI,KAAK;GAC3B,OAAO;GACP,OAAO;GACR,CAAC;AAEJ,SAAO;;CAGT,MAAM,iBAAiB,OACrB,QACA,MACA,OACA,YACyB;AACzB,SAAO,OAAO,QAAuC;GACnD,GAAG;GACH;GACA;GACA;GACA,KAAK;GACN,CAAC;;;;;;;CAQJ,MAAM,iBACJ,MAC8C;CAEhD,MAAM,mBAAmB,OACvB,QACA,MACA,UACA,YAC8C;EAC9C,MAAM,QAAQ,cAAc,SAAYC,0BAAe,UAAU,UAAU,GAAG;AAG9E,MAAI,CAFiBC,+BAAe,QAAQ,MAAM,SAAS,EAExC;GACjB,MAAM,gBAAgB,MAAM,QAAQ,MAAM;AAC1C,mBAAgB,gBAAgB,cAAc,SAAS;AACvD,SAAM,SAAS,cAAc;AAC7B,UAAO;;EAGT,MAAM,MAAMC,+BAAe,QAAQ,MAAM,SAAS;EAElD,MAAM,gBADc,MAAM,cAAc,IAAsC,IAAI,GAChD;EAElC,MAAM,cAAc,YAAY;GAC9B,MAAM,SAAS,MAAM,QAAQ,MAAM;AACnC,mBAAgB,gBAAgB,OAAO,SAAS;AAChD,UAAO,mBAAmB,KAAK,OAAO;;AAGxC,SAAO,SAAS;GACd;GACA;GACA;GACD,CAAC;;CAGJ,MAAM,UAAU,OACd,QACA,MACA,UAA8B,EAAE,KACP;EACzB,MAAM,WAAW,QAAQ,SAAS,EAAE;AAEpC,SAAO,iBAAiB,QAAQ,MAAM,WAAW,UAAU;AACzD,UAAO,gBAAgB,QAAQ,MAAM,gBAAgB,eAAe,QAAQ,MAAM,OAAO,QAAQ,CAAC;IAClG;;CAGJ,MAAM,cACJ,MACA,UAA8B,EAAE,KAC7B;AACH,SAAO,QAAQ,OAAO,MAAM,QAAQ;;CAGtC,MAAM,eAA6B;EACjC;EACA;EACA;EACA;EACD;CAED,MAAM,UAAUC,sCAAuC;EACrD,GAAG;EACH;EACD,CAAC;;;;;;;CAQF,MAAM,aAAa,YAA2B;AAC5C,QAAM,cAAc,OAAO;AAC3B,cAAY;;AAGd,QAAO;EACL,mBAAmBC,2DAAgC,aAAa;EAChE,aAAaC,8CAA0B,aAAa;EACpD;EACA,KAAK;EACL,cAAc,OAAO;EACrB,OAAOC,kCAAoB,aAAa;EACxC,QAAQC,oCAAqB,aAAa;EAC1C;EACA,MAAMC,gCAAmB,aAAa;EACvC"}

package/dist/index.d.cts

@@ -0,0 +1,161 @@
+import { DatasourceEntryCapi, GetAllData, GetAllResponses } from "./generated/datasource_entries/types.gen.cjs";
+import { DatasourceCapi, GetAllData as GetAllData$1, GetAllResponses as GetAllResponses$1, GetData, GetResponses } from "./generated/datasources/types.gen.cjs";
+import { Middleware } from "./generated/shared/client/utils.gen.cjs";
+import { ResolvedRequestOptions } from "./generated/shared/client/types.gen.cjs";
+import { GetAllData as GetAllData$2, GetAllResponses as GetAllResponses$2, LinkCapi } from "./generated/links/types.gen.cjs";
+import { GetResponses as GetResponses$1, SpaceCapi } from "./generated/spaces/types.gen.cjs";
+import { GetAllData as GetAllData$3, GetData as GetData$1, StoryCapi } from "./generated/stories/types.gen.cjs";
+import { GetAllData as GetAllData$4, GetAllResponses as GetAllResponses$3, TagCapi } from "./generated/tags/types.gen.cjs";
+import { CacheProvider, CacheStrategy, CacheStrategyHandler } from "./utils/cache.cjs";
+import { ClientError } from "./error.cjs";
+import { RateLimitConfig, createThrottle, parseRateLimitPolicyHeader } from "./utils/rate-limit.cjs";
+import { ApiResponse, HttpRequestMethod, HttpRequestOptions } from "./types.cjs";
+import { StoryWithInlinedRelations } from "./resources/stories.cjs";
+import { RetryOptions } from "ky";
+import { Region } from "@storyblok/region-helper";
+
+//#region src/index.d.ts
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+type Story = Prettify<StoryCapi>;
+/**
+ * Cache configuration.
+ *
+ * **Note:** Requests with `version: 'draft'` always bypass the cache regardless
+ * of the configured strategy. Only published content is cached.
+ */
+interface CacheConfig {
+  /** Custom cache provider. Defaults to an in-memory LRU cache (1 000 entries). */
+  provider?: CacheProvider;
+  /** Cache strategy for published requests. @default 'cache-first' */
+  strategy?: CacheStrategy | CacheStrategyHandler;
+  /** Time-to-live in milliseconds for cached entries. @default 60_000 */
+  ttlMs?: number;
+  /**
+   * Controls when the cache is flushed on cv change.
+   *
+   * - `'auto'` (default): automatically flush the cache whenever the API returns a new cv value.
+   * - `'manual'`: never auto-flush; call `client.flushCache()` explicitly (e.g. on webhook trigger).
+   */
+  flush?: 'auto' | 'manual';
+}
+interface ContentApiClientConfig<ThrowOnError extends boolean = false, InlineRelations extends boolean = false> {
+  accessToken: string;
+  region?: Region;
+  baseUrl?: string;
+  headers?: Record<string, string>;
+  throwOnError?: ThrowOnError;
+  cache?: CacheConfig;
+  inlineRelations?: InlineRelations;
+  retry?: RetryOptions;
+  /**
+   * Request timeout in milliseconds.
+   * @default 30_000
+   */
+  timeout?: number;
+  /**
+   * Preventive rate limiting to avoid hitting the Storyblok CDN rate limits.
+   *
+   * - `undefined` (default): auto-detect tier from path + `per_page` query param.
+   * - `number`: fixed max concurrent requests per second (single queue).
+   * - `{ maxConcurrent?: number; adaptToServerHeaders?: boolean }`: full config.
+   * - `false`: disable rate limiting entirely.
+   */
+  rateLimit?: RateLimitConfig | number | false;
+  /**
+   * Custom `fetch` function to use for all requests.
+   * Must be fully compatible with the Fetch API standard.
+   *
+   * Use cases:
+   * - SSR framework fetch wrappers (e.g., Next.js `fetch` with caching)
+   * - Custom instrumentation or logging around requests
+   *
+   * @default globalThis.fetch
+   */
+  fetch?: typeof globalThis.fetch;
+}
+declare const createApiClient: <ThrowOnError extends boolean = false, InlineRelations extends boolean = false>(config: ContentApiClientConfig<ThrowOnError, InlineRelations>) => {
+  datasourceEntries: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses[200], ThrowOnError_1>>;
+  };
+  datasources: {
+    get: <ThrowOnError_1 extends boolean = false>(id: GetData["path"]["id"], options?: {
+      query?: GetData["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetResponses[200], ThrowOnError_1>>;
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$1["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$1[200], ThrowOnError_1>>;
+  };
+  flushCache: () => Promise<void>;
+  get: (path: string, options?: HttpRequestOptions) => Promise<{
+    data?: unknown;
+    error?: ClientError;
+    response: Response;
+    request: Request;
+  }>;
+  interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions<"fields", boolean, string>>;
+  links: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$2["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$2[200], ThrowOnError_1>>;
+  };
+  spaces: {
+    get: <ThrowOnError_1 extends boolean = false>(options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetResponses$1[200], ThrowOnError_1>>;
+  };
+  stories: {
+    get: <ThrowOnError_1 extends boolean = false>(identifier: string | number, options?: {
+      query?: GetData$1["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1 | undefined;
+    }) => Promise<ApiResponse<Omit<{
+      story: StoryCapi;
+      cv?: number;
+      rels?: Array<StoryCapi>;
+      links?: Array<{
+        [key: string]: unknown;
+      }>;
+      rel_uuids?: Array<string>;
+      link_uuids?: Array<string>;
+    }, "story"> & {
+      story: InlineRelations extends true ? StoryWithInlinedRelations : StoryCapi;
+    }, ThrowOnError_1>>;
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$3["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1 | undefined;
+    }) => Promise<ApiResponse<Omit<{
+      stories: Array<StoryCapi>;
+      cv?: number;
+      rels?: Array<StoryCapi>;
+      links?: Array<{
+        [key: string]: unknown;
+      }>;
+      rel_uuids?: Array<string>;
+      link_uuids?: Array<string>;
+    }, "stories"> & {
+      stories: (InlineRelations extends true ? StoryWithInlinedRelations : StoryCapi)[];
+    }, ThrowOnError_1>>;
+  };
+  tags: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$4["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$3[200], ThrowOnError_1>>;
+  };
+};
+//#endregion
+export { type ApiResponse, type CacheProvider, type CacheStrategy, type CacheStrategyHandler, ClientError, ContentApiClientConfig, type DatasourceCapi as Datasource, type DatasourceEntryCapi as DatasourceEntry, type HttpRequestMethod, type HttpRequestOptions, type LinkCapi as Link, type Middleware, type RateLimitConfig, type SpaceCapi as Space, Story, type StoryWithInlinedRelations, type TagCapi as Tag, createApiClient, createThrottle, parseRateLimitPolicyHeader };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,161 @@
+import { DatasourceEntryCapi, GetAllData, GetAllResponses } from "./generated/datasource_entries/types.gen.mjs";
+import { DatasourceCapi, GetAllData as GetAllData$1, GetAllResponses as GetAllResponses$1, GetData, GetResponses } from "./generated/datasources/types.gen.mjs";
+import { Middleware } from "./generated/shared/client/utils.gen.mjs";
+import { ResolvedRequestOptions } from "./generated/shared/client/types.gen.mjs";
+import { GetAllData as GetAllData$2, GetAllResponses as GetAllResponses$2, LinkCapi } from "./generated/links/types.gen.mjs";
+import { GetResponses as GetResponses$1, SpaceCapi } from "./generated/spaces/types.gen.mjs";
+import { GetAllData as GetAllData$3, GetData as GetData$1, StoryCapi } from "./generated/stories/types.gen.mjs";
+import { GetAllData as GetAllData$4, GetAllResponses as GetAllResponses$3, TagCapi } from "./generated/tags/types.gen.mjs";
+import { CacheProvider, CacheStrategy, CacheStrategyHandler } from "./utils/cache.mjs";
+import { ClientError } from "./error.mjs";
+import { RateLimitConfig, createThrottle, parseRateLimitPolicyHeader } from "./utils/rate-limit.mjs";
+import { ApiResponse, HttpRequestMethod, HttpRequestOptions } from "./types.mjs";
+import { StoryWithInlinedRelations } from "./resources/stories.mjs";
+import { RetryOptions } from "ky";
+import { Region } from "@storyblok/region-helper";
+
+//#region src/index.d.ts
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+type Story = Prettify<StoryCapi>;
+/**
+ * Cache configuration.
+ *
+ * **Note:** Requests with `version: 'draft'` always bypass the cache regardless
+ * of the configured strategy. Only published content is cached.
+ */
+interface CacheConfig {
+  /** Custom cache provider. Defaults to an in-memory LRU cache (1 000 entries). */
+  provider?: CacheProvider;
+  /** Cache strategy for published requests. @default 'cache-first' */
+  strategy?: CacheStrategy | CacheStrategyHandler;
+  /** Time-to-live in milliseconds for cached entries. @default 60_000 */
+  ttlMs?: number;
+  /**
+   * Controls when the cache is flushed on cv change.
+   *
+   * - `'auto'` (default): automatically flush the cache whenever the API returns a new cv value.
+   * - `'manual'`: never auto-flush; call `client.flushCache()` explicitly (e.g. on webhook trigger).
+   */
+  flush?: 'auto' | 'manual';
+}
+interface ContentApiClientConfig<ThrowOnError extends boolean = false, InlineRelations extends boolean = false> {
+  accessToken: string;
+  region?: Region;
+  baseUrl?: string;
+  headers?: Record<string, string>;
+  throwOnError?: ThrowOnError;
+  cache?: CacheConfig;
+  inlineRelations?: InlineRelations;
+  retry?: RetryOptions;
+  /**
+   * Request timeout in milliseconds.
+   * @default 30_000
+   */
+  timeout?: number;
+  /**
+   * Preventive rate limiting to avoid hitting the Storyblok CDN rate limits.
+   *
+   * - `undefined` (default): auto-detect tier from path + `per_page` query param.
+   * - `number`: fixed max concurrent requests per second (single queue).
+   * - `{ maxConcurrent?: number; adaptToServerHeaders?: boolean }`: full config.
+   * - `false`: disable rate limiting entirely.
+   */
+  rateLimit?: RateLimitConfig | number | false;
+  /**
+   * Custom `fetch` function to use for all requests.
+   * Must be fully compatible with the Fetch API standard.
+   *
+   * Use cases:
+   * - SSR framework fetch wrappers (e.g., Next.js `fetch` with caching)
+   * - Custom instrumentation or logging around requests
+   *
+   * @default globalThis.fetch
+   */
+  fetch?: typeof globalThis.fetch;
+}
+declare const createApiClient: <ThrowOnError extends boolean = false, InlineRelations extends boolean = false>(config: ContentApiClientConfig<ThrowOnError, InlineRelations>) => {
+  datasourceEntries: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses[200], ThrowOnError_1>>;
+  };
+  datasources: {
+    get: <ThrowOnError_1 extends boolean = false>(id: GetData["path"]["id"], options?: {
+      query?: GetData["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetResponses[200], ThrowOnError_1>>;
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$1["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$1[200], ThrowOnError_1>>;
+  };
+  flushCache: () => Promise<void>;
+  get: (path: string, options?: HttpRequestOptions) => Promise<{
+    data?: unknown;
+    error?: ClientError;
+    response: Response;
+    request: Request;
+  }>;
+  interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions<"fields", boolean, string>>;
+  links: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$2["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$2[200], ThrowOnError_1>>;
+  };
+  spaces: {
+    get: <ThrowOnError_1 extends boolean = false>(options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetResponses$1[200], ThrowOnError_1>>;
+  };
+  stories: {
+    get: <ThrowOnError_1 extends boolean = false>(identifier: string | number, options?: {
+      query?: GetData$1["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1 | undefined;
+    }) => Promise<ApiResponse<Omit<{
+      story: StoryCapi;
+      cv?: number;
+      rels?: Array<StoryCapi>;
+      links?: Array<{
+        [key: string]: unknown;
+      }>;
+      rel_uuids?: Array<string>;
+      link_uuids?: Array<string>;
+    }, "story"> & {
+      story: InlineRelations extends true ? StoryWithInlinedRelations : StoryCapi;
+    }, ThrowOnError_1>>;
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$3["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1 | undefined;
+    }) => Promise<ApiResponse<Omit<{
+      stories: Array<StoryCapi>;
+      cv?: number;
+      rels?: Array<StoryCapi>;
+      links?: Array<{
+        [key: string]: unknown;
+      }>;
+      rel_uuids?: Array<string>;
+      link_uuids?: Array<string>;
+    }, "stories"> & {
+      stories: (InlineRelations extends true ? StoryWithInlinedRelations : StoryCapi)[];
+    }, ThrowOnError_1>>;
+  };
+  tags: {
+    getAll: <ThrowOnError_1 extends boolean = false>(options?: {
+      query?: GetAllData$4["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError_1;
+    }) => Promise<ApiResponse<GetAllResponses$3[200], ThrowOnError_1>>;
+  };
+};
+//#endregion
+export { type ApiResponse, type CacheProvider, type CacheStrategy, type CacheStrategyHandler, ClientError, ContentApiClientConfig, type DatasourceCapi as Datasource, type DatasourceEntryCapi as DatasourceEntry, type HttpRequestMethod, type HttpRequestOptions, type LinkCapi as Link, type Middleware, type RateLimitConfig, type SpaceCapi as Space, Story, type StoryWithInlinedRelations, type TagCapi as Tag, createApiClient, createThrottle, parseRateLimitPolicyHeader };
+//# sourceMappingURL=index.d.mts.map