@storystick/preview 0.0.0-stage → 0.2.0-rc.0

package/dist/server/render-id.js

@@ -0,0 +1,22 @@
+/**
+ * Deterministic preview render-id derivation.
+ *
+ * Marker identity (HMAC) incorporates the renderId, so the stability of
+ * every provenance marker across refreshes rests on this derivation
+ * having ZERO temporal or random components. Pinned by
+ * tests/preview-provenance-render-id.test.ts — do not add Date/random
+ * inputs here.
+ */
+export function defaultPreviewProvenanceRenderId(input) {
+    if (input.frameId === 'route')
+        return `render:${input.routeHash}`;
+    return `render:frame:${safeRenderFramePart(input.frameId)}:${input.routeHash}`;
+}
+/** Independent mounts of the same document must not replace each other's frame. */
+export function createPreviewOccurrenceId() {
+    return `frame_${crypto.randomUUID()}`;
+}
+function safeRenderFramePart(value) {
+    return value.replace(/[^A-Za-z0-9]+/g, '_').replace(/^_+|_+$/g, '') ||
+        'frame';
+}

package/dist/server/route-document-provenance.d.ts

@@ -0,0 +1,77 @@
+import { type PreviewFrameDependency, type PreviewProvenanceEditableTextPathManifest, type PreviewProvenanceQueryResultLike, type ProvenanceFrame, type PublicProvenanceSidecar } from '@storystick/preview/provenance';
+import { type PreviewProvenanceAttrsByKey } from '../provenance/render-context.js';
+import { type BuildPreviewRenderFrameOptions, type PreviewRenderFrameDiagnostics, type PreviewRenderFrameFixtureOptions } from './render-frame-provenance.js';
+import { type PreviewProvenanceRuntime } from './provenance-runtime.js';
+export type PreviewRouteFieldBindingsSidecar = Record<string, PreviewRouteEffectiveFieldBindings>;
+export interface PreviewRouteEffectiveFieldBindings {
+    readonly base: Record<string, PreviewRouteDocPathBindingRef>;
+    readonly variations: Record<string, Record<string, PreviewRouteDocPathBindingRef>>;
+}
+export type PreviewRouteModelFields = Record<string, unknown>;
+export interface PreviewRouteModelReadScope {
+    readonly requestedLocale?: string;
+    readonly appliedLocale?: string;
+    readonly appliedReleaseId?: string;
+    readonly releaseMemberState?: 'active' | 'archived' | 'missing' | 'locale-removed';
+}
+export type PreviewRouteModelSidecar = Record<string, PreviewRouteModelFields | undefined> & {
+    byId?: Record<string, PreviewRouteModelFields>;
+    byRef?: Record<string, PreviewRouteModelFields>;
+    scopeById?: Record<string, PreviewRouteModelReadScope>;
+    scopeByRef?: Record<string, PreviewRouteModelReadScope>;
+};
+export interface PreviewRouteDocPathBindingRef {
+    readonly kind: 'docPath';
+    readonly path: string;
+}
+export interface PreviewRouteDocumentFixtureOptions extends PreviewRenderFrameFixtureOptions {
+}
+export interface BuildPreviewRouteDocumentFrameOptions<TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown> {
+    readonly enabled?: boolean;
+    readonly document: TDocument;
+    readonly pathname: string;
+    readonly context?: TContext;
+    readonly manifest: PreviewProvenanceEditableTextPathManifest;
+    readonly frameId?: string;
+    readonly routeHash?: string;
+    readonly variantId?: string | null;
+    readonly sessionId?: string | null;
+    readonly codeVersion?: string;
+    readonly renderId?: string;
+    readonly generation?: number;
+    readonly renderNonce?: string;
+    readonly emissionRevision?: number;
+    readonly authoritativeDocumentIds?: readonly string[];
+    readonly dependencies?: readonly PreviewFrameDependency[];
+    readonly fieldBindingsFallback?: PreviewRouteFieldBindingsSidecar | null;
+    readonly fixture?: PreviewRouteDocumentFixtureOptions | null;
+    readonly projectId?: string;
+    readonly endpoint?: string;
+    readonly convexUrl?: string;
+}
+export interface PreviewRouteDocumentFrame<TDocument extends PreviewProvenanceQueryResultLike = PreviewProvenanceQueryResultLike, TContext = unknown> {
+    readonly frameId: string;
+    readonly sessionId?: string;
+    readonly routeHash: string;
+    readonly variantId: string | null;
+    readonly attrsByKey: PreviewProvenanceAttrsByKey;
+    readonly codedDocument?: TDocument;
+    readonly codedContext?: TContext;
+    readonly renderFrame: ProvenanceFrame;
+    readonly publicSidecar: PublicProvenanceSidecar | null;
+    readonly validationOk: boolean;
+    readonly diagnostics: PreviewRouteDocumentDiagnostics;
+}
+export interface PreviewRouteDocumentDiagnostics extends PreviewRenderFrameDiagnostics {
+}
+export declare function unstable_buildPreviewRouteDocumentFrameWithRuntime<TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown>(options: BuildPreviewRouteDocumentFrameOptions<TDocument, TContext>, runtime: PreviewProvenanceRuntime): Promise<PreviewRouteDocumentFrame<TDocument, TContext> | null>;
+/** Internal planning shared by routes and independently mounted server components. */
+export declare function planPreviewDocumentRender<TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown>(options: Omit<BuildPreviewRouteDocumentFrameOptions<TDocument, TContext>, 'pathname'> & {
+    readonly pathname?: string;
+}, runtime: PreviewProvenanceRuntime): BuildPreviewRenderFrameOptions<TDocument, TContext> | null;
+export declare function stripPreviewRouteMetadata<TDocument extends PreviewProvenanceQueryResultLike>(document: TDocument): TDocument;
+export declare function unstable_attachPreviewProvenanceRenderContext<T>(value: T, attrsByKey: PreviewProvenanceAttrsByKey | null | undefined): T;
+export declare function unstable_attachPreviewRouteFrameContext<TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown>(frame: PreviewRouteDocumentFrame<TDocument, TContext> | null | undefined): TDocument | null;
+export declare function unstable_attachPreviewRouteMetadataContext<TValue, TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown>(value: TValue, frame: PreviewRouteDocumentFrame<TDocument, TContext> | null | undefined): TValue;
+export declare function unstable_attachPreviewRouteRenderContext<TValue, TDocument extends PreviewProvenanceQueryResultLike, TContext = unknown>(value: TValue, frame: PreviewRouteDocumentFrame<TDocument, TContext> | null | undefined): TValue;
+export declare function unstable_collectPreviewRouteDocumentSliceTypes(document: PreviewProvenanceQueryResultLike): ReadonlySet<string>;