@microsoft/agents-hosting 1.0.0 → 1.0.7-g73d3d58001

package/dist/src/state/agentStatePropertyAccesor.d.ts

@@ -7,28 +7,35 @@ import { AgentState, CustomKey } from './agentState';
 /**
  * Interface for accessing a property in state storage with type safety.
  *
- * The interface defines standard methods for working with persisted state properties,
+ * @typeParam T The type of the property being accessed
+ *
+ * @remarks
+ * This interface defines standard methods for working with persisted state properties,
  * allowing property access with strong typing to reduce errors when working with
  * complex state objects.
  *
- * @typeParam T The type of the property being accessed
  */
 export interface StatePropertyAccessor<T = any> {
     /**
      * Deletes the persisted property from its backing storage object.
      *
+     * @param context Context for the current turn of conversation with the user.
+     *
      * @remarks
      * The properties backing storage object SHOULD be loaded into memory on first access.
      *
-     * ```JavaScript
+     * @example
+     * ```javascript
      * await myProperty.delete(context);
      * ```
-     * @param context Context for the current turn of conversation with the user.
+     *
      */
     delete(context: TurnContext): Promise<void>;
     /**
      * Reads a persisted property from its backing storage object.
      *
+     * @param context Context for the current turn of conversation with the user.
+     *
      * @remarks
      * The properties backing storage object SHOULD be loaded into memory on first access.
      *
@@ -36,10 +43,11 @@ export interface StatePropertyAccessor<T = any> {
      * specified, a clone of the `defaultValue` SHOULD be copied to the storage object. If a
      * `defaultValue` has not been specified then a value of `undefined` SHOULD be returned.
      *
-     * ```JavaScript
+     * @example
+     * ```javascript
      * const value = await myProperty.get(context, { count: 0 });
      * ```
-     * @param context Context for the current turn of conversation with the user.
+     *
      */
     get(context: TurnContext): Promise<T | undefined>;
     /**
@@ -52,25 +60,30 @@ export interface StatePropertyAccessor<T = any> {
     /**
      * Assigns a new value to the properties backing storage object.
      *
+     * @param context Context for the current turn of conversation with the user.
+     * @param value Value to assign.
+     *
      * @remarks
      * The properties backing storage object SHOULD be loaded into memory on first access.
      *
      * Depending on the state systems implementation, an additional step may be required to
      * persist the actual changes to disk.
      *
-     * ```JavaScript
+     * @example
+     * ```javascript
      * await myProperty.set(context, value);
      * ```
-     * @param context Context for the current turn of conversation with the user.
-     * @param value Value to assign.
+     *
      */
     set(context: TurnContext, value: T): Promise<void>;
 }
 /**
- * @summary Provides typed access to an Agent state property with automatic state loading and persistence management.
+ * Provides typed access to an Agent state property with automatic state loading and persistence management.
+ *
+ * @typeParam T The type of the property being accessed. Can be any serializable type.
  *
  * @remarks
- * AgentStatePropertyAccessor simplifies working with persisted state by abstracting
+ * `AgentStatePropertyAccessor` simplifies working with persisted state by abstracting
  * the complexity of loading state from storage and manipulating specific properties.
  * It provides a type-safe interface for state management with automatic handling of:
  *
@@ -82,6 +95,11 @@ export interface StatePropertyAccessor<T = any> {
  *
  * ### Key Features
  *
+ * Key features of `AgentStatePropertyAccessor` include:
+ * - [Type Safety](#type-safety)
+ * - [Automatic Default Value Handling](#automatic-default-value-handling)
+ * - [Explicit Persistence Control](#explicit-persistence-control)
+ *
  * #### Type Safety
  * The accessor provides compile-time type checking when using TypeScript:
  * ```typescript
@@ -172,8 +190,6 @@ export interface StatePropertyAccessor<T = any> {
  * - **Persistence**: Always call `state.saveChanges(context)` to persist changes to storage.
  * - **Deep Cloning**: Default values are deep cloned using JSON serialization, which may not work with complex objects containing functions or circular references.
  *
- * @typeParam T The type of the property being accessed. Can be any serializable type.
- *
  * @see {@link AgentState.createProperty} for creating property accessors
  * @see {@link StatePropertyAccessor} for the interface definition
  */
@@ -183,13 +199,13 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
     /**
      * Creates a new instance of AgentStatePropertyAccessor.
      *
+     * @param state The agent state object that manages the backing storage for this property
+     * @param name The unique name of the property within the state object. This name is used as the key in the state storage.
+     *
      * @remarks
      * This constructor is typically not called directly. Instead, use {@link AgentState.createProperty}
      * to create property accessors, which ensures proper integration with the state management system.
      *
-     * @param state The agent state object that manages the backing storage for this property
-     * @param name The unique name of the property within the state object. This name is used as the key in the state storage.
-     *
      * @example
      * ```typescript
      * // Recommended way - use AgentState.createProperty
@@ -198,10 +214,17 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * // Direct construction (not recommended)
      * const accessor = new AgentStatePropertyAccessor<UserProfile>(userState, "userProfile");
      * ```
+     *
      */
     constructor(state: AgentState, name: string);
     /**
-     * @summary Deletes the property from the state storage.
+     * Deletes the property from the state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     * Useful for multi-tenant scenarios or when state needs to be partitioned.
+     * @returns A promise that resolves when the delete operation is complete
+     *
      * @remarks
      * This operation removes the property from the in-memory state object but does not
      * automatically persist the change to the underlying storage. You must call
@@ -211,13 +234,7 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * - The deletion only affects the in-memory state until `saveChanges()` is called
      * - After deletion, subsequent `get()` calls will return `undefined` (or the default value if provided)
      *
-     * @param context The turn context for the current conversation turn
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     * Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves when the delete operation is complete
-     *
-     * @example
+     * @example Basic usage
      * ```typescript
      * const userSettings = userState.createProperty<UserSettings>("settings");
      *
@@ -237,10 +254,20 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * await userSettings.delete(context, tenantKey);
      * await userState.saveChanges(context);
      * ```
+     *
      */
     delete(context: TurnContext, customKey?: CustomKey): Promise<void>;
     /**
-     * @summary Retrieves the value of the property from state storage.
+     * Retrieves the value of the property from state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param defaultValue Optional default value to use if the property doesn't exist.
+     *                    When provided, this value is deep cloned and stored in state.
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
+     *
+     * @returns A promise that resolves to the property value, the cloned default value, or `undefined`
+     *
      * @remarks
      * This method provides intelligent default value handling:
      * - If the property exists, its value is returned
@@ -257,14 +284,6 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * **Performance**: The first access loads state from storage; subsequent accesses use
      * the in-memory cached version until the context is disposed.
      *
-     * @param context The turn context for the current conversation turn
-     * @param defaultValue Optional default value to use if the property doesn't exist.
-     *                    When provided, this value is deep cloned and stored in state.
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves to the property value, the cloned default value, or `undefined`
-     *
      * @example Basic usage
      * ```typescript
      * const counterProperty = userState.createProperty<number>("counter");
@@ -303,10 +322,19 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * const tenantKey = { key: `tenant_${tenantId}` };
      * const tenantData = await dataProperty.get(context, defaultData, tenantKey);
      * ```
+     *
      */
     get(context: TurnContext, defaultValue?: T, customKey?: CustomKey): Promise<T>;
     /**
-     * @summary Sets the value of the property in state storage.
+     * Sets the value of the property in state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param value The value to assign to the property. Can be any serializable value.
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
+     *
+     * @returns A promise that resolves when the set operation is complete
+     *
      * @remarks
      * This operation updates the property in the in-memory state object but does not
      * automatically persist the change to the underlying storage. You must call
@@ -323,13 +351,6 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * **Type Safety**: When using TypeScript, the value must match the property's
      * declared type parameter.
      *
-     * @param context The turn context for the current conversation turn
-     * @param value The value to assign to the property. Can be any serializable value.
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves when the set operation is complete
-     *
      * @example Basic usage
      * ```typescript
      * const counterProperty = userState.createProperty<number>("counter");
@@ -371,6 +392,7 @@ export declare class AgentStatePropertyAccessor<T = any> implements StatePropert
      * await dataProperty.set(context, updatedData, tenantKey);
      * await userState.saveChanges(context);
      * ```
+     *
      */
     set(context: TurnContext, value: T, customKey?: CustomKey): Promise<void>;
 }

package/dist/src/state/agentStatePropertyAccesor.js

@@ -6,10 +6,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentStatePropertyAccessor = void 0;
 /**
- * @summary Provides typed access to an Agent state property with automatic state loading and persistence management.
+ * Provides typed access to an Agent state property with automatic state loading and persistence management.
+ *
+ * @typeParam T The type of the property being accessed. Can be any serializable type.
  *
  * @remarks
- * AgentStatePropertyAccessor simplifies working with persisted state by abstracting
+ * `AgentStatePropertyAccessor` simplifies working with persisted state by abstracting
  * the complexity of loading state from storage and manipulating specific properties.
  * It provides a type-safe interface for state management with automatic handling of:
  *
@@ -21,6 +23,11 @@ exports.AgentStatePropertyAccessor = void 0;
  *
  * ### Key Features
  *
+ * Key features of `AgentStatePropertyAccessor` include:
+ * - [Type Safety](#type-safety)
+ * - [Automatic Default Value Handling](#automatic-default-value-handling)
+ * - [Explicit Persistence Control](#explicit-persistence-control)
+ *
  * #### Type Safety
  * The accessor provides compile-time type checking when using TypeScript:
  * ```typescript
@@ -111,8 +118,6 @@ exports.AgentStatePropertyAccessor = void 0;
  * - **Persistence**: Always call `state.saveChanges(context)` to persist changes to storage.
  * - **Deep Cloning**: Default values are deep cloned using JSON serialization, which may not work with complex objects containing functions or circular references.
  *
- * @typeParam T The type of the property being accessed. Can be any serializable type.
- *
  * @see {@link AgentState.createProperty} for creating property accessors
  * @see {@link StatePropertyAccessor} for the interface definition
  */
@@ -120,13 +125,13 @@ class AgentStatePropertyAccessor {
     /**
      * Creates a new instance of AgentStatePropertyAccessor.
      *
+     * @param state The agent state object that manages the backing storage for this property
+     * @param name The unique name of the property within the state object. This name is used as the key in the state storage.
+     *
      * @remarks
      * This constructor is typically not called directly. Instead, use {@link AgentState.createProperty}
      * to create property accessors, which ensures proper integration with the state management system.
      *
-     * @param state The agent state object that manages the backing storage for this property
-     * @param name The unique name of the property within the state object. This name is used as the key in the state storage.
-     *
      * @example
      * ```typescript
      * // Recommended way - use AgentState.createProperty
@@ -135,13 +140,20 @@ class AgentStatePropertyAccessor {
      * // Direct construction (not recommended)
      * const accessor = new AgentStatePropertyAccessor<UserProfile>(userState, "userProfile");
      * ```
+     *
      */
     constructor(state, name) {
         this.state = state;
         this.name = name;
     }
     /**
-     * @summary Deletes the property from the state storage.
+     * Deletes the property from the state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     * Useful for multi-tenant scenarios or when state needs to be partitioned.
+     * @returns A promise that resolves when the delete operation is complete
+     *
      * @remarks
      * This operation removes the property from the in-memory state object but does not
      * automatically persist the change to the underlying storage. You must call
@@ -151,13 +163,7 @@ class AgentStatePropertyAccessor {
      * - The deletion only affects the in-memory state until `saveChanges()` is called
      * - After deletion, subsequent `get()` calls will return `undefined` (or the default value if provided)
      *
-     * @param context The turn context for the current conversation turn
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     * Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves when the delete operation is complete
-     *
-     * @example
+     * @example Basic usage
      * ```typescript
      * const userSettings = userState.createProperty<UserSettings>("settings");
      *
@@ -177,6 +183,7 @@ class AgentStatePropertyAccessor {
      * await userSettings.delete(context, tenantKey);
      * await userState.saveChanges(context);
      * ```
+     *
      */
     async delete(context, customKey) {
         const obj = await this.state.load(context, false, customKey);
@@ -185,7 +192,16 @@ class AgentStatePropertyAccessor {
         }
     }
     /**
-     * @summary Retrieves the value of the property from state storage.
+     * Retrieves the value of the property from state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param defaultValue Optional default value to use if the property doesn't exist.
+     *                    When provided, this value is deep cloned and stored in state.
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
+     *
+     * @returns A promise that resolves to the property value, the cloned default value, or `undefined`
+     *
      * @remarks
      * This method provides intelligent default value handling:
      * - If the property exists, its value is returned
@@ -202,14 +218,6 @@ class AgentStatePropertyAccessor {
      * **Performance**: The first access loads state from storage; subsequent accesses use
      * the in-memory cached version until the context is disposed.
      *
-     * @param context The turn context for the current conversation turn
-     * @param defaultValue Optional default value to use if the property doesn't exist.
-     *                    When provided, this value is deep cloned and stored in state.
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves to the property value, the cloned default value, or `undefined`
-     *
      * @example Basic usage
      * ```typescript
      * const counterProperty = userState.createProperty<number>("counter");
@@ -248,6 +256,7 @@ class AgentStatePropertyAccessor {
      * const tenantKey = { key: `tenant_${tenantId}` };
      * const tenantData = await dataProperty.get(context, defaultData, tenantKey);
      * ```
+     *
      */
     async get(context, defaultValue, customKey) {
         const obj = await this.state.load(context, false, customKey);
@@ -260,7 +269,15 @@ class AgentStatePropertyAccessor {
         return obj[this.name];
     }
     /**
-     * @summary Sets the value of the property in state storage.
+     * Sets the value of the property in state storage.
+     *
+     * @param context The turn context for the current conversation turn
+     * @param value The value to assign to the property. Can be any serializable value.
+     * @param customKey Optional custom key for accessing state in a specific storage location.
+     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
+     *
+     * @returns A promise that resolves when the set operation is complete
+     *
      * @remarks
      * This operation updates the property in the in-memory state object but does not
      * automatically persist the change to the underlying storage. You must call
@@ -277,13 +294,6 @@ class AgentStatePropertyAccessor {
      * **Type Safety**: When using TypeScript, the value must match the property's
      * declared type parameter.
      *
-     * @param context The turn context for the current conversation turn
-     * @param value The value to assign to the property. Can be any serializable value.
-     * @param customKey Optional custom key for accessing state in a specific storage location.
-     *                  Useful for multi-tenant scenarios or when state needs to be partitioned.
-     *
-     * @returns A promise that resolves when the set operation is complete
-     *
      * @example Basic usage
      * ```typescript
      * const counterProperty = userState.createProperty<number>("counter");
@@ -325,6 +335,7 @@ class AgentStatePropertyAccessor {
      * await dataProperty.set(context, updatedData, tenantKey);
      * await userState.saveChanges(context);
      * ```
+     *
      */
     async set(context, value, customKey) {
         const obj = await this.state.load(context, false, customKey);

package/dist/src/state/agentStatePropertyAccesor.js.map

@@ -1 +1 @@
-{"version":3,"file":"agentStatePropertyAccesor.js","sourceRoot":"","sources":["../../../src/state/agentStatePropertyAccesor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,MAAa,0BAA0B;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAgC,KAAiB,EAAkB,IAAY;QAA/C,UAAK,GAAL,KAAK,CAAY;QAAkB,SAAI,GAAJ,IAAI,CAAQ;IAAI,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,MAAM,CAAE,OAAoB,EAAE,SAAqB;QACvD,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,KAAK,CAAC,GAAG,CAAE,OAAoB,EAAE,YAAgB,EAAE,SAAqB;QACtE,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YACxF,MAAM,KAAK,GACT,OAAO,YAAY,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;gBAC7D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC,CAAC,YAAY,CAAA;YAClB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;QACxB,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,KAAK,CAAC,GAAG,CAAE,OAAoB,EAAE,KAAQ,EAAE,SAAqB;QAC9D,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IACxB,CAAC;CACF;AAxND,gEAwNC"}
+{"version":3,"file":"agentStatePropertyAccesor.js","sourceRoot":"","sources":["../../../src/state/agentStatePropertyAccesor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkFH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHG;AACH,MAAa,0BAA0B;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAgC,KAAiB,EAAkB,IAAY;QAA/C,UAAK,GAAL,KAAK,CAAY;QAAkB,SAAI,GAAJ,IAAI,CAAQ;IAAI,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,MAAM,CAAE,OAAoB,EAAE,SAAqB;QACvD,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,KAAK,CAAC,GAAG,CAAE,OAAoB,EAAE,YAAgB,EAAE,SAAqB;QACtE,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YACxF,MAAM,KAAK,GACT,OAAO,YAAY,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;gBAC7D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC,CAAC,YAAY,CAAA;YAClB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;QACxB,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,KAAK,CAAC,GAAG,CAAE,OAAoB,EAAE,KAAQ,EAAE,SAAqB;QAC9D,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QACjE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IACxB,CAAC;CACF;AA9ND,gEA8NC"}

package/dist/src/storage/fileStorage.d.ts

@@ -4,7 +4,7 @@
  */
 import { Storage, StoreItem } from './storage';
 /**
- * @summary A file-based storage implementation that persists data to the local filesystem.
+ * A file-based storage implementation that persists data to the local filesystem.
  *
  * @remarks
  * FileStorage stores all data in a single JSON file named 'state.json' within a specified folder.
@@ -43,7 +43,6 @@ import { Storage, StoreItem } from './storage';
  * await storage.delete(['conversation456']);
  * ```
  *
-
  */
 export declare class FileStorage implements Storage {
     private _folder;
@@ -52,6 +51,7 @@ export declare class FileStorage implements Storage {
      * Creates a new FileStorage instance that stores data in the specified folder.
      *
      * @param folder The absolute or relative path to the folder where the state.json file will be stored
+     * @throws May throw filesystem errors if the folder cannot be created or accessed
      *
      * @remarks
      * The constructor performs the following initialization steps:
@@ -59,7 +59,6 @@ export declare class FileStorage implements Storage {
      * 2. Creates an empty state.json file if it doesn't exist
      * 3. Loads existing data from state.json into memory for fast access
      *
-     * @throws May throw filesystem errors if the folder cannot be created or accessed
      */
     constructor(folder: string);
     /**
@@ -67,13 +66,13 @@ export declare class FileStorage implements Storage {
      *
      * @param keys Array of keys to read from storage
      * @returns Promise resolving to an object containing the requested items (keys that don't exist are omitted)
-     *
      * @throws ReferenceError if keys array is empty or undefined
      *
      * @remarks
      * This method reads from the in-memory cache that was loaded during construction,
      * making it very fast but potentially returning stale data if the file was
      * modified by external processes.
+     *
      */
     read(keys: string[]): Promise<StoreItem>;
     /**
@@ -87,8 +86,10 @@ export declare class FileStorage implements Storage {
      * to the state.json file. The file is written with pretty-printing (2-space indentation)
      * for better readability during development and debugging.
      *
-     * Note: This implementation does not support eTag-based optimistic concurrency control.
-     * Any eTag values in the changes object are ignored.
+     * > [!NOTE]
+     * > This implementation does not support eTag-based optimistic concurrency control.
+     * > Any eTag values in the changes object are ignored.
+     *
      */
     write(changes: StoreItem): Promise<void>;
     /**
@@ -103,6 +104,7 @@ export declare class FileStorage implements Storage {
      * This method removes the specified keys from both the in-memory cache
      * and writes the updated state to the state.json file. Keys that don't
      * exist in storage are silently ignored.
+     *
      */
     delete(keys: string[]): Promise<void>;
 }

package/dist/src/storage/fileStorage.js

@@ -11,7 +11,7 @@ exports.FileStorage = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 /**
- * @summary A file-based storage implementation that persists data to the local filesystem.
+ * A file-based storage implementation that persists data to the local filesystem.
  *
  * @remarks
  * FileStorage stores all data in a single JSON file named 'state.json' within a specified folder.
@@ -50,13 +50,13 @@ const fs_1 = __importDefault(require("fs"));
  * await storage.delete(['conversation456']);
  * ```
  *
-
  */
 class FileStorage {
     /**
      * Creates a new FileStorage instance that stores data in the specified folder.
      *
      * @param folder The absolute or relative path to the folder where the state.json file will be stored
+     * @throws May throw filesystem errors if the folder cannot be created or accessed
      *
      * @remarks
      * The constructor performs the following initialization steps:
@@ -64,7 +64,6 @@ class FileStorage {
      * 2. Creates an empty state.json file if it doesn't exist
      * 3. Loads existing data from state.json into memory for fast access
      *
-     * @throws May throw filesystem errors if the folder cannot be created or accessed
      */
     constructor(folder) {
         this._folder = folder;
@@ -82,13 +81,13 @@ class FileStorage {
      *
      * @param keys Array of keys to read from storage
      * @returns Promise resolving to an object containing the requested items (keys that don't exist are omitted)
-     *
      * @throws ReferenceError if keys array is empty or undefined
      *
      * @remarks
      * This method reads from the in-memory cache that was loaded during construction,
      * making it very fast but potentially returning stale data if the file was
      * modified by external processes.
+     *
      */
     read(keys) {
         return new Promise((resolve, reject) => {
@@ -118,8 +117,10 @@ class FileStorage {
      * to the state.json file. The file is written with pretty-printing (2-space indentation)
      * for better readability during development and debugging.
      *
-     * Note: This implementation does not support eTag-based optimistic concurrency control.
-     * Any eTag values in the changes object are ignored.
+     * > [!NOTE]
+     * > This implementation does not support eTag-based optimistic concurrency control.
+     * > Any eTag values in the changes object are ignored.
+     *
      */
     write(changes) {
         const keys = Object.keys(changes);
@@ -141,6 +142,7 @@ class FileStorage {
      * This method removes the specified keys from both the in-memory cache
      * and writes the updated state to the state.json file. Keys that don't
      * exist in storage are silently ignored.
+     *
      */
     delete(keys) {
         return new Promise((resolve, reject) => {

package/dist/src/storage/fileStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileStorage.js","sourceRoot":"","sources":["../../../src/storage/fileStorage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,gDAAuB;AACvB,4CAAmB;AAGnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,WAAW;IAItB;;;;;;;;;;;;OAYG;IACH,YAAa,MAAc;QACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3C,CAAC;QACD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;YACpD,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;QACD,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;QACrE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAE,IAAc;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC,CAAA;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAc,EAAE,CAAA;gBAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBACjC,IAAI,IAAI,EAAE,CAAC;wBACT,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;oBAClB,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAE,OAAkB;QACvB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QACrC,CAAC;QACD,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QACxF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAE,IAAc;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,cAAc,CAAC,kCAAkC,CAAC,CAAC,CAAA;YAChE,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBAC7B,CAAC;gBACD,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;YAC1F,CAAC;YACD,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA5GD,kCA4GC"}
+{"version":3,"file":"fileStorage.js","sourceRoot":"","sources":["../../../src/storage/fileStorage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,gDAAuB;AACvB,4CAAmB;AAGnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,WAAW;IAItB;;;;;;;;;;;;OAYG;IACH,YAAa,MAAc;QACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3C,CAAC;QACD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;YACpD,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;QACD,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;QACrE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAE,IAAc;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC,CAAA;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAc,EAAE,CAAA;gBAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBACjC,IAAI,IAAI,EAAE,CAAC;wBACT,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;oBAClB,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAE,OAAkB;QACvB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;QACrC,CAAC;QACD,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QACxF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAE,IAAc;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,cAAc,CAAC,kCAAkC,CAAC,CAAC,CAAA;YAChE,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBAC7B,CAAC;gBACD,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;YAC1F,CAAC;YACD,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA/GD,kCA+GC"}

package/dist/src/storage/memoryStorage.d.ts

@@ -35,10 +35,12 @@ export declare class MemoryStorage implements Storage {
     /**
      * Gets a single shared instance of the MemoryStorage class.
      *
+     * @returns The singleton instance of MemoryStorage
+     *
+     * @remarks
      * Using this method ensures that the same storage instance is used across
      * the application, allowing for shared state without passing references.
      *
-     * @returns The singleton instance of MemoryStorage
      */
     static getSingleInstance(): MemoryStorage;
     /**
@@ -52,14 +54,15 @@ export declare class MemoryStorage implements Storage {
     /**
      * Writes storage items to memory.
      *
+     * @param changes The items to write, indexed by key
+     * @returns A promise that resolves when the write operation is complete
+     * @throws Will throw an error if changes are not provided or if there's an eTag conflict
+     *
+     * @remarks
      * This method supports optimistic concurrency control through eTags.
      * If an item has an eTag, it will only be updated if the existing item
      * has the same eTag. If an item has an eTag of '*' or no eTag, it will
      * always be written regardless of the current state.
-     *
-     * @param changes The items to write, indexed by key
-     * @returns A promise that resolves when the write operation is complete
-     * @throws Will throw an error if changes are not provided or if there's an eTag conflict
      */
     write(changes: StoreItem): Promise<void>;
     /**
@@ -72,13 +75,15 @@ export declare class MemoryStorage implements Storage {
     /**
      * Saves an item to memory with a new eTag.
      *
+     * @param key The key of the item to save
+     * @param item The item to save
+     *
+     * @remarks
      * This private method handles the details of:
      * - Creating a clone of the item to prevent modification of the original
      * - Generating a new eTag for optimistic concurrency control
      * - Converting the item to a JSON string for storage
      *
-     * @param key The key of the item to save
-     * @param item The item to save
      * @private
      */
     private saveItem;