@spacefast/common 0.0.12 → 0.0.17

package/dist/contracts/comments.d.ts

@@ -1,36 +1,89 @@
 import { z } from "zod";
+import type { GrantCapability } from "./grants.js";
 export declare const commentThreadStatusSchema: z.ZodEnum<{
     open: "open";
     archived: "archived";
 }>;
 export declare const COMMENT_SEARCH_QUERY_MAX_LENGTH = 160;
 export declare function normalizeCommentSearchQuery(value: string | undefined): string | undefined;
-export declare const collaborationReviewerLevelSchema: z.ZodEnum<{
-    viewer: "viewer";
-    commenter: "commenter";
-    editor: "editor";
-}>;
 export declare const COMMENT_PAGE_PATH_MAX_LENGTH = 2048;
-export declare const collaborationInvitedReviewerSchema: z.ZodObject<{
-    email: z.ZodString;
-    level: z.ZodEnum<{
+export declare const commentCapabilitiesSchema: z.ZodArray<z.ZodEnum<{
+    "page.view": "page.view";
+    "comments.read": "comments.read";
+    "comments.write": "comments.write";
+}>>;
+export type CommentCapability = Extract<GrantCapability, "page.view" | "comments.read" | "comments.write">;
+export type CommentCapabilities = CommentCapability[];
+export declare const collaborationGuestProjectionSchema: z.ZodObject<{
+    anonymousId: z.ZodString;
+    name: z.ZodString;
+    namedByUser: z.ZodBoolean;
+    grantId: z.ZodString;
+    admittedBy: z.ZodUnion<readonly [z.ZodLiteral<"anyone">, z.ZodTemplateLiteral<`link:${string}`>, z.ZodTemplateLiteral<`password:${string}`>]>;
+    emailVerified: z.ZodDefault<z.ZodBoolean>;
+    capabilities: z.ZodArray<z.ZodEnum<{
+        "page.view": "page.view";
+        "comments.read": "comments.read";
+        "comments.write": "comments.write";
+    }>>;
+}, z.core.$strip>;
+export type CollaborationGuestProjection = z.infer<typeof collaborationGuestProjectionSchema>;
+export declare const commentsGuestIdentitySchema: z.ZodObject<{
+    name: z.ZodString;
+    anonymousId: z.ZodString;
+    namedByUser: z.ZodBoolean;
+}, z.core.$strip>;
+export declare function commentCapabilitiesOf(capabilities: readonly string[]): CommentCapabilities;
+export declare const collaborationPublicProfileSchema: z.ZodObject<{
+    name: z.ZodNullable<z.ZodString>;
+    username: z.ZodNullable<z.ZodString>;
+    avatar_url: z.ZodNullable<z.ZodURL>;
+}, z.core.$strict>;
+export type CollaborationPublicProfile = z.infer<typeof collaborationPublicProfileSchema>;
+export declare const collaborationTicketClaimsSchema: z.ZodObject<{
+    sub: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    profile: z.ZodOptional<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        username: z.ZodNullable<z.ZodString>;
+        avatar_url: z.ZodNullable<z.ZodURL>;
+    }, z.core.$strict>>;
+    role: z.ZodEnum<{
         viewer: "viewer";
         commenter: "commenter";
         editor: "editor";
+        manager: "manager";
     }>;
+    actorKind: z.ZodEnum<{
+        user: "user";
+        guest: "guest";
+    }>;
+    authorities: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    capabilities: z.ZodArray<z.ZodEnum<{
+        "page.view": "page.view";
+        "comments.read": "comments.read";
+        "comments.write": "comments.write";
+    }>>;
+    anonymousId: z.ZodOptional<z.ZodString>;
+    grantId: z.ZodOptional<z.ZodString>;
+    namedByUser: z.ZodOptional<z.ZodBoolean>;
+    admittedBy: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"anyone">, z.ZodTemplateLiteral<`link:${string}`>, z.ZodTemplateLiteral<`password:${string}`>]>>;
+    emailVerified: z.ZodOptional<z.ZodBoolean>;
+    room: z.ZodString;
+    scope: z.ZodString;
+    surface: z.ZodEnum<{
+        preview: "preview";
+        published: "published";
+    }>;
+    nonce: z.ZodString;
+    iat: z.ZodNumber;
+    nbf: z.ZodNumber;
+    exp: z.ZodNumber;
+    iss: z.ZodLiteral<"spacefast-api">;
+    aud: z.ZodString;
 }, z.core.$strip>;
 export declare const collaborationSettingsSchema: z.ZodObject<{
-    anonymousReviewers: z.ZodOptional<z.ZodBoolean>;
-    publishedAnonymousCommenters: z.ZodOptional<z.ZodBoolean>;
     spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-    invitedReviewers: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        email: z.ZodString;
-        level: z.ZodEnum<{
-            viewer: "viewer";
-            commenter: "commenter";
-            editor: "editor";
-        }>;
-    }, z.core.$strip>>>;
     publishedComments: z.ZodOptional<z.ZodBoolean>;
     notificationPreferences: z.ZodOptional<z.ZodObject<{
         newThreads: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
@@ -40,21 +93,12 @@ export declare const collaborationSettingsSchema: z.ZodObject<{
 }, z.core.$strict>;
 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<{
-        anonymousReviewers: z.ZodOptional<z.ZodBoolean>;
-        publishedAnonymousCommenters: z.ZodOptional<z.ZodBoolean>;
         spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-        invitedReviewers: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            email: z.ZodString;
-            level: z.ZodEnum<{
-                viewer: "viewer";
-                commenter: "commenter";
-                editor: "editor";
-            }>;
-        }, z.core.$strip>>>;
         publishedComments: z.ZodOptional<z.ZodBoolean>;
         notificationPreferences: z.ZodOptional<z.ZodObject<{
             newThreads: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
@@ -66,34 +110,30 @@ export declare const collaborationSchema: z.ZodObject<{
     updatedAt: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export declare const collaborationUpdateSchema: z.ZodObject<{
-    enabled: z.ZodBoolean;
+    expectedRevision: z.ZodNumber;
+    enabled: z.ZodOptional<z.ZodBoolean>;
     settings: z.ZodOptional<z.ZodObject<{
-        anonymousReviewers: z.ZodOptional<z.ZodBoolean>;
-        publishedAnonymousCommenters: z.ZodOptional<z.ZodBoolean>;
         spamFilterEnabled: z.ZodOptional<z.ZodBoolean>;
-        invitedReviewers: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            email: z.ZodString;
-            level: z.ZodEnum<{
-                viewer: "viewer";
-                commenter: "commenter";
-                editor: "editor";
-            }>;
-        }, z.core.$strip>>>;
         publishedComments: z.ZodOptional<z.ZodBoolean>;
         notificationPreferences: z.ZodOptional<z.ZodObject<{
-            newThreads: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-            newReplies: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-            statusChanges: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-        }, z.core.$strip>>;
+            newThreads: z.ZodOptional<z.ZodBoolean>;
+            newReplies: z.ZodOptional<z.ZodBoolean>;
+            statusChanges: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
     }, z.core.$strict>>;
 }, z.core.$strip>;
-export declare const collaborationTokenRequestSchema: z.ZodObject<{
-    versionId: z.ZodOptional<z.ZodString>;
+export declare const commentsTicketRequestSchema: z.ZodObject<{
+    spaceId: z.ZodString;
     pagePath: z.ZodDefault<z.ZodString>;
-    anonymousId: z.ZodOptional<z.ZodString>;
-    displayName: z.ZodOptional<z.ZodString>;
+    origin: z.ZodString;
+    versionId: z.ZodOptional<z.ZodString>;
+    identity: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        anonymousId: z.ZodString;
+        namedByUser: z.ZodBoolean;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
-export declare const collaborationTokenResponseSchema: z.ZodObject<{
+export declare const commentsTicketResponseSchema: z.ZodObject<{
     token: z.ZodString;
     expiresAt: z.ZodString;
     cast: z.ZodObject<{
@@ -101,18 +141,6 @@ export declare const collaborationTokenResponseSchema: z.ZodObject<{
         room: z.ZodString;
     }, z.core.$strip>;
 }, z.core.$strip>;
-export declare const collaborationHandoffRequestSchema: z.ZodObject<{
-    versionId: z.ZodString;
-    pagePath: z.ZodDefault<z.ZodString>;
-}, z.core.$strip>;
-export declare const collaborationHandoffResponseSchema: z.ZodObject<{
-    handoffToken: z.ZodString;
-    expiresAt: z.ZodString;
-    url: z.ZodNullable<z.ZodString>;
-}, z.core.$strip>;
-export declare const collaborationHandoffExchangeSchema: z.ZodObject<{
-    handoffToken: z.ZodString;
-}, z.core.$strip>;
 export declare const realtimeTokenRequestSchema: z.ZodObject<{
     versionId: z.ZodOptional<z.ZodString>;
     scope: z.ZodDefault<z.ZodEnum<{
@@ -148,44 +176,7 @@ export declare const noticePublishResponseSchema: z.ZodObject<{
     event: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     broadcast: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
-export declare const collabOverlayConfigQuerySchema: z.ZodObject<{
-    path: z.ZodOptional<z.ZodString>;
-    versionId: z.ZodOptional<z.ZodString>;
-    host: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export declare const collabOverlayConfigSchema: z.ZodObject<{
-    enabled: z.ZodBoolean;
-    anonymous_commenters: 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>;
-    ws_url: z.ZodNullable<z.ZodString>;
-    endpoints: z.ZodObject<{
-        token: z.ZodString;
-        handoff_exchange: z.ZodString;
-        auth_bridge: z.ZodString;
-        screenshots: z.ZodString;
-    }, z.core.$strip>;
-    features: z.ZodObject<{
-        drawing: z.ZodBoolean;
-        capture: z.ZodBoolean;
-        notices: z.ZodBoolean;
-    }, z.core.$strip>;
-}, z.core.$strip>;
 export declare const COLLAB_VERSION_URLS_MAX_IDS = 50;
-export declare const collabVersionUrlsQuerySchema: z.ZodObject<{
-    path: z.ZodOptional<z.ZodString>;
-    versionId: z.ZodOptional<z.ZodString>;
-    host: z.ZodOptional<z.ZodString>;
-    ids: z.ZodString;
-}, z.core.$strip>;
 export declare const collabVersionUrlSchema: z.ZodObject<{
     id: z.ZodString;
     url: z.ZodString;
@@ -195,10 +186,37 @@ export declare const collabVersionUrlSchema: z.ZodObject<{
 export declare const commentAuthorSchema: z.ZodObject<{
     kind: z.ZodNullable<z.ZodString>;
     id: z.ZodNullable<z.ZodString>;
+    profileId: z.ZodNullable<z.ZodString>;
     name: z.ZodNullable<z.ZodString>;
+    username: z.ZodNullable<z.ZodString>;
+    avatarUrl: z.ZodNullable<z.ZodURL>;
     color: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export declare const commentTargetSchema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+export declare const commentReactionActorSchema: z.ZodObject<{
+    name: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export declare const commentReactionEntrySchema: z.ZodObject<{
+    count: z.ZodNumber;
+    actors: z.ZodRecord<z.ZodString, z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const COMMENT_REACTION_EMOJIS: readonly ["👍", "❤️", "🎉", "👀", "🚀", "🙏"];
+export declare const commentReactionUpdateSchema: z.ZodObject<{
+    emoji: z.ZodEnum<{
+        "\uD83D\uDC4D": "👍";
+        "\u2764\uFE0F": "❤️";
+        "\uD83C\uDF89": "🎉";
+        "\uD83D\uDC40": "👀";
+        "\uD83D\uDE80": "🚀";
+        "\uD83D\uDE4F": "🙏";
+    }>;
+    op: z.ZodEnum<{
+        remove: "remove";
+        add: "add";
+    }>;
+}, z.core.$strip>;
 export declare const commentThreadSchema: z.ZodObject<{
     id: z.ZodString;
     castThreadId: z.ZodString;
@@ -222,10 +240,19 @@ export declare const commentThreadSchema: z.ZodObject<{
     author: z.ZodNullable<z.ZodObject<{
         kind: z.ZodNullable<z.ZodString>;
         id: z.ZodNullable<z.ZodString>;
+        profileId: z.ZodNullable<z.ZodString>;
         name: z.ZodNullable<z.ZodString>;
+        username: z.ZodNullable<z.ZodString>;
+        avatarUrl: z.ZodNullable<z.ZodURL>;
         color: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>>;
     target: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    reactions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        count: z.ZodNumber;
+        actors: z.ZodRecord<z.ZodString, z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
     comments: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     permalink: z.ZodNullable<z.ZodString>;
     updatedAt: z.ZodNullable<z.ZodString>;
@@ -273,6 +300,16 @@ export declare const commentScreenshotSchema: z.ZodObject<{
     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>;
@@ -317,10 +354,19 @@ export declare const commentListResponseSchema: z.ZodObject<{
         author: z.ZodNullable<z.ZodObject<{
             kind: z.ZodNullable<z.ZodString>;
             id: z.ZodNullable<z.ZodString>;
+            profileId: z.ZodNullable<z.ZodString>;
             name: z.ZodNullable<z.ZodString>;
+            username: z.ZodNullable<z.ZodString>;
+            avatarUrl: z.ZodNullable<z.ZodURL>;
             color: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>>;
         target: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        reactions: z.ZodRecord<z.ZodString, z.ZodObject<{
+            count: z.ZodNumber;
+            actors: z.ZodRecord<z.ZodString, z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
         comments: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         permalink: z.ZodNullable<z.ZodString>;
         updatedAt: z.ZodNullable<z.ZodString>;
@@ -337,9 +383,7 @@ export declare const commentExportResponseSchema: z.ZodObject<{
     }>;
     content: z.ZodString;
 }, z.core.$strip>;
-export type CollaborationInvitedReviewer = z.infer<typeof collaborationInvitedReviewerSchema>;
 export type Collaboration = z.infer<typeof collaborationSchema>;
 export type CollaborationUpdate = z.infer<typeof collaborationUpdateSchema>;
-export type CollabOverlayConfig = z.infer<typeof collabOverlayConfigSchema>;
 export type CollabVersionUrl = z.infer<typeof collabVersionUrlSchema>;
 export type CommentThread = z.infer<typeof commentThreadSchema>;