@jsm-mit/chat-motoko-package 0.1.0 → 0.3.0

package/README.md

@@ -5,23 +5,32 @@ multi-project, multi-party chat on the Internet Computer — plus the integratio
 that prove it.
 
 ```ts
-import { ChatsActor, MessagesActor, ChatPoller } from "@jsm-mit/chat-motoko-package";
+import { RoomsActor, ChatsActor, MessagesActor, ChatPoller } from "@jsm-mit/chat-motoko-package";
 
-const chats = new ChatsActor(canisterId, identity);
-const chat = await chats.createChatAsyncUnsafe({ projectId: "sultana-dev", subject: salonId, firstMessage: "cześć" });
+// A canister admin creates the project with its accounts canister — the one asked
+// `isUser(principal)` before a non-admin opens a chat (Sultana: sultana-core-motoko).
+// A project admin defines a room: who receives the customer's messages.
+await new RoomsActor(canisterId, adminIdentity).createRoomAsyncUnsafe({
+    projectId: "sultana-stage", id: "assistant", name: "Asystent",
+    recipients: [{ principal: villagePrincipal, role: "agent", displayName: "Asystentka Ola" }],
+});
+
+// A customer opens the room — the same call returns the same chat next time.
+const chat = await new ChatsActor(canisterId, identity).openChatAsyncUnsafe({ projectId: "sultana-stage", roomId: "assistant", customerName: "Michał" });
 
 const messages = new MessagesActor(canisterId, identity);
 await messages.postAsyncUnsafe({ chatId: chat.id, text: "dodaj usługę strzyżenie" });
 const page = await messages.getMessagesAsyncUnsafe({ chatId: chat.id, sinceSeq: 0 });
 
-// An agent host: every new message in every chat this identity belongs to.
+// An agent host: every new message in every chat this identity is a recipient of, with
+// the room and the customer on each message — route by (projectId, roomId).
 const poller = new ChatPoller(messages, 1000, { onError: console.error });
-poller.messages$.subscribe((m) => console.log(m.chatId, m.kind, m.text));
+poller.messages$.subscribe((m) => console.log(m.roomId, m.customer, m.kind, m.text));
 poller.run();
 ```
 
-One class per canister controller (`AdminActor`, `ProjectsActor`, `ChatsActor`,
-`MessagesActor`), every method `…AsyncUnsafe` (throws one of `CanisterError`,
+One class per canister controller (`AdminActor`, `ProjectsActor`, `RoomsActor`,
+`ChatsActor`, `MessagesActor`), every method `…AsyncUnsafe` (throws one of `CanisterError`,
 `CriticalCanisterError`, `CallRefusedAtInspectionStage`) or `…AsyncSafe` (never
 throws). Views translate `Principal` → text, `opt` → optional, variants → string
 unions; sequence numbers are plain `number`s, timestamps `bigint` nanoseconds.
@@ -29,8 +38,11 @@ unions; sequence numbers are plain `number`s, timestamps `bigint` nanoseconds.
 `src/` is browser-safe — the same package serves the agent host and a web panel.
 
 Scripts: `build`, `typecheck`, `sync-declarations`, `test-suite`,
-`test-access-restrictions`, `sandbox` (an interactive admin/chat console:
-`npm run sandbox -- <canister-id>`). See `CLAUDE.md` for who runs what.
+`test-access-restrictions`, `user1` / `user2` (an interactive admin/chat console, one
+person per terminal: the key comes from `USER1_PEM` / `USER2_PEM` in `.env`; another
+canister: `npm run user2 -- <canister-id>`), `redeploy` (build `../chat-motoko` and install it
+on `CANISTER_ID` without tests; `npm run redeploy -- reinstall` or `-- upgrade`; after a
+reinstall claim the admin role yourself in the sandbox). See `CLAUDE.md` for who runs what.
 
 ## Publishing
 

package/declarations/chat-motoko-backend/chat-motoko-backend.did

@@ -1,110 +1,130 @@
+type UpdateRoomArgs = 
+ record {
+   name: opt text;
+   projectId: ProjectId;
+   recipients: opt vec Recipient;
+   roomId: RoomId;
+ };
 type UpdateProjectArgs = 
  record {
+   accountsCanister: opt principal;
    admins: opt vec principal;
-   agents: opt vec principal;
-   agentsMayInvite: opt bool;
-   defaultPolicy: opt Policy;
    projectId: ProjectId;
  };
-type SystemEvent = 
- variant {
-   chatClosed;
-   chatCreated;
-   memberInvited: record {
-                    by: principal;
-                    "principal": principal;
-                    role: Role;
-                  };
-   memberJoined: record {
-                   "principal": principal;
-                   role: Role;
-                 };
-   memberLeft: record {"principal": principal;};
-   memberRemoved: record {
-                    by: principal;
-                    "principal": principal;
-                  };
-   policyChanged: Policy;
- };
-type SetPolicyArgs = 
+type SystemEvent = variant {chatCreated;};
+type SetQuotaLimitsArgs = record {limits: QuotaLimits;};
+type SetLoggingEnabledArgs = record {enabled: bool;};
+type RoomId = text;
+type Room = 
  record {
-   chatId: ChatId;
-   policy: Policy;
+   createdAt: int;
+   createdBy: principal;
+   id: RoomId;
+   name: text;
+   projectId: ProjectId;
+   recipients: vec Recipient;
  };
-type SetLoggingEnabledArgs = record {enabled: bool;};
 type Role = 
  variant {
-   admin;
    agent;
-   member;
-   owner;
+   customer;
+   worker;
  };
 type Result_9 = 
  variant {
    err: Error;
-   ok: vec principal;
+   ok: vec Project;
  };
 type Result_8 = 
  variant {
    err: Error;
-   ok: MessagesPage;
+   ok: vec Room;
  };
 type Result_7 = 
  variant {
    err: Error;
-   ok: vec Chat;
+   ok: Chat;
  };
 type Result_6 = 
  variant {
    err: Error;
-   ok: vec Project;
+   ok: PollResult;
  };
 type Result_5 = 
  variant {
    err: Error;
-   ok: PollResult;
+   ok: Message;
  };
 type Result_4 = 
  variant {
    err: Error;
-   ok: Message;
+   ok: principal;
  };
 type Result_3 = 
  variant {
    err: Error;
-   ok: principal;
+   ok: bool;
  };
 type Result_2 = 
  variant {
    err: Error;
-   ok: bool;
+   ok: QuotaLimits;
+ };
+type Result_13 = 
+ variant {
+   err: Error;
+   ok: vec principal;
+ };
+type Result_12 = 
+ variant {
+   err: Error;
+   ok: MessagesPage;
+ };
+type Result_11 = 
+ variant {
+   err: Error;
+   ok: vec Chat;
+ };
+type Result_10 = 
+ variant {
+   err: Error;
+   ok: vec ChatSummary;
  };
 type Result_1 = 
  variant {
    err: Error;
-   ok: Chat;
+   ok: Project;
  };
 type Result = 
  variant {
    err: Error;
-   ok: Project;
+   ok: Room;
+ };
+type RemoveAdminArgs = record {"principal": principal;};
+type RecipientRole = 
+ variant {
+   agent;
+   worker;
  };
-type RemoveMemberArgs = 
+type Recipient = 
  record {
-   chatId: ChatId;
+   displayName: text;
    "principal": principal;
+   role: RecipientRole;
+ };
+type QuotaLimits = 
+ record {
+   chats: nat;
+   posts: nat;
  };
-type RemoveAdminArgs = record {"principal": principal;};
 type PurgeChatArgs = record {chatId: ChatId;};
 type ProjectId = text;
 type Project = 
  record {
+   accountsCanister: principal;
    admins: vec principal;
-   agents: vec principal;
-   agentsMayInvite: bool;
    createdAt: int;
    createdBy: principal;
-   defaultPolicy: Policy;
    id: ProjectId;
  };
 type PostKind = 
@@ -129,7 +149,21 @@ type PollNewMessagesArgs =
    limit: opt nat;
    sinceGlobalSeq: nat;
  };
-type Policy = record {agentsReply: bool;};
+type Participant = 
+ record {
+   displayName: text;
+   firstPostSeq: opt nat;
+   joinedAt: int;
+   lastReadSeq: nat;
+   "principal": principal;
+   role: Role;
+ };
+type OpenChatArgs = 
+ record {
+   customerName: opt text;
+   projectId: ProjectId;
+   roomId: RoomId;
+ };
 type MessagesPage = 
  record {
    lastSeq: nat;
@@ -146,44 +180,42 @@ type Message =
    author: principal;
    chatId: ChatId;
    createdAt: int;
+   customer: principal;
    globalSeq: nat;
    kind: MessageKind;
    projectId: ProjectId;
+   roomId: RoomId;
    seq: nat;
    "text": text;
  };
-type MemberInput = 
- record {
-   "principal": principal;
-   role: Role;
- };
-type Member = 
- record {
-   joinedAt: int;
-   lastReadSeq: nat;
-   "principal": principal;
-   role: Role;
- };
 type MarkReadArgs = 
  record {
    chatId: ChatId;
    seq: nat;
  };
+type ListRoomsArgs = 
+ record {
+   limit: opt nat;
+   projectId: ProjectId;
+ };
 type ListProjectsArgs = record {limit: opt nat;};
-type LeaveChatArgs = record {chatId: ChatId;};
-type InviteMemberArgs = 
+type ListProjectChatsArgs = 
  record {
-   chatId: ChatId;
-   "principal": principal;
-   role: Role;
+   limit: opt nat;
+   projectId: ProjectId;
+   roomId: opt RoomId;
+ };
+type GetRoomArgs = 
+ record {
+   projectId: ProjectId;
+   roomId: RoomId;
  };
 type GetProjectArgs = record {projectId: ProjectId;};
 type GetMyChatsArgs = 
  record {
-   includeClosed: bool;
    limit: opt nat;
    projectId: ProjectId;
-   subject: opt text;
+   roomId: opt RoomId;
  };
 type GetMessagesArgs = 
  record {
@@ -207,69 +239,69 @@ type Error =
    details: ErrorDetails;
    logsJson: text;
  };
+type CreateRoomArgs = 
+ record {
+   id: RoomId;
+   name: text;
+   projectId: ProjectId;
+   recipients: vec Recipient;
+ };
 type CreateProjectArgs = 
  record {
+   accountsCanister: principal;
    admins: vec principal;
-   agents: vec principal;
-   agentsMayInvite: bool;
-   defaultPolicy: Policy;
    id: ProjectId;
  };
-type CreateChatArgs = 
+type ChatSummary = 
  record {
-   firstMessage: opt text;
-   members: vec MemberInput;
-   policy: opt Policy;
+   createdAt: int;
+   customer: principal;
+   id: ChatId;
+   lastMessageAt: int;
+   messageCount: nat;
+   participantCount: nat;
    projectId: ProjectId;
-   subject: opt text;
-   title: opt text;
- };
-type CloseChatArgs = record {chatId: ChatId;};
-type ChatStatus = 
- variant {
-   closed;
-   open;
+   roomId: RoomId;
  };
 type ChatId = text;
 type Chat = 
  record {
    createdAt: int;
-   createdBy: principal;
+   customer: principal;
    id: ChatId;
    lastMessageAt: int;
    lastSeq: nat;
-   members: vec Member;
-   policy: Policy;
+   participants: vec Participant;
    projectId: ProjectId;
-   status: ChatStatus;
-   subject: opt text;
-   title: opt text;
+   roomId: RoomId;
  };
 type AddAdminArgs = record {"principal": principal;};
 service : {
-  addAdmin: (args: AddAdminArgs) -> (Result_2);
+  addAdmin: (args: AddAdminArgs) -> (Result_3);
   clearLogs: () -> ();
-  closeChat: (args: CloseChatArgs) -> (Result_1);
-  createChat: (args: CreateChatArgs) -> (Result_1);
-  createProject: (args: CreateProjectArgs) -> (Result);
-  getAdmins: () -> (Result_9) query;
-  getChat: (args: GetChatArgs) -> (Result_1) query;
+  createProject: (args: CreateProjectArgs) -> (Result_1);
+  createRoom: (args: CreateRoomArgs) -> (Result);
+  getAdmins: () -> (Result_13) query;
+  getChat: (args: GetChatArgs) -> (Result_7) query;
   getLogs: () -> (text) query;
-  getMessages: (args: GetMessagesArgs) -> (Result_8) query;
-  getMyChats: (args: GetMyChatsArgs) -> (Result_7) query;
-  getProject: (args: GetProjectArgs) -> (Result) query;
-  inviteMember: (args: InviteMemberArgs) -> (Result_1);
-  leaveChat: (args: LeaveChatArgs) -> (Result_2);
-  listProjects: (args: ListProjectsArgs) -> (Result_6) query;
-  markRead: (args: MarkReadArgs) -> (Result_2);
-  pollNewMessages: (args: PollNewMessagesArgs) -> (Result_5) query;
-  post: (args: PostArgs) -> (Result_4);
-  purgeChat: (args: PurgeChatArgs) -> (Result_2);
-  registerAsAdmin: () -> (Result_3);
-  removeAdmin: (args: RemoveAdminArgs) -> (Result_2);
-  removeMember: (args: RemoveMemberArgs) -> (Result_1);
-  setLoggingEnabled: (args: SetLoggingEnabledArgs) -> (Result_2);
-  setPolicy: (args: SetPolicyArgs) -> (Result_1);
-  updateProject: (args: UpdateProjectArgs) -> (Result);
+  getMessages: (args: GetMessagesArgs) -> (Result_12) query;
+  getMyChats: (args: GetMyChatsArgs) -> (Result_11) query;
+  getProject: (args: GetProjectArgs) -> (Result_1) query;
+  getQuotaLimits: () -> (Result_2) query;
+  getRoom: (args: GetRoomArgs) -> (Result) query;
+  listProjectChats: (args: ListProjectChatsArgs) -> (Result_10) query;
+  listProjects: (args: ListProjectsArgs) -> (Result_9) query;
+  listRooms: (args: ListRoomsArgs) -> (Result_8) query;
+  markRead: (args: MarkReadArgs) -> (Result_3);
+  openChat: (args: OpenChatArgs) -> (Result_7);
+  pollNewMessages: (args: PollNewMessagesArgs) -> (Result_6) query;
+  post: (args: PostArgs) -> (Result_5);
+  purgeChat: (args: PurgeChatArgs) -> (Result_3);
+  registerAsAdmin: () -> (Result_4);
+  removeAdmin: (args: RemoveAdminArgs) -> (Result_3);
+  setLoggingEnabled: (args: SetLoggingEnabledArgs) -> (Result_3);
+  setQuotaLimits: (args: SetQuotaLimitsArgs) -> (Result_2);
+  updateProject: (args: UpdateProjectArgs) -> (Result_1);
+  updateRoom: (args: UpdateRoomArgs) -> (Result);
   whoAmI: () -> (principal) query;
 }