@granular-software/sdk 0.4.5 → 0.4.6

package/README.md

@@ -8,7 +8,7 @@ The official TypeScript SDK for Granular.
 
 - 🏗️ **Domain Ontology** — Define classes, properties, and relationships as a typed graph
 - 🔧 **Class-Based Tools** — Attach instance methods, static methods, and global tools with typed I/O
-- 🤖 **Domain Synthesis** — Auto-generated TypeScript classes with `find()`, relationship accessors, and typed methods
+- 🤖 **Domain Synthesis** — Auto-generated TypeScript classes with `get({ path })`, `list()`, relationship accessors, and typed methods
 - 🔒 **Secure Execution** — Run AI-generated code in isolated sandboxes
 - 👥 **User Permissions** — Control what each user can access
 - ⚡ **Real-time** — WebSocket-based streaming and events
@@ -147,8 +147,10 @@ await granular.registerEffects(env.sandboxId, [
 const job = await env.submitJob(`
   import { Customer } from './sandbox-tools';
 
-  // Find returns a typed Customer instance with loaded field values
-  const acme = await Customer.find({ id: 'cust_42' });
+  // list() discovers instances; get({ path }) hydrates a specific graph object
+  const customers = await Customer.list();
+  const acme = customers.find((customer) => customer.name === 'Acme Corp');
+  if (!acme) throw new Error('Customer not found');
   console.log(acme.name);   // "Acme Corp"
   console.log(acme.email);  // "billing@acme.com"
 
@@ -340,8 +342,11 @@ export declare class Author {
 
   constructor(id: string, fields?: Record<string, any>);
 
-  /** Find an Author by ID */
-  static find(query: { id: string }): Promise<Author | null>;
+  /** Get a cached Author by graph path, hydrating from the graph when needed */
+  static get(query: { path: string; refresh?: boolean }): Promise<Author | null>;
+
+  /** List known Author instances */
+  static list(query?: { limit?: number; saveAs?: string; refresh?: boolean }): Promise<Author[]>;
 
   /** Get biography of an author */
   get_bio(input?: { detailed?: boolean }): Promise<{ bio: string; source?: string }>;
@@ -359,7 +364,9 @@ export declare class Book {
   readonly isbn: string;
   readonly published_year: number;
 
-  static find(query: { id: string }): Promise<Book | null>;
+  static get(query: { path: string; refresh?: boolean }): Promise<Book | null>;
+
+  static list(query?: { limit?: number; saveAs?: string; refresh?: boolean }): Promise<Book[]>;
 
   /** Navigate to author (many_to_one) */
   get_author(): Promise<Author | null>;
@@ -374,7 +381,9 @@ The LLM or user writes code against these typed classes:
 ```typescript
 import { Author, Book, global_search } from './sandbox-tools';
 
-const tolkien = await Author.find({ id: 'tolkien' });
+const authors = await Author.list();
+const tolkien = authors.find((author) => author.name === 'J.R.R. Tolkien');
+if (!tolkien) throw new Error('Author not found');
 console.log(tolkien.name);              // "J.R.R. Tolkien"
 
 const bio = await tolkien.get_bio({ detailed: true });

package/dist/cli/index.js

@@ -7771,7 +7771,31 @@ async function main() {
     await granular.registerEffects(SANDBOX_ID, ${effectsArray});
 
     log('Effects registered. Process kept alive for simulator. Press Ctrl+C to exit.');
-    await new Promise(() => {});
+
+    const keepAliveTimer = setInterval(() => {
+        // Keep an active event-loop handle so Bun/Node does not exit immediately.
+    }, 60_000);
+
+    await new Promise<void>((resolve) => {
+        let shuttingDown = false;
+
+        const shutdown = async (signal: string) => {
+            if (shuttingDown) return;
+            shuttingDown = true;
+            clearInterval(keepAliveTimer);
+            log(\`Received \${signal}. Shutting down effects host...\`);
+            try {
+                await granular.disconnectEffects(SANDBOX_ID);
+            } catch (error) {
+                console.warn('[Effects] Failed to disconnect live effects cleanly:', error);
+            }
+            resolve();
+            process.exit(0);
+        };
+
+        process.once('SIGINT', () => { void shutdown('SIGINT'); });
+        process.once('SIGTERM', () => { void shutdown('SIGTERM'); });
+    });
 }
 
 main().catch((err) => {
@@ -8714,12 +8738,16 @@ console.log('Connected to:', env.environmentId);`);
   if (classes.length > 0) {
     const cls = classes[0];
     const ClassName = cls.name.charAt(0).toUpperCase() + cls.name.slice(1);
-    lines.push(`  // 1. Find object`);
-    lines.push(`  const item = await ${ClassName}.find({ id: 'unique_${cls.name}_id' });`);
-    lines.push(`  console.log('Found:', item.id);`);
+    lines.push(`  // 1. List objects`);
+    lines.push(`  const items = await ${ClassName}.list({ limit: 10, saveAs: '${cls.name}_items' });`);
+    lines.push(`  const item = items[0] ?? null;`);
+    lines.push(`  console.log('Loaded:', item?.id);`);
     lines.push(``);
     lines.push(`  // 2. Call instance method`);
-    lines.push(`  const summary = await item.summarize({ maxLength: 100 });`);
+    lines.push(`  if (item) {`);
+    lines.push(`    const summary = await item.summarize({ maxLength: 100 });`);
+    lines.push(`    console.log(summary);`);
+    lines.push(`  }`);
     lines.push(``);
     lines.push(`  // 3. Call static method`);
     lines.push(`  const results = await ${ClassName}.search({ query: 'test' });`);

package/dist/index.d.mts

@@ -904,7 +904,8 @@ declare class Session {
      * ```typescript
      * import { Author, Book, global_search } from './sandbox-tools';
      *
-     * const tolkien = await Author.find({ id: 'tolkien' });
+     * const authors = await Author.list({ limit: 10, saveAs: 'recent_authors' });
+     * const tolkien = await Author.get({ path: 'author_tolkien' });
      * const bio = await tolkien.get_bio({ detailed: true });
      * const books = await tolkien.get_books();
      * ```
@@ -1410,6 +1411,13 @@ declare class Granular {
      * sandbox-scoped live catalog.
      */
     unregisterEffect(sandboxNameOrId: string, name: string): Promise<void>;
+    /**
+     * Disconnect one sandbox-scoped effect host, or all of them when no sandbox is provided.
+     *
+     * This is primarily useful for long-lived helper processes such as generated
+     * `granular-effects.ts` scripts that need to shut down cleanly on SIGINT/SIGTERM.
+     */
+    disconnectEffects(sandboxNameOrId?: string): Promise<void>;
     /**
      * Unregister all effects for a sandbox.
      */

package/dist/index.d.ts

@@ -904,7 +904,8 @@ declare class Session {
      * ```typescript
      * import { Author, Book, global_search } from './sandbox-tools';
      *
-     * const tolkien = await Author.find({ id: 'tolkien' });
+     * const authors = await Author.list({ limit: 10, saveAs: 'recent_authors' });
+     * const tolkien = await Author.get({ path: 'author_tolkien' });
      * const bio = await tolkien.get_bio({ detailed: true });
      * const books = await tolkien.get_books();
      * ```
@@ -1410,6 +1411,13 @@ declare class Granular {
      * sandbox-scoped live catalog.
      */
     unregisterEffect(sandboxNameOrId: string, name: string): Promise<void>;
+    /**
+     * Disconnect one sandbox-scoped effect host, or all of them when no sandbox is provided.
+     *
+     * This is primarily useful for long-lived helper processes such as generated
+     * `granular-effects.ts` scripts that need to shut down cleanly on SIGINT/SIGTERM.
+     */
+    disconnectEffects(sandboxNameOrId?: string): Promise<void>;
     /**
      * Unregister all effects for a sandbox.
      */

package/dist/index.js

@@ -4577,7 +4577,8 @@ var Session = class {
    * ```typescript
    * import { Author, Book, global_search } from './sandbox-tools';
    *
-   * const tolkien = await Author.find({ id: 'tolkien' });
+   * const authors = await Author.list({ limit: 10, saveAs: 'recent_authors' });
+   * const tolkien = await Author.get({ path: 'author_tolkien' });
    * const bio = await tolkien.get_bio({ detailed: true });
    * const books = await tolkien.get_books();
    * ```
@@ -6149,7 +6150,21 @@ var Granular = class {
     const effects = Array.from(this.getSandboxEffectMap(host.sandboxId).values()).map(
       (effect) => this.serializeEffect(effect)
     );
-    await host.wsClient.call("effects.publishCatalog", { effects });
+    const result = await host.wsClient.call("effects.publishCatalog", { effects });
+    const acceptedCount = typeof result?.acceptedCount === "number" ? result.acceptedCount : 0;
+    const rejected = Array.isArray(result?.rejected) ? result.rejected : [];
+    if (acceptedCount === 0 && rejected.length > 0) {
+      const detail = rejected.map((entry) => `${entry.name || "unknown"}: ${entry.reason || "rejected"}`).join("; ");
+      throw new Error(
+        `Failed to publish live effects for sandbox ${host.sandboxId}: ${detail}`
+      );
+    }
+    if (rejected.length > 0) {
+      console.warn(
+        `[Granular] Some live effects were rejected for sandbox ${host.sandboxId}:`,
+        rejected
+      );
+    }
   }
   async syncSandboxEffectCatalog(sandboxId) {
     const host = await this.ensureSandboxEffectHost(sandboxId);
@@ -6315,6 +6330,22 @@ var Granular = class {
     }
     await this.syncSandboxEffectCatalog(sandboxId);
   }
+  /**
+   * Disconnect one sandbox-scoped effect host, or all of them when no sandbox is provided.
+   *
+   * This is primarily useful for long-lived helper processes such as generated
+   * `granular-effects.ts` scripts that need to shut down cleanly on SIGINT/SIGTERM.
+   */
+  async disconnectEffects(sandboxNameOrId) {
+    if (sandboxNameOrId) {
+      const sandbox = await this.findOrCreateSandbox(sandboxNameOrId);
+      this.disconnectSandboxEffectHost(sandbox.sandboxId);
+      return;
+    }
+    for (const sandboxId of Array.from(this.sandboxEffectHosts.keys())) {
+      this.disconnectSandboxEffectHost(sandboxId);
+    }
+  }
   /**
    * Unregister all effects for a sandbox.
    */