@contentful/experiences-client 0.10.0 → 0.10.2
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/CHANGELOG.md +20 -0
- package/README.md +19 -5
- package/dist/index.cjs +327 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +251 -0
- package/dist/index.d.mts +251 -0
- package/dist/index.d.ts +246 -10
- package/dist/index.js +310 -16
- package/dist/index.js.map +1 -1
- package/package.json +10 -5
- package/dist/client-resolution.d.ts +0 -34
- package/dist/client-resolution.js +0 -23
- package/dist/client-resolution.js.map +0 -1
- package/dist/create-delivery-client.d.ts +0 -15
- package/dist/create-delivery-client.js +0 -13
- package/dist/create-delivery-client.js.map +0 -1
- package/dist/destination-guards.d.ts +0 -16
- package/dist/destination-guards.js +0 -14
- package/dist/destination-guards.js.map +0 -1
- package/dist/errors.d.ts +0 -57
- package/dist/errors.js +0 -31
- package/dist/errors.js.map +0 -1
- package/dist/fetch-destination-sitemap.d.ts +0 -41
- package/dist/fetch-destination-sitemap.js +0 -50
- package/dist/fetch-destination-sitemap.js.map +0 -1
- package/dist/fetch-experience.d.ts +0 -76
- package/dist/fetch-experience.js +0 -129
- package/dist/fetch-experience.js.map +0 -1
- package/dist/hosts.d.ts +0 -5
- package/dist/hosts.js +0 -9
- package/dist/hosts.js.map +0 -1
- package/dist/to-experience-payload.d.ts +0 -31
- package/dist/to-experience-payload.js +0 -16
- package/dist/to-experience-payload.js.map +0 -1
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { ContentfulViewDelivery } from '@contentful/experience-delivery';\n\nexport {\n ContentfulViewDelivery,\n ContentfulViewDeliveryClient,\n} from '@contentful/experience-delivery';\nexport const NotFoundError = ContentfulViewDelivery.NotFoundError;\n// eslint-disable-next-line no-redeclare -- value + type share a name across separate TS namespaces, not a real redeclaration\nexport type NotFoundError = InstanceType<typeof ContentfulViewDelivery.NotFoundError>;\nexport { ExperienceFetchError, DestinationPreviewNotSupportedError } from './errors.js';\nexport { createClient } from './create-delivery-client.js';\nexport type { CreateClientOptions } from './create-delivery-client.js';\nexport { fetchExperience } from './fetch-experience.js';\nexport { fetchDestinationSitemap } from './fetch-destination-sitemap.js';\nexport type {\n FetchDestinationSitemapOptions,\n FetchDestinationSitemapPaginationOptions,\n SitemapPathItem,\n DestinationSitemapResult,\n} from './fetch-destination-sitemap.js';\nexport {\n readSourceMap,\n toExperiencePayload,\n toExperiencePayloadFromDestination,\n} from './to-experience-payload.js';\nexport type { ExperienceResponse } from './to-experience-payload.js';\nexport type {\n ExperienceOptions,\n ExperienceRequestExtensions,\n PersonalizationOptions,\n ByIdExperienceOptions,\n ByDestinationNodeIdExperienceOptions,\n ByDestinationPathExperienceOptions,\n ClientOptions,\n ResolveOptions,\n DestinationRedirectResult,\n} from './fetch-experience.js';\nexport { DELIVERY_HOST, PREVIEW_HOST, PREVIEW_WEBSOCKET_HOST } from './hosts.js';\n"],"mappings":"AAAA,SAAS,8BAA8B;AAEvC;AAAA,EACE,0BAAAA;AAAA,EACA;AAAA,OACK;AACA,MAAM,gBAAgB,uBAAuB;AAGpD,SAAS,sBAAsB,2CAA2C;AAC1E,SAAS,oBAAoB;AAE7B,SAAS,uBAAuB;AAChC,SAAS,+BAA+B;AAOxC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAaP,SAAS,eAAe,cAAc,8BAA8B;","names":["ContentfulViewDelivery"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/errors.ts","../src/create-delivery-client.ts","../src/fetch-experience.ts","../src/personalization.ts","../src/destination-guards.ts","../src/hosts.ts","../src/client-resolution.ts","../src/experience-parameters.ts","../src/to-experience-payload.ts","../src/fetch-destination-sitemap.ts"],"sourcesContent":["import { ContentfulViewDelivery } from '@contentful/experience-delivery';\n\nexport {\n ContentfulViewDelivery,\n ContentfulViewDeliveryClient,\n} from '@contentful/experience-delivery';\nexport const NotFoundError = ContentfulViewDelivery.NotFoundError;\n// eslint-disable-next-line no-redeclare -- value + type share a name across separate TS namespaces, not a real redeclaration\nexport type NotFoundError = InstanceType<typeof ContentfulViewDelivery.NotFoundError>;\nexport { ExperienceFetchError, DestinationPreviewNotSupportedError } from './errors.js';\nexport { createClient } from './create-delivery-client.js';\nexport type { CreateClientOptions } from './create-delivery-client.js';\nexport { fetchExperience } from './fetch-experience.js';\nexport { fetchDestinationSitemap } from './fetch-destination-sitemap.js';\nexport type {\n FetchDestinationSitemapOptions,\n FetchDestinationSitemapPaginationOptions,\n SitemapPathItem,\n DestinationSitemapResult,\n} from './fetch-destination-sitemap.js';\nexport {\n readSourceMap,\n toExperiencePayload,\n toExperiencePayloadFromDestination,\n} from './to-experience-payload.js';\nexport type { ExperienceResponse } from './to-experience-payload.js';\nexport type {\n ExperienceOptions,\n ExperienceRequestExtensions,\n PersonalizationOptions,\n ByIdExperienceOptions,\n ByDestinationNodeIdExperienceOptions,\n ByDestinationPathExperienceOptions,\n ClientOptions,\n ResolveOptions,\n DestinationRedirectResult,\n} from './fetch-experience.js';\nexport { DELIVERY_HOST, PREVIEW_HOST, PREVIEW_WEBSOCKET_HOST } from './hosts.js';\nexport type {\n ExperienceParameters,\n ExperienceParameterValue,\n ExperienceParameterRecord,\n ExperienceParameterOrder,\n} from './experience-parameters.js';\nexport { serializePersonalization } from './personalization.js';\n","/**\n * Thrown by `fetchExperience` for a fetch failure that is not \"experience not\n * found\" — network failure, an invalid/expired token, a 5xx from the\n * delivery API, etc. This failure mode is \"surface clearly to the host app,\"\n * unlike the diagnostics `resolveExperience` collects for resolve/render-time\n * issues — there's no partial payload to render around a fetch that never\n * returned one, so a real thrown class is the right shape.\n *\n * `NotFoundError` (the delivery client's class, re-exported from this\n * package) is the one exception: it passes through undisturbed so callers\n * can route it to their framework's 404 idiom, per the existing\n * distinguishable-404 contract.\n *\n * `environmentId` is `undefined` for the destination-shaped `fetchExperience`\n * branches — the destinations delivery endpoints are space-scoped only, with\n * no environment segment, unlike the by-id path.\n */\nexport class ExperienceFetchError extends Error {\n readonly spaceId: string;\n readonly environmentId: string | undefined;\n readonly experienceId: string;\n\n constructor(\n message: string,\n options: {\n spaceId: string;\n environmentId?: string;\n experienceId: string;\n cause?: unknown;\n }\n ) {\n super(message, options.cause !== undefined ? { cause: options.cause } : undefined);\n this.name = 'ExperienceFetchError';\n this.spaceId = options.spaceId;\n this.environmentId = options.environmentId;\n this.experienceId = options.experienceId;\n }\n}\n\n/**\n * Thrown by `fetchExperience` and `fetchDestinationSitemap` when\n * `clientOptions.preview` is `true` for a destination-shaped call\n * (`destinationId` + `nodeId`/`path`, or a sitemap fetch). The Destinations\n * Delivery API has no preview host or preview-token support yet, so this\n * guards against silently hitting the production host with a preview token\n * it doesn't accept.\n *\n * This is a bridge, not a permanent design: revisit once the platform ships\n * preview support for destinations.\n *\n * Only fires for the inline-credentials branch of `ClientOptions`. A\n * caller-supplied `{ client }` already ignores `preview` entirely, per that\n * branch's existing contract.\n */\nexport class DestinationPreviewNotSupportedError extends Error {\n readonly spaceId: string;\n readonly destinationId: string;\n readonly nodeId: string | undefined;\n readonly path: string | undefined;\n\n constructor(\n message: string,\n options: { spaceId: string; destinationId: string; nodeId?: string; path?: string }\n ) {\n super(message);\n this.name = 'DestinationPreviewNotSupportedError';\n this.spaceId = options.spaceId;\n this.destinationId = options.destinationId;\n this.nodeId = options.nodeId;\n this.path = options.path;\n }\n}\n","import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\n\n/** Options for the legacy functional Delivery client constructor. */\nexport type CreateClientOptions = {\n accessToken: string;\n /**\n * Base URL for the delivery client. Defaults to `DELIVERY_HOST` when omitted.\n * Pass `PREVIEW_HOST` for preview mode, or any custom URL (staging, proxy,\n * per-region). Both constants are exported from this package.\n */\n host?: string;\n} & Omit<ContentfulViewDeliveryClient.Options, 'token' | 'baseUrl'>;\n\nexport function createClient(options: CreateClientOptions): ContentfulViewDeliveryClient {\n const { accessToken, host, ...rest } = options;\n return new ContentfulViewDeliveryClient({\n ...rest,\n token: accessToken,\n baseUrl: host,\n });\n}\n","import type { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\nimport { ContentfulViewDelivery } from '@contentful/experience-delivery';\nimport { serializePersonalization } from './personalization.js';\nimport { createDebugLogger, resolveExperience } from '@contentful/experiences-sdk-core';\nimport type { PortableRenderPlan, ResolverConfig } from '@contentful/experiences-sdk-core';\nimport { assertDestinationPreviewSupported } from './destination-guards.js';\nimport { resolveDeliveryClient, type ClientOptions } from './client-resolution.js';\nimport { ExperienceFetchError } from './errors.js';\nimport { parameterQuery, type ExperienceParameters } from './experience-parameters.js';\nimport {\n toExperiencePayload,\n toExperiencePayloadFromDestination,\n type ExperienceResponse,\n} from './to-experience-payload.js';\n\nexport type { ClientOptions };\n\ntype DeliveryExperienceRequestExtensions =\n ContentfulViewDelivery.GetWithOverridesExperienceRequestExtensions;\n\nexport type PersonalizationOptions = NonNullable<\n DeliveryExperienceRequestExtensions['personalization']\n>;\n\nexport type ExperienceRequestExtensions = Omit<\n DeliveryExperienceRequestExtensions,\n 'personalization'\n>;\n\nexport type ByIdExperienceOptions = {\n spaceId: string;\n environmentId: string;\n experienceId: string;\n locale?: string;\n /** Values for declared Experience parameters. Refetch with new values to swap content. */\n parameters?: ExperienceParameters;\n /**\n * Profile and events used by XDA to personalize the resolved Experience.\n */\n personalization?: PersonalizationOptions;\n /**\n * Additional XDA request extensions such as source maps. Supplying a defined\n * extension switches the request to POST.\n */\n extensions?: ExperienceRequestExtensions;\n};\n\n/**\n * Resolve an Experience by the Destination Node instead of `experienceId`\n * The destinations delivery endpoints are space-scoped only and have no locale\n * param, unlike the by-id path.\n */\nexport type ByDestinationNodeIdExperienceOptions = {\n spaceId: string;\n destinationId: string;\n nodeId: string;\n};\n\n/**\n * Resolve an Experience by the absolute path wired up to a\n * Destination Node, instead of a node id directly. Same scoping as\n * `ByDestinationNodeIdExperienceOptions` — no `environmentId` or `locale`.\n */\nexport type ByDestinationPathExperienceOptions = {\n spaceId: string;\n destinationId: string;\n /** Absolute path to resolve. Must start with `/`. */\n path: string;\n};\n\nexport type ExperienceOptions =\n ByIdExperienceOptions | ByDestinationNodeIdExperienceOptions | ByDestinationPathExperienceOptions;\n\n/**\n * A Destination resolution that the app must act on as control flow — honor\n * it by navigating or re-resolving at the new path — rather than a hydrated\n * Experience to render. Modeled as a normal return value, not a thrown error,\n * per the Destinations delivery API's own framing of a redirect response.\n */\nexport interface DestinationRedirectResult {\n redirect: { path: string };\n}\n\nexport type ResolveOptions = {\n config: ResolverConfig;\n /**\n * Arbitrary per-render metadata exposed to every resolver as\n * `ctx.experience.metadata` and readable at render time via the framework\n * adapter's `useExperience()` / `getExperience()`.\n */\n metadata?: Record<string, unknown>;\n /**\n * Observability switch. When on: logs the fetch (host, ids) and the raw\n * payload here, and threads through to `resolveExperience` (resolution steps\n * + `resolveData` timings) and the renderer (visible missing-component box,\n * debug fallback). A single boolean across fetch + resolve + render.\n */\n debug?: boolean;\n};\n\n// TS overload signatures, not real redeclarations — base ESLint's no-redeclare doesn't know the\n// overload form (@typescript-eslint's own version does), so each repeated signature needs a\n// disable comment.\nexport async function fetchExperience(\n experienceOptions: ByIdExperienceOptions,\n clientOptions: ClientOptions,\n resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan>;\n// eslint-disable-next-line no-redeclare -- see above\nexport async function fetchExperience(\n experienceOptions: ByDestinationNodeIdExperienceOptions,\n clientOptions: ClientOptions,\n resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan | DestinationRedirectResult>;\n// eslint-disable-next-line no-redeclare -- see above\nexport async function fetchExperience(\n experienceOptions: ByDestinationPathExperienceOptions,\n clientOptions: ClientOptions,\n resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan | DestinationRedirectResult>;\n// eslint-disable-next-line no-redeclare -- see above\nexport async function fetchExperience(\n experienceOptions: ExperienceOptions,\n clientOptions: ClientOptions,\n resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan | DestinationRedirectResult> {\n const { config, metadata, debug } = resolveOptions;\n const log = createDebugLogger(debug, 'client');\n\n if (!('client' in clientOptions) && 'destinationId' in experienceOptions) {\n const { spaceId, destinationId } = experienceOptions;\n const locator =\n 'nodeId' in experienceOptions\n ? { nodeId: experienceOptions.nodeId }\n : { path: experienceOptions.path };\n assertDestinationPreviewSupported(clientOptions.preview, {\n spaceId,\n destinationId,\n ...locator,\n });\n }\n\n const client = resolveDeliveryClient(clientOptions, log, 'fetchExperience');\n\n if ('nodeId' in experienceOptions) {\n const { spaceId, destinationId, nodeId } = experienceOptions;\n return fetchByDestination(\n { spaceId, destinationId, locator: nodeId },\n () => client.destination.resolveByNodeId(spaceId, destinationId, nodeId),\n log,\n { config, metadata, debug }\n );\n }\n\n if ('path' in experienceOptions) {\n const { spaceId, destinationId, path } = experienceOptions;\n return fetchByDestination(\n { spaceId, destinationId, locator: path },\n () => client.destination.resolveByPath(spaceId, destinationId, { path }),\n log,\n { config, metadata, debug }\n );\n }\n\n const { spaceId, environmentId, experienceId, locale, personalization, extensions } =\n experienceOptions;\n\n log.log('fetching experience', {\n spaceId,\n environmentId,\n experienceId,\n locale,\n // avoiding log any personalization sensitive data\n personalization: personalization !== undefined,\n extensions,\n });\n\n const response = await fetchByExperienceId(client, experienceOptions);\n\n const payload = toExperiencePayload(response);\n log.lazy('received raw payload', () => payload);\n\n return resolveExperience(payload, config, { metadata, debug });\n}\n\nasync function fetchByExperienceId(\n client: ContentfulViewDeliveryClient,\n options: ByIdExperienceOptions\n): Promise<ExperienceResponse> {\n const { spaceId, environmentId, experienceId, locale, parameters, personalization, extensions } =\n options;\n const requestExtensions: DeliveryExperienceRequestExtensions = { ...extensions };\n if (personalization !== undefined) {\n requestExtensions.personalization = serializePersonalization(personalization);\n }\n\n try {\n // GET uses namespaced query leaves. POST preserves values that cannot be\n // represented by leaves and carries existing request extensions.\n // The generated delivery client owns the alpha-feature header on both\n // paths, including when the caller supplied the client instance.\n //\n // Await inside the try so rejected requests are normalized below.\n const queryParams = parameterQuery(parameters);\n if (hasRequestExtensions(requestExtensions) || queryParams === undefined) {\n // dev.10's POST serializer passes through extra body keys. Its generated\n // request type omits parameters, so retain our typed extension locally.\n // TODO: Remove this intersection once contentful-experience-delivery.js\n // generates parameters on GetWithOverridesExperienceRequest and we upgrade.\n const request: ContentfulViewDelivery.GetWithOverridesExperienceRequest & {\n parameters?: ExperienceParameters;\n } = {\n locale,\n extensions: requestExtensions,\n ...(parameters === undefined ? {} : { parameters }),\n };\n return await client.experience.getWithOverrides(\n spaceId,\n environmentId,\n experienceId,\n request\n );\n }\n\n if (Object.keys(queryParams).length > 0) {\n return await client.experience.get(\n spaceId,\n environmentId,\n experienceId,\n { locale },\n {\n queryParams,\n }\n );\n }\n return await client.experience.get(spaceId, environmentId, experienceId, { locale });\n } catch (err) {\n // Preserve expected 404 control flow for framework routers. Other failures\n // are wrapped with stable SDK context instead of exposing transport-specific\n // error shapes.\n if (err instanceof ContentfulViewDelivery.NotFoundError) {\n throw err;\n }\n const reason = err instanceof Error ? err.message : String(err);\n throw new ExperienceFetchError(\n `Failed to fetch Experience \"${experienceId}\" (space \"${spaceId}\", environment ` +\n `\"${environmentId}\"): ${reason}. Check network connectivity, the access token, and ` +\n `that the space/environment/experience ids are correct.`,\n { spaceId, environmentId, experienceId, cause: err }\n );\n }\n}\n\n/**\n * Shared response-handling for both destination-shaped `fetchExperience`\n * branches (by node id, by path).\n */\nasync function fetchByDestination(\n identity: { spaceId: string; destinationId: string; locator: string },\n resolve: () => Promise<ContentfulViewDelivery.DestinationExperienceResolutionResponse>,\n log: ReturnType<typeof createDebugLogger>,\n resolveOptions: {\n config: ResolverConfig;\n metadata: Record<string, unknown> | undefined;\n debug: boolean | undefined;\n }\n): Promise<PortableRenderPlan | DestinationRedirectResult> {\n const { spaceId, destinationId, locator } = identity;\n const { config, metadata, debug } = resolveOptions;\n\n log.log('resolving destination experience', { spaceId, destinationId, locator });\n\n let response: ContentfulViewDelivery.DestinationExperienceResolutionResponse;\n try {\n response = await resolve();\n } catch (err) {\n if (err instanceof ContentfulViewDelivery.NotFoundError) {\n throw err;\n }\n const reason = err instanceof Error ? err.message : String(err);\n throw new ExperienceFetchError(\n `Failed to resolve Destination \"${destinationId}\" at \"${locator}\" (space \"${spaceId}\"): ` +\n `${reason}. Check network connectivity, the access token, and that the space/` +\n `destination/node-or-path values are correct.`,\n { spaceId, experienceId: locator, cause: err }\n );\n }\n\n if ('redirect' in response) {\n log.log('destination resolved to a redirect', response.redirect);\n return { redirect: response.redirect };\n }\n\n const [firstExperience] = response.experiences;\n if (!firstExperience) {\n throw new ExperienceFetchError(\n `Destination \"${destinationId}\" resolved \"${locator}\" to zero Experiences ` +\n `(space \"${spaceId}\"). Expected exactly one hydrated Experience or a redirect.`,\n { spaceId, experienceId: locator }\n );\n }\n\n const payload = toExperiencePayloadFromDestination(firstExperience.experience);\n log.lazy('received raw payload', () => payload);\n\n return resolveExperience(payload, config, {\n metadata,\n debug,\n });\n}\n\nfunction hasRequestExtensions(\n extensions: DeliveryExperienceRequestExtensions | undefined\n): extensions is DeliveryExperienceRequestExtensions {\n return (\n extensions !== undefined &&\n Object.values(extensions).some((extension) => extension !== undefined)\n );\n}\n","import { GetWithOverridesExperienceRequestExtensionsPersonalization as personalizationSchema } from '@contentful/experience-delivery/serialization';\nimport type { PersonalizationOptions } from './fetch-experience.js';\n\n/** Validate and serialize events to the generated XDA request contract. */\nexport function serializePersonalization(personalization: unknown): PersonalizationOptions {\n try {\n // XDA rejects EventBuilder's context.gdpr with HTTP 422. Keep caller-built\n // events intact and serialize to its generated schema, which omits consent.\n return personalizationSchema.parseOrThrow(personalization, {\n unrecognizedObjectKeys: 'strip',\n });\n } catch (cause) {\n throw new TypeError('Invalid Experience personalization options', { cause });\n }\n}\n","import { DestinationPreviewNotSupportedError } from './errors.js';\n\n/**\n * Throws `DestinationPreviewNotSupportedError` when `clientOptions.preview` is\n * `true` and `experienceOptions` is destination-shaped (a caller-supplied\n * `{ client }` already ignores `preview` entirely, so this only fires for the\n * inline-credentials branch). Shared by `fetchExperience` and\n * `fetchDestinationSitemap` — both call into the same preview-less\n * Destinations Delivery API.\n */\nexport function assertDestinationPreviewSupported(\n isPreview: boolean | undefined,\n destination: { spaceId: string; destinationId: string; nodeId?: string; path?: string }\n): void {\n if (!isPreview) return;\n\n const { spaceId, destinationId, nodeId, path } = destination;\n const locator = nodeId !== undefined ? `nodeId \"${nodeId}\"` : `path \"${path}\"`;\n throw new DestinationPreviewNotSupportedError(\n `preview: true was combined with a destination-shaped call (destinationId ` +\n `\"${destinationId}\", ${locator}). The Destinations Delivery API does not support ` +\n `preview mode yet — pass preview: false (or omit it) for destination-based fetches.`,\n { spaceId, destinationId, nodeId, path }\n );\n}\n","export const DELIVERY_HOST = 'https://xdn.contentful.com';\nexport const PREVIEW_HOST = 'https://preview.xdn.contentful.com';\nexport const PREVIEW_WEBSOCKET_HOST = 'wss://preview.xdn.contentful.com';\n","import type { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\nimport { createClient } from './create-delivery-client.js';\nimport { createDebugLogger } from '@contentful/experiences-sdk-core';\nimport { PREVIEW_HOST } from './hosts.js';\n\nexport type ClientOptions =\n | {\n accessToken: string;\n /**\n * Preview access token. Required when calling with `preview: true`.\n */\n previewToken?: string;\n /**\n * Flip between delivery (default) and preview at request time. When\n * `true`, uses `previewToken` and the preview host; when `false` or\n * unset, uses `accessToken` and the delivery host. Ignored when a\n * pre-made `client` is passed instead of inline creds.\n */\n preview?: boolean;\n /**\n * Custom base URL for the delivery client (staging, proxy, per-region).\n * Wins over the `preview`-derived default host — combine `host` with\n * `preview: true` to point preview mode at a non-prod endpoint.\n * Omit for the standard delivery / preview hosts.\n */\n host?: string;\n }\n | { client: ContentfulViewDeliveryClient };\n\n/**\n * Resolve a `ClientOptions` union into a real delivery client. Shared by\n * `fetchExperience` and `fetchDestinationSitemap` — both accept the same\n * inline-creds-or-pre-made-client shape.\n */\nexport function resolveDeliveryClient(\n clientOptions: ClientOptions,\n log: ReturnType<typeof createDebugLogger>,\n callerName: string\n): ContentfulViewDeliveryClient {\n if ('client' in clientOptions) {\n log.log('using caller-supplied delivery client');\n return clientOptions.client;\n }\n\n const { accessToken, previewToken, preview, host } = clientOptions;\n if (preview && !previewToken) {\n throw new Error(`${callerName}() called with preview: true but no previewToken was provided`);\n }\n const resolvedHost = host ?? (preview ? PREVIEW_HOST : undefined);\n const client = createClient({\n accessToken: preview ? (previewToken as string) : accessToken,\n host: resolvedHost,\n });\n log.log('created delivery client', { preview: Boolean(preview), host: resolvedHost });\n return client;\n}\n","/** One collection order path; `-` selects descending order. Delivery validates the path. */\nexport type ExperienceParameterOrder =\n `fields.${string}` | `sys.${string}` | `-fields.${string}` | `-sys.${string}`;\n\n/** Runtime values for one Record parameter. Nested records and arrays are not supported. */\nexport type ExperienceParameterRecord = Record<string, string | number>;\n\nexport type ExperienceParameterValue = string | number | ExperienceParameterRecord;\n\n/** Unprefixed IDs declared in Experience.parameters and referenced as `$parameters/<id>`. */\nexport type ExperienceParameters = Record<string, ExperienceParameterValue>;\n\n/**\n * Flatten values for the generated client's GET queryParams escape hatch.\n * An empty Record cannot be represented by query leaves: preserve it via POST.\n * Delivery owns name, requiredness, fallback and value validation.\n */\nexport function parameterQuery(\n parameters: ExperienceParameters | undefined\n): Record<string, string | number> | undefined {\n const entries: [string, string | number][] = [];\n for (const [id, value] of Object.entries(parameters ?? {})) {\n // A dotted ID could masquerade as another parameter's Record leaf on GET.\n // Preserve the original name on POST and let delivery validate it.\n if (id.includes('.')) return undefined;\n if (typeof value === 'string' || typeof value === 'number') {\n entries.push([`parameter.${id}`, value]);\n } else {\n // Untyped callers can supply other JSON shapes. Use POST so delivery\n // sees their original value rather than a lossy query string coercion.\n if (value === null || typeof value !== 'object' || Array.isArray(value)) return undefined;\n const leaves = Object.entries(value);\n if (leaves.length === 0) return undefined;\n for (const [field, leaf] of leaves) {\n if (field.includes('.')) return undefined;\n if (typeof leaf !== 'string' && typeof leaf !== 'number') return undefined;\n entries.push([`parameter.${id}.${field}`, leaf]);\n }\n }\n }\n return Object.fromEntries(entries);\n}\n","/*\n * Typed narrowing from a delivery-client response to the payload shape the\n * renderer consumes.\n */\n\nimport type { ContentfulViewDelivery } from '@contentful/experience-delivery';\nimport type { ExperiencePayload, ExperienceSourceMap } from '@contentful/experiences-sdk-core';\n\n/** Either shape the experience endpoint can return — `get()` and `getWithOverrides()` share it. */\nexport type ExperienceResponse =\n | ContentfulViewDelivery.GetExperienceResponse\n | ContentfulViewDelivery.GetWithOverridesExperienceResponse;\n\n/**\n * Narrow a delivery response to `ExperiencePayload`.\n *\n * The endpoint types its response as `HydratedView | HydratedExperienceView`.\n * The alpha-feature header the delivery client always sends guarantees the\n * latter, but TypeScript cannot know that, so callers were left casting by hand.\n *\n * `fetchExperience` uses this internally; it is exported for anyone driving the\n * delivery client directly. Type-level only — no validation, no copying.\n *\n * A legacy-shaped response carries `componentType` / `template` links instead;\n * `resolveExperience` reports those through `warnUnrenderableNode`.\n */\nexport function toExperiencePayload(response: ExperienceResponse): ExperiencePayload {\n return response as ContentfulViewDelivery.HydratedExperienceView as ExperiencePayload;\n}\n\n/** Read `extensions.sourceMap` off a response. `undefined` when the request did not opt in. */\nexport function readSourceMap(response: ExperienceResponse): ExperienceSourceMap | undefined {\n const extensions = (response as ContentfulViewDelivery.HydratedExperienceView).extensions;\n return extensions?.sourceMap as ExperienceSourceMap | undefined;\n}\n\n/**\n * Narrow a `ResolvedDestinationExperience.experience` to `ExperiencePayload`.\n *\n * Same cast rationale as `toExperiencePayload` above, for the destination\n * resolution endpoints' `HydratedExperience` shape instead of the by-id\n * endpoints' `HydratedExperienceView`.\n */\nexport function toExperiencePayloadFromDestination(\n experience: ContentfulViewDelivery.HydratedExperience\n): ExperiencePayload {\n return experience as unknown as ExperiencePayload;\n}\n","import { ContentfulViewDelivery } from '@contentful/experience-delivery';\nimport { createDebugLogger } from '@contentful/experiences-sdk-core';\nimport { assertDestinationPreviewSupported } from './destination-guards.js';\nimport { resolveDeliveryClient, type ClientOptions } from './client-resolution.js';\nimport { ExperienceFetchError } from './errors.js';\n\nexport type FetchDestinationSitemapOptions = {\n spaceId: string;\n destinationId: string;\n};\n\nexport type FetchDestinationSitemapPaginationOptions = {\n /** Maximum number of paths to return. Defaults to `100`, maximum `1000`. */\n limit?: number;\n /** Cursor from a previous call's `pages.next`. Treat as opaque; don't combine with `pagePrev`. */\n pageNext?: string;\n /** Cursor from a previous call's `pages.prev`. Treat as opaque; don't combine with `pageNext`. */\n pagePrev?: string;\n};\n\nexport type SitemapPathItem = {\n /** Path this entry routes. */\n path: string;\n /** Flat id extracted from the entry's `experienceUrn`. */\n experienceId: string;\n /** Type of the Destination Node that claims this path, e.g. `\"DestinationExperienceNode\"`. */\n type: string;\n};\n\nexport type DestinationSitemapResult = {\n items: SitemapPathItem[];\n limit: number;\n pages: { next?: string; prev?: string };\n};\n\n/**\n * List every routable path in a published Destination. Bulk enumeration —\n * pairs with `fetchExperience`'s `destinationId` + `nodeId`/`path` branches,\n * which resolve one path at a time. Does not hydrate any Experience itself\n * and does not call `fetchExperience` internally.\n */\nexport async function fetchDestinationSitemap(\n destinationOptions: FetchDestinationSitemapOptions,\n clientOptions: ClientOptions,\n paginationOptions: FetchDestinationSitemapPaginationOptions = {}\n): Promise<DestinationSitemapResult> {\n const { spaceId, destinationId } = destinationOptions;\n const log = createDebugLogger(false, 'client');\n\n if (!('client' in clientOptions)) {\n assertDestinationPreviewSupported(clientOptions.preview, { spaceId, destinationId });\n }\n\n const client = resolveDeliveryClient(clientOptions, log, 'fetchDestinationSitemap');\n\n const { limit, pageNext, pagePrev } = paginationOptions;\n\n let response: ContentfulViewDelivery.DestinationSitemap;\n try {\n response = await client.destination.sitemap(spaceId, destinationId, {\n limit,\n pageNext,\n pagePrev,\n });\n } catch (err) {\n if (err instanceof ContentfulViewDelivery.NotFoundError) {\n throw err;\n }\n const reason = err instanceof Error ? err.message : String(err);\n throw new ExperienceFetchError(\n `Failed to fetch sitemap for Destination \"${destinationId}\" (space \"${spaceId}\"): ` +\n `${reason}. Check network connectivity, the access token, and that the space/` +\n `destination ids are correct.`,\n { spaceId, experienceId: destinationId, cause: err }\n );\n }\n\n const result = {\n items: response.paths.items.map((item) => ({\n path: item.path,\n experienceId: extractIdFromUrn(item.experienceUrn),\n type: item.sys.type,\n })),\n limit: response.paths.limit,\n pages: response.paths.pages,\n };\n\n log.lazy('received sitemap page', () => result);\n\n return result;\n}\n\n/**\n * Extract the flat id from an `experienceUrn`. Real shape:\n * crn:contentful:::experience:spaces/$self/environments/$self/experiences/<id>\n *\n * Same one-line logic as the private `extractIdFromUrn` in\n * `packages/core/src/resolve-experience.ts` — not shared across the\n * `core`/`client` package boundary (core stays zero-dep) for one line.\n */\nfunction extractIdFromUrn(urn: string): string {\n const segments = urn.split('/').filter((s) => s.length > 0);\n return segments[segments.length - 1] ?? urn;\n}\n"],"mappings":";AAAA,SAAS,0BAAAA,+BAA8B;AAEvC;AAAA,EACE,0BAAAA;AAAA,EACA,gCAAAC;AAAA,OACK;;;ACYA,IAAM,uBAAN,cAAmC,MAAM;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EAET,YACE,SACA,SAMA;AACA,UAAM,SAAS,QAAQ,UAAU,SAAY,EAAE,OAAO,QAAQ,MAAM,IAAI,MAAS;AACjF,SAAK,OAAO;AACZ,SAAK,UAAU,QAAQ;AACvB,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,eAAe,QAAQ;AAAA,EAC9B;AACF;AAiBO,IAAM,sCAAN,cAAkD,MAAM;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAET,YACE,SACA,SACA;AACA,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,UAAU,QAAQ;AACvB,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,SAAS,QAAQ;AACtB,SAAK,OAAO,QAAQ;AAAA,EACtB;AACF;;;ACvEA,SAAS,oCAAoC;AAatC,SAAS,aAAa,SAA4D;AACvF,QAAM,EAAE,aAAa,MAAM,GAAG,KAAK,IAAI;AACvC,SAAO,IAAI,6BAA6B;AAAA,IACtC,GAAG;AAAA,IACH,OAAO;AAAA,IACP,SAAS;AAAA,EACX,CAAC;AACH;;;ACnBA,SAAS,8BAA8B;;;ACDvC,SAAS,8DAA8D,6BAA6B;AAI7F,SAAS,yBAAyB,iBAAkD;AACzF,MAAI;AAGF,WAAO,sBAAsB,aAAa,iBAAiB;AAAA,MACzD,wBAAwB;AAAA,IAC1B,CAAC;AAAA,EACH,SAAS,OAAO;AACd,UAAM,IAAI,UAAU,8CAA8C,EAAE,MAAM,CAAC;AAAA,EAC7E;AACF;;;ADXA,SAAS,mBAAmB,yBAAyB;;;AEO9C,SAAS,kCACd,WACA,aACM;AACN,MAAI,CAAC,UAAW;AAEhB,QAAM,EAAE,SAAS,eAAe,QAAQ,KAAK,IAAI;AACjD,QAAM,UAAU,WAAW,SAAY,WAAW,MAAM,MAAM,SAAS,IAAI;AAC3E,QAAM,IAAI;AAAA,IACR,6EACM,aAAa,MAAM,OAAO;AAAA,IAEhC,EAAE,SAAS,eAAe,QAAQ,KAAK;AAAA,EACzC;AACF;;;ACxBO,IAAM,gBAAgB;AACtB,IAAM,eAAe;AACrB,IAAM,yBAAyB;;;ACgC/B,SAAS,sBACd,eACA,KACA,YAC8B;AAC9B,MAAI,YAAY,eAAe;AAC7B,QAAI,IAAI,uCAAuC;AAC/C,WAAO,cAAc;AAAA,EACvB;AAEA,QAAM,EAAE,aAAa,cAAc,SAAS,KAAK,IAAI;AACrD,MAAI,WAAW,CAAC,cAAc;AAC5B,UAAM,IAAI,MAAM,GAAG,UAAU,+DAA+D;AAAA,EAC9F;AACA,QAAM,eAAe,SAAS,UAAU,eAAe;AACvD,QAAM,SAAS,aAAa;AAAA,IAC1B,aAAa,UAAW,eAA0B;AAAA,IAClD,MAAM;AAAA,EACR,CAAC;AACD,MAAI,IAAI,2BAA2B,EAAE,SAAS,QAAQ,OAAO,GAAG,MAAM,aAAa,CAAC;AACpF,SAAO;AACT;;;ACtCO,SAAS,eACd,YAC6C;AAC7C,QAAM,UAAuC,CAAC;AAC9C,aAAW,CAAC,IAAI,KAAK,KAAK,OAAO,QAAQ,cAAc,CAAC,CAAC,GAAG;AAG1D,QAAI,GAAG,SAAS,GAAG,EAAG,QAAO;AAC7B,QAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAAU;AAC1D,cAAQ,KAAK,CAAC,aAAa,EAAE,IAAI,KAAK,CAAC;AAAA,IACzC,OAAO;AAGL,UAAI,UAAU,QAAQ,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,EAAG,QAAO;AAChF,YAAM,SAAS,OAAO,QAAQ,KAAK;AACnC,UAAI,OAAO,WAAW,EAAG,QAAO;AAChC,iBAAW,CAAC,OAAO,IAAI,KAAK,QAAQ;AAClC,YAAI,MAAM,SAAS,GAAG,EAAG,QAAO;AAChC,YAAI,OAAO,SAAS,YAAY,OAAO,SAAS,SAAU,QAAO;AACjE,gBAAQ,KAAK,CAAC,aAAa,EAAE,IAAI,KAAK,IAAI,IAAI,CAAC;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AACA,SAAO,OAAO,YAAY,OAAO;AACnC;;;ACfO,SAAS,oBAAoB,UAAiD;AACnF,SAAO;AACT;AAGO,SAAS,cAAc,UAA+D;AAC3F,QAAM,aAAc,SAA2D;AAC/E,SAAO,YAAY;AACrB;AASO,SAAS,mCACd,YACmB;AACnB,SAAO;AACT;;;AN0EA,eAAsB,gBACpB,mBACA,eACA,gBACyD;AACzD,QAAM,EAAE,QAAQ,UAAU,MAAM,IAAI;AACpC,QAAM,MAAM,kBAAkB,OAAO,QAAQ;AAE7C,MAAI,EAAE,YAAY,kBAAkB,mBAAmB,mBAAmB;AACxE,UAAM,EAAE,SAAAC,UAAS,cAAc,IAAI;AACnC,UAAM,UACJ,YAAY,oBACR,EAAE,QAAQ,kBAAkB,OAAO,IACnC,EAAE,MAAM,kBAAkB,KAAK;AACrC,sCAAkC,cAAc,SAAS;AAAA,MACvD,SAAAA;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAEA,QAAM,SAAS,sBAAsB,eAAe,KAAK,iBAAiB;AAE1E,MAAI,YAAY,mBAAmB;AACjC,UAAM,EAAE,SAAAA,UAAS,eAAe,OAAO,IAAI;AAC3C,WAAO;AAAA,MACL,EAAE,SAAAA,UAAS,eAAe,SAAS,OAAO;AAAA,MAC1C,MAAM,OAAO,YAAY,gBAAgBA,UAAS,eAAe,MAAM;AAAA,MACvE;AAAA,MACA,EAAE,QAAQ,UAAU,MAAM;AAAA,IAC5B;AAAA,EACF;AAEA,MAAI,UAAU,mBAAmB;AAC/B,UAAM,EAAE,SAAAA,UAAS,eAAe,KAAK,IAAI;AACzC,WAAO;AAAA,MACL,EAAE,SAAAA,UAAS,eAAe,SAAS,KAAK;AAAA,MACxC,MAAM,OAAO,YAAY,cAAcA,UAAS,eAAe,EAAE,KAAK,CAAC;AAAA,MACvE;AAAA,MACA,EAAE,QAAQ,UAAU,MAAM;AAAA,IAC5B;AAAA,EACF;AAEA,QAAM,EAAE,SAAS,eAAe,cAAc,QAAQ,iBAAiB,WAAW,IAChF;AAEF,MAAI,IAAI,uBAAuB;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA,IAEA,iBAAiB,oBAAoB;AAAA,IACrC;AAAA,EACF,CAAC;AAED,QAAM,WAAW,MAAM,oBAAoB,QAAQ,iBAAiB;AAEpE,QAAM,UAAU,oBAAoB,QAAQ;AAC5C,MAAI,KAAK,wBAAwB,MAAM,OAAO;AAE9C,SAAO,kBAAkB,SAAS,QAAQ,EAAE,UAAU,MAAM,CAAC;AAC/D;AAEA,eAAe,oBACb,QACA,SAC6B;AAC7B,QAAM,EAAE,SAAS,eAAe,cAAc,QAAQ,YAAY,iBAAiB,WAAW,IAC5F;AACF,QAAM,oBAAyD,EAAE,GAAG,WAAW;AAC/E,MAAI,oBAAoB,QAAW;AACjC,sBAAkB,kBAAkB,yBAAyB,eAAe;AAAA,EAC9E;AAEA,MAAI;AAOF,UAAM,cAAc,eAAe,UAAU;AAC7C,QAAI,qBAAqB,iBAAiB,KAAK,gBAAgB,QAAW;AAKxE,YAAM,UAEF;AAAA,QACF;AAAA,QACA,YAAY;AAAA,QACZ,GAAI,eAAe,SAAY,CAAC,IAAI,EAAE,WAAW;AAAA,MACnD;AACA,aAAO,MAAM,OAAO,WAAW;AAAA,QAC7B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI,OAAO,KAAK,WAAW,EAAE,SAAS,GAAG;AACvC,aAAO,MAAM,OAAO,WAAW;AAAA,QAC7B;AAAA,QACA;AAAA,QACA;AAAA,QACA,EAAE,OAAO;AAAA,QACT;AAAA,UACE;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,WAAO,MAAM,OAAO,WAAW,IAAI,SAAS,eAAe,cAAc,EAAE,OAAO,CAAC;AAAA,EACrF,SAAS,KAAK;AAIZ,QAAI,eAAe,uBAAuB,eAAe;AACvD,YAAM;AAAA,IACR;AACA,UAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,UAAM,IAAI;AAAA,MACR,+BAA+B,YAAY,aAAa,OAAO,mBACzD,aAAa,OAAO,MAAM;AAAA,MAEhC,EAAE,SAAS,eAAe,cAAc,OAAO,IAAI;AAAA,IACrD;AAAA,EACF;AACF;AAMA,eAAe,mBACb,UACA,SACA,KACA,gBAKyD;AACzD,QAAM,EAAE,SAAS,eAAe,QAAQ,IAAI;AAC5C,QAAM,EAAE,QAAQ,UAAU,MAAM,IAAI;AAEpC,MAAI,IAAI,oCAAoC,EAAE,SAAS,eAAe,QAAQ,CAAC;AAE/E,MAAI;AACJ,MAAI;AACF,eAAW,MAAM,QAAQ;AAAA,EAC3B,SAAS,KAAK;AACZ,QAAI,eAAe,uBAAuB,eAAe;AACvD,YAAM;AAAA,IACR;AACA,UAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,UAAM,IAAI;AAAA,MACR,kCAAkC,aAAa,SAAS,OAAO,aAAa,OAAO,OAC9E,MAAM;AAAA,MAEX,EAAE,SAAS,cAAc,SAAS,OAAO,IAAI;AAAA,IAC/C;AAAA,EACF;AAEA,MAAI,cAAc,UAAU;AAC1B,QAAI,IAAI,sCAAsC,SAAS,QAAQ;AAC/D,WAAO,EAAE,UAAU,SAAS,SAAS;AAAA,EACvC;AAEA,QAAM,CAAC,eAAe,IAAI,SAAS;AACnC,MAAI,CAAC,iBAAiB;AACpB,UAAM,IAAI;AAAA,MACR,gBAAgB,aAAa,eAAe,OAAO,iCACtC,OAAO;AAAA,MACpB,EAAE,SAAS,cAAc,QAAQ;AAAA,IACnC;AAAA,EACF;AAEA,QAAM,UAAU,mCAAmC,gBAAgB,UAAU;AAC7E,MAAI,KAAK,wBAAwB,MAAM,OAAO;AAE9C,SAAO,kBAAkB,SAAS,QAAQ;AAAA,IACxC;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEA,SAAS,qBACP,YACmD;AACnD,SACE,eAAe,UACf,OAAO,OAAO,UAAU,EAAE,KAAK,CAAC,cAAc,cAAc,MAAS;AAEzE;;;AO9TA,SAAS,0BAAAC,+BAA8B;AACvC,SAAS,qBAAAC,0BAAyB;AAwClC,eAAsB,wBACpB,oBACA,eACA,oBAA8D,CAAC,GAC5B;AACnC,QAAM,EAAE,SAAS,cAAc,IAAI;AACnC,QAAM,MAAMC,mBAAkB,OAAO,QAAQ;AAE7C,MAAI,EAAE,YAAY,gBAAgB;AAChC,sCAAkC,cAAc,SAAS,EAAE,SAAS,cAAc,CAAC;AAAA,EACrF;AAEA,QAAM,SAAS,sBAAsB,eAAe,KAAK,yBAAyB;AAElF,QAAM,EAAE,OAAO,UAAU,SAAS,IAAI;AAEtC,MAAI;AACJ,MAAI;AACF,eAAW,MAAM,OAAO,YAAY,QAAQ,SAAS,eAAe;AAAA,MAClE;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,SAAS,KAAK;AACZ,QAAI,eAAeC,wBAAuB,eAAe;AACvD,YAAM;AAAA,IACR;AACA,UAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,UAAM,IAAI;AAAA,MACR,4CAA4C,aAAa,aAAa,OAAO,OACxE,MAAM;AAAA,MAEX,EAAE,SAAS,cAAc,eAAe,OAAO,IAAI;AAAA,IACrD;AAAA,EACF;AAEA,QAAM,SAAS;AAAA,IACb,OAAO,SAAS,MAAM,MAAM,IAAI,CAAC,UAAU;AAAA,MACzC,MAAM,KAAK;AAAA,MACX,cAAc,iBAAiB,KAAK,aAAa;AAAA,MACjD,MAAM,KAAK,IAAI;AAAA,IACjB,EAAE;AAAA,IACF,OAAO,SAAS,MAAM;AAAA,IACtB,OAAO,SAAS,MAAM;AAAA,EACxB;AAEA,MAAI,KAAK,yBAAyB,MAAM,MAAM;AAE9C,SAAO;AACT;AAUA,SAAS,iBAAiB,KAAqB;AAC7C,QAAM,WAAW,IAAI,MAAM,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC;AAC1D,SAAO,SAAS,SAAS,SAAS,CAAC,KAAK;AAC1C;;;AVjGO,IAAM,gBAAgBC,wBAAuB;","names":["ContentfulViewDelivery","ContentfulViewDeliveryClient","spaceId","ContentfulViewDelivery","createDebugLogger","createDebugLogger","ContentfulViewDelivery","ContentfulViewDelivery"]}
|
package/package.json
CHANGED
|
@@ -1,17 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentful/experiences-client",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.2",
|
|
4
4
|
"description": "Delivery client + fetchExperience for Contentful Experiences",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"main": "./dist/index.
|
|
8
|
-
"
|
|
7
|
+
"main": "./dist/index.cjs",
|
|
8
|
+
"module": "./dist/index.js",
|
|
9
|
+
"types": "./dist/index.d.mts",
|
|
9
10
|
"sideEffects": false,
|
|
10
11
|
"exports": {
|
|
11
12
|
".": {
|
|
12
13
|
"import": {
|
|
13
|
-
"types": "./dist/index.d.
|
|
14
|
+
"types": "./dist/index.d.mts",
|
|
14
15
|
"default": "./dist/index.js"
|
|
16
|
+
},
|
|
17
|
+
"require": {
|
|
18
|
+
"types": "./dist/index.d.cts",
|
|
19
|
+
"default": "./dist/index.cjs"
|
|
15
20
|
}
|
|
16
21
|
},
|
|
17
22
|
"./package.json": "./package.json"
|
|
@@ -31,6 +36,6 @@
|
|
|
31
36
|
},
|
|
32
37
|
"dependencies": {
|
|
33
38
|
"@contentful/experience-delivery": "1.0.0-dev.10",
|
|
34
|
-
"@contentful/experiences-sdk-core": "0.13.
|
|
39
|
+
"@contentful/experiences-sdk-core": "0.13.1"
|
|
35
40
|
}
|
|
36
41
|
}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';
|
|
2
|
-
import { createDebugLogger } from '@contentful/experiences-sdk-core';
|
|
3
|
-
|
|
4
|
-
type ClientOptions = {
|
|
5
|
-
accessToken: string;
|
|
6
|
-
/**
|
|
7
|
-
* Preview access token. Required when calling with `preview: true`.
|
|
8
|
-
*/
|
|
9
|
-
previewToken?: string;
|
|
10
|
-
/**
|
|
11
|
-
* Flip between delivery (default) and preview at request time. When
|
|
12
|
-
* `true`, uses `previewToken` and the preview host; when `false` or
|
|
13
|
-
* unset, uses `accessToken` and the delivery host. Ignored when a
|
|
14
|
-
* pre-made `client` is passed instead of inline creds.
|
|
15
|
-
*/
|
|
16
|
-
preview?: boolean;
|
|
17
|
-
/**
|
|
18
|
-
* Custom base URL for the delivery client (staging, proxy, per-region).
|
|
19
|
-
* Wins over the `preview`-derived default host — combine `host` with
|
|
20
|
-
* `preview: true` to point preview mode at a non-prod endpoint.
|
|
21
|
-
* Omit for the standard delivery / preview hosts.
|
|
22
|
-
*/
|
|
23
|
-
host?: string;
|
|
24
|
-
} | {
|
|
25
|
-
client: ContentfulViewDeliveryClient;
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* Resolve a `ClientOptions` union into a real delivery client. Shared by
|
|
29
|
-
* `fetchExperience` and `fetchDestinationSitemap` — both accept the same
|
|
30
|
-
* inline-creds-or-pre-made-client shape.
|
|
31
|
-
*/
|
|
32
|
-
declare function resolveDeliveryClient(clientOptions: ClientOptions, log: ReturnType<typeof createDebugLogger>, callerName: string): ContentfulViewDeliveryClient;
|
|
33
|
-
|
|
34
|
-
export { type ClientOptions, resolveDeliveryClient };
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { createClient } from "./create-delivery-client.js";
|
|
2
|
-
import { PREVIEW_HOST } from "./hosts.js";
|
|
3
|
-
function resolveDeliveryClient(clientOptions, log, callerName) {
|
|
4
|
-
if ("client" in clientOptions) {
|
|
5
|
-
log.log("using caller-supplied delivery client");
|
|
6
|
-
return clientOptions.client;
|
|
7
|
-
}
|
|
8
|
-
const { accessToken, previewToken, preview, host } = clientOptions;
|
|
9
|
-
if (preview && !previewToken) {
|
|
10
|
-
throw new Error(`${callerName}() called with preview: true but no previewToken was provided`);
|
|
11
|
-
}
|
|
12
|
-
const resolvedHost = host ?? (preview ? PREVIEW_HOST : void 0);
|
|
13
|
-
const client = createClient({
|
|
14
|
-
accessToken: preview ? previewToken : accessToken,
|
|
15
|
-
host: resolvedHost
|
|
16
|
-
});
|
|
17
|
-
log.log("created delivery client", { preview: Boolean(preview), host: resolvedHost });
|
|
18
|
-
return client;
|
|
19
|
-
}
|
|
20
|
-
export {
|
|
21
|
-
resolveDeliveryClient
|
|
22
|
-
};
|
|
23
|
-
//# sourceMappingURL=client-resolution.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/client-resolution.ts"],"sourcesContent":["import type { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\nimport { createClient } from './create-delivery-client.js';\nimport { createDebugLogger } from '@contentful/experiences-sdk-core';\nimport { PREVIEW_HOST } from './hosts.js';\n\nexport type ClientOptions =\n | {\n accessToken: string;\n /**\n * Preview access token. Required when calling with `preview: true`.\n */\n previewToken?: string;\n /**\n * Flip between delivery (default) and preview at request time. When\n * `true`, uses `previewToken` and the preview host; when `false` or\n * unset, uses `accessToken` and the delivery host. Ignored when a\n * pre-made `client` is passed instead of inline creds.\n */\n preview?: boolean;\n /**\n * Custom base URL for the delivery client (staging, proxy, per-region).\n * Wins over the `preview`-derived default host — combine `host` with\n * `preview: true` to point preview mode at a non-prod endpoint.\n * Omit for the standard delivery / preview hosts.\n */\n host?: string;\n }\n | { client: ContentfulViewDeliveryClient };\n\n/**\n * Resolve a `ClientOptions` union into a real delivery client. Shared by\n * `fetchExperience` and `fetchDestinationSitemap` — both accept the same\n * inline-creds-or-pre-made-client shape.\n */\nexport function resolveDeliveryClient(\n clientOptions: ClientOptions,\n log: ReturnType<typeof createDebugLogger>,\n callerName: string\n): ContentfulViewDeliveryClient {\n if ('client' in clientOptions) {\n log.log('using caller-supplied delivery client');\n return clientOptions.client;\n }\n\n const { accessToken, previewToken, preview, host } = clientOptions;\n if (preview && !previewToken) {\n throw new Error(`${callerName}() called with preview: true but no previewToken was provided`);\n }\n const resolvedHost = host ?? (preview ? PREVIEW_HOST : undefined);\n const client = createClient({\n accessToken: preview ? (previewToken as string) : accessToken,\n host: resolvedHost,\n });\n log.log('created delivery client', { preview: Boolean(preview), host: resolvedHost });\n return client;\n}\n"],"mappings":"AACA,SAAS,oBAAoB;AAE7B,SAAS,oBAAoB;AA+BtB,SAAS,sBACd,eACA,KACA,YAC8B;AAC9B,MAAI,YAAY,eAAe;AAC7B,QAAI,IAAI,uCAAuC;AAC/C,WAAO,cAAc;AAAA,EACvB;AAEA,QAAM,EAAE,aAAa,cAAc,SAAS,KAAK,IAAI;AACrD,MAAI,WAAW,CAAC,cAAc;AAC5B,UAAM,IAAI,MAAM,GAAG,UAAU,+DAA+D;AAAA,EAC9F;AACA,QAAM,eAAe,SAAS,UAAU,eAAe;AACvD,QAAM,SAAS,aAAa;AAAA,IAC1B,aAAa,UAAW,eAA0B;AAAA,IAClD,MAAM;AAAA,EACR,CAAC;AACD,MAAI,IAAI,2BAA2B,EAAE,SAAS,QAAQ,OAAO,GAAG,MAAM,aAAa,CAAC;AACpF,SAAO;AACT;","names":[]}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';
|
|
2
|
-
|
|
3
|
-
/** Options for the legacy functional Delivery client constructor. */
|
|
4
|
-
type CreateClientOptions = {
|
|
5
|
-
accessToken: string;
|
|
6
|
-
/**
|
|
7
|
-
* Base URL for the delivery client. Defaults to `DELIVERY_HOST` when omitted.
|
|
8
|
-
* Pass `PREVIEW_HOST` for preview mode, or any custom URL (staging, proxy,
|
|
9
|
-
* per-region). Both constants are exported from this package.
|
|
10
|
-
*/
|
|
11
|
-
host?: string;
|
|
12
|
-
} & Omit<ContentfulViewDeliveryClient.Options, 'token' | 'baseUrl'>;
|
|
13
|
-
declare function createClient(options: CreateClientOptions): ContentfulViewDeliveryClient;
|
|
14
|
-
|
|
15
|
-
export { type CreateClientOptions, createClient };
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { ContentfulViewDeliveryClient } from "@contentful/experience-delivery";
|
|
2
|
-
function createClient(options) {
|
|
3
|
-
const { accessToken, host, ...rest } = options;
|
|
4
|
-
return new ContentfulViewDeliveryClient({
|
|
5
|
-
...rest,
|
|
6
|
-
token: accessToken,
|
|
7
|
-
baseUrl: host
|
|
8
|
-
});
|
|
9
|
-
}
|
|
10
|
-
export {
|
|
11
|
-
createClient
|
|
12
|
-
};
|
|
13
|
-
//# sourceMappingURL=create-delivery-client.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/create-delivery-client.ts"],"sourcesContent":["import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\n\n/** Options for the legacy functional Delivery client constructor. */\nexport type CreateClientOptions = {\n accessToken: string;\n /**\n * Base URL for the delivery client. Defaults to `DELIVERY_HOST` when omitted.\n * Pass `PREVIEW_HOST` for preview mode, or any custom URL (staging, proxy,\n * per-region). Both constants are exported from this package.\n */\n host?: string;\n} & Omit<ContentfulViewDeliveryClient.Options, 'token' | 'baseUrl'>;\n\nexport function createClient(options: CreateClientOptions): ContentfulViewDeliveryClient {\n const { accessToken, host, ...rest } = options;\n return new ContentfulViewDeliveryClient({\n ...rest,\n token: accessToken,\n baseUrl: host,\n });\n}\n"],"mappings":"AAAA,SAAS,oCAAoC;AAatC,SAAS,aAAa,SAA4D;AACvF,QAAM,EAAE,aAAa,MAAM,GAAG,KAAK,IAAI;AACvC,SAAO,IAAI,6BAA6B;AAAA,IACtC,GAAG;AAAA,IACH,OAAO;AAAA,IACP,SAAS;AAAA,EACX,CAAC;AACH;","names":[]}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Throws `DestinationPreviewNotSupportedError` when `clientOptions.preview` is
|
|
3
|
-
* `true` and `experienceOptions` is destination-shaped (a caller-supplied
|
|
4
|
-
* `{ client }` already ignores `preview` entirely, so this only fires for the
|
|
5
|
-
* inline-credentials branch). Shared by `fetchExperience` and
|
|
6
|
-
* `fetchDestinationSitemap` — both call into the same preview-less
|
|
7
|
-
* Destinations Delivery API.
|
|
8
|
-
*/
|
|
9
|
-
declare function assertDestinationPreviewSupported(isPreview: boolean | undefined, destination: {
|
|
10
|
-
spaceId: string;
|
|
11
|
-
destinationId: string;
|
|
12
|
-
nodeId?: string;
|
|
13
|
-
path?: string;
|
|
14
|
-
}): void;
|
|
15
|
-
|
|
16
|
-
export { assertDestinationPreviewSupported };
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { DestinationPreviewNotSupportedError } from "./errors.js";
|
|
2
|
-
function assertDestinationPreviewSupported(isPreview, destination) {
|
|
3
|
-
if (!isPreview) return;
|
|
4
|
-
const { spaceId, destinationId, nodeId, path } = destination;
|
|
5
|
-
const locator = nodeId !== void 0 ? `nodeId "${nodeId}"` : `path "${path}"`;
|
|
6
|
-
throw new DestinationPreviewNotSupportedError(
|
|
7
|
-
`preview: true was combined with a destination-shaped call (destinationId "${destinationId}", ${locator}). The Destinations Delivery API does not support preview mode yet \u2014 pass preview: false (or omit it) for destination-based fetches.`,
|
|
8
|
-
{ spaceId, destinationId, nodeId, path }
|
|
9
|
-
);
|
|
10
|
-
}
|
|
11
|
-
export {
|
|
12
|
-
assertDestinationPreviewSupported
|
|
13
|
-
};
|
|
14
|
-
//# sourceMappingURL=destination-guards.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/destination-guards.ts"],"sourcesContent":["import { DestinationPreviewNotSupportedError } from './errors.js';\n\n/**\n * Throws `DestinationPreviewNotSupportedError` when `clientOptions.preview` is\n * `true` and `experienceOptions` is destination-shaped (a caller-supplied\n * `{ client }` already ignores `preview` entirely, so this only fires for the\n * inline-credentials branch). Shared by `fetchExperience` and\n * `fetchDestinationSitemap` — both call into the same preview-less\n * Destinations Delivery API.\n */\nexport function assertDestinationPreviewSupported(\n isPreview: boolean | undefined,\n destination: { spaceId: string; destinationId: string; nodeId?: string; path?: string }\n): void {\n if (!isPreview) return;\n\n const { spaceId, destinationId, nodeId, path } = destination;\n const locator = nodeId !== undefined ? `nodeId \"${nodeId}\"` : `path \"${path}\"`;\n throw new DestinationPreviewNotSupportedError(\n `preview: true was combined with a destination-shaped call (destinationId ` +\n `\"${destinationId}\", ${locator}). The Destinations Delivery API does not support ` +\n `preview mode yet — pass preview: false (or omit it) for destination-based fetches.`,\n { spaceId, destinationId, nodeId, path }\n );\n}\n"],"mappings":"AAAA,SAAS,2CAA2C;AAU7C,SAAS,kCACd,WACA,aACM;AACN,MAAI,CAAC,UAAW;AAEhB,QAAM,EAAE,SAAS,eAAe,QAAQ,KAAK,IAAI;AACjD,QAAM,UAAU,WAAW,SAAY,WAAW,MAAM,MAAM,SAAS,IAAI;AAC3E,QAAM,IAAI;AAAA,IACR,6EACM,aAAa,MAAM,OAAO;AAAA,IAEhC,EAAE,SAAS,eAAe,QAAQ,KAAK;AAAA,EACzC;AACF;","names":[]}
|
package/dist/errors.d.ts
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Thrown by `fetchExperience` for a fetch failure that is not "experience not
|
|
3
|
-
* found" — network failure, an invalid/expired token, a 5xx from the
|
|
4
|
-
* delivery API, etc. This failure mode is "surface clearly to the host app,"
|
|
5
|
-
* unlike the diagnostics `resolveExperience` collects for resolve/render-time
|
|
6
|
-
* issues — there's no partial payload to render around a fetch that never
|
|
7
|
-
* returned one, so a real thrown class is the right shape.
|
|
8
|
-
*
|
|
9
|
-
* `NotFoundError` (the delivery client's class, re-exported from this
|
|
10
|
-
* package) is the one exception: it passes through undisturbed so callers
|
|
11
|
-
* can route it to their framework's 404 idiom, per the existing
|
|
12
|
-
* distinguishable-404 contract.
|
|
13
|
-
*
|
|
14
|
-
* `environmentId` is `undefined` for the destination-shaped `fetchExperience`
|
|
15
|
-
* branches — the destinations delivery endpoints are space-scoped only, with
|
|
16
|
-
* no environment segment, unlike the by-id path.
|
|
17
|
-
*/
|
|
18
|
-
declare class ExperienceFetchError extends Error {
|
|
19
|
-
readonly spaceId: string;
|
|
20
|
-
readonly environmentId: string | undefined;
|
|
21
|
-
readonly experienceId: string;
|
|
22
|
-
constructor(message: string, options: {
|
|
23
|
-
spaceId: string;
|
|
24
|
-
environmentId?: string;
|
|
25
|
-
experienceId: string;
|
|
26
|
-
cause?: unknown;
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* Thrown by `fetchExperience` and `fetchDestinationSitemap` when
|
|
31
|
-
* `clientOptions.preview` is `true` for a destination-shaped call
|
|
32
|
-
* (`destinationId` + `nodeId`/`path`, or a sitemap fetch). The Destinations
|
|
33
|
-
* Delivery API has no preview host or preview-token support yet, so this
|
|
34
|
-
* guards against silently hitting the production host with a preview token
|
|
35
|
-
* it doesn't accept.
|
|
36
|
-
*
|
|
37
|
-
* This is a bridge, not a permanent design: revisit once the platform ships
|
|
38
|
-
* preview support for destinations.
|
|
39
|
-
*
|
|
40
|
-
* Only fires for the inline-credentials branch of `ClientOptions`. A
|
|
41
|
-
* caller-supplied `{ client }` already ignores `preview` entirely, per that
|
|
42
|
-
* branch's existing contract.
|
|
43
|
-
*/
|
|
44
|
-
declare class DestinationPreviewNotSupportedError extends Error {
|
|
45
|
-
readonly spaceId: string;
|
|
46
|
-
readonly destinationId: string;
|
|
47
|
-
readonly nodeId: string | undefined;
|
|
48
|
-
readonly path: string | undefined;
|
|
49
|
-
constructor(message: string, options: {
|
|
50
|
-
spaceId: string;
|
|
51
|
-
destinationId: string;
|
|
52
|
-
nodeId?: string;
|
|
53
|
-
path?: string;
|
|
54
|
-
});
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
export { DestinationPreviewNotSupportedError, ExperienceFetchError };
|
package/dist/errors.js
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
class ExperienceFetchError extends Error {
|
|
2
|
-
spaceId;
|
|
3
|
-
environmentId;
|
|
4
|
-
experienceId;
|
|
5
|
-
constructor(message, options) {
|
|
6
|
-
super(message, options.cause !== void 0 ? { cause: options.cause } : void 0);
|
|
7
|
-
this.name = "ExperienceFetchError";
|
|
8
|
-
this.spaceId = options.spaceId;
|
|
9
|
-
this.environmentId = options.environmentId;
|
|
10
|
-
this.experienceId = options.experienceId;
|
|
11
|
-
}
|
|
12
|
-
}
|
|
13
|
-
class DestinationPreviewNotSupportedError extends Error {
|
|
14
|
-
spaceId;
|
|
15
|
-
destinationId;
|
|
16
|
-
nodeId;
|
|
17
|
-
path;
|
|
18
|
-
constructor(message, options) {
|
|
19
|
-
super(message);
|
|
20
|
-
this.name = "DestinationPreviewNotSupportedError";
|
|
21
|
-
this.spaceId = options.spaceId;
|
|
22
|
-
this.destinationId = options.destinationId;
|
|
23
|
-
this.nodeId = options.nodeId;
|
|
24
|
-
this.path = options.path;
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
export {
|
|
28
|
-
DestinationPreviewNotSupportedError,
|
|
29
|
-
ExperienceFetchError
|
|
30
|
-
};
|
|
31
|
-
//# sourceMappingURL=errors.js.map
|
package/dist/errors.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Thrown by `fetchExperience` for a fetch failure that is not \"experience not\n * found\" — network failure, an invalid/expired token, a 5xx from the\n * delivery API, etc. This failure mode is \"surface clearly to the host app,\"\n * unlike the diagnostics `resolveExperience` collects for resolve/render-time\n * issues — there's no partial payload to render around a fetch that never\n * returned one, so a real thrown class is the right shape.\n *\n * `NotFoundError` (the delivery client's class, re-exported from this\n * package) is the one exception: it passes through undisturbed so callers\n * can route it to their framework's 404 idiom, per the existing\n * distinguishable-404 contract.\n *\n * `environmentId` is `undefined` for the destination-shaped `fetchExperience`\n * branches — the destinations delivery endpoints are space-scoped only, with\n * no environment segment, unlike the by-id path.\n */\nexport class ExperienceFetchError extends Error {\n readonly spaceId: string;\n readonly environmentId: string | undefined;\n readonly experienceId: string;\n\n constructor(\n message: string,\n options: {\n spaceId: string;\n environmentId?: string;\n experienceId: string;\n cause?: unknown;\n }\n ) {\n super(message, options.cause !== undefined ? { cause: options.cause } : undefined);\n this.name = 'ExperienceFetchError';\n this.spaceId = options.spaceId;\n this.environmentId = options.environmentId;\n this.experienceId = options.experienceId;\n }\n}\n\n/**\n * Thrown by `fetchExperience` and `fetchDestinationSitemap` when\n * `clientOptions.preview` is `true` for a destination-shaped call\n * (`destinationId` + `nodeId`/`path`, or a sitemap fetch). The Destinations\n * Delivery API has no preview host or preview-token support yet, so this\n * guards against silently hitting the production host with a preview token\n * it doesn't accept.\n *\n * This is a bridge, not a permanent design: revisit once the platform ships\n * preview support for destinations.\n *\n * Only fires for the inline-credentials branch of `ClientOptions`. A\n * caller-supplied `{ client }` already ignores `preview` entirely, per that\n * branch's existing contract.\n */\nexport class DestinationPreviewNotSupportedError extends Error {\n readonly spaceId: string;\n readonly destinationId: string;\n readonly nodeId: string | undefined;\n readonly path: string | undefined;\n\n constructor(\n message: string,\n options: { spaceId: string; destinationId: string; nodeId?: string; path?: string }\n ) {\n super(message);\n this.name = 'DestinationPreviewNotSupportedError';\n this.spaceId = options.spaceId;\n this.destinationId = options.destinationId;\n this.nodeId = options.nodeId;\n this.path = options.path;\n }\n}\n"],"mappings":"AAiBO,MAAM,6BAA6B,MAAM;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EAET,YACE,SACA,SAMA;AACA,UAAM,SAAS,QAAQ,UAAU,SAAY,EAAE,OAAO,QAAQ,MAAM,IAAI,MAAS;AACjF,SAAK,OAAO;AACZ,SAAK,UAAU,QAAQ;AACvB,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,eAAe,QAAQ;AAAA,EAC9B;AACF;AAiBO,MAAM,4CAA4C,MAAM;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAET,YACE,SACA,SACA;AACA,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,UAAU,QAAQ;AACvB,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,SAAS,QAAQ;AACtB,SAAK,OAAO,QAAQ;AAAA,EACtB;AACF;","names":[]}
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import { ClientOptions } from './client-resolution.js';
|
|
2
|
-
import '@contentful/experience-delivery';
|
|
3
|
-
import '@contentful/experiences-sdk-core';
|
|
4
|
-
|
|
5
|
-
type FetchDestinationSitemapOptions = {
|
|
6
|
-
spaceId: string;
|
|
7
|
-
destinationId: string;
|
|
8
|
-
};
|
|
9
|
-
type FetchDestinationSitemapPaginationOptions = {
|
|
10
|
-
/** Maximum number of paths to return. Defaults to `100`, maximum `1000`. */
|
|
11
|
-
limit?: number;
|
|
12
|
-
/** Cursor from a previous call's `pages.next`. Treat as opaque; don't combine with `pagePrev`. */
|
|
13
|
-
pageNext?: string;
|
|
14
|
-
/** Cursor from a previous call's `pages.prev`. Treat as opaque; don't combine with `pageNext`. */
|
|
15
|
-
pagePrev?: string;
|
|
16
|
-
};
|
|
17
|
-
type SitemapPathItem = {
|
|
18
|
-
/** Path this entry routes. */
|
|
19
|
-
path: string;
|
|
20
|
-
/** Flat id extracted from the entry's `experienceUrn`. */
|
|
21
|
-
experienceId: string;
|
|
22
|
-
/** Type of the Destination Node that claims this path, e.g. `"DestinationExperienceNode"`. */
|
|
23
|
-
type: string;
|
|
24
|
-
};
|
|
25
|
-
type DestinationSitemapResult = {
|
|
26
|
-
items: SitemapPathItem[];
|
|
27
|
-
limit: number;
|
|
28
|
-
pages: {
|
|
29
|
-
next?: string;
|
|
30
|
-
prev?: string;
|
|
31
|
-
};
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* List every routable path in a published Destination. Bulk enumeration —
|
|
35
|
-
* pairs with `fetchExperience`'s `destinationId` + `nodeId`/`path` branches,
|
|
36
|
-
* which resolve one path at a time. Does not hydrate any Experience itself
|
|
37
|
-
* and does not call `fetchExperience` internally.
|
|
38
|
-
*/
|
|
39
|
-
declare function fetchDestinationSitemap(destinationOptions: FetchDestinationSitemapOptions, clientOptions: ClientOptions, paginationOptions?: FetchDestinationSitemapPaginationOptions): Promise<DestinationSitemapResult>;
|
|
40
|
-
|
|
41
|
-
export { type DestinationSitemapResult, type FetchDestinationSitemapOptions, type FetchDestinationSitemapPaginationOptions, type SitemapPathItem, fetchDestinationSitemap };
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import { ContentfulViewDelivery } from "@contentful/experience-delivery";
|
|
2
|
-
import { createDebugLogger } from "@contentful/experiences-sdk-core";
|
|
3
|
-
import { assertDestinationPreviewSupported } from "./destination-guards.js";
|
|
4
|
-
import { resolveDeliveryClient } from "./client-resolution.js";
|
|
5
|
-
import { ExperienceFetchError } from "./errors.js";
|
|
6
|
-
async function fetchDestinationSitemap(destinationOptions, clientOptions, paginationOptions = {}) {
|
|
7
|
-
const { spaceId, destinationId } = destinationOptions;
|
|
8
|
-
const log = createDebugLogger(false, "client");
|
|
9
|
-
if (!("client" in clientOptions)) {
|
|
10
|
-
assertDestinationPreviewSupported(clientOptions.preview, { spaceId, destinationId });
|
|
11
|
-
}
|
|
12
|
-
const client = resolveDeliveryClient(clientOptions, log, "fetchDestinationSitemap");
|
|
13
|
-
const { limit, pageNext, pagePrev } = paginationOptions;
|
|
14
|
-
let response;
|
|
15
|
-
try {
|
|
16
|
-
response = await client.destination.sitemap(spaceId, destinationId, {
|
|
17
|
-
limit,
|
|
18
|
-
pageNext,
|
|
19
|
-
pagePrev
|
|
20
|
-
});
|
|
21
|
-
} catch (err) {
|
|
22
|
-
if (err instanceof ContentfulViewDelivery.NotFoundError) {
|
|
23
|
-
throw err;
|
|
24
|
-
}
|
|
25
|
-
const reason = err instanceof Error ? err.message : String(err);
|
|
26
|
-
throw new ExperienceFetchError(
|
|
27
|
-
`Failed to fetch sitemap for Destination "${destinationId}" (space "${spaceId}"): ${reason}. Check network connectivity, the access token, and that the space/destination ids are correct.`,
|
|
28
|
-
{ spaceId, experienceId: destinationId, cause: err }
|
|
29
|
-
);
|
|
30
|
-
}
|
|
31
|
-
const result = {
|
|
32
|
-
items: response.paths.items.map((item) => ({
|
|
33
|
-
path: item.path,
|
|
34
|
-
experienceId: extractIdFromUrn(item.experienceUrn),
|
|
35
|
-
type: item.sys.type
|
|
36
|
-
})),
|
|
37
|
-
limit: response.paths.limit,
|
|
38
|
-
pages: response.paths.pages
|
|
39
|
-
};
|
|
40
|
-
log.lazy("received sitemap page", () => result);
|
|
41
|
-
return result;
|
|
42
|
-
}
|
|
43
|
-
function extractIdFromUrn(urn) {
|
|
44
|
-
const segments = urn.split("/").filter((s) => s.length > 0);
|
|
45
|
-
return segments[segments.length - 1] ?? urn;
|
|
46
|
-
}
|
|
47
|
-
export {
|
|
48
|
-
fetchDestinationSitemap
|
|
49
|
-
};
|
|
50
|
-
//# sourceMappingURL=fetch-destination-sitemap.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/fetch-destination-sitemap.ts"],"sourcesContent":["import { ContentfulViewDelivery } from '@contentful/experience-delivery';\nimport { createDebugLogger } from '@contentful/experiences-sdk-core';\nimport { assertDestinationPreviewSupported } from './destination-guards.js';\nimport { resolveDeliveryClient, type ClientOptions } from './client-resolution.js';\nimport { ExperienceFetchError } from './errors.js';\n\nexport type FetchDestinationSitemapOptions = {\n spaceId: string;\n destinationId: string;\n};\n\nexport type FetchDestinationSitemapPaginationOptions = {\n /** Maximum number of paths to return. Defaults to `100`, maximum `1000`. */\n limit?: number;\n /** Cursor from a previous call's `pages.next`. Treat as opaque; don't combine with `pagePrev`. */\n pageNext?: string;\n /** Cursor from a previous call's `pages.prev`. Treat as opaque; don't combine with `pageNext`. */\n pagePrev?: string;\n};\n\nexport type SitemapPathItem = {\n /** Path this entry routes. */\n path: string;\n /** Flat id extracted from the entry's `experienceUrn`. */\n experienceId: string;\n /** Type of the Destination Node that claims this path, e.g. `\"DestinationExperienceNode\"`. */\n type: string;\n};\n\nexport type DestinationSitemapResult = {\n items: SitemapPathItem[];\n limit: number;\n pages: { next?: string; prev?: string };\n};\n\n/**\n * List every routable path in a published Destination. Bulk enumeration —\n * pairs with `fetchExperience`'s `destinationId` + `nodeId`/`path` branches,\n * which resolve one path at a time. Does not hydrate any Experience itself\n * and does not call `fetchExperience` internally.\n */\nexport async function fetchDestinationSitemap(\n destinationOptions: FetchDestinationSitemapOptions,\n clientOptions: ClientOptions,\n paginationOptions: FetchDestinationSitemapPaginationOptions = {}\n): Promise<DestinationSitemapResult> {\n const { spaceId, destinationId } = destinationOptions;\n const log = createDebugLogger(false, 'client');\n\n if (!('client' in clientOptions)) {\n assertDestinationPreviewSupported(clientOptions.preview, { spaceId, destinationId });\n }\n\n const client = resolveDeliveryClient(clientOptions, log, 'fetchDestinationSitemap');\n\n const { limit, pageNext, pagePrev } = paginationOptions;\n\n let response: ContentfulViewDelivery.DestinationSitemap;\n try {\n response = await client.destination.sitemap(spaceId, destinationId, {\n limit,\n pageNext,\n pagePrev,\n });\n } catch (err) {\n if (err instanceof ContentfulViewDelivery.NotFoundError) {\n throw err;\n }\n const reason = err instanceof Error ? err.message : String(err);\n throw new ExperienceFetchError(\n `Failed to fetch sitemap for Destination \"${destinationId}\" (space \"${spaceId}\"): ` +\n `${reason}. Check network connectivity, the access token, and that the space/` +\n `destination ids are correct.`,\n { spaceId, experienceId: destinationId, cause: err }\n );\n }\n\n const result = {\n items: response.paths.items.map((item) => ({\n path: item.path,\n experienceId: extractIdFromUrn(item.experienceUrn),\n type: item.sys.type,\n })),\n limit: response.paths.limit,\n pages: response.paths.pages,\n };\n\n log.lazy('received sitemap page', () => result);\n\n return result;\n}\n\n/**\n * Extract the flat id from an `experienceUrn`. Real shape:\n * crn:contentful:::experience:spaces/$self/environments/$self/experiences/<id>\n *\n * Same one-line logic as the private `extractIdFromUrn` in\n * `packages/core/src/resolve-experience.ts` — not shared across the\n * `core`/`client` package boundary (core stays zero-dep) for one line.\n */\nfunction extractIdFromUrn(urn: string): string {\n const segments = urn.split('/').filter((s) => s.length > 0);\n return segments[segments.length - 1] ?? urn;\n}\n"],"mappings":"AAAA,SAAS,8BAA8B;AACvC,SAAS,yBAAyB;AAClC,SAAS,yCAAyC;AAClD,SAAS,6BAAiD;AAC1D,SAAS,4BAA4B;AAqCrC,eAAsB,wBACpB,oBACA,eACA,oBAA8D,CAAC,GAC5B;AACnC,QAAM,EAAE,SAAS,cAAc,IAAI;AACnC,QAAM,MAAM,kBAAkB,OAAO,QAAQ;AAE7C,MAAI,EAAE,YAAY,gBAAgB;AAChC,sCAAkC,cAAc,SAAS,EAAE,SAAS,cAAc,CAAC;AAAA,EACrF;AAEA,QAAM,SAAS,sBAAsB,eAAe,KAAK,yBAAyB;AAElF,QAAM,EAAE,OAAO,UAAU,SAAS,IAAI;AAEtC,MAAI;AACJ,MAAI;AACF,eAAW,MAAM,OAAO,YAAY,QAAQ,SAAS,eAAe;AAAA,MAClE;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,SAAS,KAAK;AACZ,QAAI,eAAe,uBAAuB,eAAe;AACvD,YAAM;AAAA,IACR;AACA,UAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,UAAM,IAAI;AAAA,MACR,4CAA4C,aAAa,aAAa,OAAO,OACxE,MAAM;AAAA,MAEX,EAAE,SAAS,cAAc,eAAe,OAAO,IAAI;AAAA,IACrD;AAAA,EACF;AAEA,QAAM,SAAS;AAAA,IACb,OAAO,SAAS,MAAM,MAAM,IAAI,CAAC,UAAU;AAAA,MACzC,MAAM,KAAK;AAAA,MACX,cAAc,iBAAiB,KAAK,aAAa;AAAA,MACjD,MAAM,KAAK,IAAI;AAAA,IACjB,EAAE;AAAA,IACF,OAAO,SAAS,MAAM;AAAA,IACtB,OAAO,SAAS,MAAM;AAAA,EACxB;AAEA,MAAI,KAAK,yBAAyB,MAAM,MAAM;AAE9C,SAAO;AACT;AAUA,SAAS,iBAAiB,KAAqB;AAC7C,QAAM,WAAW,IAAI,MAAM,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC;AAC1D,SAAO,SAAS,SAAS,SAAS,CAAC,KAAK;AAC1C;","names":[]}
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import { ContentfulViewDelivery } from '@contentful/experience-delivery';
|
|
2
|
-
import { ResolverConfig, PortableRenderPlan } from '@contentful/experiences-sdk-core';
|
|
3
|
-
import { ClientOptions } from './client-resolution.js';
|
|
4
|
-
|
|
5
|
-
type DeliveryExperienceRequestExtensions = ContentfulViewDelivery.GetWithOverridesExperienceRequestExtensions;
|
|
6
|
-
type PersonalizationOptions = NonNullable<DeliveryExperienceRequestExtensions['personalization']>;
|
|
7
|
-
type ExperienceRequestExtensions = Omit<DeliveryExperienceRequestExtensions, 'personalization'>;
|
|
8
|
-
type ByIdExperienceOptions = {
|
|
9
|
-
spaceId: string;
|
|
10
|
-
environmentId: string;
|
|
11
|
-
experienceId: string;
|
|
12
|
-
locale?: string;
|
|
13
|
-
/**
|
|
14
|
-
* Profile and events used by XDA to personalize the resolved Experience.
|
|
15
|
-
*/
|
|
16
|
-
personalization?: PersonalizationOptions;
|
|
17
|
-
/**
|
|
18
|
-
* Additional XDA request extensions such as source maps. Supplying a defined
|
|
19
|
-
* extension switches the request to POST.
|
|
20
|
-
*/
|
|
21
|
-
extensions?: ExperienceRequestExtensions;
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* Resolve an Experience by the Destination Node instead of `experienceId`
|
|
25
|
-
* The destinations delivery endpoints are space-scoped only and have no locale
|
|
26
|
-
* param, unlike the by-id path.
|
|
27
|
-
*/
|
|
28
|
-
type ByDestinationNodeIdExperienceOptions = {
|
|
29
|
-
spaceId: string;
|
|
30
|
-
destinationId: string;
|
|
31
|
-
nodeId: string;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* Resolve an Experience by the absolute path wired up to a
|
|
35
|
-
* Destination Node, instead of a node id directly. Same scoping as
|
|
36
|
-
* `ByDestinationNodeIdExperienceOptions` — no `environmentId` or `locale`.
|
|
37
|
-
*/
|
|
38
|
-
type ByDestinationPathExperienceOptions = {
|
|
39
|
-
spaceId: string;
|
|
40
|
-
destinationId: string;
|
|
41
|
-
/** Absolute path to resolve. Must start with `/`. */
|
|
42
|
-
path: string;
|
|
43
|
-
};
|
|
44
|
-
type ExperienceOptions = ByIdExperienceOptions | ByDestinationNodeIdExperienceOptions | ByDestinationPathExperienceOptions;
|
|
45
|
-
/**
|
|
46
|
-
* A Destination resolution that the app must act on as control flow — honor
|
|
47
|
-
* it by navigating or re-resolving at the new path — rather than a hydrated
|
|
48
|
-
* Experience to render. Modeled as a normal return value, not a thrown error,
|
|
49
|
-
* per the Destinations delivery API's own framing of a redirect response.
|
|
50
|
-
*/
|
|
51
|
-
interface DestinationRedirectResult {
|
|
52
|
-
redirect: {
|
|
53
|
-
path: string;
|
|
54
|
-
};
|
|
55
|
-
}
|
|
56
|
-
type ResolveOptions = {
|
|
57
|
-
config: ResolverConfig;
|
|
58
|
-
/**
|
|
59
|
-
* Arbitrary per-render metadata exposed to every resolver as
|
|
60
|
-
* `ctx.experience.metadata` and readable at render time via the framework
|
|
61
|
-
* adapter's `useExperience()` / `getExperience()`.
|
|
62
|
-
*/
|
|
63
|
-
metadata?: Record<string, unknown>;
|
|
64
|
-
/**
|
|
65
|
-
* Observability switch. When on: logs the fetch (host, ids) and the raw
|
|
66
|
-
* payload here, and threads through to `resolveExperience` (resolution steps
|
|
67
|
-
* + `resolveData` timings) and the renderer (visible missing-component box,
|
|
68
|
-
* debug fallback). A single boolean across fetch + resolve + render.
|
|
69
|
-
*/
|
|
70
|
-
debug?: boolean;
|
|
71
|
-
};
|
|
72
|
-
declare function fetchExperience(experienceOptions: ByIdExperienceOptions, clientOptions: ClientOptions, resolveOptions: ResolveOptions): Promise<PortableRenderPlan>;
|
|
73
|
-
declare function fetchExperience(experienceOptions: ByDestinationNodeIdExperienceOptions, clientOptions: ClientOptions, resolveOptions: ResolveOptions): Promise<PortableRenderPlan | DestinationRedirectResult>;
|
|
74
|
-
declare function fetchExperience(experienceOptions: ByDestinationPathExperienceOptions, clientOptions: ClientOptions, resolveOptions: ResolveOptions): Promise<PortableRenderPlan | DestinationRedirectResult>;
|
|
75
|
-
|
|
76
|
-
export { type ByDestinationNodeIdExperienceOptions, type ByDestinationPathExperienceOptions, type ByIdExperienceOptions, ClientOptions, type DestinationRedirectResult, type ExperienceOptions, type ExperienceRequestExtensions, type PersonalizationOptions, type ResolveOptions, fetchExperience };
|