@treeseed/sdk 0.4.8 → 0.4.10

package/dist/platform/published-content.d.ts

@@ -0,0 +1,223 @@
+import type { TreeseedDeployConfig } from './contracts.ts';
+import type { CloudflareRuntime, R2BucketLike } from '../types/cloudflare.ts';
+export declare const PUBLISHED_CONTENT_MANIFEST_SCHEMA_VERSION = 2;
+export declare const EDITORIAL_PREVIEW_COOKIE = "treeseed-content-preview";
+export type PublishedContentVisibility = 'public' | 'authenticated' | 'team' | 'private';
+export type HostedContentMode = 'production' | 'editorial_overlay';
+export interface PublishedContentObjectPointer {
+    objectKey: string;
+    sha256: string;
+    size?: number;
+    contentType?: string;
+    publicUrl?: string;
+}
+export interface PublishedContentEntry {
+    id: string;
+    model: string;
+    slug: string;
+    title?: string;
+    summary?: string;
+    status?: string;
+    visibility?: PublishedContentVisibility;
+    teamId?: string;
+    publishedAt?: string;
+    updatedAt?: string;
+    content: PublishedContentObjectPointer;
+    rendered?: PublishedContentObjectPointer;
+    search?: PublishedContentObjectPointer;
+    metadata?: Record<string, unknown>;
+}
+export interface PublishedCollectionIndex {
+    model: string;
+    generatedAt: string;
+    count?: number;
+    entries: PublishedContentEntry[];
+}
+export interface PublishedArtifactVersion {
+    id: string;
+    itemId: string;
+    kind: string;
+    version: string;
+    label?: string;
+    visibility?: PublishedContentVisibility;
+    teamId?: string;
+    publishedAt: string;
+    content: PublishedContentObjectPointer;
+    metadata?: Record<string, unknown>;
+}
+export interface PublishedManifestTombstone {
+    path: string;
+    removedAt: string;
+    previousSha256?: string;
+}
+export interface TeamScopedContentLocator {
+    teamId: string;
+    manifestKey: string;
+    previewRoot: string;
+    overlayKey?: string;
+    previewId?: string;
+    mode?: HostedContentMode;
+}
+export interface CatalogIndexEntry {
+    id: string;
+    teamId: string;
+    kind: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    visibility?: PublishedContentVisibility;
+    listingEnabled?: boolean;
+    offerMode?: 'free' | 'paid' | 'contact' | 'one_time_current_version' | 'subscription_updates' | 'private';
+    manifestKey?: string;
+    artifactKey?: string;
+    updatedAt: string;
+    searchText?: string;
+    metadata?: Record<string, unknown>;
+}
+export type PublishedRuntimePointers = {
+    docsHomePath?: string;
+    booksRuntime?: PublishedContentObjectPointer;
+    docsTree?: PublishedContentObjectPointer;
+    searchIndex?: PublishedContentObjectPointer;
+};
+export interface PublishedContentManifest {
+    schemaVersion: number;
+    siteSlug: string;
+    teamId: string;
+    revision: string;
+    generatedAt: string;
+    mode?: HostedContentMode;
+    sourceCommit?: string;
+    appRevision?: string;
+    appCompatibility?: {
+        min?: string;
+        max?: string;
+        lastKnownCompatibleRevision?: string;
+    };
+    locator?: TeamScopedContentLocator;
+    collections?: Record<string, PublishedContentObjectPointer>;
+    entries: PublishedContentEntry[];
+    artifacts?: PublishedArtifactVersion[];
+    runtime?: PublishedRuntimePointers;
+    tombstones?: PublishedManifestTombstone[];
+    metadata?: Record<string, unknown>;
+}
+export interface PublishedOverlayManifest {
+    schemaVersion: number;
+    siteSlug: string;
+    teamId: string;
+    previewId: string;
+    generatedAt: string;
+    mode?: HostedContentMode;
+    baseManifestKey: string;
+    baseRevision?: string;
+    sourceCommit?: string;
+    expiresAt?: string;
+    locator?: TeamScopedContentLocator;
+    collections?: Record<string, PublishedContentObjectPointer>;
+    entries?: PublishedContentEntry[];
+    artifacts?: PublishedArtifactVersion[];
+    runtime?: PublishedRuntimePointers;
+    tombstones?: PublishedManifestTombstone[];
+    metadata?: Record<string, unknown>;
+}
+export interface ContentRuntimeProvider {
+    getManifest(): Promise<PublishedContentManifest>;
+    getProductionManifest(): Promise<PublishedContentManifest>;
+    getOverlayManifest(): Promise<PublishedOverlayManifest | null>;
+    getCollectionIndex(model: string): Promise<PublishedCollectionIndex>;
+    listCollection(model: string): Promise<PublishedContentEntry[]>;
+    getEntry(model: string, slugOrId: string): Promise<PublishedContentEntry | null>;
+    getArtifactVersion(itemId: string, version?: string): Promise<PublishedArtifactVersion | null>;
+    getObject<T = unknown>(pointer: string | PublishedContentObjectPointer): Promise<T | null>;
+}
+export interface PublishContentObjectInput {
+    pointer: PublishedContentObjectPointer;
+    body: string | ArrayBuffer | ArrayBufferView;
+    httpMetadata?: Record<string, unknown>;
+    customMetadata?: Record<string, string>;
+}
+export interface PublishContentRevisionInput {
+    manifest: PublishedContentManifest;
+    objects: PublishContentObjectInput[];
+}
+export interface PublishOverlayInput {
+    overlay: PublishedOverlayManifest;
+    objects: PublishContentObjectInput[];
+}
+export interface PublishContentRevisionResult {
+    revision: string;
+    manifestKey: string;
+}
+export interface PublishOverlayResult {
+    previewId: string;
+    overlayKey: string;
+}
+export interface PromoteOverlayInput {
+    previewId: string;
+    revision?: string;
+    generatedAt?: string;
+    sourceCommit?: string;
+    appRevision?: string;
+}
+export interface ContentPublishProvider {
+    publishRevision(input: PublishContentRevisionInput): Promise<PublishContentRevisionResult>;
+    publishOverlay(input: PublishOverlayInput): Promise<PublishOverlayResult>;
+    promoteOverlay(input: PromoteOverlayInput): Promise<PublishContentRevisionResult>;
+    rollbackRevision(snapshotKey: string): Promise<PublishContentRevisionResult>;
+    deleteOverlay(previewId: string, overlay?: PublishedOverlayManifest | null): Promise<void>;
+}
+export interface EditorialPreviewTokenPayload {
+    teamId: string;
+    previewId: string;
+    expiresAt: string;
+}
+export declare function parsePublishedContentManifest(value: unknown): PublishedContentManifest;
+export declare function parsePublishedOverlayManifest(value: unknown): PublishedOverlayManifest;
+export declare function parsePublishedCollectionIndex(value: unknown): PublishedCollectionIndex;
+export declare function resolvePublishedContentBucketBinding(config: Pick<TreeseedDeployConfig, 'cloudflare'>): string;
+export declare function resolvePublishedContentManifestKey(config: Pick<TreeseedDeployConfig, 'cloudflare'> & Partial<Pick<TreeseedDeployConfig, 'slug'>>, teamId?: string): string;
+export declare function resolvePublishedContentPreviewRoot(config: Pick<TreeseedDeployConfig, 'cloudflare'> & Partial<Pick<TreeseedDeployConfig, 'slug'>>, teamId?: string): string;
+export declare function resolvePublishedContentPreviewTtlHours(config: Pick<TreeseedDeployConfig, 'cloudflare'>): number;
+export declare function resolveTeamScopedContentLocator(config: Pick<TreeseedDeployConfig, 'cloudflare'>, teamId: string, previewId?: string): TeamScopedContentLocator;
+export declare function isTeamScopedR2ContentEnabled(config: Pick<TreeseedDeployConfig, 'providers' | 'cloudflare'>): boolean;
+export declare function signEditorialPreviewToken(payload: EditorialPreviewTokenPayload, secret: string): string;
+export declare function verifyEditorialPreviewToken(token: string, secret: string): EditorialPreviewTokenPayload | null;
+export declare function resolveCloudflareR2Bucket(runtime: CloudflareRuntime | null | undefined, binding: string): R2BucketLike | null;
+export declare function readPublishedContentManifest(bucket: R2BucketLike, manifestKey: string): Promise<PublishedContentManifest | null>;
+export declare function readPublishedOverlayManifest(bucket: R2BucketLike, overlayKey: string): Promise<PublishedOverlayManifest | null>;
+export declare class TeamScopedR2OverlayContentRuntimeProvider implements ContentRuntimeProvider {
+    private readonly bucket;
+    private readonly locator;
+    private productionManifestPromise;
+    private overlayManifestPromise;
+    private manifestPromise;
+    private readonly collectionCache;
+    constructor(bucket: R2BucketLike, locator: TeamScopedContentLocator);
+    getProductionManifest(): Promise<PublishedContentManifest>;
+    getOverlayManifest(): Promise<PublishedOverlayManifest | null>;
+    getManifest(): Promise<PublishedContentManifest>;
+    getCollectionIndex(model: string): Promise<PublishedCollectionIndex>;
+    listCollection(model: string): Promise<PublishedContentEntry[]>;
+    getEntry(model: string, slugOrId: string): Promise<PublishedContentEntry | null>;
+    getArtifactVersion(itemId: string, version?: string): Promise<PublishedArtifactVersion | null>;
+    getObject<T = unknown>(pointer: string | PublishedContentObjectPointer): Promise<T | null>;
+}
+export declare class TeamScopedR2OverlayContentPublishProvider implements ContentPublishProvider {
+    private readonly bucket;
+    private readonly locator;
+    constructor(bucket: R2BucketLike, locator: TeamScopedContentLocator);
+    publishRevision(input: PublishContentRevisionInput): Promise<PublishContentRevisionResult>;
+    publishOverlay(input: PublishOverlayInput): Promise<PublishOverlayResult>;
+    promoteOverlay(input: PromoteOverlayInput): Promise<PublishContentRevisionResult>;
+    rollbackRevision(snapshotKey: string): Promise<PublishContentRevisionResult>;
+    deleteOverlay(previewId: string, overlay?: PublishedOverlayManifest | null): Promise<void>;
+}
+export declare function createTeamScopedR2OverlayContentRuntimeProvider(options: {
+    bucket: R2BucketLike;
+    locator: TeamScopedContentLocator;
+}): TeamScopedR2OverlayContentRuntimeProvider;
+export declare function createTeamScopedR2OverlayContentPublishProvider(options: {
+    bucket: R2BucketLike;
+    locator: TeamScopedContentLocator;
+}): TeamScopedR2OverlayContentPublishProvider;