@spacefast/common 0.0.21 → 0.0.24

package/dist/contracts/comments.d.ts

@@ -40,6 +40,20 @@ export declare const collaborationPublicProfileSchema: z.ZodObject<{
     avatar_url: z.ZodNullable<z.ZodURL>;
 }, z.core.$strict>;
 export type CollaborationPublicProfile = z.infer<typeof collaborationPublicProfileSchema>;
+/**
+ * Where the browser holding this ticket is.
+ *
+ * "embed" is a third-party site the owner allowlisted, and it is its own state
+ * precisely so nothing pretends a foreign origin is a published Spacefast host:
+ * the room an embed ticket names is origin-scoped, and both the mint and Cast
+ * refuse the pairing in either direction.
+ */
+export declare const collaborationSurfaceSchema: z.ZodEnum<{
+    preview: "preview";
+    published: "published";
+    embed: "embed";
+}>;
+export type CollaborationSurface = z.infer<typeof collaborationSurfaceSchema>;
 export declare const collaborationTicketClaimsSchema: z.ZodObject<{
     sub: z.ZodString;
     email: z.ZodOptional<z.ZodString>;
@@ -74,6 +88,7 @@ export declare const collaborationTicketClaimsSchema: z.ZodObject<{
     surface: z.ZodEnum<{
         preview: "preview";
         published: "published";
+        embed: "embed";
     }>;
     nonce: z.ZodString;
     iat: z.ZodNumber;
@@ -82,9 +97,30 @@ export declare const collaborationTicketClaimsSchema: z.ZodObject<{
     iss: z.ZodLiteral<"spacefast-api">;
     aud: z.ZodString;
 }, z.core.$strip>;
+export declare const commentsSurfaceSchema: z.ZodEnum<{
+    off: "off";
+    previews: "previews";
+    everywhere: "everywhere";
+}>;
+export declare const COMMENTS_EMBED_ORIGINS_MAX = 20;
+/**
+ * A site the Space owner allows the one-line Collab insert to run on.
+ *
+ * Exactly one https origin — scheme, host, and port, nothing else. No
+ * wildcards: on a foreign site this list IS the entitlement, and `*.example.com`
+ * hands it to every subdomain the site ever loses control of. An off-shape
+ * value is refused rather than normalized, so what the owner typed and what the
+ * server matches are the same string.
+ */
+export declare const commentsEmbedOriginSchema: z.ZodString;
 export declare const collaborationSettingsSchema: z.ZodObject<{
     spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-    publishedComments: z.ZodOptional<z.ZodBoolean>;
+    surface: z.ZodDefault<z.ZodEnum<{
+        off: "off";
+        previews: "previews";
+        everywhere: "everywhere";
+    }>>;
+    embedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
     notificationPreferences: z.ZodOptional<z.ZodObject<{
         newThreads: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         newReplies: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
@@ -94,12 +130,16 @@ export declare const collaborationSettingsSchema: z.ZodObject<{
 export declare const collaborationSchema: z.ZodObject<{
     spaceId: z.ZodString;
     revision: z.ZodNumber;
-    enabled: z.ZodBoolean;
     castResourceId: z.ZodNullable<z.ZodString>;
     castResourceKey: z.ZodNullable<z.ZodString>;
     settings: z.ZodObject<{
         spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-        publishedComments: z.ZodOptional<z.ZodBoolean>;
+        surface: z.ZodDefault<z.ZodEnum<{
+            off: "off";
+            previews: "previews";
+            everywhere: "everywhere";
+        }>>;
+        embedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
         notificationPreferences: z.ZodOptional<z.ZodObject<{
             newThreads: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
             newReplies: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
@@ -111,42 +151,91 @@ export declare const collaborationSchema: z.ZodObject<{
 }, z.core.$strip>;
 export declare const collaborationUpdateSchema: z.ZodObject<{
     expectedRevision: z.ZodNumber;
-    enabled: z.ZodOptional<z.ZodBoolean>;
-    settings: z.ZodOptional<z.ZodObject<{
+    settings: z.ZodObject<{
         spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-        publishedComments: z.ZodOptional<z.ZodBoolean>;
+        surface: z.ZodOptional<z.ZodEnum<{
+            off: "off";
+            previews: "previews";
+            everywhere: "everywhere";
+        }>>;
+        embedOrigins: z.ZodOptional<z.ZodArray<z.ZodString>>;
         notificationPreferences: z.ZodOptional<z.ZodObject<{
             newThreads: z.ZodOptional<z.ZodBoolean>;
             newReplies: z.ZodOptional<z.ZodBoolean>;
             statusChanges: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strict>>;
-    }, z.core.$strict>>;
+    }, z.core.$strict>;
 }, z.core.$strip>;
-export declare const commentsTicketRequestSchema: z.ZodObject<{
-    spaceId: z.ZodString;
+/**
+ * The overlay's whole configuration, in one shape.
+ *
+ * Both lanes carry this: the Space's own origins get it from the runtime's
+ * same-origin exchange, a third-party site fetches it over CORS keyed by
+ * `data-space`. Only the transport differs — the SDK parses one shape.
+ */
+export declare const collabOverlayConfigSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    resource_key: z.ZodNullable<z.ZodString>;
+    room_key: z.ZodNullable<z.ZodString>;
+    version: z.ZodObject<{
+        id: z.ZodNullable<z.ZodString>;
+        current: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    space: z.ZodObject<{
+        live_url: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    theme: z.ZodObject<{
+        accent: z.ZodNullable<z.ZodString>;
+        hide_branding: z.ZodBoolean;
+    }, z.core.$strip>;
+    ws_url: z.ZodNullable<z.ZodString>;
+    endpoints: z.ZodObject<{
+        ticket: z.ZodString;
+    }, z.core.$strip>;
+    features: z.ZodObject<{
+        picker: z.ZodOptional<z.ZodBoolean>;
+        drawing: z.ZodBoolean;
+        capture: z.ZodBoolean;
+        attachments: z.ZodBoolean;
+        notices: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type CollabOverlayConfig = z.infer<typeof collabOverlayConfigSchema>;
+export declare const commentsEmbedIdentitySchema: z.ZodObject<{
+    name: z.ZodString;
+    namedByUser: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const commentsEmbedTicketRequestSchema: z.ZodObject<{
     pagePath: z.ZodDefault<z.ZodString>;
-    origin: z.ZodString;
-    versionId: z.ZodOptional<z.ZodString>;
-    identity: z.ZodOptional<z.ZodObject<{
+    identity: z.ZodObject<{
         name: z.ZodString;
-        anonymousId: z.ZodString;
         namedByUser: z.ZodBoolean;
-    }, z.core.$strip>>;
+    }, z.core.$strip>;
+    visitorToken: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-export declare const commentsTicketResponseSchema: z.ZodObject<{
+export declare const commentsEmbedTicketResponseSchema: z.ZodObject<{
     token: z.ZodString;
     expiresAt: z.ZodString;
     cast: z.ZodObject<{
         resource: z.ZodString;
         room: z.ZodString;
     }, z.core.$strip>;
+    visitorToken: z.ZodString;
+    visitorExpiresAt: z.ZodString;
 }, z.core.$strip>;
-export declare const realtimeTokenRequestSchema: z.ZodObject<{
-    versionId: z.ZodOptional<z.ZodString>;
-    scope: z.ZodDefault<z.ZodEnum<{
-        space: "space";
-        version: "version";
-    }>>;
+export declare const commentsTicketResponseSchema: z.ZodObject<{
+    token: z.ZodString;
+    expiresAt: z.ZodString;
+    cast: z.ZodObject<{
+        resource: z.ZodString;
+        room: z.ZodString;
+        wsUrl: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    notice: z.ZodNullable<z.ZodObject<{
+        token: z.ZodString;
+        room: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const realtimeTokenResponseSchema: z.ZodObject<{
     token: z.ZodString;
@@ -154,8 +243,16 @@ export declare const realtimeTokenResponseSchema: z.ZodObject<{
     cast: z.ZodObject<{
         resource: z.ZodString;
         room: z.ZodString;
+        wsUrl: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * A Space-level fact worth interrupting someone for. It travels as a `notice`
+ * on the Space's notice room — never as an event in a page room — because it
+ * is not conversation content: every open surface needs it regardless of which
+ * page it happens to be sitting on, including surfaces (the dashboard) that
+ * are in no page room at all.
+ */
 export declare const noticePublishSchema: z.ZodObject<{
     versionId: z.ZodOptional<z.ZodString>;
     kind: z.ZodDefault<z.ZodString>;
@@ -164,17 +261,22 @@ export declare const noticePublishSchema: z.ZodObject<{
     level: z.ZodDefault<z.ZodEnum<{
         info: "info";
         success: "success";
-        error: "error";
         warning: "warning";
+        error: "error";
     }>>;
     payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    durable: z.ZodDefault<z.ZodBoolean>;
-    idempotencyKey: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/** The wire shape of one notice, shared by the platform and comment lanes. */
+export declare const spaceNoticeSchema: z.ZodObject<{
+    kind: z.ZodString;
+    version_id: z.ZodNullable<z.ZodString>;
+}, z.core.$loose>;
 export declare const noticePublishResponseSchema: z.ZodObject<{
     status: z.ZodString;
-    event: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    broadcast: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    notice: z.ZodObject<{
+        kind: z.ZodString;
+        version_id: z.ZodNullable<z.ZodString>;
+    }, z.core.$loose>;
 }, z.core.$strip>;
 export declare const COLLAB_VERSION_URLS_MAX_IDS = 50;
 export declare const collabVersionUrlSchema: z.ZodObject<{
@@ -193,6 +295,57 @@ export declare const commentAuthorSchema: z.ZodObject<{
     color: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export declare const commentTargetSchema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+/**
+ * How many attachments one thread or reply may carry. Mirrors Cast's own
+ * `@attachment_limit`: Cast is the authority that enforces it on write, this
+ * bound is what REST readers can rely on.
+ */
+export declare const COMMENT_ATTACHMENT_MAX_COUNT = 10;
+/**
+ * A pointer to a storage object on the Space's own runtime plus the descriptor
+ * needed to render it — never a URL. Cast stores exactly this (snake_case) under
+ * `metadata.attachments`; the id is a bare 32-hex object id.
+ */
+export declare const commentAttachmentSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    contentType: z.ZodString;
+    size: z.ZodNumber;
+    kind: z.ZodEnum<{
+        file: "file";
+        image: "image";
+        screenshot: "screenshot";
+    }>;
+    crop: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * What a REST reader gets: the stored attachment plus a freshly composed read
+ * URL. `url` is null when the runtime's revocable read key cannot be resolved —
+ * an honest degraded read rather than a dead link or a dropped attachment.
+ */
+export declare const commentAttachmentViewSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    contentType: z.ZodString;
+    size: z.ZodNumber;
+    kind: z.ZodEnum<{
+        file: "file";
+        image: "image";
+        screenshot: "screenshot";
+    }>;
+    crop: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    url: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
 export declare const commentReactionActorSchema: z.ZodObject<{
     name: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -217,6 +370,31 @@ export declare const commentReactionUpdateSchema: z.ZodObject<{
         add: "add";
     }>;
 }, z.core.$strip>;
+/**
+ * A reply keeps Cast's own free-form shape; `attachments` is the one field the
+ * API composes rather than passes through (Cast carries it in the reply's
+ * `metadata`, without URLs).
+ */
+export declare const commentReplyViewSchema: z.ZodObject<{
+    attachments: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        contentType: z.ZodString;
+        size: z.ZodNumber;
+        kind: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            screenshot: "screenshot";
+        }>;
+        crop: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        url: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$loose>;
 export declare const commentThreadSchema: z.ZodObject<{
     id: z.ZodString;
     castThreadId: z.ZodString;
@@ -253,7 +431,44 @@ export declare const commentThreadSchema: z.ZodObject<{
             name: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>>;
     }, z.core.$strip>>;
-    comments: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    attachments: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        contentType: z.ZodString;
+        size: z.ZodNumber;
+        kind: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            screenshot: "screenshot";
+        }>;
+        crop: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        url: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    comments: z.ZodArray<z.ZodObject<{
+        attachments: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            contentType: z.ZodString;
+            size: z.ZodNumber;
+            kind: z.ZodEnum<{
+                file: "file";
+                image: "image";
+                screenshot: "screenshot";
+            }>;
+            crop: z.ZodOptional<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, z.core.$strip>>;
+            url: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$loose>>;
     permalink: z.ZodNullable<z.ZodString>;
     updatedAt: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -284,32 +499,6 @@ export declare const commentCreateSchema: z.ZodObject<{
     target: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
     idempotencyKey: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-export declare const commentScreenshotCreateSchema: z.ZodObject<{
-    versionId: z.ZodString;
-    pagePath: z.ZodDefault<z.ZodString>;
-    contentType: z.ZodEnum<{
-        "image/jpeg": "image/jpeg";
-        "image/png": "image/png";
-        "image/webp": "image/webp";
-    }>;
-    contentBase64: z.ZodString;
-}, z.core.$strip>;
-export declare const commentScreenshotSchema: z.ZodObject<{
-    id: z.ZodString;
-    key: z.ZodString;
-    url: z.ZodString;
-    expiresAt: z.ZodString;
-}, z.core.$strip>;
-export declare const commentScreenshotRefreshSchema: z.ZodObject<{
-    versionId: z.ZodString;
-    pagePath: z.ZodDefault<z.ZodString>;
-    key: z.ZodString;
-}, z.core.$strip>;
-export declare const commentScreenshotRefreshResponseSchema: z.ZodObject<{
-    key: z.ZodString;
-    url: z.ZodString;
-    expiresAt: z.ZodString;
-}, z.core.$strip>;
 export declare const commentReplySchema: z.ZodObject<{
     body: z.ZodString;
     idempotencyKey: z.ZodOptional<z.ZodString>;
@@ -367,7 +556,44 @@ export declare const commentListResponseSchema: z.ZodObject<{
                 name: z.ZodNullable<z.ZodString>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
-        comments: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        attachments: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            contentType: z.ZodString;
+            size: z.ZodNumber;
+            kind: z.ZodEnum<{
+                file: "file";
+                image: "image";
+                screenshot: "screenshot";
+            }>;
+            crop: z.ZodOptional<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, z.core.$strip>>;
+            url: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+        comments: z.ZodArray<z.ZodObject<{
+            attachments: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                contentType: z.ZodString;
+                size: z.ZodNumber;
+                kind: z.ZodEnum<{
+                    file: "file";
+                    image: "image";
+                    screenshot: "screenshot";
+                }>;
+                crop: z.ZodOptional<z.ZodObject<{
+                    x: z.ZodNumber;
+                    y: z.ZodNumber;
+                    width: z.ZodNumber;
+                    height: z.ZodNumber;
+                }, z.core.$strip>>;
+                url: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$loose>>;
         permalink: z.ZodNullable<z.ZodString>;
         updatedAt: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>>;
@@ -385,5 +611,8 @@ export declare const commentExportResponseSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type Collaboration = z.infer<typeof collaborationSchema>;
 export type CollaborationUpdate = z.infer<typeof collaborationUpdateSchema>;
+export type CommentsSurface = z.infer<typeof commentsSurfaceSchema>;
 export type CollabVersionUrl = z.infer<typeof collabVersionUrlSchema>;
 export type CommentThread = z.infer<typeof commentThreadSchema>;
+export type CommentAttachment = z.infer<typeof commentAttachmentSchema>;
+export type CommentAttachmentView = z.infer<typeof commentAttachmentViewSchema>;