@parall/sdk 1.47.0 → 1.49.0

package/src/client.ts

@@ -167,6 +167,8 @@ import type {
   DispatchExpireResult,
   ResolveRefsResponse,
   BacklinksResponse,
+  OutboundRefsRequest,
+  OutboundRefsResponse,
   RefGraphResponse,
   BrokenRefsResponse,
   PushSubscribeRequest,
@@ -209,6 +211,8 @@ import type {
   InvokeClipResponse,
   OnlineClipInfo,
   RegistryClipInfo,
+  ClipRegistryEntry,
+  InstallRegistryClipResponse,
   MachineClip,
   BrowserProfile,
   MachineBrowserProfile,
@@ -221,12 +225,20 @@ import type {
   BrowserProfileLifecycleRequest,
   BrowserViewerCommandRequest,
   BrowserViewerCommandResponse,
+  EdgeViewerCommandRequest,
+  EdgeViewerCommandResponse,
   GrantBrowserProfileConsentRequest,
   EdgeDevice,
   EdgePlacement,
   EdgeBrowserProfile,
+  EdgeProfileProxyStatus,
+  SetEdgeProfileProxyRequest,
   ClipConnection,
   EdgeOnboardingStatus,
+  ExecEdgeClipRequest,
+  EdgeClipExecResult,
+  ReactionSummary,
+  ToggleReactionResponse,
 } from './types.js';
 
 export interface ParallClientOptions {
@@ -417,6 +429,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;
     },
@@ -439,7 +453,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
@@ -1091,6 +1105,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> {
@@ -1753,6 +1781,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,
@@ -1809,9 +1859,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;
   }
 
@@ -1819,6 +1883,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,
@@ -3157,6 +3229,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
@@ -3472,6 +3555,43 @@ export class ParallClient {
     return resp.data;
   }
 
+  // ---- Clip registry (v3, api-server org registry — `crg_` entries) ----
+
+  /**
+   * List registry clips visible to the org: its own plus public+approved
+   * cross-org entries. This is the surface `installRegistryClip` and clip
+   * connections operate on — NOT the Pinix catalog proxy
+   * ({@link listRegistryClips}), whose entries carry no `crg_` id.
+   */
+  async listOrgRegistryClips(orgId: string): Promise<ClipRegistryEntry[]> {
+    // Server default page is 50 (max 100); one max-size page covers today's
+    // catalogs — revisit with real pagination if registries outgrow it.
+    const resp = await this.request<ClipRegistryEntry[] | null>(
+      'GET',
+      `${ENDPOINTS.ORG_CLIP_REGISTRY(orgId)}?limit=100`,
+    );
+    return resp ?? [];
+  }
+
+  /**
+   * Install a registry clip into the org (a reference in `clip_installs`, not a
+   * copy). Idempotent: installing an already-installed clip returns the same
+   * `200 {ok:true}`. Fails closed with `403 CLIP_NOT_APPROVED` when the clip is
+   * not eligible (cross-org requires public + approved).
+   */
+  async installRegistryClip(orgId: string, clipId: string): Promise<InstallRegistryClipResponse> {
+    return this.request('POST', ENDPOINTS.ORG_CLIP_INSTALL(orgId), { clip_id: clipId });
+  }
+
+  /** List the org's installed registry clips (full entries). */
+  async listInstalledRegistryClips(orgId: string): Promise<ClipRegistryEntry[]> {
+    const resp = await this.request<ClipRegistryEntry[] | null>(
+      'GET',
+      ENDPOINTS.ORG_CLIPS_INSTALLED(orgId),
+    );
+    return resp ?? [];
+  }
+
   // ---- Edge devices ----
 
   async listEdgeDevices(orgId: string): Promise<{ data: EdgeDevice[] }> {
@@ -3495,8 +3615,8 @@ export class ParallClient {
   }
 
   /**
-   * Delete a hosted Cloud Profile. Hosted only — a BYOC device is removed by
-   * uninstalling Parall Clip on that machine (`400 EDGE_PLACEMENT_UNSUPPORTED`).
+   * Delete a hosted Cloud Profile. Hosted only — use {@link unregisterEdgeDevice}
+   * for an offline BYOC registration (`400 EDGE_PLACEMENT_UNSUPPORTED` here).
    *
    * Idempotent and ASYNC: returns `202` with `hosted_state: 'deleting'` on the first
    * call and on every repeat. The device stops being usable immediately (no exec, no
@@ -3507,6 +3627,17 @@ export class ParallClient {
     return this.request('DELETE', ENDPOINTS.ORG_EDGE_DEVICE(orgId, edgeId));
   }
 
+  /**
+   * Remove the interactive human caller's own offline BYOC registration.
+   *
+   * Synchronous and idempotent: a committed removal and a repeat after removal
+   * both resolve with no response body. A live connection returns `EDGE_ONLINE`;
+   * callers must not clear local device identity until this method resolves.
+   */
+  async unregisterEdgeDevice(orgId: string, edgeId: string): Promise<void> {
+    await this.request('DELETE', ENDPOINTS.ORG_EDGE_DEVICE_UNREGISTER(orgId, edgeId));
+  }
+
   async getEdgeOnboarding(orgId: string): Promise<EdgeOnboardingStatus> {
     return this.request('GET', ENDPOINTS.ORG_EDGE_ONBOARDING(orgId));
   }
@@ -3515,6 +3646,137 @@ 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.
+   *
+   * A hosted (Cloud Profile) device is reachable ONLY through an explicit
+   * `connection` (id `ccn_…` or alias) — there is no implicit route to an
+   * org-shared browser login. BYOC keeps its legacy selectors (`edge_id`, or
+   * nothing for the caller's own online device).
+   *
+   * Returns the result envelope on completion (`success` may be false when the
+   * command RAN and failed — `error`/`error_code` describe why). Everything
+   * else throws a typed {@link ApiError}; match on `err.code`:
+   *
+   * Safe to retry (guaranteed nothing was dispatched):
+   * - `EDGE_ACTIVATING` 503 + `Retry-After` — cold cloud profile is starting.
+   *   Bounded backoff, same `correlation_id` across the loop.
+   * - `EDGE_BUSY` 409 — the device is executing another request.
+   * - `EDGE_CONCURRENCY_LIMIT` 429 — org at its concurrent-session limit.
+   * - `EDGE_UNAVAILABLE` 503 — session torn down / replaced mid-dispatch.
+   *
+   * NOT retryable:
+   * - `OUTCOME_UNKNOWN` 504 — dispatched, but no result arrived. The command
+   *   MAY HAVE EXECUTED (posted, ordered, deleted…). Never retry
+   *   automatically: verify the effect first, then decide. The message carries
+   *   the request id for audit.
+   * - `EDGE_DEADLINE_EXCEEDED` 504 — arrived late, provably NOT executed.
+   * - `EDGE_HOSTED_DISABLED_FOR_ORG` 403, `EDGE_REPAIR` 503 (operator-held),
+   *   `EDGE_RUNTIME_UNAVAILABLE` 503 (deployment has no hosted runtime).
+   * - Routing errors: `HOSTED_CONNECTION_REQUIRED`, `CONNECTION_NOT_FOUND`,
+   *   `CONNECTION_CLIP_MISMATCH`, `CONNECTION_TARGET_GONE`,
+   *   `CONNECTION_PROFILE_MISMATCH`, `EDGE_DELETING`, `DEVICE_OFFLINE`.
+   */
+  async execEdgeClip(orgId: string, req: ExecEdgeClipRequest): Promise<EdgeClipExecResult> {
+    // The server holds the connection open for timeout + ~5s of result wait;
+    // give the HTTP layer headroom past that so a slow-but-successful exec is
+    // not chopped locally into a fake transport error. The effective value
+    // mirrors the SERVER's rule exactly (out-of-range → its 30s default): a
+    // local clamp that disagreed would abort the HTTP call while the server
+    // legitimately keeps executing — manufacturing a transport error for a
+    // request that may still succeed.
+    const t = req.timeout;
+    const serverTimeout = t !== undefined && t > 0 && t <= 120000 ? t : 30000;
+    const timeoutMs = serverTimeout + 10_000;
+    try {
+      return await this.request('POST', ENDPOINTS.ORG_EDGE_EXEC(orgId), req, undefined, false, {
+        timeoutMs,
+      });
+    } catch (err) {
+      // A 422 is the RESULT envelope (the command ran and failed), not the
+      // standard error envelope — lift its stable `error_code` into
+      // ApiError.code so callers match one field for every failure.
+      if (
+        err instanceof ApiError &&
+        err.status === 422 &&
+        !err.code &&
+        typeof err.extras?.error_code === 'string'
+      ) {
+        err.code = err.extras.error_code;
+      }
+      throw err;
+    }
+  }
+
   // ---- Clip connections ----
 
   async listClipConnections(orgId: string, clipId: string): Promise<{ data: ClipConnection[] }> {
@@ -3550,6 +3812,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_…". */
@@ -3577,7 +3841,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 =
@@ -3600,6 +3864,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

@@ -410,6 +410,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 +783,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 +793,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`,
 
@@ -871,13 +877,30 @@ export const ENDPOINTS = {
   ORG_EDGE: (orgId: string) => `/api/v1/orgs/${orgId}/edge`,
   ORG_EDGE_DEVICES: (orgId: string) => `/api/v1/orgs/${orgId}/edge/devices`,
   ORG_EDGE_DEVICE: (orgId: string, edgeId: string) => `/api/v1/orgs/${orgId}/edge/${edgeId}`,
+  ORG_EDGE_DEVICE_UNREGISTER: (orgId: string, edgeId: string) =>
+    `/api/v1/orgs/${orgId}/edge/${edgeId}/unregister`,
   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) =>
     `/api/v1/orgs/${orgId}/clip-connections/${connId}`,
+
+  // Clip registry (v3, org-scoped, served by api-server — `crg_` entries; the
+  // Pinix Hub catalog proxy above is a different, id-less surface)
+  ORG_CLIP_REGISTRY: (orgId: string) => `/api/v1/orgs/${orgId}/clip-registry`,
+  ORG_CLIP_INSTALL: (orgId: string) => `/api/v1/orgs/${orgId}/clips/install`,
+  ORG_CLIPS_INSTALLED: (orgId: string) => `/api/v1/orgs/${orgId}/clips/installed`,
 } as const;
 
 /**
@@ -932,6 +955,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',
@@ -972,6 +996,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',