@shaxpir/duiduidui-models 1.20.1 → 1.24.0

package/dist/models/Chat.d.ts

@@ -2,7 +2,9 @@ import { Doc } from '@shaxpir/sharedb/lib/client';
 import { CompactDateTime, MultiTime } from '@shaxpir/shaxpir-common';
 import { ShareSync } from '../repo';
 import { ArrayView } from './ArrayView';
-import { Content, ContentBody, ContentId, ContentMeta } from './Content';
+import { ContentBody, ContentId, ContentMeta } from './Content';
+import { SharedContent } from './SharedContent';
+import { SocialUser } from './Social';
 export interface TextBlock {
     type: 'text';
     text: string;
@@ -43,6 +45,7 @@ export interface ChatMessage {
     role: 'user' | 'assistant';
     content: ContentBlock[];
     timestamp: CompactDateTime;
+    sender_id?: ContentId;
     system_prompt_hash?: string;
     model?: string;
     usage?: ChatUsage;
@@ -60,32 +63,62 @@ export interface ChatScratchpad {
 export interface ChatStub {
     id: ContentId;
     title?: string;
+    participants: SocialUser[];
     last_message_preview?: string;
     updated_at: CompactDateTime;
+    has_unread: {
+        [user_id: string]: boolean;
+    };
+}
+export type ChatStatus = 'idle' | 'pending' | 'error';
+export interface ChatError {
+    message: string;
+    code?: string;
+    retryable: boolean;
 }
 export interface ChatPayload {
     title?: string;
+    participants: SocialUser[];
     messages: ChatMessage[];
-    scratchpad: ChatScratchpad;
+    last_read: {
+        [user_id: string]: CompactDateTime;
+    };
+    status: ChatStatus;
+    error?: ChatError;
 }
 export interface ChatBody extends ContentBody {
     meta: ContentMeta;
     payload: ChatPayload;
 }
-export declare class Chat extends Content {
+export declare class Chat extends SharedContent {
     private _messagesView;
+    private _participantsView;
     constructor(doc: Doc, shouldAcquire: boolean, shareSync: ShareSync);
     static makeChatId(userId: ContentId, chatKey: string): ContentId;
-    static createDefaultPayload(): ChatPayload;
-    static create(userId: ContentId, chatKey: string, payload?: ChatPayload, createdAt?: MultiTime): Chat;
+    static create(userId: ContentId, chatKey: string, participants: SocialUser[], createdAt?: MultiTime): Chat;
+    getAllSharedUserIds(): ContentId[];
+    /**
+     * Override to update manifests for all participants (via SharedContent)
+     * and update workspace chat stubs for each participant.
+     */
+    modelUpdated(): Promise<void>;
     get payload(): ChatPayload;
     get title(): string | undefined;
+    get participants(): ArrayView<SocialUser>;
     get messages(): ArrayView<ChatMessage>;
-    get scratchpad(): ChatScratchpad;
+    get lastRead(): {
+        [user_id: string]: CompactDateTime;
+    };
+    get status(): ChatStatus;
+    get error(): ChatError | undefined;
     setTitle(title: string): void;
-    setScratchpad(scratchpad: ChatScratchpad): void;
-    updateScratchpadField(key: string, value: any): void;
-    clearScratchpad(): void;
+    setStatus(status: ChatStatus): void;
+    setError(error: ChatError): void;
+    clearError(): void;
+    addParticipant(user: SocialUser): void;
+    removeParticipant(userId: ContentId): void;
+    markRead(userId: ContentId): void;
+    hasUnread(userId: ContentId): boolean;
     toStub(): ChatStub;
     appendMessage(message: ChatMessage): void;
     setBreakpoint(messageIndex: number, ttl: 'ephemeral' | 'standard'): void;

package/dist/models/Chat.js

@@ -4,30 +4,24 @@ exports.Chat = void 0;
 const shaxpir_common_1 = require("@shaxpir/shaxpir-common");
 const repo_1 = require("../repo");
 const ArrayView_1 = require("./ArrayView");
-const Content_1 = require("./Content");
 const ContentKind_1 = require("./ContentKind");
 const Operation_1 = require("./Operation");
+const SharedContent_1 = require("./SharedContent");
 // ---- Chat model ----
-class Chat extends Content_1.Content {
+class Chat extends SharedContent_1.SharedContent {
     constructor(doc, shouldAcquire, shareSync) {
         super(doc, shouldAcquire, shareSync);
         this._messagesView = new ArrayView_1.ArrayView(this, ['payload', 'messages']);
+        this._participantsView = new ArrayView_1.ArrayView(this, ['payload', 'participants']);
     }
     // ---- ID generation ----
     static makeChatId(userId, chatKey) {
         return shaxpir_common_1.CachingHasher.makeMd5Base62Hash(`${ContentKind_1.ContentKind.CHAT}-${userId}-${chatKey}`);
     }
     // ---- Factory ----
-    static createDefaultPayload() {
-        return {
-            messages: [],
-            scratchpad: {},
-        };
-    }
-    static create(userId, chatKey, payload, createdAt) {
+    static create(userId, chatKey, participants, createdAt) {
         const now = shaxpir_common_1.ClockService.getClock().now();
         createdAt ??= now;
-        payload ??= Chat.createDefaultPayload();
         const chatId = Chat.makeChatId(userId, chatKey);
         return repo_1.ShareSyncFactory.get().createContent({
             meta: {
@@ -38,9 +32,46 @@ class Chat extends Content_1.Content {
                 created_at: createdAt,
                 updated_at: createdAt
             },
-            payload
+            payload: {
+                participants,
+                messages: [],
+                last_read: {},
+                status: 'idle',
+            }
         });
     }
+    // ---- SharedContent implementation ----
+    getAllSharedUserIds() {
+        return this._participantsView.values.map(p => p.user_id);
+    }
+    /**
+     * Override to update manifests for all participants (via SharedContent)
+     * and update workspace chat stubs for each participant.
+     */
+    async modelUpdated() {
+        this.checkDisposed('Chat.modelUpdated');
+        // Update manifests for all participants
+        await super.modelUpdated();
+        // Update workspace stubs for all participants
+        const stub = this.toStub();
+        const userIds = this.getAllSharedUserIds();
+        for (const userId of userIds) {
+            try {
+                const workspaceId = shaxpir_common_1.CachingHasher.makeMd5Base62Hash(userId + "-" + ContentKind_1.ContentKind.WORKSPACE);
+                const workspace = this.shareSync.load(ContentKind_1.ContentKind.WORKSPACE, workspaceId);
+                if (workspace) {
+                    await workspace.acquire();
+                    if (workspace.exists()) {
+                        workspace.upsertChatStub(stub);
+                    }
+                    workspace.release();
+                }
+            }
+            catch {
+                // Workspace may not exist yet for this user
+            }
+        }
+    }
     // ---- Getters ----
     get payload() {
         return this.doc.data.payload;
@@ -49,13 +80,25 @@ class Chat extends Content_1.Content {
         this.checkDisposed('Chat.title');
         return this.payload.title;
     }
+    get participants() {
+        this.checkDisposed('Chat.participants');
+        return this._participantsView;
+    }
     get messages() {
         this.checkDisposed('Chat.messages');
         return this._messagesView;
     }
-    get scratchpad() {
-        this.checkDisposed('Chat.scratchpad');
-        return this.payload.scratchpad;
+    get lastRead() {
+        this.checkDisposed('Chat.lastRead');
+        return this.payload.last_read;
+    }
+    get status() {
+        this.checkDisposed('Chat.status');
+        return this.payload.status;
+    }
+    get error() {
+        this.checkDisposed('Chat.error');
+        return this.payload.error;
     }
     // ---- Setters ----
     setTitle(title) {
@@ -64,24 +107,57 @@ class Chat extends Content_1.Content {
         batch.setPathValue(['payload', 'title'], title);
         batch.commit();
     }
-    setScratchpad(scratchpad) {
-        this.checkDisposed('Chat.setScratchpad');
+    setStatus(status) {
+        this.checkDisposed('Chat.setStatus');
         const batch = new Operation_1.BatchOperation(this);
-        batch.setPathValue(['payload', 'scratchpad'], scratchpad);
+        batch.setPathValue(['payload', 'status'], status);
         batch.commit();
     }
-    updateScratchpadField(key, value) {
-        this.checkDisposed('Chat.updateScratchpadField');
+    setError(error) {
+        this.checkDisposed('Chat.setError');
         const batch = new Operation_1.BatchOperation(this);
-        batch.setPathValue(['payload', 'scratchpad', key], value);
+        batch.setPathValue(['payload', 'status'], 'error');
+        batch.setPathValue(['payload', 'error'], error);
         batch.commit();
     }
-    clearScratchpad() {
-        this.checkDisposed('Chat.clearScratchpad');
+    clearError() {
+        this.checkDisposed('Chat.clearError');
+        const batch = new Operation_1.BatchOperation(this);
+        batch.setPathValue(['payload', 'status'], 'idle');
+        batch.removeValueAtPath(['payload', 'error']);
+        batch.commit();
+    }
+    // ---- Participant operations ----
+    addParticipant(user) {
+        this.checkDisposed('Chat.addParticipant');
+        const exists = this._participantsView.firstIndexWhere(p => p.user_id === user.user_id) >= 0;
+        if (!exists) {
+            this._participantsView.push(user);
+        }
+    }
+    removeParticipant(userId) {
+        this.checkDisposed('Chat.removeParticipant');
+        this._participantsView.removeFirstWhere(p => p.user_id === userId);
+    }
+    // ---- Read tracking ----
+    markRead(userId) {
+        this.checkDisposed('Chat.markRead');
+        const now = shaxpir_common_1.ClockService.getClock().utc();
         const batch = new Operation_1.BatchOperation(this);
-        batch.setPathValue(['payload', 'scratchpad'], {});
+        batch.setPathValue(['payload', 'last_read', userId], now);
         batch.commit();
     }
+    hasUnread(userId) {
+        this.checkDisposed('Chat.hasUnread');
+        const lastRead = this.payload.last_read[userId];
+        if (!lastRead)
+            return this._messagesView.length > 0;
+        const msgs = this._messagesView.values;
+        if (msgs.length === 0)
+            return false;
+        const lastMessageTimestamp = msgs[msgs.length - 1].timestamp;
+        return shaxpir_common_1.Time.isDateTimeAfter(lastMessageTimestamp, lastRead);
+    }
     // ---- Stub generation ----
     toStub() {
         this.checkDisposed('Chat.toStub');
@@ -94,11 +170,18 @@ class Chat extends Content_1.Content {
                 preview = textBlock.text.slice(0, 100);
             }
         }
+        const has_unread = {};
+        for (let i = 0; i < this._participantsView.length; i++) {
+            const participant = this._participantsView.get(i);
+            has_unread[participant.user_id] = this.hasUnread(participant.user_id);
+        }
         return {
             id: this.id,
             title: this.title,
+            participants: this.participants.values,
             last_message_preview: preview,
             updated_at: this.updatedAt.utc_time,
+            has_unread,
         };
     }
     // ---- Message operations ----

package/dist/models/Model.d.ts

@@ -1,7 +1,7 @@
 import { Doc } from '@shaxpir/sharedb/lib/client';
 import { CompactDateTime, DispatchTopic } from '@shaxpir/shaxpir-common';
 import { ShareSync } from '../repo';
-import { ContentId, ContentMeta, ContentRef } from "./Content";
+import { ContentBody, ContentId, ContentRef } from "./Content";
 import { ContentKind } from './ContentKind';
 import { ManifestBody } from './Manifest';
 import { PermissionType } from './Permissions';
@@ -40,6 +40,6 @@ export declare abstract class Model {
     ensureRecentData(minVersion: CompactDateTime): Promise<Model>;
     doesUserHavePermission(userId: ContentId, type: PermissionType): boolean;
     static doesUserHaveManifestPermission(data: ManifestBody, userId: ContentId, type: PermissionType): boolean;
-    static doesUserHaveContentPermission(kind: ContentKind, meta: ContentMeta, userId: ContentId, type: PermissionType): boolean;
+    static doesUserHaveContentPermission(kind: ContentKind, body: ContentBody, userId: ContentId, type: PermissionType): boolean;
     private log;
 }

package/dist/models/Model.js

@@ -269,24 +269,27 @@ class Model {
             return Model.doesUserHaveManifestPermission(this.doc.data, userId, type);
         }
         else {
-            // Content objects and checkpoints all have a PermissionsMeta
-            const meta = this.doc.data.meta;
-            return Model.doesUserHaveContentPermission(this.kind, meta, userId, type);
+            return Model.doesUserHaveContentPermission(this.kind, this.doc.data, userId, type);
         }
     }
     static doesUserHaveManifestPermission(data, userId, type) {
         return data.meta.owner === userId;
     }
-    static doesUserHaveContentPermission(kind, meta, userId, type) {
-        // Users are allowed to read any of their own content, but they are not allowed to write their User, Billing, or Social objects.
-        if (meta.owner === userId) {
+    static doesUserHaveContentPermission(kind, body, userId, type) {
+        // Users are allowed to read any of their own content, but they are not allowed to write their User, Billing, Social, or Chat objects.
+        if (body.meta.owner === userId) {
             if (type === Permissions_1.PermissionType.READ) {
                 return true;
             }
             else if (type === Permissions_1.PermissionType.WRITE) {
-                return kind !== ContentKind_1.ContentKind.USER && kind !== ContentKind_1.ContentKind.BILLING && kind !== ContentKind_1.ContentKind.SOCIAL;
+                return kind !== ContentKind_1.ContentKind.USER && kind !== ContentKind_1.ContentKind.BILLING && kind !== ContentKind_1.ContentKind.SOCIAL && kind !== ContentKind_1.ContentKind.CHAT;
             }
         }
+        // Shared content: participants can read but not write (server-controlled).
+        if (kind === ContentKind_1.ContentKind.CHAT && type === Permissions_1.PermissionType.READ) {
+            const chatPayload = body.payload;
+            return chatPayload.participants.some(p => p.user_id === userId);
+        }
         // If all else fails, deny permission.
         return false;
     }

package/dist/models/SharedContent.d.ts

@@ -0,0 +1,30 @@
+import { Doc } from '@shaxpir/sharedb/lib/client';
+import { ContentId } from './Content';
+import { Content } from './Content';
+import { ShareSync } from '../repo';
+/**
+ * Base class for content models that are shared between multiple users.
+ *
+ * Unlike Content (which updates only the owner's manifest), SharedContent
+ * updates the manifests of all users who have access to the model. This
+ * enables reactive sync for all participants.
+ *
+ * Subclasses must implement getAllSharedUserIds() to identify which users
+ * should receive manifest notifications when the model changes.
+ *
+ * SharedContent models are server-controlled: clients can READ them but
+ * not WRITE them directly. All mutations go through server endpoints.
+ */
+export declare abstract class SharedContent extends Content {
+    constructor(doc: Doc, shouldAcquire: boolean, shareSync: ShareSync);
+    /**
+     * Return the user IDs of all users who should receive manifest
+     * notifications when this model changes.
+     */
+    abstract getAllSharedUserIds(): ContentId[];
+    /**
+     * Override modelUpdated to update manifests for ALL shared users,
+     * not just the owner.
+     */
+    modelUpdated(): Promise<void>;
+}

package/dist/models/SharedContent.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedContent = void 0;
+const ContentKind_1 = require("./ContentKind");
+const Content_1 = require("./Content");
+const Manifest_1 = require("./Manifest");
+/**
+ * Base class for content models that are shared between multiple users.
+ *
+ * Unlike Content (which updates only the owner's manifest), SharedContent
+ * updates the manifests of all users who have access to the model. This
+ * enables reactive sync for all participants.
+ *
+ * Subclasses must implement getAllSharedUserIds() to identify which users
+ * should receive manifest notifications when the model changes.
+ *
+ * SharedContent models are server-controlled: clients can READ them but
+ * not WRITE them directly. All mutations go through server endpoints.
+ */
+class SharedContent extends Content_1.Content {
+    constructor(doc, shouldAcquire, shareSync) {
+        super(doc, shouldAcquire, shareSync);
+    }
+    /**
+     * Override modelUpdated to update manifests for ALL shared users,
+     * not just the owner.
+     */
+    async modelUpdated() {
+        this.checkDisposed("SharedContent.modelUpdated");
+        this.acquire();
+        const userIds = this.getAllSharedUserIds();
+        for (const userId of userIds) {
+            const manifestId = Manifest_1.Manifest.makeManifestId(userId);
+            const manifest = this.shareSync.load(ContentKind_1.ContentKind.MANIFEST, manifestId);
+            if (manifest) {
+                await manifest.acquire();
+                manifest.update(this);
+                manifest.release();
+            }
+        }
+        this.release();
+    }
+}
+exports.SharedContent = SharedContent;

package/dist/models/Workspace.d.ts

@@ -2,7 +2,7 @@ import { Doc } from '@shaxpir/sharedb/lib/client';
 import { CompactDate, CompactDateTime, MultiTime } from "@shaxpir/shaxpir-common";
 import { ShareSync } from '../repo';
 import { ArrayView } from './ArrayView';
-import { ChatStub } from './Chat';
+import { ChatScratchpad, ChatStub } from './Chat';
 import { Content, ContentBody, ContentId, ContentMeta } from "./Content";
 import { Conditions } from './Condition';
 import { Session } from './Session';
@@ -22,6 +22,9 @@ export interface WorkspacePayload {
     global_conditions: Conditions;
     uploaded_avatars: ContentId[];
     default_voice?: VoicePreference;
+    chat_scratchpads: {
+        [chatId: string]: ChatScratchpad;
+    };
 }
 export interface WorkspaceBody extends ContentBody {
     meta: ContentMeta;
@@ -56,6 +59,10 @@ export declare class Workspace extends Content {
      * we update its fields in place to avoid unnecessary churn.
      */
     upsertChatStub(stub: ChatStub): void;
+    getChatScratchpad(chatId: string): ChatScratchpad;
+    updateChatScratchpadText(chatId: string, text: string): void;
+    updateChatScratchpadField(chatId: string, key: string, value: any): void;
+    clearChatScratchpad(chatId: string): void;
     get devices(): ArrayView<ContentId>;
     get uploadedAvatars(): ArrayView<ContentId>;
     acquireSessionForUtcTime(utcTime: CompactDateTime): Promise<Session | null>;

package/dist/models/Workspace.js

@@ -56,6 +56,9 @@ class Workspace extends Content_1.Content {
         if (!Array.isArray(payload.uploaded_avatars)) {
             throw new Error('Workspace.create: payload.uploaded_avatars must be an array');
         }
+        if (!payload.chat_scratchpads || typeof payload.chat_scratchpads !== 'object' || Array.isArray(payload.chat_scratchpads)) {
+            throw new Error('Workspace.create: payload.chat_scratchpads must be an object');
+        }
     }
     static create(userId, payload) {
         Workspace.validatePayload(payload);
@@ -113,6 +116,36 @@ class Workspace extends Content_1.Content {
             this._chatsView.unshift(stub);
         }
     }
+    // ---- Chat scratchpads (per-user draft state, keyed by chat ID) ----
+    // Use empty string '' as the key for the "new chat" scratchpad.
+    getChatScratchpad(chatId) {
+        this.checkDisposed("Workspace.getChatScratchpad");
+        return this.payload.chat_scratchpads?.[chatId] || {};
+    }
+    updateChatScratchpadText(chatId, text) {
+        this.checkDisposed("Workspace.updateChatScratchpadText");
+        const batch = new Operation_1.BatchOperation(this);
+        batch.editPathText(['payload', 'chat_scratchpads', chatId, 'text'], text);
+        batch.commit();
+    }
+    updateChatScratchpadField(chatId, key, value) {
+        this.checkDisposed("Workspace.updateChatScratchpadField");
+        const batch = new Operation_1.BatchOperation(this);
+        batch.setPathValue(['payload', 'chat_scratchpads', chatId, key], value);
+        batch.commit();
+    }
+    clearChatScratchpad(chatId) {
+        this.checkDisposed("Workspace.clearChatScratchpad");
+        const path = ['payload', 'chat_scratchpads', chatId];
+        const current = this.payload.chat_scratchpads?.[chatId];
+        if (!current)
+            return;
+        const batch = new Operation_1.BatchOperation(this);
+        for (const key of Object.keys(current)) {
+            batch.removeValueAtPath([...path, key]);
+        }
+        batch.commit();
+    }
     // NOTE: As the user adds devices, we will always add new devices to the end of the array.
     // So the most-recently-added device will always be at the end.
     get devices() {

package/dist/models/index.d.ts

@@ -26,6 +26,7 @@ export * from './RecordType';
 export * from './Review';
 export * from './SearchState';
 export * from './Session';
+export * from './SharedContent';
 export * from './SkillLevel';
 export * from './Social';
 export * from './Streaks';

package/dist/models/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./RecordType"), exports);
 __exportStar(require("./Review"), exports);
 __exportStar(require("./SearchState"), exports);
 __exportStar(require("./Session"), exports);
+__exportStar(require("./SharedContent"), exports);
 __exportStar(require("./SkillLevel"), exports);
 __exportStar(require("./Social"), exports);
 __exportStar(require("./Streaks"), exports);

package/dist/repo/ShareSync.js

@@ -42,6 +42,7 @@ const shaxpir_common_1 = require("@shaxpir/shaxpir-common");
 const reconnecting_websocket_1 = __importDefault(require("reconnecting-websocket"));
 const models_1 = require("../models");
 const Billing_1 = require("../models/Billing");
+const Chat_1 = require("../models/Chat");
 const Collection_1 = require("../models/Collection");
 const Content_1 = require("../models/Content");
 const ContentKind_1 = require("../models/ContentKind");
@@ -478,6 +479,9 @@ class ShareSync {
         if (kind === ContentKind_1.ContentKind.BILLING) {
             return new Billing_1.Billing(doc, shouldAcquire, shareSync);
         }
+        else if (kind === ContentKind_1.ContentKind.CHAT) {
+            return new Chat_1.Chat(doc, shouldAcquire, shareSync);
+        }
         else if (kind === ContentKind_1.ContentKind.COLLECTION) {
             return new Collection_1.Collection(doc, shouldAcquire, shareSync);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaxpir/duiduidui-models",
-  "version": "1.20.1",
+  "version": "1.24.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/shaxpir/duiduidui-models"