@parall/sdk 1.48.0 → 1.50.0

package/src/client.ts

@@ -23,6 +23,10 @@ import type {
   Organization,
   OrgMember,
   OrgMemberRole,
+  MemberProfile,
+  UpdateMemberProfileRequest,
+  AgentInstructions,
+  UpdateAgentInstructionsRequest,
   Team,
   Chat,
   ChatMember,
@@ -167,6 +171,8 @@ import type {
   DispatchExpireResult,
   ResolveRefsResponse,
   BacklinksResponse,
+  OutboundRefsRequest,
+  OutboundRefsResponse,
   RefGraphResponse,
   BrokenRefsResponse,
   PushSubscribeRequest,
@@ -223,14 +229,23 @@ import type {
   BrowserProfileLifecycleRequest,
   BrowserViewerCommandRequest,
   BrowserViewerCommandResponse,
+  EdgeViewerCommandRequest,
+  EdgeViewerCommandResponse,
   GrantBrowserProfileConsentRequest,
   EdgeDevice,
   EdgePlacement,
   EdgeBrowserProfile,
+  EdgeProfileProxyStatus,
+  SetEdgeProfileProxyRequest,
   ClipConnection,
   EdgeOnboardingStatus,
   ExecEdgeClipRequest,
   EdgeClipExecResult,
+  ReactionSummary,
+  ToggleReactionResponse,
+  DeployTemplateRequest,
+  Template,
+  TemplateDeploymentReport,
 } from './types.js';
 
 export interface ParallClientOptions {
@@ -421,6 +436,8 @@ export class ParallClient {
       timeoutMs?: number;
       signal?: AbortSignal;
       keepalive?: boolean;
+      /** Additional request preconditions such as If-Match. */
+      headers?: Record<string, string>;
       /** Observes the final HTTP status of a successful request (e.g. 200-idempotent-replay vs 201-created). */
       onStatus?: (status: number) => void;
     },
@@ -443,7 +460,7 @@ export class ParallClient {
       if (qs) url += `?${qs}`;
     }
 
-    const headers = this.buildHeaders(path);
+    const headers = this.buildHeaders(path, opts?.headers);
 
     // Cancellation: the caller's AbortSignal (e.g. a superseded search query)
     // races the per-request timeout. AbortSignal.any aborts as soon as either
@@ -743,6 +760,42 @@ export class ParallClient {
     return this.request('PATCH', ENDPOINTS.ORG_MEMBER(orgId, userId), { role });
   }
 
+  /** Org-scoped public profile (title / description) of any active member. */
+  async getMemberProfile(orgId: string, userId: string): Promise<MemberProfile> {
+    return this.request('GET', ENDPOINTS.ORG_MEMBER_PROFILE(orgId, userId));
+  }
+
+  /**
+   * CAS full-replacement of a member's public profile. Humans edit their
+   * own; Human org admins/owners edit agents'. A stale expected_version
+   * gets 409 PROFILE_VERSION_CONFLICT with error.details.current_version.
+   */
+  async updateMemberProfile(
+    orgId: string,
+    userId: string,
+    req: UpdateMemberProfileRequest,
+  ): Promise<MemberProfile> {
+    return this.request('PATCH', ENDPOINTS.ORG_MEMBER_PROFILE(orgId, userId), req);
+  }
+
+  /** Private agent Instructions — agent self or Human org admin/owner only. */
+  async getAgentInstructions(orgId: string, agentId: string): Promise<AgentInstructions> {
+    return this.request('GET', ENDPOINTS.AGENT_INSTRUCTIONS(orgId, agentId));
+  }
+
+  /**
+   * CAS update of the private Instructions (Human org admin/owner only).
+   * A stale expected_version gets 409 INSTRUCTIONS_VERSION_CONFLICT with
+   * error.details.current_version.
+   */
+  async updateAgentInstructions(
+    orgId: string,
+    agentId: string,
+    req: UpdateAgentInstructionsRequest,
+  ): Promise<AgentInstructions> {
+    return this.request('PATCH', ENDPOINTS.AGENT_INSTRUCTIONS(orgId, agentId), req);
+  }
+
   // Member activity surfaces — chats the member participates in within this org,
   // ordered by most recent activity. Powers the member profile Activity tab.
   async getMemberChats(
@@ -1095,6 +1148,20 @@ export class ParallClient {
     return this.request('GET', ENDPOINTS.MESSAGE_REPLIES(id), undefined, params);
   }
 
+  // ---- Reactions ----
+
+  async toggleReaction(messageId: string, emoji: string): Promise<ToggleReactionResponse> {
+    return this.request('PUT', ENDPOINTS.MESSAGE_REACTION(messageId, emoji));
+  }
+
+  async listReactions(messageId: string): Promise<ReactionSummary[]> {
+    const res = await this.request<{ reactions: ReactionSummary[] }>(
+      'GET',
+      ENDPOINTS.MESSAGE_REACTIONS(messageId),
+    );
+    return res.reactions;
+  }
+
   // ---- File Upload ----
 
   async getUploadPresignUrl(orgId: string, req: PresignUploadRequest): Promise<PresignResponse> {
@@ -1757,6 +1824,28 @@ export class ParallClient {
     );
   }
 
+  /**
+   * Drive the Cloud Edge live viewer (V1b, design §6): WebRTC signaling + input +
+   * tab nav for a hosted browser (Cloud Profile). Same request/reply shape as
+   * browserViewerCommand, on the v3 edge pipe; additive — the v2 browser-profile
+   * viewer is unchanged.
+   */
+  async edgeViewerCommand(
+    orgId: string,
+    edgeId: string,
+    req: EdgeViewerCommandRequest,
+    opts?: { timeoutMs?: number; keepalive?: boolean },
+  ): Promise<EdgeViewerCommandResponse> {
+    return this.request(
+      'POST',
+      ENDPOINTS.ORG_EDGE_VIEWER_COMMAND(orgId, edgeId),
+      req,
+      undefined,
+      false,
+      opts,
+    );
+  }
+
   async resizeMachine(
     orgId: string,
     machineId: string,
@@ -1813,9 +1902,23 @@ export class ParallClient {
 
   // ---- Unread ----
 
-  async getUnreadCounts(orgId?: string): Promise<Record<string, UnreadEntry>> {
+  async getUnreadCounts(
+    orgId?: string,
+    opts?: {
+      /** Add unread thread replies (per-thread cursors) to count/mentions.
+       *  Opt-in: only clients that can clear thread cursors should pass it. */
+      includeThreadReplies?: boolean;
+    },
+  ): Promise<Record<string, UnreadEntry>> {
     const endpoint = orgId ? ENDPOINTS.ORG_UNREAD(orgId) : ENDPOINTS.UNREAD;
-    const res = await this.request<{ data: Record<string, UnreadEntry> }>('GET', endpoint);
+    const res = await this.request<{ data: Record<string, UnreadEntry> }>(
+      'GET',
+      endpoint,
+      undefined,
+      {
+        include_thread_replies: opts?.includeThreadReplies ? 'true' : undefined,
+      },
+    );
     return res.data;
   }
 
@@ -1823,6 +1926,14 @@ export class ParallClient {
     return this.request('POST', ENDPOINTS.CHAT_READ(orgId, chatId), { message_id: messageId });
   }
 
+  /** Mark everything in a chat read: the channel cursor jumps to the latest
+   *  top-level message and every thread cursor to its latest reply, in one
+   *  idempotent call. The server echoes the same per-cursor WS events the
+   *  single-cursor routes emit and auto-clears covered inbox items. */
+  async markAllRead(orgId: string, chatId: string): Promise<void> {
+    return this.request('POST', ENDPOINTS.CHAT_READ_ALL(orgId, chatId));
+  }
+
   async getThreadUnread(
     orgId: string,
     chatId: string,
@@ -3161,6 +3272,17 @@ export class ParallClient {
     return this.request('GET', ENDPOINTS.REFS_BACKLINKS(orgId), undefined, params);
   }
 
+  /**
+   * Outbound prll:// refs authored in a set of sources, as raw ref_links rows
+   * (dedupe/group client-side). Pass `{ thread_root_id }` to list a whole
+   * thread's refs (root + all replies, resolved server-side — the client's
+   * reply window may be partial), or `{ source_type, source_ids }` for
+   * explicit sources (max 500; v1 accepts only message sources).
+   */
+  async listOutboundRefs(orgId: string, req: OutboundRefsRequest): Promise<OutboundRefsResponse> {
+    return this.request('POST', ENDPOINTS.REFS_OUTBOUND(orgId), req);
+  }
+
   /**
    * Bounded multi-hop walk of the prll:// reference graph around `uri`. `uri`
    * must be an entity-level prll:// URI — a refined URI (path/query/fragment) is
@@ -3211,6 +3333,40 @@ export class ParallClient {
     return this.request('GET', ENDPOINTS.FEATURE_FLAGS(orgId));
   }
 
+  // ---- Official Template catalog (org-contextual owner/admin reads + Hire) ----
+
+  async listOfficialTemplates(orgId: string): Promise<Template[]> {
+    const response = await this.request<{ templates: Template[] }>(
+      'GET',
+      ENDPOINTS.TEMPLATES(orgId),
+    );
+    return response.templates ?? [];
+  }
+
+  async getOfficialTemplate(orgId: string, templateId: string): Promise<Template> {
+    return this.request('GET', ENDPOINTS.TEMPLATE(orgId, templateId));
+  }
+
+  async deployTemplate(
+    orgId: string,
+    request: DeployTemplateRequest,
+  ): Promise<TemplateDeploymentReport> {
+    // The server grants this synchronous, non-idempotent operation a 3-minute
+    // write deadline because it may provision several agents in sequence.
+    // Keep the client alive slightly longer so it does not manufacture an
+    // ambiguous timeout while the team is still being created.
+    return this.request('POST', ENDPOINTS.TEMPLATE_DEPLOYMENTS(orgId), request, undefined, false, {
+      timeoutMs: 185_000,
+    });
+  }
+
+  async getTemplateDeployment(
+    orgId: string,
+    deploymentId: string,
+  ): Promise<TemplateDeploymentReport> {
+    return this.request('GET', ENDPOINTS.TEMPLATE_DEPLOYMENT(orgId, deploymentId));
+  }
+
   // ---- Billing & Credits (org-scoped) ----
 
   async getBilling(orgId: string): Promise<BillingSummary> {
@@ -3567,6 +3723,75 @@ export class ParallClient {
     return this.request('GET', ENDPOINTS.ORG_EDGE_PROFILES(orgId, edgeId));
   }
 
+  /**
+   * Read a hosted Cloud Profile's egress-proxy status (manager-only: hosted
+   * human maintainer or org admin). Sanitized — the password never comes back.
+   * Typed errors: `EDGE_NOT_HOSTED` (BYOC device), `PROXY_CONFIG_CORRUPT` /
+   * validation codes as 422 when a stored config no longer passes current rules.
+   * `can_mutate` and `lease_status` are the authoritative idle gate; device
+   * list status is not a substitute.
+   */
+  async getEdgeProfileProxy(
+    orgId: string,
+    edgeId: string,
+    profileName: string,
+  ): Promise<EdgeProfileProxyStatus> {
+    return this.request('GET', ENDPOINTS.ORG_EDGE_PROFILE_PROXY(orgId, edgeId, profileName));
+  }
+
+  /**
+   * Set/replace the profile's egress proxy (full triple every time) — IDLE
+   * ONLY: while the profile's hosted browser is running (a viewer session is
+   * open or a pod is otherwise live) the server answers 409
+   * `EDGE_PROFILE_IN_USE`; close the viewer, wait for idle scale-to-zero, and
+   * retry. The next cold start uses the new egress; browser login state is
+   * preserved across it. Other typed errors: the validation vocabulary
+   * (`INVALID_PROXY_SERVER`, `PROXY_AUTH_INCOMPLETE`,
+   * `PROXY_SERVER_FORBIDDEN_TARGET`, …), `EDGE_DELETING` (409), and
+   * `SECRETBOX_UNCONFIGURED` (503 — server cannot store credentials safely),
+   * and `EDGE_PROFILE_PROXY_STALE` (409 — expectedVersion lost a tab race).
+   */
+  async setEdgeProfileProxy(
+    orgId: string,
+    edgeId: string,
+    profileName: string,
+    req: SetEdgeProfileProxyRequest,
+    expectedVersion?: string,
+  ): Promise<EdgeProfileProxyStatus> {
+    return this.request(
+      'PUT',
+      ENDPOINTS.ORG_EDGE_PROFILE_PROXY(orgId, edgeId, profileName),
+      req,
+      undefined,
+      false,
+      {
+        headers: expectedVersion ? { 'If-Match': `"proxy-${expectedVersion}"` } : undefined,
+      },
+    );
+  }
+
+  /**
+   * Clear the profile's egress proxy; the next pod start egresses directly.
+   * Idle-only like set — 409 `EDGE_PROFILE_IN_USE` while the browser is live.
+   */
+  async clearEdgeProfileProxy(
+    orgId: string,
+    edgeId: string,
+    profileName: string,
+    expectedVersion?: string,
+  ): Promise<EdgeProfileProxyStatus> {
+    return this.request(
+      'DELETE',
+      ENDPOINTS.ORG_EDGE_PROFILE_PROXY(orgId, edgeId, profileName),
+      undefined,
+      undefined,
+      false,
+      {
+        headers: expectedVersion ? { 'If-Match': `"proxy-${expectedVersion}"` } : undefined,
+      },
+    );
+  }
+
   /**
    * Execute a registry clip command on an Edge device.
    *
@@ -3664,6 +3889,8 @@ function normalizeWikiChangeset(changeset: WikiChangeset): WikiChangeset {
 
 export class ApiError extends Error {
   extras?: Record<string, unknown>;
+  /** Retry-After delta seconds when the server supplies one. */
+  retryAfterSeconds?: number;
   /** Attempted action (authorization denials) — e.g. "chat.add_member". */
   action?: string;
   /** Target resource URI that was evaluated — e.g. "prll://cht_…". */
@@ -3691,7 +3918,7 @@ export class ApiError extends Error {
  * See docs/engineering-design/error-contract-design.md
  */
 function buildApiError(
-  res: { status: number; statusText: string },
+  res: { status: number; statusText: string; headers?: { get(name: string): string | null } },
   rawErrorBody: unknown,
 ): ApiError {
   const errorBody =
@@ -3714,6 +3941,8 @@ function buildApiError(
     (typeof errorObj?.code === 'string' ? errorObj.code : undefined) ??
     (typeof errorBody.code === 'string' ? (errorBody.code as string) : undefined);
   const apiError = new ApiError(res.status, errMsg ?? res.statusText, errCode);
+  const retryAfter = Number(res.headers?.get('Retry-After'));
+  if (Number.isFinite(retryAfter) && retryAfter > 0) apiError.retryAfterSeconds = retryAfter;
   // Machine anchors: present under `error`, with a legacy flat fallback.
   const anchors = errorObj ?? errorBody;
   if (typeof anchors.action === 'string') apiError.action = anchors.action;

package/src/constants.ts

@@ -377,6 +377,14 @@ export const ENDPOINTS = {
     `${API_BASE}/orgs/${orgId}/members/${memberId}/chats`,
   ORG_MEMBER_TASKS: (orgId: string, memberId: string) =>
     `${API_BASE}/orgs/${orgId}/members/${memberId}/tasks`,
+  // Org-scoped public profile (title / description). GET readable by every
+  // active member; PATCH is CAS-guarded (expected_version).
+  ORG_MEMBER_PROFILE: (orgId: string, userId: string) =>
+    `${API_BASE}/orgs/${orgId}/members/${userId}/profile`,
+  // Private agent Instructions — visibility gated server-side
+  // (agent self + Human org admin/owner). Never cached.
+  AGENT_INSTRUCTIONS: (orgId: string, agentId: string) =>
+    `${API_BASE}/orgs/${orgId}/agents/${agentId}/instructions`,
   REF_SEARCH: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/search`,
 
   // Direct messages (org-scoped, atomic find-or-create + send)
@@ -410,6 +418,9 @@ export const ENDPOINTS = {
   MESSAGE_WATCH: (id: string) => `${API_BASE}/messages/${id}/watch`,
   MESSAGE_WATCHERS: (id: string) => `${API_BASE}/messages/${id}/watchers`,
   MESSAGE_WATCHING: (id: string) => `${API_BASE}/messages/${id}/watching`,
+  MESSAGE_REACTIONS: (id: string) => `${API_BASE}/messages/${id}/reactions`,
+  MESSAGE_REACTION: (id: string, emoji: string) =>
+    `${API_BASE}/messages/${id}/reactions/${encodeURIComponent(emoji)}`,
 
   // Upload (org-scoped)
   UPLOAD_PRESIGN: (orgId: string) => `${API_BASE}/orgs/${orgId}/upload/presign`,
@@ -780,6 +791,8 @@ export const ENDPOINTS = {
   UNREAD: `${API_BASE}/me/unread`,
   ORG_UNREAD: (orgId: string) => `${API_BASE}/orgs/${orgId}/unread`,
   CHAT_READ: (orgId: string, chatId: string) => `${API_BASE}/orgs/${orgId}/chats/${chatId}/read`,
+  CHAT_READ_ALL: (orgId: string, chatId: string) =>
+    `${API_BASE}/orgs/${orgId}/chats/${chatId}/read-all`,
   THREAD_UNREAD: (orgId: string, chatId: string, threadRootId: string) =>
     `${API_BASE}/orgs/${orgId}/chats/${chatId}/threads/${threadRootId}/unread`,
   THREAD_READ: (orgId: string, chatId: string, threadRootId: string) =>
@@ -788,6 +801,7 @@ export const ENDPOINTS = {
   // References (org-scoped)
   REFS_RESOLVE: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/resolve`,
   REFS_BACKLINKS: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/backlinks`,
+  REFS_OUTBOUND: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/outbound`,
   REFS_GRAPH: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/graph`,
   REFS_CHECK: (orgId: string) => `${API_BASE}/orgs/${orgId}/refs/check`,
 
@@ -808,6 +822,14 @@ export const ENDPOINTS = {
   // Feature flags (org-scoped, server-evaluated)
   FEATURE_FLAGS: (orgId: string) => `${API_BASE}/orgs/${orgId}/feature-flags`,
 
+  // Team templates (org-scoped, owner/admin only)
+  TEMPLATES: (orgId: string) => `${API_BASE}/orgs/${orgId}/templates`,
+  TEMPLATE: (orgId: string, templateId: string) =>
+    `${API_BASE}/orgs/${orgId}/templates/${templateId}`,
+  TEMPLATE_DEPLOYMENTS: (orgId: string) => `${API_BASE}/orgs/${orgId}/template-deployments`,
+  TEMPLATE_DEPLOYMENT: (orgId: string, deploymentId: string) =>
+    `${API_BASE}/orgs/${orgId}/template-deployments/${deploymentId}`,
+
   // Billing & Credits (org-scoped)
   BILLING: (orgId: string) => `${API_BASE}/orgs/${orgId}/billing`,
   BILLING_TRANSACTIONS: (orgId: string) => `${API_BASE}/orgs/${orgId}/billing/transactions`,
@@ -876,7 +898,15 @@ export const ENDPOINTS = {
   ORG_EDGE_ONBOARDING: (orgId: string) => `/api/v1/orgs/${orgId}/edge/onboarding`,
   ORG_EDGE_PROFILES: (orgId: string, edgeId: string) =>
     `/api/v1/orgs/${orgId}/edge/${edgeId}/profiles`,
+  // Per-profile egress proxy (hosted Cloud Profiles; manager-only, human-only).
+  ORG_EDGE_PROFILE_PROXY: (orgId: string, edgeId: string, profileName: string) =>
+    `/api/v1/orgs/${orgId}/edge/${edgeId}/profiles/${encodeURIComponent(profileName)}/proxy`,
   ORG_EDGE_EXEC: (orgId: string) => `/api/v1/orgs/${orgId}/edge/exec`,
+  // Cloud Edge live viewer command (V1b) — api-server, gated on cap:edge-viewer.
+  // Same request/reply shape as the v2 browser-profile viewer, on the v3 edge
+  // pipe. Additive: does NOT replace BROWSER_PROFILE_VIEWER_COMMAND.
+  ORG_EDGE_VIEWER_COMMAND: (orgId: string, edgeId: string) =>
+    `/api/v1/orgs/${orgId}/edge/${edgeId}/viewer/command`,
   CLIP_CONNECTIONS: (orgId: string, clipId: string) =>
     `/api/v1/orgs/${orgId}/clip-registry/${clipId}/connections`,
   CLIP_CONNECTION: (orgId: string, connId: string) =>
@@ -941,6 +971,7 @@ export const WS_EVENTS = {
   MESSAGE_PATCH: 'message.patch',
   MESSAGE_EDIT: 'message.edit',
   MESSAGE_DELETE: 'message.delete',
+  MESSAGE_REACTION_UPDATED: 'message.reaction.updated',
   TYPING_UPDATE: 'typing.update',
   CHAT_UPDATE: 'chat.update',
   CHAT_DELETED: 'chat.deleted',
@@ -981,6 +1012,7 @@ export const WS_EVENTS = {
   INBOX_UPDATE: 'inbox.update',
   INBOX_BULK_UPDATE: 'inbox.bulk_update',
   READ_POSITION_UPDATED: 'read_position.updated',
+  THREAD_READ_POSITION_UPDATED: 'thread_read_position.updated',
   DISPATCH_NEW: 'dispatch.new',
   DISPATCH_RECEIVED: 'dispatch.received',
   DISPATCH_RESOLVED: 'dispatch.resolved',