xmemory 2.3.0 → 3.0.0

package/README.md

@@ -122,6 +122,7 @@ Extract and store structured objects from text.
 ```typescript
 const result = await inst.write("Bob is a designer based in Berlin.");
 console.log(result.write_id, result.trace_id);
+console.log(result.changes); // what the write created / updated / deleted
 ```
 
 Options: `{ extractionLogic?, diffEngine?, timeoutMs? }` — `extractionLogic` defaults to `"fast"`.

package/dist/instance.d.ts

@@ -5,6 +5,7 @@ import type { ApplyPendingDecisionsResult, AsyncWriteResult, DecideSuggestionsRe
 export declare class DescribeResult {
     readonly instanceId: string;
     readonly instanceName: string;
+    readonly about: string;
     readonly schemaSummary: string;
     readonly tools: readonly ToolDescription[];
     constructor(raw: RawDescribeResult);

package/dist/instance.js

@@ -5,11 +5,13 @@ const DEFAULT_DESCRIBE_TTL_MS = 300_000; // 5 minutes
 export class DescribeResult {
     instanceId;
     instanceName;
+    about;
     schemaSummary;
     tools;
     constructor(raw) {
         this.instanceId = raw.instance_id;
         this.instanceName = raw.instance_name;
+        this.about = raw.about ?? "";
         this.schemaSummary = raw.schema_summary;
         this.tools = raw.tools;
     }
@@ -24,6 +26,9 @@ export class DescribeResult {
         const includeHttp = options?.includeHttp ?? false;
         const lines = [];
         lines.push(`Instance: ${this.instanceName} (${this.instanceId})`);
+        if (this.about) {
+            lines.push(`\n${this.about}`);
+        }
         if (this.schemaSummary) {
             lines.push(`\n${this.schemaSummary}`);
         }

package/dist/types.d.ts

@@ -6,7 +6,7 @@ export declare const SchemaType: {
     readonly JSON: 1;
 };
 export type SchemaTypeValue = (typeof SchemaType)[keyof typeof SchemaType];
-export type ExtractionLogic = "fast" | "regular" | "deep";
+export type ExtractionLogic = "fast" | "deep";
 export type ReadMode = "single-answer" | "raw-tables" | "xresponse";
 /**
  * One concrete object a scoped read may touch. Identify it by `type` (PascalCase
@@ -81,7 +81,8 @@ export interface ReadResult {
 export interface WriteResult {
     readonly write_id: string;
     readonly trace_id: string | null;
-    readonly cleaned_objects: unknown;
+    /** What the write did, grouped into `created` / `updated` / `deleted`. */
+    readonly changes: unknown;
 }
 export interface AsyncWriteResult {
     readonly write_id: string;
@@ -326,6 +327,7 @@ export interface ToolDescription {
 export interface RawDescribeResult {
     readonly instance_id: string;
     readonly instance_name: string;
+    readonly about?: string;
     readonly schema_summary: string;
     readonly tools: ToolDescription[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xmemory",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "xmemory",
   "keywords": [
     "xmemory"