@ponraaj/dimple-sdk 0.0.0-alpha.1

package/dist/internal/store/schema/metadata.d.ts

@@ -0,0 +1,51 @@
+/**
+ * `MemoryMetadata` — the typed overlay on the raw `memories.metadata` JSON
+ * blob.
+ *
+ * The blob stays the raw store: this schema only *reads* and *writes* the
+ * well-known keys it declares. Unknown keys in an existing blob are
+ * preserved on write (`mergeMetadataBlob`), so the overlay is additive and
+ * never destroys data written by other producers.
+ *
+ * Decode is undefined-tolerant by design: a missing, malformed or
+ * non-conforming blob decodes to `undefined` — never an error — so metadata
+ * accessors are safe on memories written before the overlay existed.
+ */
+import { Schema } from "effect";
+export declare const MemoryMetadata: Schema.Struct<{
+    /** Concept tags (from inductive clustering). */
+    readonly topics: Schema.$Array<Schema.String>;
+    /** "conversation" | "document" | "code" | "fact" */
+    readonly sourceType: Schema.String;
+    readonly temporalContext: Schema.optional<Schema.Struct<{
+        readonly windowStart: Schema.Number;
+        readonly windowEnd: Schema.Number;
+    }>>;
+    /** 0-1 */
+    readonly confidence: Schema.Number;
+    /** What the memory enables: "factual_lookup" | "pattern_match" | "code_example" | ... */
+    readonly affordances: Schema.$Array<Schema.String>;
+    /** Code-specific: "typescript" | "rust" | ... */
+    readonly language: Schema.optional<Schema.String>;
+    /** Writer-set pin: the memory is deliberately stable — automatic graph
+     * lifecycle moves should leave it alone. */
+    readonly pinned: Schema.optional<Schema.Boolean>;
+}>;
+export interface MemoryMetadata extends Schema.Schema.Type<typeof MemoryMetadata> {
+}
+/**
+ * Decode a stored metadata blob into the typed overlay. Undefined-tolerant:
+ * `null` / `undefined` / malformed JSON / schema mismatch all yield
+ * `undefined` — never an error (metadata is optional, best-effort
+ * enrichment over the raw blob).
+ */
+export declare const parseMetadata: (blob: string | null | undefined) => MemoryMetadata | undefined;
+/** Encode the typed overlay for storage (stringify). */
+export declare const encodeMetadata: (metadata: MemoryMetadata) => string;
+/**
+ * Merge a typed overlay INTO an existing raw blob, preserving unknown keys.
+ * The typed fields win over the existing blob's values; any key the overlay
+ * does not declare (producer-specific extensions) survives. A malformed
+ * existing blob is treated as empty — the merge never throws.
+ */
+export declare const mergeMetadataBlob: (existing: string | null | undefined, typed: MemoryMetadata) => string;