@parall/sdk 1.12.0

package/src/constants.ts

@@ -0,0 +1,265 @@
+// API base path
+export const API_BASE = '/api/v1';
+
+// Wiki-service base path (served by wiki-service, routed via LB path rules)
+export const WIKI_BASE = '/wiki/v1';
+
+// REST endpoints
+export const ENDPOINTS = {
+  // Auth
+  AUTH_REGISTER: `${API_BASE}/auth/register`,
+  AUTH_LOGIN: `${API_BASE}/auth/login`,
+  AUTH_REFRESH: `${API_BASE}/auth/refresh`,
+  AUTH_LOGOUT: `${API_BASE}/auth/logout`,
+  AUTH_CHECK_EMAIL: `${API_BASE}/auth/check-email`,
+  AUTH_VERIFY_EMAIL: `${API_BASE}/auth/verify-email`,
+  AUTH_RESEND_CODE: `${API_BASE}/auth/resend-code`,
+
+  // Users
+  USERS_ME: `${API_BASE}/users/me`,
+  USER: (id: string) => `${API_BASE}/users/${id}`,
+
+  // WebSocket ticket
+  WS_TICKET: `${API_BASE}/ws/ticket`,
+
+  // Organizations (global)
+  ORGS: `${API_BASE}/orgs`,
+  // Org-scoped
+  ORG: (orgId: string) => `${API_BASE}/orgs/${orgId}`,
+  ORG_MEMBERS: (orgId: string) => `${API_BASE}/orgs/${orgId}/members`,
+  ORG_MEMBERS_ONLINE: (orgId: string) => `${API_BASE}/orgs/${orgId}/members/online`,
+  ORG_MEMBER: (orgId: string, userId: string) =>
+    `${API_BASE}/orgs/${orgId}/members/${userId}`,
+
+  // Direct messages (org-scoped, atomic find-or-create + send)
+  DM: (orgId: string) => `${API_BASE}/orgs/${orgId}/dm`,
+
+  // Chats (org-scoped)
+  CHATS: (orgId: string) => `${API_BASE}/orgs/${orgId}/chats`,
+  CHAT: (orgId: string, chatId: string) => `${API_BASE}/orgs/${orgId}/chats/${chatId}`,
+  CHAT_MEMBERS: (orgId: string, chatId: string) =>
+    `${API_BASE}/orgs/${orgId}/chats/${chatId}/members`,
+  CHAT_MEMBER: (orgId: string, chatId: string, userId: string) =>
+    `${API_BASE}/orgs/${orgId}/chats/${chatId}/members/${userId}`,
+  CHAT_MESSAGES: (orgId: string, chatId: string) =>
+    `${API_BASE}/orgs/${orgId}/chats/${chatId}/messages`,
+
+  // Messages (global, by message ID)
+  MESSAGE: (id: string) => `${API_BASE}/messages/${id}`,
+  MESSAGE_PATCHES: (id: string) => `${API_BASE}/messages/${id}/patches`,
+  MESSAGE_REPLIES: (id: string) => `${API_BASE}/messages/${id}/replies`,
+
+  // Upload (org-scoped)
+  UPLOAD_PRESIGN: (orgId: string) => `${API_BASE}/orgs/${orgId}/upload/presign`,
+  UPLOAD_COMPLETE: (orgId: string) => `${API_BASE}/orgs/${orgId}/upload/complete`,
+  FILE: (id: string) => `${API_BASE}/files/${id}`,
+
+  // Approvals (global)
+  APPROVAL_DECIDE: (id: string) => `${API_BASE}/approvals/${id}/decide`,
+  APPROVALS_PENDING: `${API_BASE}/approvals/pending`,
+
+  // Agents (org-scoped)
+  AGENTS: (orgId: string) => `${API_BASE}/orgs/${orgId}/agents`,
+  AGENT: (orgId: string, agentId: string) => `${API_BASE}/orgs/${orgId}/agents/${agentId}`,
+  AGENT_API_KEYS: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/api-keys`,
+  AGENT_API_KEY: (orgId: string, agentId: string, key: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/api-keys/${key}`,
+  AGENT_ACTIVITY: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/activity`,
+  AGENT_MONITOR: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/monitor`,
+  AGENT_ME: (orgId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/me`,
+  AGENT_SESSIONS: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/sessions`,
+  AGENT_SESSION: (orgId: string, agentId: string, sessionId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/sessions/${sessionId}`,
+  AGENT_SESSION_STEPS: (orgId: string, agentId: string, sessionId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/sessions/${sessionId}/steps`,
+  AGENT_TASKS: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/tasks`,
+  // Machines (org-scoped)
+  MACHINES: (orgId: string) => `${API_BASE}/orgs/${orgId}/machines`,
+  MACHINE: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}`,
+  MACHINE_START: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/start`,
+  MACHINE_STOP: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/stop`,
+  MACHINE_STATUS: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/status`,
+  MACHINE_LOGS: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/logs`,
+  MACHINE_RESTART: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/restart`,
+  MACHINE_RESTART_ALL: (orgId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/restart-all`,
+  MACHINE_WORKSPACE: (orgId: string, machineId: string) =>
+    `${API_BASE}/orgs/${orgId}/machines/${machineId}/workspace`,
+  // Tasks (org-scoped)
+  TASKS: (orgId: string) => `${API_BASE}/orgs/${orgId}/tasks`,
+  TASK: (orgId: string, taskId: string) => `${API_BASE}/orgs/${orgId}/tasks/${taskId}`,
+  TASK_SUBTASKS: (orgId: string, taskId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/subtasks`,
+  TASK_RELATIONS: (orgId: string, taskId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/relations`,
+  TASK_RELATION: (orgId: string, taskId: string, relId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/relations/${relId}`,
+  TASK_COMMENTS: (orgId: string, taskId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/comments`,
+  TASK_COMMENT: (orgId: string, taskId: string, commentId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/comments/${commentId}`,
+  TASK_ACTIVITIES: (orgId: string, taskId: string) =>
+    `${API_BASE}/orgs/${orgId}/tasks/${taskId}/activities`,
+
+  // Projects (org-scoped)
+  PROJECTS: (orgId: string) => `${API_BASE}/orgs/${orgId}/projects`,
+  PROJECT: (orgId: string, projectId: string) => `${API_BASE}/orgs/${orgId}/projects/${projectId}`,
+
+  // Invitations (org-scoped, admin)
+  ORG_INVITATIONS: (orgId: string) => `${API_BASE}/orgs/${orgId}/invitations`,
+  ORG_INVITATION: (orgId: string, invId: string) =>
+    `${API_BASE}/orgs/${orgId}/invitations/${invId}`,
+  ORG_INVITATION_RESEND: (orgId: string, invId: string) =>
+    `${API_BASE}/orgs/${orgId}/invitations/${invId}/resend`,
+
+  // Invitations (invitee)
+  MY_INVITATIONS: `${API_BASE}/invitations/pending`,
+  INVITATION_ACCEPT: (id: string) => `${API_BASE}/invitations/${id}/accept`,
+  INVITATION_DECLINE: (id: string) => `${API_BASE}/invitations/${id}/decline`,
+  INVITATION_BY_TOKEN: (token: string) => `${API_BASE}/invitations/by-token/${token}`,
+
+  // Wikis (org-scoped, served by wiki-service)
+  WIKIS: (orgId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis`,
+  WIKI: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}`,
+  WIKI_TREE: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/tree`,
+  WIKI_BLOB: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/blob`,
+  WIKI_NODE_SECTIONS: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/node-sections`,
+  WIKI_SEARCH: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/search`,
+  WIKI_PAGE_INDEX: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/page-index`,
+  WIKI_REFS: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/refs`,
+  WIKI_REFS_CHECK: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/refs/check`,
+  WIKI_CHANGESETS: (orgId: string, wikiId: string) => `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/changesets`,
+  WIKI_CHANGESET: (orgId: string, wikiId: string, changesetId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/changesets/${changesetId}`,
+  WIKI_CHANGESET_DIFF: (orgId: string, wikiId: string, changesetId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/changesets/${changesetId}/diff`,
+  WIKI_CHANGESET_MERGE: (orgId: string, wikiId: string, changesetId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/changesets/${changesetId}/merge`,
+  WIKI_CHANGESET_CLOSE: (orgId: string, wikiId: string, changesetId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/changesets/${changesetId}/close`,
+
+  // Wiki Path Scopes (AFCS ACL)
+  WIKI_PATH_SCOPES: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/path-scopes`,
+  WIKI_PATH_SCOPE: (orgId: string, wikiId: string, scopeId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/path-scopes/${scopeId}`,
+  WIKI_ACCESS_STATUS: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/access-status`,
+  WIKI_ACCESS_REQUESTS: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/access-requests`,
+
+  // Wiki History (commits, file commits, blame)
+  WIKI_COMMITS: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/commits`,
+  WIKI_FILE_COMMITS: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/file-commits`,
+  WIKI_BLAME: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/blame`,
+
+  // Wiki Operations (audit log)
+  WIKI_OPERATIONS: (orgId: string, wikiId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/operations`,
+  WIKI_OPERATION_REVERT: (orgId: string, wikiId: string, opId: string) =>
+    `${WIKI_BASE}/orgs/${orgId}/wikis/${wikiId}/operations/${opId}/revert`,
+
+  // Inbox (org-scoped)
+  INBOX: (orgId: string) => `${API_BASE}/orgs/${orgId}/inbox`,
+  INBOX_UNREAD_COUNT: (orgId: string) => `${API_BASE}/orgs/${orgId}/inbox/unread-count`,
+  INBOX_ITEM_READ: (orgId: string, id: string) => `${API_BASE}/orgs/${orgId}/inbox/${id}/read`,
+  INBOX_ITEM_ARCHIVE: (orgId: string, id: string) => `${API_BASE}/orgs/${orgId}/inbox/${id}/archive`,
+  // Snooze/Unsnooze deferred until un-snooze cron worker is implemented
+  INBOX_MARK_ALL_READ: (orgId: string) => `${API_BASE}/orgs/${orgId}/inbox/mark-all-read`,
+  INBOX_ARCHIVE_ALL: (orgId: string) => `${API_BASE}/orgs/${orgId}/inbox/archive-all`,
+  INBOX_ITEM: (orgId: string, id: string) => `${API_BASE}/orgs/${orgId}/inbox/${id}`,
+  INBOX_ACK: (orgId: string) => `${API_BASE}/orgs/${orgId}/inbox/ack`,
+
+  // Dispatch (agent event delivery)
+  DISPATCH: (orgId: string) => `${API_BASE}/orgs/${orgId}/dispatch`,
+  DISPATCH_PENDING_COUNT: (orgId: string) => `${API_BASE}/orgs/${orgId}/dispatch/pending-count`,
+  DISPATCH_ACK: (orgId: string) => `${API_BASE}/orgs/${orgId}/dispatch/ack`,
+  DISPATCH_ACK_BY_ID: (orgId: string, id: string) => `${API_BASE}/orgs/${orgId}/dispatch/${id}/ack`,
+
+  // Unread
+  UNREAD: `${API_BASE}/me/unread`,
+  CHAT_READ: (orgId: string, chatId: string) =>
+    `${API_BASE}/orgs/${orgId}/chats/${chatId}/read`,
+
+  // References (org-scoped)
+  REFS_RESOLVE: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/resolve`,
+  REFS_BACKLINKS: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/backlinks`,
+  REFS_CHECK: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/check`,
+
+  // Platform config (agent-scoped, not org-scoped)
+  PLATFORM_CONFIG: `${API_BASE}/agents/platform-config`,
+
+  // Push notifications
+  PUSH_SUBSCRIBE: `${API_BASE}/push/subscribe`,
+  PUSH_UNSUBSCRIBE: `${API_BASE}/push/unsubscribe`,
+  PUSH_VAPID_KEY: `${API_BASE}/push/vapid-key`,
+
+  // Notification preferences
+  NOTIFICATION_PREFERENCES: `${API_BASE}/notification-preferences`,
+
+} as const;
+
+// WebSocket event types
+export const WS_EVENTS = {
+  // Client -> Server
+  PING: 'ping',
+  TYPING: 'typing',
+  WATCH: 'watch',
+  AGENT_HEARTBEAT: 'agent.heartbeat',
+
+  // Server -> Client
+  HELLO: 'hello',
+  PONG: 'pong',
+  WATCHING: 'watching',
+  MESSAGE_NEW: 'message.new',
+  MESSAGE_PATCH: 'message.patch',
+  MESSAGE_EDIT: 'message.edit',
+  MESSAGE_DELETE: 'message.delete',
+  TYPING_UPDATE: 'typing.update',
+  CHAT_UPDATE: 'chat.update',
+  CHAT_DELETED: 'chat.deleted',
+  APPROVAL_UPDATE: 'approval.update', // deprecated
+  CARD_UPDATE: 'card.update',
+  RECOVERY_OVERFLOW: 'recovery.overflow',
+  MEMBERSHIP_CHANGED: 'membership.changed',
+  TASK_CREATED: 'task.created',
+  TASK_UPDATED: 'task.updated',
+  TASK_DELETED: 'task.deleted',
+  TASK_COMMENT_CREATED: 'task.comment.created',
+  TASK_COMMENT_UPDATED: 'task.comment.updated',
+  TASK_COMMENT_DELETED: 'task.comment.deleted',
+  PROJECT_CREATED: 'project.created',
+  PROJECT_UPDATED: 'project.updated',
+  PROJECT_DELETED: 'project.deleted',
+  AGENT_SESSION_NEW: 'agent_session.new',
+  AGENT_SESSION_UPDATE: 'agent_session.update',
+  AGENT_STEP_NEW: 'agent_step.new',
+  INVITATION_NEW: 'invitation.new',
+  INVITATION_ACCEPTED: 'invitation.accepted',
+  INVITATION_DECLINED: 'invitation.declined',
+  AGENT_CONFIG_UPDATE: 'agent_config.update',
+  PRESENCE_UPDATE: 'presence.update',
+  WIKI_CHANGESET_CREATED: 'wiki.changeset.created',
+  WIKI_CHANGESET_UPDATED: 'wiki.changeset.updated',
+  NOTIFICATION_ALERT: 'notification.alert',
+  INBOX_NEW: 'inbox.new',
+  INBOX_UPDATE: 'inbox.update',
+  INBOX_BULK_UPDATE: 'inbox.bulk_update',
+  READ_POSITION_UPDATED: 'read_position.updated',
+  DISPATCH_NEW: 'dispatch.new',
+} as const;

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './types.js';
+export * from './constants.js';
+export { ParallClient, ApiError } from './client.js';
+export type { ParallClientOptions } from './client.js';
+export { ParallWs } from './ws.js';
+export type { ParallWsOptions, WsConnectionState, WsEventType, WsEventHandler, WsClientEventMap } from './ws.js';