@picked/client 0.0.1-dev.1786065500148 → 0.0.1-dev.1786072899095

package/dist/types/data-source/provider.d.ts

@@ -1,91 +0,0 @@
-import type { ContentLoader, ExperienceContentResponse, PickedManifestMetadata, ProjectConfig, VirtualPickedData } from '../plugins/dynamic-experiences/types';
-import { isVirtualPickedData } from './virtual-data';
-/** Where a data provider reads project config and CMS content from. */
-export type PickedDataMode = 'bundle' | 'api';
-/** Options for {@link createPickedDataProvider}. */
-export interface PickedDataProviderOptions {
-    /** Base URL for the Picked API. Used by `'api'` mode and by every preview session. */
-    apiUrl: string;
-    /** Project ID to resolve data for. */
-    projectId: string;
-    /**
-     * Which source to read from. Omit to keep the legacy behaviour: `'bundle'` when
-     * `virtual:picked/data` resolves, `'api'` otherwise.
-     */
-    mode?: PickedDataMode;
-    /**
-     * Preview token from the current session. A present token forces `'api'` for both config
-     * and content and overrides `bundle` and `projectConfig`, because preview renders
-     * unpublished data that no bundled snapshot can contain.
-     */
-    previewToken?: string;
-    /**
-     * The `virtual:picked/data` module. Supply it to skip the dynamic import — which is also
-     * how a consumer places the module in a chosen chunk, since a module that is both
-     * statically and dynamically imported is placed in the static chunk. A value that does not
-     * match the module's shape is ignored with a warning, the same as an unresolvable import.
-     */
-    bundle?: VirtualPickedData;
-    /** Explicit project config. Supersedes both sources, except under a preview token. */
-    projectConfig?: ProjectConfig;
-    /** Explicit content loader. Supersedes both sources, except under a preview token. */
-    getContent?: ContentLoader;
-    /** Abort signal applied to API fetches, such as an `AbortSignal.timeout` deadline. */
-    signal?: AbortSignal;
-}
-/** Read-only description of what a provider resolved to. */
-export interface PickedDataProviderMeta {
-    /** The mode in force, after preview-token resolution. */
-    mode: PickedDataMode;
-    /** The bundle's manifest metadata, or `null` when not reading from a bundle. */
-    manifest: PickedManifestMetadata | null;
-}
-/** Resolves this session's project config and per-experience CMS content. */
-export interface PickedDataProvider {
-    /** What this provider resolved to. `manifest` populates once a bundle has been read. */
-    readonly meta: PickedDataProviderMeta;
-    /** Resolves the project config, or `null` when unavailable. Deduplicated across callers. */
-    getProjectConfig: () => Promise<ProjectConfig | null>;
-    /** Resolves an experience's content, or `null` when unavailable. Deduplicated per experience id. */
-    getContent: (experience: {
-        id: string;
-        key: string;
-    }, options?: {
-        signal?: AbortSignal;
-    }) => Promise<ExperienceContentResponse | null>;
-}
-/**
- * Attempts to resolve `virtual:picked/data` provided by `@picked/vite-plugin-picked`.
- *
- * The dynamic import uses a literal string specifier (intentionally — using a variable plus
- * `@vite-ignore` defeats Vite's import-analysis, so the plugin's `resolveId` is never called
- * at build time and the bundle ends up with a runtime fetch to a `virtual:` URL that the
- * browser cannot resolve). The SDK's own build marks `virtual:picked/data` as external so
- * this literal import is preserved into the published dist, then downstream Vite builds with
- * `@picked/vite-plugin-picked` resolve it through the plugin pipeline.
- *
- * Returns `null` when the virtual module is unresolvable (the consumer is not using the Vite
- * plugin, or its build did not generate the module). Errors are swallowed: the caller falls
- * back to the API path.
- *
- * @returns {Promise<VirtualPickedData | null>} The virtual module exports, or `null`.
- * @example
- * ```typescript
- * const bundle = await resolveVirtualDataModule()
- * ```
- */
-export declare function resolveVirtualDataModule(): Promise<VirtualPickedData | null>;
-export { isVirtualPickedData };
-/**
- * Creates the data provider for a session.
- *
- * @param {PickedDataProviderOptions} options - Provider configuration.
- * @returns {PickedDataProvider} A provider resolving config and content from one source.
- * @example
- * ```typescript
- * const provider = createPickedDataProvider({ mode: 'api', apiUrl, projectId })
- * const config = await provider.getProjectConfig()
- * ```
- */
-export declare function createPickedDataProvider(options: PickedDataProviderOptions): PickedDataProvider;
-//# sourceMappingURL=provider.d.ts.map

package/dist/types/data-source/provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/data-source/provider.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,aAAa,EACb,yBAAyB,EACzB,sBAAsB,EACtB,aAAa,EACb,iBAAiB,EAClB,MAAM,sCAAsC,CAAA;AAG7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEpD,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,KAAK,CAAA;AAQ7C,oDAAoD;AACpD,MAAM,WAAW,yBAAyB;IACxC,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,sFAAsF;IACtF,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,sFAAsF;IACtF,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,IAAI,EAAE,cAAc,CAAA;IACpB,gFAAgF;IAChF,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAA;CACxC;AAED,6EAA6E;AAC7E,MAAM,WAAW,kBAAkB;IACjC,wFAAwF;IACxF,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAA;IACrC,4FAA4F;IAC5F,gBAAgB,EAAE,MAAM,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IACrD,oGAAoG;IACpG,UAAU,EAAE,CACV,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EACvC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,KAC/B,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,wBAAwB,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAYlF;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAA;AA0B9B;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,kBAAkB,CAwK/F"}

package/dist/types/data-source/registry.d.ts

@@ -1,27 +0,0 @@
-import type { VirtualPickedData } from '../plugins/dynamic-experiences/types';
-/**
- * Records the bundle the build generated, for this session's data provider to read.
- *
- * A value that does not match the module shape is refused rather than stored, so a malformed
- * registration lands on the already-defined "no bundle" path instead of an undefined read at
- * the first content resolution. Any usable bundle registered earlier is kept.
- *
- * @param {unknown} bundle - The generated module's exports.
- * @returns {void} Nothing.
- * @example
- * ```typescript
- * registerPickedBundle({ projectConfig, experienceContent, manifestMetadata })
- * ```
- */
-export declare function registerPickedBundle(bundle: unknown): void;
-/**
- * Reads the registered bundle.
- *
- * @returns {VirtualPickedData | null} The bundle, or `null` when nothing has registered one.
- * @example
- * ```typescript
- * const bundle = readRegisteredBundle()
- * ```
- */
-export declare function readRegisteredBundle(): VirtualPickedData | null;
-//# sourceMappingURL=registry.d.ts.map

package/dist/types/data-source/registry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/data-source/registry.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAK7E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAQ1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,iBAAiB,GAAG,IAAI,CAE/D"}

package/dist/types/data-source/virtual-data.d.ts

@@ -1,19 +0,0 @@
-/**
- * @file The shape guard for the generated `virtual:picked/data` module.
- *
- * Lives apart from the provider and the registry because both validate against it, and a guard
- * shared by two modules that also reference each other would otherwise close an import cycle.
- */
-import type { VirtualPickedData } from '../plugins/dynamic-experiences/types';
-/**
- * Runtime type guard that validates the shape of a `virtual:picked/data` module.
- *
- * @param {unknown} value - Candidate module exports.
- * @returns {boolean} Whether `value` matches the {@link VirtualPickedData} shape.
- * @example
- * ```typescript
- * if (isVirtualPickedData(mod)) { useVirtualModule(mod) }
- * ```
- */
-export declare function isVirtualPickedData(value: unknown): value is VirtualPickedData;
-//# sourceMappingURL=virtual-data.d.ts.map

package/dist/types/data-source/virtual-data.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"virtual-data.d.ts","sourceRoot":"","sources":["../../../src/data-source/virtual-data.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAE7E;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAU9E"}