@storystick/client 0.0.0-stage → 0.2.0-rc.1

package/dist/typed-route.d.ts

@@ -0,0 +1,22 @@
+import type { QuerySchemaDefinition, QueryStoriesOf, QueryStoryType } from './query-schema.js';
+import type { SelectedDocument } from './query-builder.js';
+import type { QueryResult, ResolvedRoute } from './types.js';
+export type SchemaStoryName<TSchema extends QuerySchemaDefinition> = keyof QueryStoriesOf<TSchema> & string;
+export type RoutableSchemaStoryName<TSchema extends QuerySchemaDefinition> = {
+    [TStoryName in SchemaStoryName<TSchema>]: QueryStoriesOf<TSchema>[TStoryName] extends QueryStoryType<unknown, object, boolean, boolean, true> ? TStoryName : never;
+}[SchemaStoryName<TSchema>];
+export type RequestedStoryName<TSchema extends QuerySchemaDefinition, TStoryTypes extends readonly SchemaStoryName<TSchema>[] | undefined> = TStoryTypes extends readonly (infer TStoryName)[] ? Extract<TStoryName, SchemaStoryName<TSchema>> : RoutableSchemaStoryName<TSchema>;
+export type TypedRouteDocument<TSchema extends QuerySchemaDefinition, TStoryName extends SchemaStoryName<TSchema>> = SelectedDocument<QueryStoriesOf<TSchema>[TStoryName], 'all'> & {
+    readonly storyType: TStoryName;
+} & Pick<QueryResult, 'resolved'>;
+export type TypedDocumentRoute<TSchema extends QuerySchemaDefinition, TStoryTypes extends readonly SchemaStoryName<TSchema>[] | undefined> = {
+    readonly [TStoryName in RequestedStoryName<TSchema, TStoryTypes>]: Omit<Extract<ResolvedRoute, {
+        type: 'document';
+    }>, 'document' | 'storyType'> & {
+        readonly document: TypedRouteDocument<TSchema, TStoryName>;
+        readonly storyType: TStoryName;
+    };
+}[RequestedStoryName<TSchema, TStoryTypes>];
+export type ResolvedRouteForSchema<TSchema extends QuerySchemaDefinition, TStoryTypes extends readonly SchemaStoryName<TSchema>[] | undefined = undefined> = [SchemaStoryName<TSchema>] extends [never] ? ResolvedRoute : TypedDocumentRoute<TSchema, TStoryTypes> | Exclude<ResolvedRoute, {
+    type: 'document';
+}>;

package/dist/typed-route.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -0,0 +1,147 @@
+import type { DocumentLocaleRouting } from './locale-routing.js';
+import type { DeliveryDocumentV1 } from '@storystick/types';
+import type { LocaleRouting, RoutingLocale } from '@storystick/types/internal/locale-routing';
+export interface RequestLocaleContext {
+    locale: string;
+    defaultLocale: string;
+    pathname: string;
+    publicPathname: string;
+    locales: readonly RoutingLocale[];
+    localeRouting: LocaleRouting;
+    publicOrigins?: import('./locale-routing.js').PublicLocaleOrigins;
+    synthetic: boolean;
+}
+export interface PublicationSeo {
+    readonly indexable: boolean;
+    readonly canonicalUrl?: string;
+}
+export type ResolvedRoute = {
+    type: 'document';
+    document: QueryResult;
+    storyType: string;
+    canonicalPathname: string;
+    publicPathname: string;
+    localeContext: RequestLocaleContext;
+    primaryLocale: string;
+    alternates: Readonly<Record<string, string>>;
+    seo: PublicationSeo;
+} | {
+    type: 'redirect';
+    redirectTo: string;
+    permanent: boolean;
+} | {
+    type: 'notFound';
+    localeContext?: RequestLocaleContext;
+};
+export interface PreviewReadScopeEcho {
+    requestedVariantId: string | null;
+    requestedDocumentId: string | null;
+    requestedLocale?: string | null;
+    /** Locale view materialized for this concrete owner document. */
+    appliedLocale?: string | null;
+    appliesToDocument: boolean | null;
+    appliedVariantId: string | null;
+    requestedReleaseId: string | null;
+    releaseScopeStatus: 'none' | 'active' | 'missing' | 'not-previewable' | 'unbound';
+    releaseLifecycleStatus?: string;
+    appliedReleaseId: string | null;
+    releaseMemberState?: 'active' | 'archived' | 'missing' | 'locale-removed';
+    degradedReason?: 'archived' | 'missing' | 'locale-removed';
+}
+export interface QueryResult extends DeliveryDocumentV1 {
+    readonly _localeRouting?: DocumentLocaleRouting;
+    resolved?: Record<string, QueryResult | QueryResult[] | null>;
+}
+export interface ResolveRouteInput {
+    /** Explicit locale: pathname is canonical and unprefixed (domain deployments). */
+    locale?: string;
+    pathname: string | string[] | undefined;
+    storyTypes?: readonly string[];
+    tenant?: string;
+}
+export interface RequestOptions {
+    /** Bypass both edge decision/data caches and the framework fetch cache. */
+    deliveryCache?: 'default' | 'bypass';
+    locale?: string;
+    cache?: 'force-cache' | 'no-store';
+    next?: {
+        revalidate?: number | false;
+        tags?: string[];
+    };
+    signal?: AbortSignal;
+}
+export type DefaultRequestOptions = Omit<RequestOptions, 'signal'>;
+export interface PreviewProvenanceReadLifecycleInput<T> {
+    readonly kind: 'query-single' | 'query-many' | 'resolved-route';
+    readonly cacheKey: string;
+    readonly signal?: AbortSignal;
+    readonly executeRaw: () => Promise<T>;
+}
+export interface PreviewProvenanceReadLifecycle {
+    <T>(input: PreviewProvenanceReadLifecycleInput<T>): Promise<T>;
+}
+export interface RequestContext {
+    previewToken?: string;
+    previewReadContext?: import('@storystick/types/preview-query-targeting').PreviewReadContext;
+    /** Exact Preview view selector. Distinct from the per-render observation. */
+    previewSessionId?: string;
+    previewQueryConsumer?: 'server-render' | 'client-cache';
+    /** @internal Request a server-verified live-query receipt capability. */
+    previewLiveQueryOverlayEnabled?: boolean;
+    variantId?: string | null;
+    releaseId?: string | null;
+    previewObservationId?: string;
+    previewCodeVersion?: string;
+    refreshPreviewToken?: (oldToken: string | undefined) => Promise<string | undefined>;
+    onAccessedContent?: (observation: {
+        readonly documentIds: readonly string[];
+        readonly storyTypes: readonly string[];
+        readonly codeVersion: string;
+        readonly observationId: string;
+        readonly renderWatermark: number;
+    }) => void;
+    /** @deprecated Document-only rollout bridge. */
+    onAccessedDocuments?: (documentIds: readonly string[]) => void;
+    unstable_previewProvenanceReadLifecycle?: PreviewProvenanceReadLifecycle;
+}
+export type ClientAuth = {
+    apiKey: string;
+    publishableKey?: never;
+} | {
+    apiKey?: never;
+    publishableKey: string;
+};
+export interface Transport {
+    request(input: TransportRequest): Promise<TransportResponse>;
+}
+export interface PublicTransportRequest {
+    udfPath: string;
+    args: Record<string, unknown>;
+    options?: RequestOptions;
+    signal?: AbortSignal;
+}
+export interface TransportRequest extends PublicTransportRequest {
+    /** @internal Consumer binding, propagated before any SDK-owned observation. Never sent as server authority. */
+    expectedProjectId?: string;
+    requestContext?: RequestContext;
+}
+export interface TransportResponse {
+    data: unknown;
+    /** Canonical project short ID authenticated by the server, never echoed from client configuration. */
+    projectId?: string;
+    /** Observation of the exact published snapshot, used only for explicit render receipts. */
+    publicReadIdentity?: import('@storystick/types/public-delivery').PublicReadIdentityV1;
+    fromCache?: boolean;
+    /** @internal Authoritative Q2b identity; never copied into public QueryMeta. */
+    executionIdentity?: {
+        queryHash: string;
+        readScopeIdentity: string;
+    };
+    /** @internal Opaque private receipt for targeted Preview cache convergence. */
+    previewQueryReceiptId?: string;
+}
+export type { ReferencedDocumentFailureReason, ReferencedDocumentPolicy, ReferencedDocumentSidecarEntry, ReferencedDocumentSidecarFailure, ReferencedDocumentsSidecar, } from '@storystick/types';
+/** Request shape available to a custom application transport. */
+export interface PublicTransport {
+    request(input: PublicTransportRequest): Promise<TransportResponse>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,73 @@
 {
   "name": "@storystick/client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0-rc.1",
+  "license": "FSL-1.1-MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "import": "./dist/internal.js"
+    },
+    "./normalize-pathname": {
+      "types": "./dist/normalize-pathname.d.ts",
+      "import": "./dist/normalize-pathname.js"
+    },
+    "./locale-routing": {
+      "types": "./dist/locale-routing.d.ts",
+      "import": "./dist/locale-routing.js"
+    },
+    "./adapter": {
+      "types": "./dist/adapter.d.ts",
+      "import": "./dist/adapter.js"
+    },
+    "./seo": {
+      "types": "./dist/seo.d.ts",
+      "import": "./dist/seo.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "PUBLIC-API.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": false,
+    "tag": "beta"
+  },
+  "dependencies": {
+    "@storystick/media": "0.2.0-rc.1",
+    "@storystick/types": "0.1.0-rc.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2",
+    "vitest": "^3.1.1",
+    "@types/node": "^22.13.10"
+  },
+  "engines": {
+    "node": ">=24.19.0 <25"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/withstorystick/storystick.git",
+    "directory": "packages/client"
+  },
+  "homepage": "https://storystick.app",
+  "bugs": {
+    "url": "https://storystick.app"
+  },
+  "scripts": {
+    "build": "node ../../scripts/package-dist.mjs clean && tsc && node ../../scripts/package-dist.mjs seal",
+    "test": "vitest run",
+    "test:dist-fresh": "node ../../scripts/package-dist.mjs assert",
+    "test:types": "tsc -p tsconfig.type-tests.json --noEmit",
+    "test:watch": "vitest"
+  }
 }