@granular-software/sdk 0.4.32 → 0.4.33

package/dist/{client-C2Gk641P.d.mts → client-DTvI5MUG.d.mts}

@@ -9,7 +9,7 @@ import { Doc } from '@automerge/automerge/slim';
  * Configuration for the Granular client
  */
 type AccessTokenProvider = () => Promise<string | null | undefined> | string | null | undefined;
-type EndpointMode = 'auto' | 'local' | 'production';
+type EndpointMode = "auto" | "local" | "production";
 interface GranularOptions {
     /** Your Granular API key (for service/CLI auth; use with GRANULAR_API_KEY) */
     apiKey?: string;
@@ -168,7 +168,7 @@ interface ConversationSessionInfo {
     environmentId: string;
     versionId?: string | null;
     docId: string;
-    status: 'active' | 'closed' | 'expired';
+    status: "active" | "closed" | "expired";
     createdAt: string;
     lastSeenAt: string;
     summary?: string | null;
@@ -276,7 +276,7 @@ interface AssignmentListResponse {
  * pin themselves to one immutable ontology version.
  */
 interface BuildPolicy {
-    mode: 'tag' | 'current' | 'pinned';
+    mode: "tag" | "current" | "pinned";
     buildId?: string;
     versionId?: string;
     tagId?: string;
@@ -287,7 +287,7 @@ interface VersionTag {
     tagId: string;
     sandboxId: string;
     name: string;
-    kind: 'channel' | 'release' | 'system';
+    kind: "channel" | "release" | "system";
     targetBuildId?: string | null;
     targetVersionId?: string | null;
     description?: string | null;
@@ -312,7 +312,7 @@ interface EnvironmentData {
     tag?: VersionTag | null;
     tracking?: BuildPolicy;
     buildPolicy: BuildPolicy;
-    updateState?: 'up_to_date' | 'update_available' | 'upgrading' | 'failed';
+    updateState?: "up_to_date" | "update_available" | "upgrading" | "failed";
     createdAt: number;
     updatedAt: number;
 }
@@ -361,7 +361,7 @@ interface Manifest {
 interface ManifestListResponse {
     items: Manifest[];
 }
-type BuildStatus = 'queued' | 'building' | 'completed' | 'failed' | 'canceled';
+type BuildStatus = "queued" | "building" | "completed" | "failed" | "canceled";
 /**
  * An immutable ontology version derived from a specific manifest revision.
  *
@@ -396,8 +396,8 @@ interface BuildListResponse {
 }
 interface SemanticVersionDiffEntry {
     operationId: string;
-    kind: 'create' | 'update' | 'relationship' | 'effect' | 'eventStream' | 'unknown';
-    changeType: 'added' | 'removed' | 'changed';
+    kind: "create" | "update" | "relationship" | "effect" | "eventStream" | "unknown";
+    changeType: "added" | "removed" | "changed";
     label: string;
     additive: boolean;
     breaking: boolean;
@@ -459,7 +459,7 @@ interface ResolvedEffectBehaviors {
     reverse?: ResolvedEffectReverse;
     approvalRequired?: ResolvedEffectApprovalRequired;
 }
-type EffectInvocationMode = 'execute' | 'dryRun' | 'reverse';
+type EffectInvocationMode = "execute" | "dryRun" | "reverse";
 interface EffectInvocationMetadata {
     mode?: EffectInvocationMode;
     reverseHandler?: string;
@@ -516,9 +516,9 @@ interface ToolSchema {
      * ```
      */
     outputSchema?: Record<string, unknown>;
-    stability?: 'stable' | 'experimental' | 'deprecated';
+    stability?: "stable" | "experimental" | "deprecated";
     provenance?: {
-        source: 'mcp' | 'custom';
+        source: "mcp" | "custom";
     };
     tags?: string[];
     /**
@@ -625,8 +625,8 @@ interface EffectsChangedEvent extends ToolsChangedEvent {
 }
 type EffectHandler = ToolHandler;
 type InstanceEffectHandler = InstanceToolHandler;
-type JobStatus = 'queued' | 'running' | 'awaitingTool' | 'awaitingHuman' | 'succeeded' | 'failed' | 'timeout' | 'canceled';
-type JobFeedbackSentiment = 'good' | 'bad';
+type JobStatus = "queued" | "running" | "awaitingTool" | "awaitingHuman" | "succeeded" | "failed" | "timeout" | "canceled";
+type JobFeedbackSentiment = "good" | "bad";
 interface JobFeedbackToolCall {
     callId?: string;
     toolName?: string;
@@ -638,7 +638,7 @@ interface JobFeedbackToolCall {
     durationMs?: number | null;
 }
 interface JobFeedbackMetadata {
-    source: 'sdk';
+    source: "sdk";
     status: JobStatus;
     code: string;
     domainRevision?: string;
@@ -706,7 +706,7 @@ interface Job {
 }
 interface Prompt {
     id: string;
-    type: 'confirm' | 'choice' | 'input';
+    type: "confirm" | "choice" | "input";
     title: string;
     message: string;
     options?: Array<string | {
@@ -725,7 +725,7 @@ interface ConversationMessageShowRefs {
     variableNames?: string[];
 }
 interface ConversationMessageInput {
-    role: 'user' | 'assistant';
+    role: "user" | "assistant";
     content?: string;
     show?: ConversationMessageShowRefs;
     jobId?: string;
@@ -739,9 +739,55 @@ interface ConversationAppendResult {
     jobId?: string;
     promptId?: string;
 }
+interface SessionConversationMessage {
+    id: string;
+    role: "user" | "assistant";
+    content?: string;
+    show?: ConversationMessageShowRefs;
+    jobId?: string;
+    promptId?: string;
+    ts: number;
+    [key: string]: unknown;
+}
+interface SessionTimelineEvent {
+    id?: string;
+    eventId?: string;
+    kind?: string;
+    type?: string;
+    status?: string | null;
+    message?: string;
+    summary?: string;
+    title?: string;
+    ts?: number;
+    timestamp?: number;
+    at?: number;
+    createdAt?: number;
+    [key: string]: unknown;
+}
+interface SessionJobRecord {
+    jobId: string;
+    status: string;
+    code?: string;
+    createdAt?: number;
+    startedAt?: number;
+    completedAt?: number;
+    durationMs?: number | null;
+    progressPercent?: number | null;
+    progressMessage?: string | null;
+    stdout?: string[];
+    stderr?: string[];
+    result?: unknown;
+    error?: string | null;
+    toolCalls?: JobFeedbackToolCall[];
+    prompts?: Record<string, unknown>;
+    actionSummary?: string[];
+    actionTrace?: Array<Record<string, unknown>>;
+    agentMessages?: Array<Record<string, unknown>>;
+    [key: string]: unknown;
+}
 interface SessionTranscriptEntry {
     id: string;
-    role: 'user' | 'assistant';
+    role: "user" | "assistant";
     content: string;
     timestamp: number;
     jobId?: string;
@@ -752,9 +798,9 @@ interface SessionTranscriptEntry {
     error?: string;
     show?: ConversationMessageShowRefs;
     historyContent?: string;
-    source: 'conversation' | 'job_code' | 'job_result' | 'job_prompt' | 'job_agent_message';
+    source: "conversation" | "job_code" | "job_result" | "job_prompt" | "job_agent_message";
 }
-type SessionHeapFieldType = 'string' | 'number' | 'boolean' | 'null' | 'unknown';
+type SessionHeapFieldType = "string" | "number" | "boolean" | "null" | "unknown";
 interface SessionHeapFieldValue {
     name: string;
     type: SessionHeapFieldType;
@@ -782,7 +828,7 @@ interface SessionHeapList {
 }
 interface SessionHeapVariable {
     name: string;
-    kind: 'entry' | 'list' | 'scalar';
+    kind: "entry" | "list" | "scalar";
     entryPath?: string;
     listName?: string;
     value?: string | number | boolean | null;
@@ -795,6 +841,23 @@ interface SessionHeapSnapshot {
     variablesByName: Record<string, SessionHeapVariable>;
     updatedAt: number;
 }
+interface SessionDocumentResult {
+    sessionState: Record<string, unknown> | null;
+    document: Record<string, unknown> | null;
+    savedAt: number;
+}
+interface SessionCollectionListOptions {
+    limit?: number;
+    cursor?: string | null;
+}
+interface SessionJobListOptions extends SessionCollectionListOptions {
+    status?: string | null;
+}
+interface SessionCollectionListResult<T = unknown> {
+    items: T[];
+    nextCursor: string | null;
+    totalCount: number;
+}
 interface WSDisconnectInfo {
     code?: number;
     reason?: string;
@@ -819,13 +882,13 @@ interface WSClientOptions {
     onReconnectError?: (info: WSReconnectErrorInfo) => void;
 }
 interface RPCRequest {
-    type: 'rpc';
+    type: "rpc";
     method: string;
     params: unknown;
     id: string;
 }
 interface RPCResponse {
-    type: 'rpc_result' | 'rpc_error';
+    type: "rpc_result" | "rpc_error";
     id: string;
     result?: unknown;
     error?: {
@@ -835,12 +898,12 @@ interface RPCResponse {
     };
 }
 interface SyncMessage {
-    type: 'sync';
+    type: "sync";
     message?: string | number[] | Uint8Array;
     data?: number[];
 }
 interface RPCRequestFromServer {
-    type: 'rpc';
+    type: "rpc";
     method: string;
     params: unknown;
     id: string;
@@ -884,7 +947,7 @@ interface RelationshipInfo {
     /** The foreign model type */
     foreign_model: ModelRef;
     /** Computed relationship kind: "one_to_one" | "one_to_many" | "many_to_one" | "many_to_many" */
-    relationship_kind: 'one_to_one' | 'one_to_many' | 'many_to_one' | 'many_to_many';
+    relationship_kind: "one_to_one" | "one_to_many" | "many_to_one" | "many_to_many";
 }
 /**
  * Options for defining a relationship between two model types
@@ -983,8 +1046,8 @@ interface RecordObjectsOptions {
      */
     onChunkComplete?: (info: RecordObjectsChunkInfo) => void | Promise<void>;
 }
-type RecordImportStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'canceled';
-type RecordImportItemStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'canceled';
+type RecordImportStatus = "queued" | "processing" | "completed" | "failed" | "canceled";
+type RecordImportItemStatus = "queued" | "processing" | "completed" | "failed" | "canceled";
 interface RecordImportStats {
     totalRecords: number;
     queuedRecords: number;
@@ -1052,7 +1115,7 @@ interface ManifestPropertySpec {
     filterBy?: boolean | string[] | ManifestFilterBySpec;
     validate?: ManifestValidationRuleSpec[];
 }
-type ManifestValidationOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'true' | 'false' | 'regex' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with';
+type ManifestValidationOperator = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "true" | "false" | "regex" | "contains" | "not_contains" | "starts_with" | "ends_with";
 interface ManifestEnumRuleSpec {
     values: string[];
     message?: string;
@@ -1141,7 +1204,7 @@ interface ManifestEffectDeclaration {
     isStatic?: boolean;
     inputSchema: ManifestEffectSchema;
     outputSchema?: ManifestEffectSchema;
-    stability?: 'stable' | 'experimental' | 'deprecated';
+    stability?: "stable" | "experimental" | "deprecated";
     tags?: string[];
     metamodels?: ManifestEffectMetamodelSpec;
 }
@@ -1202,7 +1265,7 @@ interface ManifestImport {
 }
 interface ManifestVolume {
     name: string;
-    scope: 'sandbox' | 'build' | 'user';
+    scope: "sandbox" | "build" | "user";
     imports?: ManifestImport[];
     operations: ManifestOperation[];
 }
@@ -1245,7 +1308,7 @@ interface StreamEvent {
     environmentId: string;
     sessionId?: string;
     subjectId?: string;
-    source: 'sandbox' | 'api';
+    source: "sandbox" | "api";
     isAcked: boolean;
     createdAt: number;
 }
@@ -1883,6 +1946,7 @@ declare class EnvironmentSession extends Session {
     get ontologyId(): string;
     get subjectId(): string;
     get envName(): string;
+    get tag(): string | null;
     get versionId(): string;
     get granularId(): string;
     get permissionProfileId(): string;
@@ -1903,9 +1967,41 @@ declare class EnvironmentSession extends Session {
         list: () => Promise<EnvironmentFeedbackRecord[]>;
     };
     /**
-     * Return a plain JS snapshot of the synced session heap.
+     * Return a plain JS copy of the synced session heap.
      */
     getHeap(): SessionHeapSnapshot;
+    private sessionDataRequest;
+    private collectAllSessionItems;
+    /**
+     * Fetch the live session document from the runtime DO.
+     *
+     * For history and saved artifacts, prefer the collection APIs on
+     * `messages`, `timeline`, `jobs`, and `heap`.
+     */
+    getDocument(): Promise<SessionDocumentResult>;
+    get messages(): {
+        list: (options?: SessionCollectionListOptions) => Promise<SessionCollectionListResult<SessionConversationMessage>>;
+    };
+    get timeline(): {
+        list: (options?: SessionCollectionListOptions) => Promise<SessionCollectionListResult<SessionTimelineEvent>>;
+    };
+    get jobs(): {
+        list: (options?: SessionJobListOptions) => Promise<SessionCollectionListResult<SessionJobRecord>>;
+        get: (jobId: string) => Promise<SessionJobRecord>;
+    };
+    get heap(): {
+        entries: {
+            list: (options?: SessionCollectionListOptions) => Promise<SessionCollectionListResult<SessionHeapEntry>>;
+            get: (path: string) => Promise<SessionHeapEntry>;
+        };
+        lists: {
+            list: (options?: SessionCollectionListOptions) => Promise<SessionCollectionListResult<SessionHeapList>>;
+            get: (name: string) => Promise<SessionHeapList>;
+        };
+    };
+    get transcript(): {
+        list: (options?: SessionCollectionListOptions) => Promise<SessionCollectionListResult<SessionTranscriptEntry>>;
+    };
     graphql<T = any>(query: string, variables?: Record<string, any>): Promise<GraphQLResult<T>>;
     defineRelationship(options: DefineRelationshipOptions): Promise<RelationshipInfo>;
     getRelationships(modelPath: string): Promise<RelationshipInfo[]>;
@@ -2230,4 +2326,4 @@ declare class Granular {
     private request;
 }
 
-export { type SemanticVersionDiff as $, type AccessTokenProvider as A, type BuildPolicy as B, type ConnectOptions as C, type DomainState as D, type EndpointMode as E, type VersionTag as F, Granular as G, type EnvironmentData as H, type InstanceToolHandler as I, type CreateEnvironmentData as J, type EnvironmentListResponse as K, type Manifest as L, type ManifestEffectMetamodelSpec as M, type ManifestListResponse as N, OntologyHandle as O, type Prompt as P, type BuildStatus as Q, type ResolvedEffectBehaviors as R, type SessionHeapEntry as S, type ToolWithHandler as T, type User as U, type VersionTracking as V, WSClient as W, type Build as X, type Version as Y, type BuildListResponse as Z, type SemanticVersionDiffEntry as _, type EffectHandlerContext as a, type ManifestApprovalRequiredSpec as a$, type ResolvedEffectPostCondition as a0, type ResolvedEffectDryRun as a1, type ResolvedEffectReverse as a2, type ResolvedEffectApprovalRequired as a3, type EffectInvocationMode as a4, type EffectInvocationMetadata as a5, type EffectSchema as a6, type EffectWithHandler as a7, type PublishEffectsResult as a8, type ToolInfo as a9, type RPCRequestFromServer as aA, type ToolInvokeParams as aB, type ToolResultParams as aC, type ModelRef as aD, type RelationshipInfo as aE, type DefineRelationshipOptions as aF, type RecordObjectOptions as aG, type RecordObjectResult as aH, type RecordObjectsChunkInfo as aI, type RecordObjectsOptions as aJ, type RecordImportStatus as aK, type RecordImportItemStatus as aL, type RecordImportStats as aM, type RecordImportItem as aN, type RecordImport as aO, type EnvironmentRecordImportSummary as aP, type ManifestPropertySpec as aQ, type ManifestValidationOperator as aR, type ManifestEnumRuleSpec as aS, type ManifestFilterBySpec as aT, type ManifestValidationRuleSpec as aU, type ManifestStateMachineStateSpec as aV, type ManifestStateMachineTransitionSpec as aW, type ManifestStateMachineSpec as aX, type ManifestPostConditionSpec as aY, type ManifestDryRunSpec as aZ, type ManifestReverseSpec as a_, type EffectInfo as aa, type ToolsChangedEvent as ab, type EffectsChangedEvent as ac, type EffectHandler as ad, type InstanceEffectHandler as ae, type JobStatus as af, type JobFeedbackSentiment as ag, type JobFeedbackToolCall as ah, type JobFeedbackMetadata as ai, type JobFeedbackInput as aj, type JobFeedbackRecord as ak, type EnvironmentFeedbackRecord as al, type JobSubmitResult as am, type Job as an, type ConversationMessageShowRefs as ao, type ConversationMessageInput as ap, type ConversationAppendResult as aq, type SessionHeapFieldType as ar, type SessionHeapFieldValue as as, type SessionHeapVariable as at, type WSDisconnectInfo as au, type WSReconnectErrorInfo as av, type WSClientOptions as aw, type RPCRequest as ax, type RPCResponse as ay, type SyncMessage as az, type SessionHeapList as b, type ManifestRelationshipDef as b0, type ManifestEffectSchema as b1, type ManifestEffectDeclaration as b2, type ManifestEventTypeDef as b3, type ManifestEventStreamDef as b4, type ManifestOperation as b5, type ManifestImport as b6, type ManifestVolume as b7, type ManifestContent as b8, type GraphQLResult as b9, type APIError as ba, type DeleteResponse as bb, type StreamEvent as bc, type StreamSubscription as bd, type StreamStats as be, type SessionHeapSnapshot as c, type SessionTranscriptEntry as d, Environment as e, EnvironmentSession as f, Session as g, type ToolSchema as h, type PublishToolsResult as i, type ToolHandler as j, type GranularOptions as k, type GranularAuth as l, type RecordUserOptions as m, type Subject as n, type OpenEnvironmentOptions as o, type CreateSessionOptions as p, type ConversationSessionInfo as q, type Sandbox as r, type CreateSandboxData as s, type SandboxListResponse as t, type PermissionRules as u, type PermissionProfile as v, type CreatePermissionProfileData as w, type PermissionProfileListResponse as x, type Assignment as y, type AssignmentListResponse as z };
+export { type SemanticVersionDiff as $, type AccessTokenProvider as A, type BuildPolicy as B, type ConnectOptions as C, type DomainState as D, type EndpointMode as E, type VersionTag as F, Granular as G, type EnvironmentData as H, type InstanceToolHandler as I, type CreateEnvironmentData as J, type EnvironmentListResponse as K, type Manifest as L, type ManifestEffectMetamodelSpec as M, type ManifestListResponse as N, OntologyHandle as O, type Prompt as P, type BuildStatus as Q, type ResolvedEffectBehaviors as R, type SessionHeapEntry as S, type ToolWithHandler as T, type User as U, type VersionTracking as V, WSClient as W, type Build as X, type Version as Y, type BuildListResponse as Z, type SemanticVersionDiffEntry as _, type EffectHandlerContext as a, type ManifestValidationRuleSpec as a$, type ResolvedEffectPostCondition as a0, type ResolvedEffectDryRun as a1, type ResolvedEffectReverse as a2, type ResolvedEffectApprovalRequired as a3, type EffectInvocationMode as a4, type EffectInvocationMetadata as a5, type EffectSchema as a6, type EffectWithHandler as a7, type PublishEffectsResult as a8, type ToolInfo as a9, type SessionCollectionListResult as aA, type WSDisconnectInfo as aB, type WSReconnectErrorInfo as aC, type WSClientOptions as aD, type RPCRequest as aE, type RPCResponse as aF, type SyncMessage as aG, type RPCRequestFromServer as aH, type ToolInvokeParams as aI, type ToolResultParams as aJ, type ModelRef as aK, type RelationshipInfo as aL, type DefineRelationshipOptions as aM, type RecordObjectOptions as aN, type RecordObjectResult as aO, type RecordObjectsChunkInfo as aP, type RecordObjectsOptions as aQ, type RecordImportStatus as aR, type RecordImportItemStatus as aS, type RecordImportStats as aT, type RecordImportItem as aU, type RecordImport as aV, type EnvironmentRecordImportSummary as aW, type ManifestPropertySpec as aX, type ManifestValidationOperator as aY, type ManifestEnumRuleSpec as aZ, type ManifestFilterBySpec as a_, type EffectInfo as aa, type ToolsChangedEvent as ab, type EffectsChangedEvent as ac, type EffectHandler as ad, type InstanceEffectHandler as ae, type JobStatus as af, type JobFeedbackSentiment as ag, type JobFeedbackToolCall as ah, type JobFeedbackMetadata as ai, type JobFeedbackInput as aj, type JobFeedbackRecord as ak, type EnvironmentFeedbackRecord as al, type JobSubmitResult as am, type Job as an, type ConversationMessageShowRefs as ao, type ConversationMessageInput as ap, type ConversationAppendResult as aq, type SessionConversationMessage as ar, type SessionTimelineEvent as as, type SessionJobRecord as at, type SessionHeapFieldType as au, type SessionHeapFieldValue as av, type SessionHeapVariable as aw, type SessionDocumentResult as ax, type SessionCollectionListOptions as ay, type SessionJobListOptions as az, type SessionHeapList as b, type ManifestStateMachineStateSpec as b0, type ManifestStateMachineTransitionSpec as b1, type ManifestStateMachineSpec as b2, type ManifestPostConditionSpec as b3, type ManifestDryRunSpec as b4, type ManifestReverseSpec as b5, type ManifestApprovalRequiredSpec as b6, type ManifestRelationshipDef as b7, type ManifestEffectSchema as b8, type ManifestEffectDeclaration as b9, type ManifestEventTypeDef as ba, type ManifestEventStreamDef as bb, type ManifestOperation as bc, type ManifestImport as bd, type ManifestVolume as be, type ManifestContent as bf, type GraphQLResult as bg, type APIError as bh, type DeleteResponse as bi, type StreamEvent as bj, type StreamSubscription as bk, type StreamStats as bl, type SessionHeapSnapshot as c, type SessionTranscriptEntry as d, Environment as e, EnvironmentSession as f, Session as g, type ToolSchema as h, type PublishToolsResult as i, type ToolHandler as j, type GranularOptions as k, type GranularAuth as l, type RecordUserOptions as m, type Subject as n, type OpenEnvironmentOptions as o, type CreateSessionOptions as p, type ConversationSessionInfo as q, type Sandbox as r, type CreateSandboxData as s, type SandboxListResponse as t, type PermissionRules as u, type PermissionProfile as v, type CreatePermissionProfileData as w, type PermissionProfileListResponse as x, type Assignment as y, type AssignmentListResponse as z };