mindcache 3.1.0 → 3.3.0

package/dist/{CloudAdapter-Bx-ITNdi.d.mts → CloudAdapter-CSncOr3V.d.mts}

@@ -19,12 +19,16 @@ type AccessLevel = 'user' | 'system';
  * @deprecated 'template' - Use 'ApplyTemplate' instead
  */
 type SystemTag = 'SystemPrompt' | 'LLMRead' | 'LLMWrite' | 'protected' | 'ApplyTemplate' | 'prompt' | 'readonly' | 'template';
+/**
+ * Type of value stored in a MindCache key
+ */
+type KeyType = 'text' | 'image' | 'file' | 'json' | 'document';
 /**
  * Attributes that can be set on a MindCache key
  */
 interface KeyAttributes {
     /** The type of value stored */
-    type: 'text' | 'image' | 'file' | 'json' | 'document';
+    type: KeyType;
     /** MIME type for files/images */
     contentType?: string;
     /** User-defined tags for organizing keys */
@@ -102,6 +106,8 @@ interface MindCacheCloudOptions {
     projectId?: string;
     /** API endpoint to fetch WS token (recommended for browser) */
     tokenEndpoint?: string;
+    /** Function to fetch token dynamically (overrides tokenEndpoint) */
+    tokenProvider?: () => Promise<string>;
     /** Direct API key (server-side only, never expose in browser!) */
     apiKey?: string;
     /** WebSocket base URL (defaults to production) */
@@ -214,13 +220,171 @@ declare class MindCache {
     private encodeFileToBase64;
     private createDataUrl;
     private validateContentType;
-    private injectSTM;
-    getAll(): STM;
+    private _injectSTMInternal;
+    /**
+     * Replace {{key}} placeholders in a template string with values from MindCache.
+     * @param template The template string with {{key}} placeholders
+     * @returns The template with placeholders replaced by values
+     */
+    injectSTM(template: string): string;
+    getAll(): Record<string, any>;
+    /**
+     * Get all entries with their full structure (value + attributes).
+     * Use this for UI/admin interfaces that need to display key properties.
+     * Unlike serialize(), this format is stable and won't change.
+     */
+    getAllEntries(): STM;
     get_value(key: string, _processingStack?: Set<string>): any;
     get_attributes(key: string): KeyAttributes | undefined;
+    /**
+     * Update only the attributes of a key without modifying the value.
+     * Useful for updating tags, permissions etc. on document type keys.
+     */
+    set_attributes(key: string, attributes: Partial<KeyAttributes>): void;
     set_value(key: string, value: any, attributes?: Partial<KeyAttributes>): void;
     delete_key(key: string): void;
     clear(): void;
+    /**
+     * Check if a key exists in MindCache.
+     */
+    has(key: string): boolean;
+    /**
+     * Delete a key from MindCache.
+     * @returns true if the key existed and was deleted
+     */
+    delete(key: string): boolean;
+    /** @deprecated Use get_value instead */
+    get(key: string): any;
+    /** @deprecated Use set_value instead */
+    set(key: string, value: any): void;
+    /**
+     * Update multiple values at once from an object.
+     * @deprecated Use set_value for individual keys
+     */
+    update(data: Record<string, any>): void;
+    /**
+     * Get the number of keys in MindCache.
+     */
+    size(): number;
+    /**
+     * Get all keys in MindCache (including temporal keys).
+     */
+    keys(): string[];
+    /**
+     * Get all values in MindCache (including temporal values).
+     */
+    values(): any[];
+    /**
+     * Get all key-value entries (including temporal entries).
+     */
+    entries(): Array<[string, any]>;
+    /**
+     * Unsubscribe from key changes.
+     * @deprecated Use the cleanup function returned by subscribe() instead
+     */
+    unsubscribe(key: string, listener: Listener): void;
+    /**
+     * Get the STM as a formatted string for LLM context.
+     * @deprecated Use get_system_prompt() instead
+     */
+    getSTM(): string;
+    /**
+     * Get the STM as an object with values directly (no attributes).
+     * Includes system keys ($date, $time).
+     * @deprecated Use getAll() for full STM format
+     */
+    getSTMObject(): Record<string, any>;
+    /**
+     * Add a content tag to a key.
+     * @returns true if the tag was added, false if key doesn't exist or tag already exists
+     */
+    addTag(key: string, tag: string): boolean;
+    /**
+     * Remove a content tag from a key.
+     * @returns true if the tag was removed
+     */
+    removeTag(key: string, tag: string): boolean;
+    /**
+     * Get all content tags for a key.
+     */
+    getTags(key: string): string[];
+    /**
+     * Get all unique content tags across all keys.
+     */
+    getAllTags(): string[];
+    /**
+     * Check if a key has a specific content tag.
+     */
+    hasTag(key: string, tag: string): boolean;
+    /**
+     * Get all keys with a specific content tag as formatted string.
+     */
+    getTagged(tag: string): string;
+    /**
+     * Get array of keys with a specific content tag.
+     */
+    getKeysByTag(tag: string): string[];
+    /**
+     * Add a system tag to a key (requires system access).
+     * System tags: 'SystemPrompt', 'LLMRead', 'LLMWrite', 'readonly', 'protected', 'ApplyTemplate'
+     */
+    systemAddTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Remove a system tag from a key (requires system access).
+     */
+    systemRemoveTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Get all system tags for a key (requires system access).
+     */
+    systemGetTags(key: string): SystemTag[];
+    /**
+     * Check if a key has a specific system tag (requires system access).
+     */
+    systemHasTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Set all system tags for a key at once (requires system access).
+     */
+    systemSetTags(key: string, tags: SystemTag[]): boolean;
+    /**
+     * Get all keys with a specific system tag (requires system access).
+     */
+    systemGetKeysByTag(tag: SystemTag): string[];
+    /**
+     * Helper to get sorted keys (by zIndex).
+     */
+    private getSortedKeys;
+    /**
+     * Serialize to JSON string.
+     */
+    toJSON(): string;
+    /**
+     * Deserialize from JSON string.
+     */
+    fromJSON(jsonString: string): void;
+    /**
+     * Export to Markdown format.
+     */
+    toMarkdown(): string;
+    /**
+     * Import from Markdown format.
+     */
+    fromMarkdown(markdown: string): void;
+    /**
+     * Set base64 binary data.
+     */
+    set_base64(key: string, base64Data: string, contentType: string, type?: 'image' | 'file', attributes?: Partial<KeyAttributes>): void;
+    /**
+     * Add an image from base64 data.
+     */
+    add_image(key: string, base64Data: string, contentType?: string, attributes?: Partial<KeyAttributes>): void;
+    /**
+     * Get the data URL for an image or file key.
+     */
+    get_data_url(key: string): string | undefined;
+    /**
+     * Get the base64 data for an image or file key.
+     */
+    get_base64(key: string): string | undefined;
     set_file(key: string, file: File, attributes?: Partial<KeyAttributes>): Promise<void>;
     set_image(key: string, file: File, attributes?: Partial<KeyAttributes>): Promise<void>;
     /**
@@ -363,4 +527,4 @@ declare class CloudAdapter {
     private scheduleReconnect;
 }
 
-export { CloudAdapter as C, DEFAULT_KEY_ATTRIBUTES as D, type KeyAttributes as K, type Listener as L, MindCache as M, type Operation as O, type STM as S, type MindCacheOptions as a, type STMEntry as b, type MindCacheCloudOptions as c, type MindCacheIndexedDBOptions as d, type CloudConfig as e, type ConnectionState as f, type CloudAdapterEvents as g, type SetOperation as h, type DeleteOperation as i, type ClearOperation as j };
+export { type AccessLevel as A, CloudAdapter as C, DEFAULT_KEY_ATTRIBUTES as D, type GlobalListener as G, type HistoryEntry as H, type KeyAttributes as K, type Listener as L, MindCache as M, type Operation as O, type SystemTag as S, type MindCacheOptions as a, type KeyType as b, type STM as c, type STMEntry as d, type HistoryOptions as e, type MindCacheCloudOptions as f, type MindCacheIndexedDBOptions as g, type CloudConfig as h, type ConnectionState as i, type CloudAdapterEvents as j, type SetOperation as k, type DeleteOperation as l, type ClearOperation as m };

package/dist/{CloudAdapter-Bx-ITNdi.d.ts → CloudAdapter-CSncOr3V.d.ts}

@@ -19,12 +19,16 @@ type AccessLevel = 'user' | 'system';
  * @deprecated 'template' - Use 'ApplyTemplate' instead
  */
 type SystemTag = 'SystemPrompt' | 'LLMRead' | 'LLMWrite' | 'protected' | 'ApplyTemplate' | 'prompt' | 'readonly' | 'template';
+/**
+ * Type of value stored in a MindCache key
+ */
+type KeyType = 'text' | 'image' | 'file' | 'json' | 'document';
 /**
  * Attributes that can be set on a MindCache key
  */
 interface KeyAttributes {
     /** The type of value stored */
-    type: 'text' | 'image' | 'file' | 'json' | 'document';
+    type: KeyType;
     /** MIME type for files/images */
     contentType?: string;
     /** User-defined tags for organizing keys */
@@ -102,6 +106,8 @@ interface MindCacheCloudOptions {
     projectId?: string;
     /** API endpoint to fetch WS token (recommended for browser) */
     tokenEndpoint?: string;
+    /** Function to fetch token dynamically (overrides tokenEndpoint) */
+    tokenProvider?: () => Promise<string>;
     /** Direct API key (server-side only, never expose in browser!) */
     apiKey?: string;
     /** WebSocket base URL (defaults to production) */
@@ -214,13 +220,171 @@ declare class MindCache {
     private encodeFileToBase64;
     private createDataUrl;
     private validateContentType;
-    private injectSTM;
-    getAll(): STM;
+    private _injectSTMInternal;
+    /**
+     * Replace {{key}} placeholders in a template string with values from MindCache.
+     * @param template The template string with {{key}} placeholders
+     * @returns The template with placeholders replaced by values
+     */
+    injectSTM(template: string): string;
+    getAll(): Record<string, any>;
+    /**
+     * Get all entries with their full structure (value + attributes).
+     * Use this for UI/admin interfaces that need to display key properties.
+     * Unlike serialize(), this format is stable and won't change.
+     */
+    getAllEntries(): STM;
     get_value(key: string, _processingStack?: Set<string>): any;
     get_attributes(key: string): KeyAttributes | undefined;
+    /**
+     * Update only the attributes of a key without modifying the value.
+     * Useful for updating tags, permissions etc. on document type keys.
+     */
+    set_attributes(key: string, attributes: Partial<KeyAttributes>): void;
     set_value(key: string, value: any, attributes?: Partial<KeyAttributes>): void;
     delete_key(key: string): void;
     clear(): void;
+    /**
+     * Check if a key exists in MindCache.
+     */
+    has(key: string): boolean;
+    /**
+     * Delete a key from MindCache.
+     * @returns true if the key existed and was deleted
+     */
+    delete(key: string): boolean;
+    /** @deprecated Use get_value instead */
+    get(key: string): any;
+    /** @deprecated Use set_value instead */
+    set(key: string, value: any): void;
+    /**
+     * Update multiple values at once from an object.
+     * @deprecated Use set_value for individual keys
+     */
+    update(data: Record<string, any>): void;
+    /**
+     * Get the number of keys in MindCache.
+     */
+    size(): number;
+    /**
+     * Get all keys in MindCache (including temporal keys).
+     */
+    keys(): string[];
+    /**
+     * Get all values in MindCache (including temporal values).
+     */
+    values(): any[];
+    /**
+     * Get all key-value entries (including temporal entries).
+     */
+    entries(): Array<[string, any]>;
+    /**
+     * Unsubscribe from key changes.
+     * @deprecated Use the cleanup function returned by subscribe() instead
+     */
+    unsubscribe(key: string, listener: Listener): void;
+    /**
+     * Get the STM as a formatted string for LLM context.
+     * @deprecated Use get_system_prompt() instead
+     */
+    getSTM(): string;
+    /**
+     * Get the STM as an object with values directly (no attributes).
+     * Includes system keys ($date, $time).
+     * @deprecated Use getAll() for full STM format
+     */
+    getSTMObject(): Record<string, any>;
+    /**
+     * Add a content tag to a key.
+     * @returns true if the tag was added, false if key doesn't exist or tag already exists
+     */
+    addTag(key: string, tag: string): boolean;
+    /**
+     * Remove a content tag from a key.
+     * @returns true if the tag was removed
+     */
+    removeTag(key: string, tag: string): boolean;
+    /**
+     * Get all content tags for a key.
+     */
+    getTags(key: string): string[];
+    /**
+     * Get all unique content tags across all keys.
+     */
+    getAllTags(): string[];
+    /**
+     * Check if a key has a specific content tag.
+     */
+    hasTag(key: string, tag: string): boolean;
+    /**
+     * Get all keys with a specific content tag as formatted string.
+     */
+    getTagged(tag: string): string;
+    /**
+     * Get array of keys with a specific content tag.
+     */
+    getKeysByTag(tag: string): string[];
+    /**
+     * Add a system tag to a key (requires system access).
+     * System tags: 'SystemPrompt', 'LLMRead', 'LLMWrite', 'readonly', 'protected', 'ApplyTemplate'
+     */
+    systemAddTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Remove a system tag from a key (requires system access).
+     */
+    systemRemoveTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Get all system tags for a key (requires system access).
+     */
+    systemGetTags(key: string): SystemTag[];
+    /**
+     * Check if a key has a specific system tag (requires system access).
+     */
+    systemHasTag(key: string, tag: SystemTag): boolean;
+    /**
+     * Set all system tags for a key at once (requires system access).
+     */
+    systemSetTags(key: string, tags: SystemTag[]): boolean;
+    /**
+     * Get all keys with a specific system tag (requires system access).
+     */
+    systemGetKeysByTag(tag: SystemTag): string[];
+    /**
+     * Helper to get sorted keys (by zIndex).
+     */
+    private getSortedKeys;
+    /**
+     * Serialize to JSON string.
+     */
+    toJSON(): string;
+    /**
+     * Deserialize from JSON string.
+     */
+    fromJSON(jsonString: string): void;
+    /**
+     * Export to Markdown format.
+     */
+    toMarkdown(): string;
+    /**
+     * Import from Markdown format.
+     */
+    fromMarkdown(markdown: string): void;
+    /**
+     * Set base64 binary data.
+     */
+    set_base64(key: string, base64Data: string, contentType: string, type?: 'image' | 'file', attributes?: Partial<KeyAttributes>): void;
+    /**
+     * Add an image from base64 data.
+     */
+    add_image(key: string, base64Data: string, contentType?: string, attributes?: Partial<KeyAttributes>): void;
+    /**
+     * Get the data URL for an image or file key.
+     */
+    get_data_url(key: string): string | undefined;
+    /**
+     * Get the base64 data for an image or file key.
+     */
+    get_base64(key: string): string | undefined;
     set_file(key: string, file: File, attributes?: Partial<KeyAttributes>): Promise<void>;
     set_image(key: string, file: File, attributes?: Partial<KeyAttributes>): Promise<void>;
     /**
@@ -363,4 +527,4 @@ declare class CloudAdapter {
     private scheduleReconnect;
 }
 
-export { CloudAdapter as C, DEFAULT_KEY_ATTRIBUTES as D, type KeyAttributes as K, type Listener as L, MindCache as M, type Operation as O, type STM as S, type MindCacheOptions as a, type STMEntry as b, type MindCacheCloudOptions as c, type MindCacheIndexedDBOptions as d, type CloudConfig as e, type ConnectionState as f, type CloudAdapterEvents as g, type SetOperation as h, type DeleteOperation as i, type ClearOperation as j };
+export { type AccessLevel as A, CloudAdapter as C, DEFAULT_KEY_ATTRIBUTES as D, type GlobalListener as G, type HistoryEntry as H, type KeyAttributes as K, type Listener as L, MindCache as M, type Operation as O, type SystemTag as S, type MindCacheOptions as a, type KeyType as b, type STM as c, type STMEntry as d, type HistoryOptions as e, type MindCacheCloudOptions as f, type MindCacheIndexedDBOptions as g, type CloudConfig as h, type ConnectionState as i, type CloudAdapterEvents as j, type SetOperation as k, type DeleteOperation as l, type ClearOperation as m };

package/dist/cloud/index.d.mts

@@ -1,5 +1,5 @@
-import { M as MindCache, e as CloudConfig, C as CloudAdapter } from '../CloudAdapter-Bx-ITNdi.mjs';
-export { j as ClearOperation, g as CloudAdapterEvents, f as ConnectionState, i as DeleteOperation, O as Operation, h as SetOperation } from '../CloudAdapter-Bx-ITNdi.mjs';
+import { M as MindCache, h as CloudConfig, C as CloudAdapter } from '../CloudAdapter-CSncOr3V.mjs';
+export { m as ClearOperation, j as CloudAdapterEvents, i as ConnectionState, l as DeleteOperation, O as Operation, k as SetOperation } from '../CloudAdapter-CSncOr3V.mjs';
 import 'yjs';
 
 /**

package/dist/cloud/index.d.ts

@@ -1,5 +1,5 @@
-import { M as MindCache, e as CloudConfig, C as CloudAdapter } from '../CloudAdapter-Bx-ITNdi.js';
-export { j as ClearOperation, g as CloudAdapterEvents, f as ConnectionState, i as DeleteOperation, O as Operation, h as SetOperation } from '../CloudAdapter-Bx-ITNdi.js';
+import { M as MindCache, h as CloudConfig, C as CloudAdapter } from '../CloudAdapter-CSncOr3V.js';
+export { m as ClearOperation, j as CloudAdapterEvents, i as ConnectionState, l as DeleteOperation, O as Operation, k as SetOperation } from '../CloudAdapter-CSncOr3V.js';
 import 'yjs';
 
 /**