@storyblok/api-client 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +5 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -2
- package/dist/index.d.mts +16 -2
- package/dist/index.mjs +5 -3
- package/dist/index.mjs.map +1 -1
- package/dist/resources/datasource-entries.cjs +6 -2
- package/dist/resources/datasource-entries.cjs.map +1 -1
- package/dist/resources/datasource-entries.mjs +6 -2
- package/dist/resources/datasource-entries.mjs.map +1 -1
- package/dist/resources/datasources.cjs +12 -4
- package/dist/resources/datasources.cjs.map +1 -1
- package/dist/resources/datasources.mjs +12 -4
- package/dist/resources/datasources.mjs.map +1 -1
- package/dist/resources/links.cjs +6 -2
- package/dist/resources/links.cjs.map +1 -1
- package/dist/resources/links.mjs +6 -2
- package/dist/resources/links.mjs.map +1 -1
- package/dist/resources/spaces.cjs +6 -2
- package/dist/resources/spaces.cjs.map +1 -1
- package/dist/resources/spaces.mjs +6 -2
- package/dist/resources/spaces.mjs.map +1 -1
- package/dist/resources/stories.cjs +14 -6
- package/dist/resources/stories.cjs.map +1 -1
- package/dist/resources/stories.mjs +14 -6
- package/dist/resources/stories.mjs.map +1 -1
- package/dist/resources/tags.cjs +6 -2
- package/dist/resources/tags.cjs.map +1 -1
- package/dist/resources/tags.mjs +6 -2
- package/dist/resources/tags.mjs.map +1 -1
- package/dist/types.d.cts +19 -1
- package/dist/types.d.mts +19 -1
- package/dist/utils/cache.cjs +10 -4
- package/dist/utils/cache.cjs.map +1 -1
- package/dist/utils/cache.mjs +10 -4
- package/dist/utils/cache.mjs.map +1 -1
- package/dist/utils/inline-relations.cjs +10 -7
- package/dist/utils/inline-relations.cjs.map +1 -1
- package/dist/utils/inline-relations.mjs +10 -7
- package/dist/utils/inline-relations.mjs.map +1 -1
- package/package.json +5 -6
package/dist/index.cjs
CHANGED
|
@@ -27,7 +27,8 @@ const createApiClient = (config) => {
|
|
|
27
27
|
};
|
|
28
28
|
const throttleManager = require_rate_limit.createThrottleManager(rateLimit ?? {});
|
|
29
29
|
const cacheProvider = cache.provider ?? require_cache.createMemoryCacheProvider();
|
|
30
|
-
const
|
|
30
|
+
const swrOptions = cache.onRevalidationError ? { onRevalidationError: cache.onRevalidationError } : void 0;
|
|
31
|
+
const strategy = cache.strategy ? typeof cache.strategy === "string" ? require_cache.createStrategy(cache.strategy, swrOptions) : cache.strategy : require_cache.createStrategy("cache-first");
|
|
31
32
|
const cacheTtlMs = cache.ttlMs ?? 6e4;
|
|
32
33
|
const cacheFlush = cache.flush ?? "auto";
|
|
33
34
|
let currentCv;
|
|
@@ -84,7 +85,7 @@ const createApiClient = (config) => {
|
|
|
84
85
|
* runtime value IS a ClientError.
|
|
85
86
|
*/
|
|
86
87
|
const asApiResponse = (p) => p;
|
|
87
|
-
const requestWithCache = async (method, path, rawQuery, fetchFn) => {
|
|
88
|
+
const requestWithCache = async (method, path, rawQuery, fetchFn, cacheOptions) => {
|
|
88
89
|
const query = currentCv !== void 0 ? require_cv.applyCvToQuery(rawQuery, currentCv) : rawQuery;
|
|
89
90
|
if (!require_request.shouldUseCache(method, path, rawQuery)) {
|
|
90
91
|
const networkResult = await fetchFn(query);
|
|
@@ -92,7 +93,8 @@ const createApiClient = (config) => {
|
|
|
92
93
|
await updateCv(networkResult);
|
|
93
94
|
return networkResult;
|
|
94
95
|
}
|
|
95
|
-
const
|
|
96
|
+
const baseKey = require_request.createCacheKey(method, path, rawQuery);
|
|
97
|
+
const key = cacheOptions?.cacheKeyPrefix ? `${cacheOptions.cacheKeyPrefix}:${baseKey}` : baseKey;
|
|
96
98
|
const cachedResult = (await cacheProvider.get(key))?.value;
|
|
97
99
|
const loadNetwork = async () => {
|
|
98
100
|
const result = await fetchFn(query);
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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"}
|
|
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, FetchOptions, HttpRequestMethod, HttpRequestOptions, RequestWithCacheOptions, 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, FetchOptions, 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 * Called when SWR background revalidation fails.\n * Only relevant when `strategy` is `'swr'`.\n * @default console.warn\n */\n onRevalidationError?: (error: unknown) => void;\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 swrOptions = cache.onRevalidationError ? { onRevalidationError: cache.onRevalidationError } : undefined;\n const strategy = cache.strategy\n ? typeof cache.strategy === 'string'\n ? createStrategy(cache.strategy, swrOptions)\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 cacheOptions?: RequestWithCacheOptions,\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 baseKey = createCacheKey(method, path, rawQuery);\n const key = cacheOptions?.cacheKeyPrefix ? `${cacheOptions.cacheKeyPrefix}:${baseKey}` : baseKey;\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":";;;;;;;;;;;;;;;;;;;AA0GA,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,aAAa,MAAM,sBAAsB,EAAE,qBAAqB,MAAM,qBAAqB,GAAG;CACpG,MAAM,WAAW,MAAM,WACnB,OAAO,MAAM,aAAa,WACxBC,6BAAe,MAAM,UAAU,WAAW,GAC1C,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,SACA,iBAC8C;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,UAAUC,+BAAe,QAAQ,MAAM,SAAS;EACtD,MAAM,MAAM,cAAc,iBAAiB,GAAG,aAAa,eAAe,GAAG,YAAY;EAEzF,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
CHANGED
|
@@ -9,7 +9,7 @@ import { GetAllData as GetAllData$4, GetAllResponses as GetAllResponses$3, TagCa
|
|
|
9
9
|
import { CacheProvider, CacheStrategy, CacheStrategyHandler } from "./utils/cache.cjs";
|
|
10
10
|
import { ClientError } from "./error.cjs";
|
|
11
11
|
import { RateLimitConfig, createThrottle, parseRateLimitPolicyHeader } from "./utils/rate-limit.cjs";
|
|
12
|
-
import { ApiResponse, HttpRequestMethod, HttpRequestOptions } from "./types.cjs";
|
|
12
|
+
import { ApiResponse, FetchOptions, HttpRequestMethod, HttpRequestOptions } from "./types.cjs";
|
|
13
13
|
import { StoryWithInlinedRelations } from "./resources/stories.cjs";
|
|
14
14
|
import { RetryOptions } from "ky";
|
|
15
15
|
import { Region } from "@storyblok/region-helper";
|
|
@@ -37,6 +37,12 @@ interface CacheConfig {
|
|
|
37
37
|
* - `'manual'`: never auto-flush; call `client.flushCache()` explicitly (e.g. on webhook trigger).
|
|
38
38
|
*/
|
|
39
39
|
flush?: 'auto' | 'manual';
|
|
40
|
+
/**
|
|
41
|
+
* Called when SWR background revalidation fails.
|
|
42
|
+
* Only relevant when `strategy` is `'swr'`.
|
|
43
|
+
* @default console.warn
|
|
44
|
+
*/
|
|
45
|
+
onRevalidationError?: (error: unknown) => void;
|
|
40
46
|
}
|
|
41
47
|
interface ContentApiClientConfig<ThrowOnError extends boolean = false, InlineRelations extends boolean = false> {
|
|
42
48
|
accessToken: string;
|
|
@@ -79,6 +85,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
79
85
|
query?: GetAllData["query"];
|
|
80
86
|
signal?: AbortSignal;
|
|
81
87
|
throwOnError?: ThrowOnError_1;
|
|
88
|
+
fetchOptions?: FetchOptions;
|
|
82
89
|
}) => Promise<ApiResponse<GetAllResponses[200], ThrowOnError_1>>;
|
|
83
90
|
};
|
|
84
91
|
datasources: {
|
|
@@ -86,11 +93,13 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
86
93
|
query?: GetData["query"];
|
|
87
94
|
signal?: AbortSignal;
|
|
88
95
|
throwOnError?: ThrowOnError_1;
|
|
96
|
+
fetchOptions?: FetchOptions;
|
|
89
97
|
}) => Promise<ApiResponse<GetResponses[200], ThrowOnError_1>>;
|
|
90
98
|
getAll: <ThrowOnError_1 extends boolean = false>(options?: {
|
|
91
99
|
query?: GetAllData$1["query"];
|
|
92
100
|
signal?: AbortSignal;
|
|
93
101
|
throwOnError?: ThrowOnError_1;
|
|
102
|
+
fetchOptions?: FetchOptions;
|
|
94
103
|
}) => Promise<ApiResponse<GetAllResponses$1[200], ThrowOnError_1>>;
|
|
95
104
|
};
|
|
96
105
|
flushCache: () => Promise<void>;
|
|
@@ -106,12 +115,14 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
106
115
|
query?: GetAllData$2["query"];
|
|
107
116
|
signal?: AbortSignal;
|
|
108
117
|
throwOnError?: ThrowOnError_1;
|
|
118
|
+
fetchOptions?: FetchOptions;
|
|
109
119
|
}) => Promise<ApiResponse<GetAllResponses$2[200], ThrowOnError_1>>;
|
|
110
120
|
};
|
|
111
121
|
spaces: {
|
|
112
122
|
get: <ThrowOnError_1 extends boolean = false>(options?: {
|
|
113
123
|
signal?: AbortSignal;
|
|
114
124
|
throwOnError?: ThrowOnError_1;
|
|
125
|
+
fetchOptions?: FetchOptions;
|
|
115
126
|
}) => Promise<ApiResponse<GetResponses$1[200], ThrowOnError_1>>;
|
|
116
127
|
};
|
|
117
128
|
stories: {
|
|
@@ -119,6 +130,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
119
130
|
query?: GetData$1["query"];
|
|
120
131
|
signal?: AbortSignal;
|
|
121
132
|
throwOnError?: ThrowOnError_1 | undefined;
|
|
133
|
+
fetchOptions?: FetchOptions;
|
|
122
134
|
}) => Promise<ApiResponse<Omit<{
|
|
123
135
|
story: StoryCapi;
|
|
124
136
|
cv?: number;
|
|
@@ -135,6 +147,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
135
147
|
query?: GetAllData$3["query"];
|
|
136
148
|
signal?: AbortSignal;
|
|
137
149
|
throwOnError?: ThrowOnError_1 | undefined;
|
|
150
|
+
fetchOptions?: FetchOptions;
|
|
138
151
|
}) => Promise<ApiResponse<Omit<{
|
|
139
152
|
stories: Array<StoryCapi>;
|
|
140
153
|
cv?: number;
|
|
@@ -153,9 +166,10 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
153
166
|
query?: GetAllData$4["query"];
|
|
154
167
|
signal?: AbortSignal;
|
|
155
168
|
throwOnError?: ThrowOnError_1;
|
|
169
|
+
fetchOptions?: FetchOptions;
|
|
156
170
|
}) => Promise<ApiResponse<GetAllResponses$3[200], ThrowOnError_1>>;
|
|
157
171
|
};
|
|
158
172
|
};
|
|
159
173
|
//#endregion
|
|
160
|
-
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 };
|
|
174
|
+
export { type ApiResponse, type CacheProvider, type CacheStrategy, type CacheStrategyHandler, ClientError, ContentApiClientConfig, type DatasourceCapi as Datasource, type DatasourceEntryCapi as DatasourceEntry, type FetchOptions, 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 };
|
|
161
175
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.mts
CHANGED
|
@@ -9,7 +9,7 @@ import { GetAllData as GetAllData$4, GetAllResponses as GetAllResponses$3, TagCa
|
|
|
9
9
|
import { CacheProvider, CacheStrategy, CacheStrategyHandler } from "./utils/cache.mjs";
|
|
10
10
|
import { ClientError } from "./error.mjs";
|
|
11
11
|
import { RateLimitConfig, createThrottle, parseRateLimitPolicyHeader } from "./utils/rate-limit.mjs";
|
|
12
|
-
import { ApiResponse, HttpRequestMethod, HttpRequestOptions } from "./types.mjs";
|
|
12
|
+
import { ApiResponse, FetchOptions, HttpRequestMethod, HttpRequestOptions } from "./types.mjs";
|
|
13
13
|
import { StoryWithInlinedRelations } from "./resources/stories.mjs";
|
|
14
14
|
import { RetryOptions } from "ky";
|
|
15
15
|
import { Region } from "@storyblok/region-helper";
|
|
@@ -37,6 +37,12 @@ interface CacheConfig {
|
|
|
37
37
|
* - `'manual'`: never auto-flush; call `client.flushCache()` explicitly (e.g. on webhook trigger).
|
|
38
38
|
*/
|
|
39
39
|
flush?: 'auto' | 'manual';
|
|
40
|
+
/**
|
|
41
|
+
* Called when SWR background revalidation fails.
|
|
42
|
+
* Only relevant when `strategy` is `'swr'`.
|
|
43
|
+
* @default console.warn
|
|
44
|
+
*/
|
|
45
|
+
onRevalidationError?: (error: unknown) => void;
|
|
40
46
|
}
|
|
41
47
|
interface ContentApiClientConfig<ThrowOnError extends boolean = false, InlineRelations extends boolean = false> {
|
|
42
48
|
accessToken: string;
|
|
@@ -79,6 +85,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
79
85
|
query?: GetAllData["query"];
|
|
80
86
|
signal?: AbortSignal;
|
|
81
87
|
throwOnError?: ThrowOnError_1;
|
|
88
|
+
fetchOptions?: FetchOptions;
|
|
82
89
|
}) => Promise<ApiResponse<GetAllResponses[200], ThrowOnError_1>>;
|
|
83
90
|
};
|
|
84
91
|
datasources: {
|
|
@@ -86,11 +93,13 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
86
93
|
query?: GetData["query"];
|
|
87
94
|
signal?: AbortSignal;
|
|
88
95
|
throwOnError?: ThrowOnError_1;
|
|
96
|
+
fetchOptions?: FetchOptions;
|
|
89
97
|
}) => Promise<ApiResponse<GetResponses[200], ThrowOnError_1>>;
|
|
90
98
|
getAll: <ThrowOnError_1 extends boolean = false>(options?: {
|
|
91
99
|
query?: GetAllData$1["query"];
|
|
92
100
|
signal?: AbortSignal;
|
|
93
101
|
throwOnError?: ThrowOnError_1;
|
|
102
|
+
fetchOptions?: FetchOptions;
|
|
94
103
|
}) => Promise<ApiResponse<GetAllResponses$1[200], ThrowOnError_1>>;
|
|
95
104
|
};
|
|
96
105
|
flushCache: () => Promise<void>;
|
|
@@ -106,12 +115,14 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
106
115
|
query?: GetAllData$2["query"];
|
|
107
116
|
signal?: AbortSignal;
|
|
108
117
|
throwOnError?: ThrowOnError_1;
|
|
118
|
+
fetchOptions?: FetchOptions;
|
|
109
119
|
}) => Promise<ApiResponse<GetAllResponses$2[200], ThrowOnError_1>>;
|
|
110
120
|
};
|
|
111
121
|
spaces: {
|
|
112
122
|
get: <ThrowOnError_1 extends boolean = false>(options?: {
|
|
113
123
|
signal?: AbortSignal;
|
|
114
124
|
throwOnError?: ThrowOnError_1;
|
|
125
|
+
fetchOptions?: FetchOptions;
|
|
115
126
|
}) => Promise<ApiResponse<GetResponses$1[200], ThrowOnError_1>>;
|
|
116
127
|
};
|
|
117
128
|
stories: {
|
|
@@ -119,6 +130,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
119
130
|
query?: GetData$1["query"];
|
|
120
131
|
signal?: AbortSignal;
|
|
121
132
|
throwOnError?: ThrowOnError_1 | undefined;
|
|
133
|
+
fetchOptions?: FetchOptions;
|
|
122
134
|
}) => Promise<ApiResponse<Omit<{
|
|
123
135
|
story: StoryCapi;
|
|
124
136
|
cv?: number;
|
|
@@ -135,6 +147,7 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
135
147
|
query?: GetAllData$3["query"];
|
|
136
148
|
signal?: AbortSignal;
|
|
137
149
|
throwOnError?: ThrowOnError_1 | undefined;
|
|
150
|
+
fetchOptions?: FetchOptions;
|
|
138
151
|
}) => Promise<ApiResponse<Omit<{
|
|
139
152
|
stories: Array<StoryCapi>;
|
|
140
153
|
cv?: number;
|
|
@@ -153,9 +166,10 @@ declare const createApiClient: <ThrowOnError extends boolean = false, InlineRela
|
|
|
153
166
|
query?: GetAllData$4["query"];
|
|
154
167
|
signal?: AbortSignal;
|
|
155
168
|
throwOnError?: ThrowOnError_1;
|
|
169
|
+
fetchOptions?: FetchOptions;
|
|
156
170
|
}) => Promise<ApiResponse<GetAllResponses$3[200], ThrowOnError_1>>;
|
|
157
171
|
};
|
|
158
172
|
};
|
|
159
173
|
//#endregion
|
|
160
|
-
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 };
|
|
174
|
+
export { type ApiResponse, type CacheProvider, type CacheStrategy, type CacheStrategyHandler, ClientError, ContentApiClientConfig, type DatasourceCapi as Datasource, type DatasourceEntryCapi as DatasourceEntry, type FetchOptions, 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 };
|
|
161
175
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.mjs
CHANGED
|
@@ -25,7 +25,8 @@ const createApiClient = (config) => {
|
|
|
25
25
|
};
|
|
26
26
|
const throttleManager = createThrottleManager(rateLimit ?? {});
|
|
27
27
|
const cacheProvider = cache.provider ?? createMemoryCacheProvider();
|
|
28
|
-
const
|
|
28
|
+
const swrOptions = cache.onRevalidationError ? { onRevalidationError: cache.onRevalidationError } : void 0;
|
|
29
|
+
const strategy = cache.strategy ? typeof cache.strategy === "string" ? createStrategy(cache.strategy, swrOptions) : cache.strategy : createStrategy("cache-first");
|
|
29
30
|
const cacheTtlMs = cache.ttlMs ?? 6e4;
|
|
30
31
|
const cacheFlush = cache.flush ?? "auto";
|
|
31
32
|
let currentCv;
|
|
@@ -82,7 +83,7 @@ const createApiClient = (config) => {
|
|
|
82
83
|
* runtime value IS a ClientError.
|
|
83
84
|
*/
|
|
84
85
|
const asApiResponse = (p) => p;
|
|
85
|
-
const requestWithCache = async (method, path, rawQuery, fetchFn) => {
|
|
86
|
+
const requestWithCache = async (method, path, rawQuery, fetchFn, cacheOptions) => {
|
|
86
87
|
const query = currentCv !== void 0 ? applyCvToQuery(rawQuery, currentCv) : rawQuery;
|
|
87
88
|
if (!shouldUseCache(method, path, rawQuery)) {
|
|
88
89
|
const networkResult = await fetchFn(query);
|
|
@@ -90,7 +91,8 @@ const createApiClient = (config) => {
|
|
|
90
91
|
await updateCv(networkResult);
|
|
91
92
|
return networkResult;
|
|
92
93
|
}
|
|
93
|
-
const
|
|
94
|
+
const baseKey = createCacheKey(method, path, rawQuery);
|
|
95
|
+
const key = cacheOptions?.cacheKeyPrefix ? `${cacheOptions.cacheKeyPrefix}:${baseKey}` : baseKey;
|
|
94
96
|
const cachedResult = (await cacheProvider.get(key))?.value;
|
|
95
97
|
const loadNetwork = async () => {
|
|
96
98
|
const result = await fetchFn(query);
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"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,kBAAkB,sBAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,gBAAgB,MAAM,YAAY,2BAA2B;CACnE,MAAM,WAAW,MAAM,WACnB,OAAO,MAAM,aAAa,WACxB,eAAe,MAAM,SAAS,GAC9B,MAAM,WACR,eAAe,cAAc;CACjC,MAAM,aAAa,MAAM,SAAS;CAClC,MAAM,aAAa,MAAM,SAAS;CAClC,IAAI;CAEJ,MAAM,SAAiB,aACrB,aAAa;EACX,MAAM;EACN,SAAS,WAAW,iBAAiB,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,IAAI,YAAY,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,SAAS,UAAU,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,SAAY,eAAe,UAAU,UAAU,GAAG;AAG9E,MAAI,CAFiB,eAAe,QAAQ,MAAM,SAAS,EAExC;GACjB,MAAM,gBAAgB,MAAM,QAAQ,MAAM;AAC1C,mBAAgB,gBAAgB,cAAc,SAAS;AACvD,SAAM,SAAS,cAAc;AAC7B,UAAO;;EAGT,MAAM,MAAM,eAAe,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,UAAU,sBAAuC;EACrD,GAAG;EACH;EACD,CAAC;;;;;;;CAQF,MAAM,aAAa,YAA2B;AAC5C,QAAM,cAAc,OAAO;AAC3B,cAAY;;AAGd,QAAO;EACL,mBAAmB,gCAAgC,aAAa;EAChE,aAAa,0BAA0B,aAAa;EACpD;EACA,KAAK;EACL,cAAc,OAAO;EACrB,OAAO,oBAAoB,aAAa;EACxC,QAAQ,qBAAqB,aAAa;EAC1C;EACA,MAAM,mBAAmB,aAAa;EACvC"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"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, FetchOptions, HttpRequestMethod, HttpRequestOptions, RequestWithCacheOptions, 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, FetchOptions, 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 * Called when SWR background revalidation fails.\n * Only relevant when `strategy` is `'swr'`.\n * @default console.warn\n */\n onRevalidationError?: (error: unknown) => void;\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 swrOptions = cache.onRevalidationError ? { onRevalidationError: cache.onRevalidationError } : undefined;\n const strategy = cache.strategy\n ? typeof cache.strategy === 'string'\n ? createStrategy(cache.strategy, swrOptions)\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 cacheOptions?: RequestWithCacheOptions,\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 baseKey = createCacheKey(method, path, rawQuery);\n const key = cacheOptions?.cacheKeyPrefix ? `${cacheOptions.cacheKeyPrefix}:${baseKey}` : baseKey;\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":";;;;;;;;;;;;;;;;;AA0GA,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,kBAAkB,sBAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,gBAAgB,MAAM,YAAY,2BAA2B;CACnE,MAAM,aAAa,MAAM,sBAAsB,EAAE,qBAAqB,MAAM,qBAAqB,GAAG;CACpG,MAAM,WAAW,MAAM,WACnB,OAAO,MAAM,aAAa,WACxB,eAAe,MAAM,UAAU,WAAW,GAC1C,MAAM,WACR,eAAe,cAAc;CACjC,MAAM,aAAa,MAAM,SAAS;CAClC,MAAM,aAAa,MAAM,SAAS;CAClC,IAAI;CAEJ,MAAM,SAAiB,aACrB,aAAa;EACX,MAAM;EACN,SAAS,WAAW,iBAAiB,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,IAAI,YAAY,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,SAAS,UAAU,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,SACA,iBAC8C;EAC9C,MAAM,QAAQ,cAAc,SAAY,eAAe,UAAU,UAAU,GAAG;AAG9E,MAAI,CAFiB,eAAe,QAAQ,MAAM,SAAS,EAExC;GACjB,MAAM,gBAAgB,MAAM,QAAQ,MAAM;AAC1C,mBAAgB,gBAAgB,cAAc,SAAS;AACvD,SAAM,SAAS,cAAc;AAC7B,UAAO;;EAGT,MAAM,UAAU,eAAe,QAAQ,MAAM,SAAS;EACtD,MAAM,MAAM,cAAc,iBAAiB,GAAG,aAAa,eAAe,GAAG,YAAY;EAEzF,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,UAAU,sBAAuC;EACrD,GAAG;EACH;EACD,CAAC;;;;;;;CAQF,MAAM,aAAa,YAA2B;AAC5C,QAAM,cAAc,OAAO;AAC3B,cAAY;;AAGd,QAAO;EACL,mBAAmB,gCAAgC,aAAa;EAChE,aAAa,0BAA0B,aAAa;EACpD;EACA,KAAK;EACL,cAAc,OAAO;EACrB,OAAO,oBAAoB,aAAa;EACxC,QAAQ,qBAAqB,aAAa;EAC1C;EACA,MAAM,mBAAmB,aAAa;EACvC"}
|
|
@@ -4,14 +4,18 @@ const require_sdk_gen = require('../generated/datasource_entries/sdk.gen.cjs');
|
|
|
4
4
|
function createDatasourceEntriesResource(deps) {
|
|
5
5
|
const { client, requestWithCache, asApiResponse, throttleManager } = deps;
|
|
6
6
|
return { getAll: async (options = {}) => {
|
|
7
|
-
const { query = {}, signal, throwOnError } = options;
|
|
7
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
8
8
|
const requestPath = "/v2/cdn/datasource_entries";
|
|
9
9
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
10
10
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(require_sdk_gen.getAll({
|
|
11
11
|
client,
|
|
12
12
|
query: requestQuery,
|
|
13
13
|
signal,
|
|
14
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
14
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
15
|
+
...fetchOptions ? { kyOptions: {
|
|
16
|
+
...client.getConfig().kyOptions,
|
|
17
|
+
...fetchOptions
|
|
18
|
+
} } : {}
|
|
15
19
|
})));
|
|
16
20
|
});
|
|
17
21
|
} };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datasource-entries.cjs","names":["getAllDatasourceEntriesApi"],"sources":["../../src/resources/datasource-entries.ts"],"sourcesContent":["import { getAll as getAllDatasourceEntriesApi } from '../generated/datasource_entries/sdk.gen';\nimport type {\n GetAllData as DatasourceEntriesGetAllData,\n GetAllResponses as DatasourceEntriesGetAllResponses,\n} from '../generated/datasource_entries/types.gen';\nimport type { ApiResponse, ResourceDeps } from '../types';\n\nexport function createDatasourceEntriesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourceEntriesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = '/v2/cdn/datasource_entries';\n return requestWithCache<DatasourceEntriesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>(getAllDatasourceEntriesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAOA,SAAgB,gCAAgC,MAAoB;CAClE,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,
|
|
1
|
+
{"version":3,"file":"datasource-entries.cjs","names":["getAllDatasourceEntriesApi"],"sources":["../../src/resources/datasource-entries.ts"],"sourcesContent":["import { getAll as getAllDatasourceEntriesApi } from '../generated/datasource_entries/sdk.gen';\nimport type {\n GetAllData as DatasourceEntriesGetAllData,\n GetAllResponses as DatasourceEntriesGetAllResponses,\n} from '../generated/datasource_entries/types.gen';\nimport type { ApiResponse, FetchOptions, ResourceDeps } from '../types';\n\nexport function createDatasourceEntriesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourceEntriesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = '/v2/cdn/datasource_entries';\n return requestWithCache<DatasourceEntriesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>(getAllDatasourceEntriesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAOA,SAAgB,gCAAgC,MAAoB;CAClE,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,UAA4I,EAAE,KAChE;EAC9E,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;EAC3D,MAAM,cAAc;AACpB,SAAO,iBAAsE,OAAO,aAAa,QAAQ,iBAA0C;AACjJ,UAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAAmEA,uBAA2B;IAC5F;IACA,OAAO;IACP;IACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;IACtD,GAAI,eAAe,EAAE,WAAW;KAAE,GAAG,OAAO,WAAW,CAAC;KAAW,GAAG;KAAc,EAAE,GAAG,EAAE;IAC5F,CAAC,CAAC,CAAC;IACN;IAEL"}
|
|
@@ -4,14 +4,18 @@ import { getAll } from "../generated/datasource_entries/sdk.gen.mjs";
|
|
|
4
4
|
function createDatasourceEntriesResource(deps) {
|
|
5
5
|
const { client, requestWithCache, asApiResponse, throttleManager } = deps;
|
|
6
6
|
return { getAll: async (options = {}) => {
|
|
7
|
-
const { query = {}, signal, throwOnError } = options;
|
|
7
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
8
8
|
const requestPath = "/v2/cdn/datasource_entries";
|
|
9
9
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
10
10
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(getAll({
|
|
11
11
|
client,
|
|
12
12
|
query: requestQuery,
|
|
13
13
|
signal,
|
|
14
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
14
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
15
|
+
...fetchOptions ? { kyOptions: {
|
|
16
|
+
...client.getConfig().kyOptions,
|
|
17
|
+
...fetchOptions
|
|
18
|
+
} } : {}
|
|
15
19
|
})));
|
|
16
20
|
});
|
|
17
21
|
} };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datasource-entries.mjs","names":["getAllDatasourceEntriesApi"],"sources":["../../src/resources/datasource-entries.ts"],"sourcesContent":["import { getAll as getAllDatasourceEntriesApi } from '../generated/datasource_entries/sdk.gen';\nimport type {\n GetAllData as DatasourceEntriesGetAllData,\n GetAllResponses as DatasourceEntriesGetAllResponses,\n} from '../generated/datasource_entries/types.gen';\nimport type { ApiResponse, ResourceDeps } from '../types';\n\nexport function createDatasourceEntriesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourceEntriesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = '/v2/cdn/datasource_entries';\n return requestWithCache<DatasourceEntriesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>(getAllDatasourceEntriesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAOA,SAAgB,gCAAgC,MAAoB;CAClE,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,
|
|
1
|
+
{"version":3,"file":"datasource-entries.mjs","names":["getAllDatasourceEntriesApi"],"sources":["../../src/resources/datasource-entries.ts"],"sourcesContent":["import { getAll as getAllDatasourceEntriesApi } from '../generated/datasource_entries/sdk.gen';\nimport type {\n GetAllData as DatasourceEntriesGetAllData,\n GetAllResponses as DatasourceEntriesGetAllResponses,\n} from '../generated/datasource_entries/types.gen';\nimport type { ApiResponse, FetchOptions, ResourceDeps } from '../types';\n\nexport function createDatasourceEntriesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourceEntriesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = '/v2/cdn/datasource_entries';\n return requestWithCache<DatasourceEntriesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourceEntriesGetAllResponses[200], ThrowOnError>(getAllDatasourceEntriesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAOA,SAAgB,gCAAgC,MAAoB;CAClE,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,UAA4I,EAAE,KAChE;EAC9E,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;EAC3D,MAAM,cAAc;AACpB,SAAO,iBAAsE,OAAO,aAAa,QAAQ,iBAA0C;AACjJ,UAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAAmEA,OAA2B;IAC5F;IACA,OAAO;IACP;IACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;IACtD,GAAI,eAAe,EAAE,WAAW;KAAE,GAAG,OAAO,WAAW,CAAC;KAAW,GAAG;KAAc,EAAE,GAAG,EAAE;IAC5F,CAAC,CAAC,CAAC;IACN;IAEL"}
|
|
@@ -5,7 +5,7 @@ function createDatasourcesResource(deps) {
|
|
|
5
5
|
const { client, requestWithCache, asApiResponse, throttleManager } = deps;
|
|
6
6
|
return {
|
|
7
7
|
get: async (id, options = {}) => {
|
|
8
|
-
const { query = {}, signal, throwOnError } = options;
|
|
8
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
9
9
|
const requestPath = `/v2/cdn/datasources/${id}`;
|
|
10
10
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
11
11
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(require_sdk_gen.get({
|
|
@@ -13,19 +13,27 @@ function createDatasourcesResource(deps) {
|
|
|
13
13
|
path: { id },
|
|
14
14
|
query: requestQuery,
|
|
15
15
|
signal,
|
|
16
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
16
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
17
|
+
...fetchOptions ? { kyOptions: {
|
|
18
|
+
...client.getConfig().kyOptions,
|
|
19
|
+
...fetchOptions
|
|
20
|
+
} } : {}
|
|
17
21
|
})));
|
|
18
22
|
});
|
|
19
23
|
},
|
|
20
24
|
getAll: async (options = {}) => {
|
|
21
|
-
const { query = {}, signal, throwOnError } = options;
|
|
25
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
22
26
|
const requestPath = "/v2/cdn/datasources";
|
|
23
27
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
24
28
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(require_sdk_gen.getAll({
|
|
25
29
|
client,
|
|
26
30
|
query: requestQuery,
|
|
27
31
|
signal,
|
|
28
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
32
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
33
|
+
...fetchOptions ? { kyOptions: {
|
|
34
|
+
...client.getConfig().kyOptions,
|
|
35
|
+
...fetchOptions
|
|
36
|
+
} } : {}
|
|
29
37
|
})));
|
|
30
38
|
});
|
|
31
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datasources.cjs","names":["getDatasourceApi","getAllDatasourcesApi"],"sources":["../../src/resources/datasources.ts"],"sourcesContent":["import { getAll as getAllDatasourcesApi, get as getDatasourceApi } from '../generated/datasources/sdk.gen';\nimport type {\n GetAllData as DatasourcesGetAllData,\n GetAllResponses as DatasourcesGetAllResponses,\n GetData as DatasourcesGetData,\n GetResponses as DatasourcesGetResponses,\n} from '../generated/datasources/types.gen';\nimport type { ApiResponse, ResourceDeps } from '../types';\n\nexport function createDatasourcesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n get: async <ThrowOnError extends boolean = false>(\n id: DatasourcesGetData['path']['id'],\n options: { query?: DatasourcesGetData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourcesGetResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = `/v2/cdn/datasources/${id}`;\n return requestWithCache<DatasourcesGetResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetResponses[200], ThrowOnError>(getDatasourceApi({\n client,\n path: { id },\n query: requestQuery as DatasourcesGetData['query'], // bridge generic cache callback (Record<string, unknown>) to typed SDK query\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourcesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = '/v2/cdn/datasources';\n return requestWithCache<DatasourcesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>(getAllDatasourcesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AASA,SAAgB,0BAA0B,MAAoB;CAC5D,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO;EACL,KAAK,OACH,IACA,
|
|
1
|
+
{"version":3,"file":"datasources.cjs","names":["getDatasourceApi","getAllDatasourcesApi"],"sources":["../../src/resources/datasources.ts"],"sourcesContent":["import { getAll as getAllDatasourcesApi, get as getDatasourceApi } from '../generated/datasources/sdk.gen';\nimport type {\n GetAllData as DatasourcesGetAllData,\n GetAllResponses as DatasourcesGetAllResponses,\n GetData as DatasourcesGetData,\n GetResponses as DatasourcesGetResponses,\n} from '../generated/datasources/types.gen';\nimport type { ApiResponse, FetchOptions, ResourceDeps } from '../types';\n\nexport function createDatasourcesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n get: async <ThrowOnError extends boolean = false>(\n id: DatasourcesGetData['path']['id'],\n options: { query?: DatasourcesGetData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourcesGetResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = `/v2/cdn/datasources/${id}`;\n return requestWithCache<DatasourcesGetResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetResponses[200], ThrowOnError>(getDatasourceApi({\n client,\n path: { id },\n query: requestQuery as DatasourcesGetData['query'], // bridge generic cache callback (Record<string, unknown>) to typed SDK query\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourcesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = '/v2/cdn/datasources';\n return requestWithCache<DatasourcesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>(getAllDatasourcesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AASA,SAAgB,0BAA0B,MAAoB;CAC5D,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO;EACL,KAAK,OACH,IACA,UAAmI,EAAE,KAChE;GACrE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;GAC3D,MAAM,cAAc,uBAAuB;AAC3C,UAAO,iBAA6D,OAAO,aAAa,QAAQ,iBAA0C;AACxI,WAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAA0DA,oBAAiB;KACzE;KACA,MAAM,EAAE,IAAI;KACZ,OAAO;KACP;KACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;KACtD,GAAI,eAAe,EAAE,WAAW;MAAE,GAAG,OAAO,WAAW,CAAC;MAAW,GAAG;MAAc,EAAE,GAAG,EAAE;KAC5F,CAAC,CAAC,CAAC;KACN;;EAGJ,QAAQ,OACN,UAAsI,EAAE,KAChE;GACxE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;GAC3D,MAAM,cAAc;AACpB,UAAO,iBAAgE,OAAO,aAAa,QAAQ,iBAA0C;AAC3I,WAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAA6DC,uBAAqB;KAChF;KACA,OAAO;KACP;KACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;KACtD,GAAI,eAAe,EAAE,WAAW;MAAE,GAAG,OAAO,WAAW,CAAC;MAAW,GAAG;MAAc,EAAE,GAAG,EAAE;KAC5F,CAAC,CAAC,CAAC;KACN;;EAEL"}
|
|
@@ -5,7 +5,7 @@ function createDatasourcesResource(deps) {
|
|
|
5
5
|
const { client, requestWithCache, asApiResponse, throttleManager } = deps;
|
|
6
6
|
return {
|
|
7
7
|
get: async (id, options = {}) => {
|
|
8
|
-
const { query = {}, signal, throwOnError } = options;
|
|
8
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
9
9
|
const requestPath = `/v2/cdn/datasources/${id}`;
|
|
10
10
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
11
11
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(get({
|
|
@@ -13,19 +13,27 @@ function createDatasourcesResource(deps) {
|
|
|
13
13
|
path: { id },
|
|
14
14
|
query: requestQuery,
|
|
15
15
|
signal,
|
|
16
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
16
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
17
|
+
...fetchOptions ? { kyOptions: {
|
|
18
|
+
...client.getConfig().kyOptions,
|
|
19
|
+
...fetchOptions
|
|
20
|
+
} } : {}
|
|
17
21
|
})));
|
|
18
22
|
});
|
|
19
23
|
},
|
|
20
24
|
getAll: async (options = {}) => {
|
|
21
|
-
const { query = {}, signal, throwOnError } = options;
|
|
25
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
22
26
|
const requestPath = "/v2/cdn/datasources";
|
|
23
27
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
24
28
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(getAll({
|
|
25
29
|
client,
|
|
26
30
|
query: requestQuery,
|
|
27
31
|
signal,
|
|
28
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
32
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
33
|
+
...fetchOptions ? { kyOptions: {
|
|
34
|
+
...client.getConfig().kyOptions,
|
|
35
|
+
...fetchOptions
|
|
36
|
+
} } : {}
|
|
29
37
|
})));
|
|
30
38
|
});
|
|
31
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datasources.mjs","names":["getDatasourceApi","getAllDatasourcesApi"],"sources":["../../src/resources/datasources.ts"],"sourcesContent":["import { getAll as getAllDatasourcesApi, get as getDatasourceApi } from '../generated/datasources/sdk.gen';\nimport type {\n GetAllData as DatasourcesGetAllData,\n GetAllResponses as DatasourcesGetAllResponses,\n GetData as DatasourcesGetData,\n GetResponses as DatasourcesGetResponses,\n} from '../generated/datasources/types.gen';\nimport type { ApiResponse, ResourceDeps } from '../types';\n\nexport function createDatasourcesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n get: async <ThrowOnError extends boolean = false>(\n id: DatasourcesGetData['path']['id'],\n options: { query?: DatasourcesGetData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourcesGetResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = `/v2/cdn/datasources/${id}`;\n return requestWithCache<DatasourcesGetResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetResponses[200], ThrowOnError>(getDatasourceApi({\n client,\n path: { id },\n query: requestQuery as DatasourcesGetData['query'], // bridge generic cache callback (Record<string, unknown>) to typed SDK query\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourcesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = '/v2/cdn/datasources';\n return requestWithCache<DatasourcesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>(getAllDatasourcesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AASA,SAAgB,0BAA0B,MAAoB;CAC5D,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO;EACL,KAAK,OACH,IACA,
|
|
1
|
+
{"version":3,"file":"datasources.mjs","names":["getDatasourceApi","getAllDatasourcesApi"],"sources":["../../src/resources/datasources.ts"],"sourcesContent":["import { getAll as getAllDatasourcesApi, get as getDatasourceApi } from '../generated/datasources/sdk.gen';\nimport type {\n GetAllData as DatasourcesGetAllData,\n GetAllResponses as DatasourcesGetAllResponses,\n GetData as DatasourcesGetData,\n GetResponses as DatasourcesGetResponses,\n} from '../generated/datasources/types.gen';\nimport type { ApiResponse, FetchOptions, ResourceDeps } from '../types';\n\nexport function createDatasourcesResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n get: async <ThrowOnError extends boolean = false>(\n id: DatasourcesGetData['path']['id'],\n options: { query?: DatasourcesGetData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourcesGetResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = `/v2/cdn/datasources/${id}`;\n return requestWithCache<DatasourcesGetResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetResponses[200], ThrowOnError>(getDatasourceApi({\n client,\n path: { id },\n query: requestQuery as DatasourcesGetData['query'], // bridge generic cache callback (Record<string, unknown>) to typed SDK query\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: DatasourcesGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = '/v2/cdn/datasources';\n return requestWithCache<DatasourcesGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<DatasourcesGetAllResponses[200], ThrowOnError>(getAllDatasourcesApi({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AASA,SAAgB,0BAA0B,MAAoB;CAC5D,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO;EACL,KAAK,OACH,IACA,UAAmI,EAAE,KAChE;GACrE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;GAC3D,MAAM,cAAc,uBAAuB;AAC3C,UAAO,iBAA6D,OAAO,aAAa,QAAQ,iBAA0C;AACxI,WAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAA0DA,IAAiB;KACzE;KACA,MAAM,EAAE,IAAI;KACZ,OAAO;KACP;KACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;KACtD,GAAI,eAAe,EAAE,WAAW;MAAE,GAAG,OAAO,WAAW,CAAC;MAAW,GAAG;MAAc,EAAE,GAAG,EAAE;KAC5F,CAAC,CAAC,CAAC;KACN;;EAGJ,QAAQ,OACN,UAAsI,EAAE,KAChE;GACxE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;GAC3D,MAAM,cAAc;AACpB,UAAO,iBAAgE,OAAO,aAAa,QAAQ,iBAA0C;AAC3I,WAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAA6DC,OAAqB;KAChF;KACA,OAAO;KACP;KACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;KACtD,GAAI,eAAe,EAAE,WAAW;MAAE,GAAG,OAAO,WAAW,CAAC;MAAW,GAAG;MAAc,EAAE,GAAG,EAAE;KAC5F,CAAC,CAAC,CAAC;KACN;;EAEL"}
|
package/dist/resources/links.cjs
CHANGED
|
@@ -4,14 +4,18 @@ const require_sdk_gen = require('../generated/links/sdk.gen.cjs');
|
|
|
4
4
|
function createLinksResource(deps) {
|
|
5
5
|
const { client, requestWithCache, asApiResponse, throttleManager } = deps;
|
|
6
6
|
return { getAll: async (options = {}) => {
|
|
7
|
-
const { query = {}, signal, throwOnError } = options;
|
|
7
|
+
const { query = {}, signal, throwOnError, fetchOptions } = options;
|
|
8
8
|
const requestPath = "/v2/cdn/links";
|
|
9
9
|
return requestWithCache("GET", requestPath, query, (requestQuery) => {
|
|
10
10
|
return throttleManager.execute(requestPath, requestQuery, () => asApiResponse(require_sdk_gen.getAll({
|
|
11
11
|
client,
|
|
12
12
|
query: requestQuery,
|
|
13
13
|
signal,
|
|
14
|
-
...throwOnError === void 0 ? {} : { throwOnError }
|
|
14
|
+
...throwOnError === void 0 ? {} : { throwOnError },
|
|
15
|
+
...fetchOptions ? { kyOptions: {
|
|
16
|
+
...client.getConfig().kyOptions,
|
|
17
|
+
...fetchOptions
|
|
18
|
+
} } : {}
|
|
15
19
|
})));
|
|
16
20
|
});
|
|
17
21
|
} };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"links.cjs","names":["getAllLinks"],"sources":["../../src/resources/links.ts"],"sourcesContent":["import { getAll as getAllLinks } from '../generated/links/sdk.gen';\nimport type { GetAllData as LinksGetAllData, GetAllResponses as LinksGetAllResponses } from '../generated/links/types.gen';\nimport type { ApiResponse, ResourceDeps } from '../types';\n\nexport function createLinksResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: LinksGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError } = {},\n ): Promise<ApiResponse<LinksGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError } = options;\n const requestPath = '/v2/cdn/links';\n return requestWithCache<LinksGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<LinksGetAllResponses[200], ThrowOnError>(getAllLinks({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAIA,SAAgB,oBAAoB,MAAoB;CACtD,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,
|
|
1
|
+
{"version":3,"file":"links.cjs","names":["getAllLinks"],"sources":["../../src/resources/links.ts"],"sourcesContent":["import { getAll as getAllLinks } from '../generated/links/sdk.gen';\nimport type { GetAllData as LinksGetAllData, GetAllResponses as LinksGetAllResponses } from '../generated/links/types.gen';\nimport type { ApiResponse, FetchOptions, ResourceDeps } from '../types';\n\nexport function createLinksResource(deps: ResourceDeps) {\n const { client, requestWithCache, asApiResponse, throttleManager } = deps;\n\n return {\n getAll: async <ThrowOnError extends boolean = false>(\n options: { query?: LinksGetAllData['query']; signal?: AbortSignal; throwOnError?: ThrowOnError; fetchOptions?: FetchOptions } = {},\n ): Promise<ApiResponse<LinksGetAllResponses[200], ThrowOnError>> => {\n const { query = {}, signal, throwOnError, fetchOptions } = options;\n const requestPath = '/v2/cdn/links';\n return requestWithCache<LinksGetAllResponses[200], ThrowOnError>('GET', requestPath, query, (requestQuery: Record<string, unknown>) => {\n return throttleManager.execute(requestPath, requestQuery, () =>\n asApiResponse<LinksGetAllResponses[200], ThrowOnError>(getAllLinks({\n client,\n query: requestQuery,\n signal,\n ...(throwOnError === undefined ? {} : { throwOnError }),\n ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}),\n })));\n });\n },\n };\n}\n"],"mappings":";;;AAIA,SAAgB,oBAAoB,MAAoB;CACtD,MAAM,EAAE,QAAQ,kBAAkB,eAAe,oBAAoB;AAErE,QAAO,EACL,QAAQ,OACN,UAAgI,EAAE,KAChE;EAClE,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,cAAc,iBAAiB;EAC3D,MAAM,cAAc;AACpB,SAAO,iBAA0D,OAAO,aAAa,QAAQ,iBAA0C;AACrI,UAAO,gBAAgB,QAAQ,aAAa,oBAC1C,cAAuDA,uBAAY;IACjE;IACA,OAAO;IACP;IACA,GAAI,iBAAiB,SAAY,EAAE,GAAG,EAAE,cAAc;IACtD,GAAI,eAAe,EAAE,WAAW;KAAE,GAAG,OAAO,WAAW,CAAC;KAAW,GAAG;KAAc,EAAE,GAAG,EAAE;IAC5F,CAAC,CAAC,CAAC;IACN;IAEL"}
|