@parall/sdk 1.36.0 → 1.37.0

package/dist/types.d.ts

@@ -611,11 +611,17 @@ export interface Machine {
     clip_provider_url?: string;
     daemon_version?: string | null;
     self_update_capable?: boolean;
+    detected_runtimes?: DetectedRuntime[] | null;
     region: string | null;
     created_by: string;
     created_at: string;
     updated_at: string;
 }
+export interface DetectedRuntime {
+    runtime_type: string;
+    version?: string;
+    status: 'ok' | 'broken';
+}
 export type DaemonWorkspaceMode = 'default' | 'local_path' | 'git';
 export type DaemonWorkspaceSetupRunOn = 'first_attach' | 'config_change';
 export interface DaemonWorkspaceGitConfig {
@@ -670,7 +676,7 @@ export interface AgentProfile {
     model_management: string | null;
     permissions: string[];
     machine_id: string | null;
-    hosting_mode?: 'hosted' | 'self_hosted';
+    hosting_mode?: 'hosted' | 'self_hosted' | 'platform_runtime';
     runtime_type: string;
     description: string | null;
     thinking_effort: string | null;
@@ -724,6 +730,11 @@ export interface MachineConfigUpdatedData {
     llm_source?: string;
     provider_enabled?: boolean;
 }
+export interface MachineAgentConfigUpdatedData {
+    machine_id: string;
+    agent_id: string;
+    llm_source: string;
+}
 export interface MachineWorkspaceSetupRequestedData {
     machine_id: string;
     agent_id: string;
@@ -754,6 +765,14 @@ export interface MachineBrowserProfileLifecycleData {
     profile_id: string;
     action: BrowserProfileLifecycleAction;
     start_url?: string;
+    /** Profile's lifecycle_generation after this transition's bump (PR #1650). The
+     *  daemon acts under it and echoes it in its status report so the server can
+     *  reject a stale report. Absent/0 from a pre-generation server. */
+    generation?: number;
+    /** Profile's reset_generation after this transition (bumped only by `reset`). On
+     *  an online reset the daemon records it in its per-profile sidecar so a later
+     *  reconnect doesn't redundantly re-wipe. */
+    reset_generation?: number;
 }
 /**
  * Live-viewer control command relayed to the host daemon over `machine:{id}`.
@@ -850,6 +869,13 @@ export interface Task {
     canceled_at: string | null;
     archived_at?: string | null;
     deleted_at?: string | null;
+    /**
+     * Per-viewer: whether the requesting user may manage OTHER members' comment
+     * subscriptions for this task (creator / assignee / project lead / org
+     * owner-admin). Populated on single-task GET; undefined elsewhere. Read this to
+     * gate subscriber-management UI — do not re-derive the rule client-side.
+     */
+    can_manage_subscribers?: boolean;
 }
 export interface TaskWatcher {
     task_id: string;
@@ -1239,6 +1265,19 @@ export interface Wiki {
     created_by: string;
     created_at: string;
     updated_at: string;
+    /** Protected default wiki — cannot be deleted. */
+    is_default?: boolean | null;
+    /** Set when the wiki is soft-deleted (recoverable). */
+    deleted_at?: string | null;
+    /** User who soft-deleted the wiki. */
+    deleted_by?: string | null;
+    /** Set once purge is claimed — the wiki can no longer be restored. */
+    purge_started_at?: string | null;
+    /** deleted_at + retention window (server-computed) — the recycle-bin countdown
+     *  source. Past this, restore is rejected with 410 WIKI_RETENTION_EXPIRED. */
+    purge_eligible_at?: string | null;
+    /** Server-computed restore availability for recycle-bin rows. */
+    restorable?: boolean | null;
 }
 export interface WikiFileChange {
     path: string;
@@ -1267,10 +1306,18 @@ export interface WikiTreeEntry {
     path: string;
     type: 'tree' | 'blob';
     size?: number;
+    /**
+     * Entry sits inside a read-gated private subtree (path restriction). Advisory
+     * display flag — the caller already passed read authorization to receive the
+     * entry; use it to badge private folders, never for access decisions.
+     */
+    restricted?: boolean;
 }
 export interface WikiTreeResponse {
     data: WikiTreeEntry[];
     path: string;
+    /** Whether the listed directory itself sits inside a read-gated private subtree. */
+    path_restricted?: boolean;
 }
 export interface WikiFileManifestEntry {
     path: string;
@@ -1491,6 +1538,7 @@ export interface CreateWikiPathRestrictionRequest {
     level?: 'read' | 'maintain' | 'admin';
     subjects: string[];
     apply_to_admins?: boolean;
+    create_only?: boolean;
 }
 export interface WikiAccessStatus {
     path: string;
@@ -1518,6 +1566,22 @@ export interface WikiOperationsResponse {
     data: WikiOperation[];
     has_more: boolean;
 }
+/**
+ * Copy one wiki file to another path as an independent snapshot (no ongoing
+ * sync). Primary use: "share a private file out" — copy from the caller's
+ * personal namespace (`users/{userId}/…`) into the public wiki so the whole
+ * org can read + edit the copy, leaving the private original untouched.
+ */
+export interface CopyWikiFileRequest {
+    source_path: string;
+    dest_path: string;
+    message?: string;
+}
+export interface CopyWikiFileResponse {
+    source_path: string;
+    dest_path: string;
+    commit_sha: string;
+}
 export interface WikiBlob {
     path: string;
     ref: string;
@@ -1527,6 +1591,8 @@ export interface WikiBlob {
     content?: string;
     line_count?: number;
     sha256?: string;
+    /** File sits inside a read-gated private subtree — advisory display flag. */
+    restricted?: boolean;
     mime?: string;
     is_lfs?: boolean;
     content_sha?: string;
@@ -1636,6 +1702,15 @@ export interface MembershipChangedData {
     user_id: string;
     action: 'added' | 'removed' | 'role_changed';
 }
+/**
+ * A member was removed from an org — kicked by an admin or self-removal
+ * ("leave org"). Delivered on org:{orgId} (remaining members refresh the
+ * directory) and user:{userId} (the removed user's clients drop the org).
+ */
+export interface OrgMemberRemovedData {
+    org_id: string;
+    user_id: string;
+}
 export type TaskActivityAction = 'created' | 'field_changed' | 'commented';
 export interface TaskComment {
     id: string;
@@ -1757,6 +1832,13 @@ export type WikiChangesetCreatedData = WikiChangeset & {
 export type WikiChangesetUpdatedData = WikiChangeset & {
     org_id: string;
 };
+export interface WikiDeletedData {
+    org_id: string;
+    wiki_id: string;
+    slug: string;
+    name: string;
+}
+export type WikiRestoredData = WikiDeletedData;
 export interface Comment {
     id: string;
     org_id: string;
@@ -1811,7 +1893,114 @@ export interface InboxItem {
     created_at: string;
     updated_at: string;
 }
-export type DispatchEventType = 'message' | 'task_assign' | 'task_update' | 'task_comment' | 'wiki_comment' | 'schedule.fire' | 'external_trigger' | 'approval_decided';
+export type ChannelProvider = 'feishu' | 'slack';
+export type ChannelConnectionStatus = 'pending' | 'active' | 'disabled';
+/**
+ * Inbound transport for a connection. Defaults to the provider's lowest-
+ * onboarding-cost mode server-side (Feishu → socket, Slack → webhook) when
+ * omitted on create; can be overridden per connection.
+ */
+export type ChannelIngressMode = 'webhook' | 'socket';
+export type ChannelMessageStatus = 'received' | 'dispatched' | 'failed';
+export interface ChannelConnection {
+    id: string;
+    org_id: string;
+    agent_id: string;
+    provider: ChannelProvider;
+    ingress_mode: ChannelIngressMode;
+    display_name: string;
+    created_by: string;
+    status: ChannelConnectionStatus;
+    external_app_id?: string;
+    external_team_id?: string;
+    archived_at?: string | null;
+    archive_reason?: string | null;
+    /** Returned once at mint time (create / token regeneration). */
+    ingress_url?: string;
+    /** Returned once at mint time (create / token regeneration). */
+    ingress_token?: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface ChannelCredentialsInput {
+    app_id: string;
+    app_secret: string;
+    verification_token?: string;
+    encrypt_key?: string;
+    team_id?: string;
+}
+export interface CreateChannelConnectionInput {
+    agent_id: string;
+    provider: ChannelProvider;
+    display_name: string;
+    /** Override the provider's default inbound transport (optional). */
+    ingress_mode?: ChannelIngressMode;
+    /** Manual provisioning: activates the connection immediately. */
+    credentials?: ChannelCredentialsInput;
+}
+export interface UpdateChannelConnectionInput {
+    display_name?: string;
+    status?: 'active' | 'disabled';
+}
+export interface ChannelConversation {
+    id: string;
+    org_id: string;
+    connection_id: string;
+    agent_id: string;
+    agent_session_id?: string | null;
+    external_conversation_id: string;
+    external_thread_id: string;
+    conversation_type: string;
+    external_user_id: string;
+    external_user_name: string;
+    last_inbound_at?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface ChannelMessage {
+    id: string;
+    org_id: string;
+    connection_id: string;
+    conversation_id: string;
+    external_message_id: string;
+    text: string;
+    external_user_id: string;
+    external_user_name: string;
+    status: ChannelMessageStatus;
+    received_at: string;
+    created_at: string;
+}
+/**
+ * Feishu one-click provisioning session (OAuth device flow). The client
+ * renders `verification_url` as a QR code and lazily polls the status
+ * endpoint every `poll_interval_seconds` — each poll may forward one
+ * provider poll server-side, so respect the interval.
+ */
+export type ChannelProvisioningStatus = 'pending' | 'polling' | 'done' | 'expired' | 'denied' | 'canceled' | 'failed';
+export interface ChannelProvisioningSession {
+    id: string;
+    org_id: string;
+    agent_id: string;
+    provider: ChannelProvider;
+    created_by: string;
+    status: ChannelProvisioningStatus;
+    poll_interval_seconds: number;
+    /** Set when status = 'done': the minted connection. */
+    connection_id?: string;
+    /** Terminal detail: access_denied / expired_token / domain_switched / connection_exists / alias_conflict / internal. */
+    error_code?: string;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+    /** QR target — present on live (pending/polling) sessions only. */
+    verification_url?: string;
+    user_code?: string;
+}
+export interface InitiateChannelProvisioningInput {
+    agent_id: string;
+    provider: ChannelProvider;
+}
+export type DispatchEventType = 'message' | 'task_assign' | 'task_update' | 'task_comment' | 'wiki_comment' | 'schedule.fire' | 'external_trigger' | 'approval_decided' | 'channel_message';
 export type DispatchStatus = 'pending' | 'received' | 'acked';
 export type DispatchDeliveryReason = 'mention' | 'watcher' | 'assignee' | 'creator';
 export interface DispatchEvent {
@@ -1924,10 +2113,13 @@ export type WsEventMap = {
     'invitation.revoked': InvitationRevokedEventData;
     'org.join_request.new': OrgJoinRequestNewEventData;
     'org.invite_link.joined': OrgInviteLinkJoinedEventData;
+    'org.member.removed': OrgMemberRemovedData;
     'agent_config.update': AgentConfigUpdateData;
     'presence.update': PresenceUpdateData;
     'wiki.changeset.created': WikiChangesetCreatedData;
     'wiki.changeset.updated': WikiChangesetUpdatedData;
+    'wiki.deleted': WikiDeletedData;
+    'wiki.restored': WikiRestoredData;
     'comment.created': CommentCreatedData;
     'comment.updated': CommentUpdatedData;
     'comment.deleted': CommentDeletedData;
@@ -1951,6 +2143,7 @@ export type WsEventMap = {
     'machine.agent.attached': MachineAgentAttachedData;
     'machine.agent.detached': MachineAgentDetachedData;
     'machine.config.updated': MachineConfigUpdatedData;
+    'machine.agent_config.updated': MachineAgentConfigUpdatedData;
     'machine.workspace.setup.requested': MachineWorkspaceSetupRequestedData;
     'machine.stop': MachineStopData;
     'machine.filesystem.browse': MachineFilesystemBrowseData;
@@ -2008,7 +2201,14 @@ export interface PlatformConfigResponse {
     version: string;
     schema_version: number;
     min_plugin_version?: string;
+    /** @deprecated V1-compat only — old bridges read this for override-vs-floor. New bridges read `model_is_pin`. */
     mode?: string;
+    /**
+     * Whether the delivered model is an operator PIN (override, beats the runtime's
+     * env/default) vs a catalog FLOOR (loses to env). Optional: an old server omits
+     * it and the bridge falls back to the legacy `model_management`-derived signal.
+     */
+    model_is_pin?: boolean;
     config: Record<string, unknown>;
 }
 export interface AgentConfigUpdateData {
@@ -2091,6 +2291,35 @@ export interface BacklinksResponse {
     backlinks: BacklinkItem[];
     next_cursor?: string;
 }
+/**
+ * One entity in a multi-hop ref-graph traversal (GET /refs/graph). `id`/`uri` are
+ * the ref_links endpoint identifier: a bare prll:// entity id for most nodes
+ * (`tsk_abc` → `prll://tsk_abc`), but a wiki_file source node carries its file
+ * path (`wik_abc/docs/a.md` → `prll://wik_abc/docs/a.md`, type `wik`). The query
+ * root must be entity-level (refined path/anchor URIs are rejected 400), yet
+ * interior wiki_file nodes can legitimately be path-bearing.
+ */
+export interface RefGraphNode {
+    uri: string;
+    type: string;
+    id: string;
+    depth: number;
+}
+/** One directed prll:// reference between two nodes in the graph. */
+export interface RefGraphEdge {
+    source_uri: string;
+    target_uri: string;
+    source_type: string;
+    target_type: string;
+    context?: string;
+}
+export interface RefGraphResponse {
+    root: string;
+    depth: number;
+    nodes: RefGraphNode[];
+    edges: RefGraphEdge[];
+    truncated: boolean;
+}
 export interface BrokenRefItem {
     ref_link_id: string;
     source_type: string;
@@ -2238,6 +2467,58 @@ export interface ComputePricing {
     created_at: string;
 }
 export type ComputePricingResponse = Record<string, ComputePricing>;
+/**
+ * Per-runtime capability row from GET /api/v1/runtimes (public, no auth).
+ * Server SSOT: server/pkg/hosting/capabilities.go RuntimeCapability — the
+ * data source for the create/settings interlock (which compute × intelligence
+ * × model combinations are offerable per runtime).
+ */
+export interface RuntimeCapability {
+    runtime: string;
+    /** Where the runtime can run: "hosted" and/or "local". Hermes is cloud-only. */
+    compute_modes: string[];
+    /**
+     * Provider family the runtime's OWN credentials can serve ("anthropic" /
+     * "openai"), or "any" for family-agnostic runtimes. Own-route restriction
+     * only — see cross_family_via_parall.
+     */
+    native_model_family: string;
+    /** On the Parall proxy route any catalog model is allowed regardless of family. */
+    cross_family_via_parall: boolean;
+    /** Whether a pinned model is delivered when the agent runs on its own credentials. */
+    own_route_model_pin: boolean;
+    /** Catalog default the UI pre-selects for this runtime. */
+    recommended_model: string;
+}
+/**
+ * Catalog entry from GET /api/v1/models (public, no auth) — the DB-backed
+ * platform model catalog. Server SSOT: handler.PlatformModelDTO
+ * (docs/engineering-design/model-catalog-design.md §6.1). Replaces the
+ * compile-time PLATFORM_MODELS constant as the picker data source.
+ */
+export interface PlatformModelInfo {
+    id: string;
+    name: string;
+    /** Provider family ("anthropic", "openai", "google", ...). */
+    family: string;
+    contextWindow: number;
+    maxTokens: number;
+    effortLevels?: string[];
+    /** Runtime type → runtime-native CLI model name. */
+    runtime_names?: Record<string, string>;
+    /** Set on client-behavior variants (the "(1M)" entries) — see isPlatformModelSelectableForRuntime. */
+    upstream_id?: string;
+    /** Display hints: "recommended" / "new" / "beta". */
+    tags?: string[];
+    sort_order: number;
+    /** True only for a legacy entry appended via include_model (not in the active catalog). */
+    hidden?: boolean;
+}
+export interface PlatformModelsResponse {
+    data: PlatformModelInfo[];
+    /** Catalog content hash — changes whenever the catalog changes. */
+    version: string;
+}
 export interface MachinePreset {
     key: string;
     cpu_cores: number;
@@ -2292,7 +2573,8 @@ export interface BillingMachineStoppedEvent {
 export interface BillingInsufficientEvent {
     org_id: string;
 }
-export type ClipSourceType = 'registry' | 'custom' | 'builtin';
+export type ClipSourceType = 'registry' | 'custom' | 'builtin' | 'channel';
+export type UserClipSourceType = 'registry' | 'custom' | 'builtin';
 export type ClipStatus = 'active' | 'disabled';
 export interface Clip {
     id: string;
@@ -2324,7 +2606,7 @@ export interface CreateClipRequest {
     display_name?: string;
     description?: string;
     manifest?: Record<string, unknown>;
-    source_type?: ClipSourceType;
+    source_type?: UserClipSourceType;
     source_ref?: string;
     version?: string;
     machine_id: string;
@@ -2387,6 +2669,14 @@ export type BrowserProfileStatus = 'pending' | 'running' | 'stopped' | 'error' |
  * required), `hosted` runs on the platform pool (machine_id null).
  */
 export type BrowserPlacement = 'byoc' | 'hosted';
+/** Deployment-wide hosted browser runtime availability (the controller startup
+ *  gate). Drives whether the create UI offers the platform-hosted placement; it
+ *  is org-scoped only for auth — the value itself is the same for every org.
+ *  Fail-closed: the server reports `available: false` if it cannot verify. */
+export interface BrowserRuntimeStatus {
+    available: boolean;
+    reason?: string;
+}
 export interface BrowserProfile {
     id: string;
     org_id: string;
@@ -2407,6 +2697,14 @@ export interface BrowserProfile {
      *  or control gate and owner/admin can always control. The org-wide list uses
      *  {@link BrowserProfileListItem.can_open} (per-viewer) instead. */
     can_open?: boolean;
+    /** Per-profile outbound proxy (BYO provider credentials). Returned to the owner /
+     *  org admin (Get) for the edit form. The password is NEVER returned —
+     *  {@link proxy_password_set} reports only whether one is configured. */
+    proxy_server?: string | null;
+    proxy_username?: string | null;
+    /** True when a proxy password is stored. Drives the edit form's "leave blank to
+     *  keep" affordance; the value itself is never sent to a human-facing client. */
+    proxy_password_set?: boolean;
 }
 /** Sanitized row from `GET /orgs/{orgId}/browser-profiles` (org-wide discovery).
  *  Carries only the fields the Browser Profiles tab needs to render + gate
@@ -2429,6 +2727,34 @@ export interface BrowserProfileListItem {
     can_open?: boolean;
     error_msg?: string | null;
     last_seen?: string | null;
+    /** Non-sensitive discovery flag: does this profile egress through a proxy. The
+     *  proxy server / credentials are NOT in the org-wide list (owner/admin Get only). */
+    proxy_configured?: boolean;
+}
+/** Daemon-facing browser profile returned by `GET /machines/me/browser-profiles`
+ *  (mck_-authed, machine-scoped). Unlike {@link BrowserProfile} it carries
+ *  `proxy_password`: the local BYOC daemon must replay it to bb-browser. This is the
+ *  single intended channel for the credential to leave the server — never surface it
+ *  on a human-facing path. */
+export interface MachineBrowserProfile {
+    id: string;
+    org_id: string;
+    placement: BrowserPlacement;
+    machine_id: string | null;
+    owner_user_id: string;
+    display_name: string;
+    status: BrowserProfileStatus;
+    error_msg?: string | null;
+    last_seen?: string | null;
+    proxy_server?: string | null;
+    proxy_username?: string | null;
+    proxy_password?: string | null;
+    /** Per-profile fencing tokens (PR #1650): lifecycle_generation bumps on every
+     *  open/stop/reset (daemon reports under it; stale reports rejected);
+     *  reset_generation bumps only on reset (daemon wipes local state on reconnect
+     *  when this is newer than what it last applied). Default 0. */
+    lifecycle_generation: number;
+    reset_generation: number;
 }
 export interface BrowserProfileConsent {
     id: string;
@@ -2447,9 +2773,20 @@ export interface CreateBrowserProfileRequest {
     machine_id?: string | null;
     owner_user_id: string;
     display_name: string;
+    /** Optional BYO proxy. Omit all for direct egress. proxy_server is `host:port`
+     *  (optional http/https/socks5 scheme); proxy_username/password are sent together. */
+    proxy_server?: string | null;
+    proxy_username?: string | null;
+    proxy_password?: string | null;
 }
 export interface UpdateBrowserProfileRequest {
     display_name?: string;
+    /** Per-field proxy edit (tri-state): omit = leave unchanged, "" = clear (an empty
+     *  proxy_server clears the whole proxy), value = set. Omitting proxy_password keeps
+     *  the stored one (never re-entered / echoed). */
+    proxy_server?: string | null;
+    proxy_username?: string | null;
+    proxy_password?: string | null;
 }
 export interface BrowserProfileLifecycleRequest {
     start_url?: string;
@@ -2540,12 +2877,25 @@ export interface ClipRemovedData {
     clip_id: string;
     org_id: string;
 }
-export interface SearchParams {
+export type SearchParams = {
     q: string;
+    /** Entity selector CSV: message / task / wiki. Distinct from `wiki_type`. */
     types?: string;
     chat_id?: string;
     limit?: number;
-}
+    /** Page offset into the per-type candidate pool (default 0). Reachability is capped — past the pool, results are empty with `has_more` false. */
+    offset?: number;
+    /** Wiki document-type facet (frontmatter `type`) — a separate axis from `types`. */
+    wiki_type?: string;
+    /** RFC3339 or YYYY-MM-DD lower bound; narrows messages (created_at) and tasks (updated_at). Not applied to wiki. */
+    since?: string;
+    /** Sender filter (Slack `from:`) — user id. Messages only; tasks/wiki carry no sender. */
+    from?: string;
+    /** Result order: `relevance` (default, RRF hybrid) or `recent` (newest-first). Recent applies to messages/tasks; wiki stays relevance (no authored timestamp). */
+    order?: 'relevance' | 'recent';
+    /** Collapse cross-chat message results to one hit per chat (default true). Pass false on the full results page to page every match. No effect when `chat_id` is set. */
+    collapse_by_chat?: boolean;
+};
 export interface SearchMessageResult {
     message_id: string;
     chat_id: string;
@@ -2585,6 +2935,12 @@ export interface SearchResponse {
     messages: SearchMessageResult[];
     tasks: SearchTaskResult[];
     wiki: SearchWikiResult[];
+    /** Per-type flag: more results remain past the returned page (within the reachable pool). Lets a tabbed results UI page each type independently. Optional for resilience to older payloads; clients default to all-false. */
+    has_more?: {
+        messages: boolean;
+        tasks: boolean;
+        wiki: boolean;
+    };
 }
 export {};
 //# sourceMappingURL=types.d.ts.map