@granular-software/sdk 0.2.0 → 0.3.1

package/dist/{types-D46q5WTh.d.mts → types-CnX4jXYQ.d.mts}

@@ -6,11 +6,17 @@
  * Configuration for the Granular client
  */
 interface GranularOptions {
-    /** Your Granular API key */
-    apiKey: string;
+    /** Your Granular API key (for service/CLI auth; use with GRANULAR_API_KEY) */
+    apiKey?: string;
+    /** Application/session JWT (for user-context auth; use from simulator or getAccessToken) */
+    token?: string;
     /** Optional API URL (for on-prem or testing) */
     apiUrl?: string;
+    /** Optional WebSocket constructor (for Node.js environments) */
+    WebSocketCtor?: any;
 }
+/** Resolved auth credential: either apiKey or token must be provided */
+type GranularAuth = string;
 /**
  * A user/subject object returned from recordUser()
  */
@@ -60,6 +66,9 @@ interface ConnectOptions {
     sandbox: string;
     /** The user to connect as (from recordUser()) */
     user: User;
+    /** Optional stable client ID. Defaults to `client_${Date.now()}`. Use a fixed
+     *  value for long-lived effect hosts so tool catalogs don't accumulate. */
+    clientId?: string;
 }
 /**
  * A sandbox container
@@ -330,6 +339,40 @@ interface DomainState {
     }>;
     [key: string]: unknown;
 }
+/**
+ * Information about a published tool
+ */
+interface ToolInfo {
+    /** Unique name of the tool */
+    name: string;
+    /** Description of what the tool does */
+    description?: string;
+    /** JSON Schema for tool input */
+    inputSchema?: Record<string, unknown>;
+    /** JSON Schema for tool output */
+    outputSchema?: Record<string, unknown>;
+    /** Client ID that published this tool (absent for domain-only entries) */
+    clientId?: string;
+    /** Whether the tool is ready for use (has a registered handler) */
+    ready: boolean;
+    /** Timestamp when the tool was published */
+    publishedAt?: number;
+    /** Class this tool belongs to (instance/static method) */
+    className?: string;
+    /** Whether this is a static method */
+    static?: boolean;
+}
+/**
+ * Event data when the list of available tools changes
+ */
+interface ToolsChangedEvent {
+    /** The current list of all available tools */
+    tools: ToolInfo[];
+    /** Names of tools that were added or updated */
+    added: string[];
+    /** Names of tools that were removed */
+    removed: string[];
+}
 type JobStatus = 'queued' | 'running' | 'succeeded' | 'failed' | 'timeout' | 'canceled';
 /**
  * Result from submitting a job
@@ -362,6 +405,7 @@ interface WSClientOptions {
     url: string;
     sessionId: string;
     token: string;
+    WebSocketCtor?: any;
 }
 interface RPCRequest {
     type: 'rpc';
@@ -592,4 +636,4 @@ interface DeleteResponse {
     deleted: boolean;
 }
 
-export type { APIError as $, AssignmentListResponse as A, BuildPolicy as B, ConnectOptions as C, DomainState as D, EnvironmentData as E, Prompt as F, GranularOptions as G, RPCRequest as H, InstanceToolHandler as I, Job as J, RPCResponse as K, SyncMessage as L, ModelRef as M, RPCRequestFromServer as N, ToolInvokeParams as O, PublishToolsResult as P, ToolResultParams as Q, RecordUserOptions as R, SandboxListResponse as S, ToolWithHandler as T, User as U, ManifestPropertySpec as V, WSClientOptions as W, ManifestRelationshipDef as X, ManifestOperation as Y, ManifestImport as Z, ManifestVolume as _, ToolHandler as a, GraphQLResult as b, DefineRelationshipOptions as c, RelationshipInfo as d, ManifestContent as e, RecordObjectOptions as f, RecordObjectResult as g, Sandbox as h, CreateSandboxData as i, DeleteResponse as j, PermissionProfile as k, CreatePermissionProfileData as l, CreateEnvironmentData as m, Subject as n, ToolSchema as o, PermissionRules as p, PermissionProfileListResponse as q, Assignment as r, EnvironmentListResponse as s, Manifest as t, ManifestListResponse as u, BuildStatus as v, Build as w, BuildListResponse as x, JobStatus as y, JobSubmitResult as z };
+export type { ManifestOperation as $, AssignmentListResponse as A, BuildPolicy as B, ConnectOptions as C, DomainState as D, EnvironmentData as E, BuildListResponse as F, GranularOptions as G, JobStatus as H, InstanceToolHandler as I, Job as J, JobSubmitResult as K, Prompt as L, ModelRef as M, RPCRequest as N, RPCResponse as O, PublishToolsResult as P, SyncMessage as Q, RecordUserOptions as R, SandboxListResponse as S, ToolWithHandler as T, User as U, RPCRequestFromServer as V, WSClientOptions as W, ToolInvokeParams as X, ToolResultParams as Y, ManifestPropertySpec as Z, ManifestRelationshipDef as _, ToolHandler as a, ManifestImport as a0, ManifestVolume as a1, APIError as a2, ToolInfo as b, ToolsChangedEvent as c, GraphQLResult as d, DefineRelationshipOptions as e, RelationshipInfo as f, ManifestContent as g, RecordObjectOptions as h, RecordObjectResult as i, Sandbox as j, CreateSandboxData as k, DeleteResponse as l, PermissionProfile as m, CreatePermissionProfileData as n, CreateEnvironmentData as o, Subject as p, ToolSchema as q, GranularAuth as r, PermissionRules as s, PermissionProfileListResponse as t, Assignment as u, EnvironmentListResponse as v, Manifest as w, ManifestListResponse as x, BuildStatus as y, Build as z };

package/dist/{types-D46q5WTh.d.ts → types-CnX4jXYQ.d.ts}

@@ -6,11 +6,17 @@
  * Configuration for the Granular client
  */
 interface GranularOptions {
-    /** Your Granular API key */
-    apiKey: string;
+    /** Your Granular API key (for service/CLI auth; use with GRANULAR_API_KEY) */
+    apiKey?: string;
+    /** Application/session JWT (for user-context auth; use from simulator or getAccessToken) */
+    token?: string;
     /** Optional API URL (for on-prem or testing) */
     apiUrl?: string;
+    /** Optional WebSocket constructor (for Node.js environments) */
+    WebSocketCtor?: any;
 }
+/** Resolved auth credential: either apiKey or token must be provided */
+type GranularAuth = string;
 /**
  * A user/subject object returned from recordUser()
  */
@@ -60,6 +66,9 @@ interface ConnectOptions {
     sandbox: string;
     /** The user to connect as (from recordUser()) */
     user: User;
+    /** Optional stable client ID. Defaults to `client_${Date.now()}`. Use a fixed
+     *  value for long-lived effect hosts so tool catalogs don't accumulate. */
+    clientId?: string;
 }
 /**
  * A sandbox container
@@ -330,6 +339,40 @@ interface DomainState {
     }>;
     [key: string]: unknown;
 }
+/**
+ * Information about a published tool
+ */
+interface ToolInfo {
+    /** Unique name of the tool */
+    name: string;
+    /** Description of what the tool does */
+    description?: string;
+    /** JSON Schema for tool input */
+    inputSchema?: Record<string, unknown>;
+    /** JSON Schema for tool output */
+    outputSchema?: Record<string, unknown>;
+    /** Client ID that published this tool (absent for domain-only entries) */
+    clientId?: string;
+    /** Whether the tool is ready for use (has a registered handler) */
+    ready: boolean;
+    /** Timestamp when the tool was published */
+    publishedAt?: number;
+    /** Class this tool belongs to (instance/static method) */
+    className?: string;
+    /** Whether this is a static method */
+    static?: boolean;
+}
+/**
+ * Event data when the list of available tools changes
+ */
+interface ToolsChangedEvent {
+    /** The current list of all available tools */
+    tools: ToolInfo[];
+    /** Names of tools that were added or updated */
+    added: string[];
+    /** Names of tools that were removed */
+    removed: string[];
+}
 type JobStatus = 'queued' | 'running' | 'succeeded' | 'failed' | 'timeout' | 'canceled';
 /**
  * Result from submitting a job
@@ -362,6 +405,7 @@ interface WSClientOptions {
     url: string;
     sessionId: string;
     token: string;
+    WebSocketCtor?: any;
 }
 interface RPCRequest {
     type: 'rpc';
@@ -592,4 +636,4 @@ interface DeleteResponse {
     deleted: boolean;
 }
 
-export type { APIError as $, AssignmentListResponse as A, BuildPolicy as B, ConnectOptions as C, DomainState as D, EnvironmentData as E, Prompt as F, GranularOptions as G, RPCRequest as H, InstanceToolHandler as I, Job as J, RPCResponse as K, SyncMessage as L, ModelRef as M, RPCRequestFromServer as N, ToolInvokeParams as O, PublishToolsResult as P, ToolResultParams as Q, RecordUserOptions as R, SandboxListResponse as S, ToolWithHandler as T, User as U, ManifestPropertySpec as V, WSClientOptions as W, ManifestRelationshipDef as X, ManifestOperation as Y, ManifestImport as Z, ManifestVolume as _, ToolHandler as a, GraphQLResult as b, DefineRelationshipOptions as c, RelationshipInfo as d, ManifestContent as e, RecordObjectOptions as f, RecordObjectResult as g, Sandbox as h, CreateSandboxData as i, DeleteResponse as j, PermissionProfile as k, CreatePermissionProfileData as l, CreateEnvironmentData as m, Subject as n, ToolSchema as o, PermissionRules as p, PermissionProfileListResponse as q, Assignment as r, EnvironmentListResponse as s, Manifest as t, ManifestListResponse as u, BuildStatus as v, Build as w, BuildListResponse as x, JobStatus as y, JobSubmitResult as z };
+export type { ManifestOperation as $, AssignmentListResponse as A, BuildPolicy as B, ConnectOptions as C, DomainState as D, EnvironmentData as E, BuildListResponse as F, GranularOptions as G, JobStatus as H, InstanceToolHandler as I, Job as J, JobSubmitResult as K, Prompt as L, ModelRef as M, RPCRequest as N, RPCResponse as O, PublishToolsResult as P, SyncMessage as Q, RecordUserOptions as R, SandboxListResponse as S, ToolWithHandler as T, User as U, RPCRequestFromServer as V, WSClientOptions as W, ToolInvokeParams as X, ToolResultParams as Y, ManifestPropertySpec as Z, ManifestRelationshipDef as _, ToolHandler as a, ManifestImport as a0, ManifestVolume as a1, APIError as a2, ToolInfo as b, ToolsChangedEvent as c, GraphQLResult as d, DefineRelationshipOptions as e, RelationshipInfo as f, ManifestContent as g, RecordObjectOptions as h, RecordObjectResult as i, Sandbox as j, CreateSandboxData as k, DeleteResponse as l, PermissionProfile as m, CreatePermissionProfileData as n, CreateEnvironmentData as o, Subject as p, ToolSchema as q, GranularAuth as r, PermissionRules as s, PermissionProfileListResponse as t, Assignment as u, EnvironmentListResponse as v, Manifest as w, ManifestListResponse as x, BuildStatus as y, Build as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granular-software/sdk",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "TypeScript SDK and CLI for Granular - define, build, and deploy AI sandboxes",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -70,13 +70,12 @@
     "url": "https://github.com/granular-dev/granular-sdk"
   },
   "dependencies": {
-    "@automerge/automerge": "^2.2.9",
+    "@automerge/automerge": "^3.2.1",
     "chalk": "^5.4.1",
     "chokidar": "^4.0.3",
     "commander": "^13.1.0",
     "dotenv": "^16.4.7",
     "ora": "^8.2.0",
-    "ws": "^8.18.2",
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {