@stateforge-labs/herdr-sdk 0.0.0-stage → 0.3.0

package/dist/herdr/generated/events.d.ts

@@ -0,0 +1,274 @@
+export type AgentSessionInfo = {
+    "agent": string;
+    "kind": AgentSessionRefKind;
+    "source": string;
+    "value": string;
+};
+export type AgentSessionRefKind = "id" | "path";
+export type AgentStatus = "idle" | "working" | "blocked" | "done" | "unknown";
+export type EventData = ({
+    "type": "workspace_created";
+    "workspace": WorkspaceInfo;
+}) | ({
+    "type": "workspace_updated";
+    "workspace": WorkspaceInfo;
+}) | ({
+    "type": "workspace_metadata_updated";
+    "workspace": WorkspaceInfo;
+}) | ({
+    "type": "workspace_closed";
+    "workspace"?: (WorkspaceInfo) | (null);
+    "workspace_id": string;
+}) | ({
+    "label": string;
+    "type": "workspace_renamed";
+    "workspace_id": string;
+}) | ({
+    "insert_index": number;
+    "type": "workspace_moved";
+    "workspace_id": string;
+    "workspaces": Array<WorkspaceInfo>;
+}) | ({
+    "before_workspace_id"?: string | null;
+    "type": "workspace_reordered";
+    "workspace_ids": Array<string>;
+    "workspaces": Array<WorkspaceInfo>;
+}) | ({
+    "type": "workspace_focused";
+    "workspace_id": string;
+}) | ({
+    "type": "worktree_created";
+    "workspace": WorkspaceInfo;
+    "worktree": WorktreeInfo;
+}) | ({
+    "already_open": boolean;
+    "type": "worktree_opened";
+    "workspace": WorkspaceInfo;
+    "worktree": WorktreeInfo;
+}) | ({
+    "forced": boolean;
+    "type": "worktree_removed";
+    "workspace"?: (WorkspaceInfo) | (null);
+    "workspace_id": string;
+    "worktree": WorktreeInfo;
+}) | ({
+    "tab": TabInfo;
+    "type": "tab_created";
+}) | ({
+    "tab_id": string;
+    "type": "tab_closed";
+    "workspace_id": string;
+}) | ({
+    "label": string;
+    "tab_id": string;
+    "type": "tab_renamed";
+    "workspace_id": string;
+}) | ({
+    "insert_index": number;
+    "tab_id": string;
+    "tabs": Array<TabInfo>;
+    "type": "tab_moved";
+    "workspace_id": string;
+}) | ({
+    "tab_id": string;
+    "type": "tab_focused";
+    "workspace_id": string;
+}) | ({
+    "pane": PaneInfo;
+    "type": "pane_created";
+}) | ({
+    "pane_id": string;
+    "type": "pane_closed";
+    "workspace_id": string;
+}) | ({
+    "pane": PaneInfo;
+    "type": "pane_updated";
+}) | ({
+    "pane_id": string;
+    "type": "pane_focused";
+    "workspace_id": string;
+}) | ({
+    "closed_tab_id"?: string | null;
+    "closed_workspace_id"?: string | null;
+    "created_tab"?: (TabInfo) | (null);
+    "created_workspace"?: (WorkspaceInfo) | (null);
+    "pane": PaneInfo;
+    "previous_pane_id": string;
+    "previous_tab_id": string;
+    "previous_workspace_id": string;
+    "type": "pane_moved";
+}) | ({
+    "pane_id": string; /** uint64: values above 2^53 lose precision */
+    "revision": number;
+    "type": "pane_output_changed";
+    "workspace_id": string;
+}) | ({
+    "pane_id": string;
+    "type": "pane_exited";
+    "workspace_id": string;
+}) | ({
+    "agent"?: string | null;
+    "final_status"?: (AgentStatus) | (null);
+    "pane_id": string;
+    "released"?: boolean;
+    "type": "pane_agent_detected";
+    "workspace_id": string;
+}) | ({
+    "agent"?: string | null;
+    "agent_status": AgentStatus;
+    "display_agent"?: string | null;
+    "pane_id": string;
+    "state_labels"?: {
+        [key: string]: string;
+    };
+    "title"?: string | null;
+    "type": "pane_agent_status_changed";
+    "workspace_id": string;
+}) | ({
+    "layout": PaneLayoutSnapshot;
+    "type": "layout_updated";
+});
+export type EventKind = "workspace_created" | "workspace_updated" | "workspace_metadata_updated" | "workspace_closed" | "workspace_renamed" | "workspace_moved" | "workspace_reordered" | "workspace_focused" | "worktree_created" | "worktree_opened" | "worktree_removed" | "tab_created" | "tab_closed" | "tab_renamed" | "tab_moved" | "tab_focused" | "pane_created" | "pane_closed" | "pane_updated" | "pane_focused" | "pane_moved" | "pane_output_changed" | "pane_exited" | "pane_agent_detected" | "pane_agent_status_changed" | "layout_updated";
+export type PaneInfo = {
+    "agent"?: string | null;
+    "agent_session"?: (AgentSessionInfo) | (null);
+    "agent_status": AgentStatus;
+    "cwd"?: string | null;
+    "display_agent"?: string | null;
+    "focused": boolean;
+    "foreground_cwd"?: string | null;
+    "label"?: string | null;
+    "pane_id": string;
+    "restore_error"?: string | null; /** uint64: values above 2^53 lose precision */
+    "revision": number;
+    "scroll"?: (PaneScrollInfo) | (null);
+    "state_labels"?: {
+        [key: string]: string;
+    };
+    "tab_id": string;
+    "terminal_id": string;
+    "terminal_title"?: string | null;
+    "terminal_title_stripped"?: string | null;
+    "title"?: string | null; /** keys match ^[A-Za-z0-9_-]{1,32}$ */
+    "tokens"?: {
+        [key: string]: string;
+    };
+    "workspace_id": string;
+};
+export type PaneLayoutPane = {
+    "focused": boolean;
+    "pane_id": string;
+    "rect": PaneLayoutRect;
+};
+export type PaneLayoutRect = {
+    "height": number;
+    "width": number;
+    "x": number;
+    "y": number;
+};
+export type PaneLayoutSnapshot = {
+    "area": PaneLayoutRect;
+    "focused_pane_id": string;
+    "panes": Array<PaneLayoutPane>;
+    "splits": Array<PaneLayoutSplit>;
+    "tab_id": string;
+    "workspace_id": string;
+    "zoomed": boolean;
+};
+export type PaneLayoutSplit = {
+    "direction": SplitDirection;
+    "id": string;
+    "ratio": number;
+    "rect": PaneLayoutRect;
+};
+export type PaneScrollInfo = {
+    "max_offset_from_bottom": number; /** uint64: values above 2^53 lose precision */
+    "offset_from_bottom": number; /** uint64: values above 2^53 lose precision */
+    "viewport_rows": number;
+};
+export type SplitDirection = "right" | "down";
+export type TabInfo = {
+    "agent_status": AgentStatus;
+    "focused": boolean;
+    "label": string;
+    "number": number;
+    "pane_count": number;
+    "tab_id": string;
+    "workspace_id": string;
+};
+export type WorkspaceInfo = {
+    "active_tab_id": string;
+    "agent_status": AgentStatus;
+    "focused": boolean;
+    "label": string;
+    "number": number;
+    "pane_count": number;
+    "tab_count": number; /** keys match ^[A-Za-z0-9_-]{1,32}$ */
+    "tokens"?: {
+        [key: string]: string;
+    };
+    "workspace_id": string;
+    "worktree"?: (WorkspaceWorktreeInfo) | (null);
+};
+export type WorkspaceWorktreeInfo = {
+    "checkout_path": string;
+    "is_linked_worktree": boolean;
+    "repo_key": string;
+    "repo_name": string;
+    "repo_root": string;
+};
+export type WorktreeInfo = {
+    "branch"?: string | null;
+    "is_bare": boolean;
+    "is_detached": boolean;
+    "is_linked_worktree": boolean;
+    "is_prunable": boolean;
+    "label": string;
+    "open_workspace_id"?: string | null;
+    "path": string;
+};
+export type PaneAgentStatusChangedEvent = {
+    "agent"?: string | null;
+    "agent_status": AgentStatus;
+    "display_agent"?: string | null;
+    "pane_id": string;
+    "state_labels"?: {
+        [key: string]: string;
+    };
+    "title"?: string | null;
+    "workspace_id": string;
+};
+export type PaneOutputMatchedEvent = {
+    "matched_line": string;
+    "pane_id": string;
+    "read": PaneReadResult;
+};
+export type PaneReadResult = {
+    "format": ReadFormat;
+    "pane_id": string; /** uint64: values above 2^53 lose precision */
+    "revision": number;
+    "source": ReadSource;
+    "tab_id": string;
+    "text": string;
+    "truncated": boolean;
+    "workspace_id": string;
+};
+export type PaneScrollChangedEvent = {
+    "pane_id": string;
+    "scroll": PaneScrollInfo;
+    "workspace_id": string;
+};
+export type ReadFormat = "text" | "ansi";
+export type ReadSource = "visible" | "recent" | "recent_unwrapped" | "detection";
+export type SubscriptionEventData = (PaneOutputMatchedEvent) | (PaneAgentStatusChangedEvent) | (PaneScrollChangedEvent);
+export type SubscriptionEventKind = "pane.output_matched" | "pane.agent_status_changed" | "pane.scroll_changed";
+export type EventFrame = {
+    event: EventKind;
+    data: EventData;
+};
+export type SubscriptionEventFrame = {
+    event: SubscriptionEventKind;
+    data: SubscriptionEventData;
+};
+/** Any frame that can arrive on a subscription connection after the ack. */
+export type PushFrame = EventFrame | SubscriptionEventFrame;

package/dist/herdr/generated/events.js

@@ -0,0 +1,3 @@
+// GENERATED by tools/gen/ from schema/herdr-api.schema.json. Do not edit.
+// herdr protocol 22, schema_version 1.
+export {};

package/dist/herdr/generated/index.d.ts

@@ -0,0 +1,20 @@
+export * as params from './params.js';
+export * as results from './results.js';
+export * as errors from './errors.js';
+export * as events from './events.js';
+export { METHODS } from './method-table.js';
+export { METHOD_RESULT } from './results.js';
+export type { MethodParams, Subscription } from './params.js';
+export type { ResponseResult, ResultByTag } from './results.js';
+export type { ErrorBody } from './errors.js';
+export type { EventFrame, SubscriptionEventFrame, PushFrame } from './events.js';
+export { Method, EventKind, SubscriptionEventKind, SubscriptionType, EventMatchKind, ResultTag, AgentStatus, CapabilityClass, ServerCapability, TOKEN_NAME_PATTERN, } from './names/index.js';
+export { ENTRY_METHODS } from './entry-methods.js';
+export { PRESET_METHODS } from './preset-methods.js';
+export { DEFAULT_RESULT } from './test-data/defaults.js';
+export { JsonKind, PARAMS_SHAPE } from './test-data/shapes.js';
+export type { FieldShape, ParamsShape } from './test-data/shapes.js';
+export { CAPABILITY_GATE, LONG_POLL, STREAM_RETURNS } from './overrides.js';
+export type * from './namespaces.js';
+export declare const PROTOCOL: 22;
+export declare const SCHEMA_VERSION: 1;

package/dist/herdr/generated/index.js

@@ -0,0 +1,19 @@
+// GENERATED by tools/gen/ from schema/herdr-api.schema.json. Do not edit.
+// herdr protocol 22, schema_version 1.
+// Each schema namespace is its own module: type names such as PaneInfo, TabInfo
+// and WorkspaceInfo are defined DIFFERENTLY in the event and response namespaces,
+// so a flat merge would be wrong, not just ambiguous.
+export * as params from './params.js';
+export * as results from './results.js';
+export * as errors from './errors.js';
+export * as events from './events.js';
+export { METHODS } from './method-table.js';
+export { METHOD_RESULT } from './results.js';
+export { Method, EventKind, SubscriptionEventKind, SubscriptionType, EventMatchKind, ResultTag, AgentStatus, CapabilityClass, ServerCapability, TOKEN_NAME_PATTERN, } from './names/index.js';
+export { ENTRY_METHODS } from './entry-methods.js';
+export { PRESET_METHODS } from './preset-methods.js';
+export { DEFAULT_RESULT } from './test-data/defaults.js';
+export { JsonKind, PARAMS_SHAPE } from './test-data/shapes.js';
+export { CAPABILITY_GATE, LONG_POLL, STREAM_RETURNS } from './overrides.js';
+export const PROTOCOL = 22;
+export const SCHEMA_VERSION = 1;