@fluidframework/map 2.0.0-internal.2.0.2 → 2.0.0-internal.2.1.0

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Interface describing actions on a directory.\n *\n * @remarks\n * When used as a Map, operates on its keys.\n */\nexport interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {\n    /**\n     * The absolute path of the directory.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * Retrieves the value stored at the given key from the directory.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set at\n     * @param value - Value to set\n     * @returns The IDirectory itself\n     */\n    set<T = any>(key: string, value: T): this;\n\n    /**\n     * Get the number of sub directory within the directory.\n     * @returns The number of sub directory within a directory.\n     */\n    countSubDirectory?(): number;\n\n    /**\n     * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the\n     * same name already exists.\n     * @param subdirName - Name of the new child directory to create\n     * @returns The IDirectory child that was created or retrieved\n     */\n    createSubDirectory(subdirName: string): IDirectory;\n\n    /**\n     * Gets an IDirectory child of this IDirectory, if it exists.\n     * @param subdirName - Name of the child directory to get\n     * @returns The requested IDirectory\n     */\n    getSubDirectory(subdirName: string): IDirectory | undefined;\n\n    /**\n     * Checks whether this directory has a child directory with the given name.\n     * @param subdirName - Name of the child directory to check\n     * @returns True if it exists, false otherwise\n     */\n    hasSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.\n     * @param subdirName - Name of the child directory to delete\n     * @returns True if the IDirectory existed and was deleted, false if it did not exist\n     */\n    deleteSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Gets an iterator over the IDirectory children of this IDirectory.\n     * @returns The IDirectory iterator\n     */\n    subdirectories(): IterableIterator<[string, IDirectory]>;\n\n    /**\n     * Get an IDirectory within the directory, in order to use relative paths from that location.\n     * @param relativePath - Path of the IDirectory to get, relative to this IDirectory\n     * @returns The requested IDirectory\n     */\n    getWorkingDirectory(relativePath: string): IDirectory | undefined;\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.\n */\nexport interface ISharedDirectoryEvents extends ISharedObjectEvents {\n     /**\n     * Emitted when a key is set or deleted. This is emitted for any key in the {@link ISharedDirectory} or any\n     * subdirectory.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed, its value prior to the change, and the path to the\n     * key that changed.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IDirectoryValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when the {@link ISharedDirectory} is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the create originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n */\nexport interface IDirectoryEvents extends IEvent {\n    /**\n     * Emitted when a key is set or deleted. As opposed to the\n     * {@link SharedDirectory}'s valueChanged event, this is emitted only on the {@link IDirectory} that directly\n     * contains the key.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"containedValueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the creation originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when this sub directory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"disposed\", listener: (\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Provides a hierarchical organization of map-like data structures as SubDirectories.\n * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.\n * SubDirectories can be retrieved for use as working directories.\n */\nexport interface ISharedDirectory extends\n    ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,\n    Omit<IDirectory, \"on\" | \"once\" | \"off\"> {\n    // The Omit type excludes symbols, which we don't want to exclude.  Adding them back here manually.\n    // https://github.com/microsoft/TypeScript/issues/31671\n    [Symbol.iterator](): IterableIterator<[string, any]>;\n    readonly [Symbol.toStringTag]: string;\n}\n\n/**\n * Type of \"valueChanged\" event parameter for {@link ISharedDirectory}\n */\nexport interface IDirectoryValueChanged extends IValueChanged {\n    /**\n     * The absolute path to the IDirectory storing the key which changed.\n     */\n    path: string;\n}\n\n/**\n * Events emitted in response to changes to the {@link ISharedMap | map} data.\n */\nexport interface ISharedMapEvents extends ISharedObjectEvents {\n    /**\n     * Emitted when a key is set or deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n\n    /**\n     * Emitted when the map is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting\n * and retrieving values that JavaScript developers are accustomed to with the\n * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.\n * However, the keys of a SharedMap must be strings, and the values must either be a JSON-serializable object or a\n * {@link @fluidframework/shared-object-base#SharedObjectHandle}.\n *\n * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.\n */\nexport interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {\n    /**\n     * Retrieves the given key from the map if it exists.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set\n     * @param value - Value to set\n     * @returns The {@link ISharedMap} itself\n     */\n    set<T = any>(key: string, value: T): this;\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * {@link ISerializableValue.\"type\"} to understand whether they're storing a Plain JavaScript object,\n * a {@link @fluidframework/shared-object-base#SharedObject}, or a value type.\n *\n * @remarks\n *\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead).  An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n *\n * If type is Plain, it must be a plain JS object that can survive a JSON.stringify/parse.  E.g. a URL object will\n * just get stringified to a URL string and not rehydrate as a URL object on the other side. It may contain members\n * that are ISerializedHandle (the serialized form of a handle).\n *\n * If type is a value type then it must be amongst the types registered via registerValueType or we won't know how\n * to serialize/deserialize it (we rely on its factory via .load() and .store()).  Its value will be type-dependent.\n * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a\n * channel ID.\n *\n * @deprecated This type is legacy and deprecated.\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\n/**\n * Serialized {@link ISerializableValue} counterpart.\n */\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     *\n     * @remarks Will be undefined if the original value was undefined.\n     */\n    value: string | undefined;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Interface describing actions on a directory.\n *\n * @remarks\n * When used as a Map, operates on its keys.\n */\nexport interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {\n    /**\n     * The absolute path of the directory.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * Retrieves the value stored at the given key from the directory.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set at\n     * @param value - Value to set\n     * @returns The IDirectory itself\n     */\n    set<T = any>(key: string, value: T): this;\n\n    /**\n     * Get the number of sub directory within the directory.\n     * @returns The number of sub directory within a directory.\n     */\n    countSubDirectory?(): number;\n\n    /**\n     * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the\n     * same name already exists.\n     * @param subdirName - Name of the new child directory to create\n     * @returns The IDirectory child that was created or retrieved\n     */\n    createSubDirectory(subdirName: string): IDirectory;\n\n    /**\n     * Gets an IDirectory child of this IDirectory, if it exists.\n     * @param subdirName - Name of the child directory to get\n     * @returns The requested IDirectory\n     */\n    getSubDirectory(subdirName: string): IDirectory | undefined;\n\n    /**\n     * Checks whether this directory has a child directory with the given name.\n     * @param subdirName - Name of the child directory to check\n     * @returns True if it exists, false otherwise\n     */\n    hasSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.\n     * @param subdirName - Name of the child directory to delete\n     * @returns True if the IDirectory existed and was deleted, false if it did not exist\n     */\n    deleteSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Gets an iterator over the IDirectory children of this IDirectory.\n     * @returns The IDirectory iterator\n     */\n    subdirectories(): IterableIterator<[string, IDirectory]>;\n\n    /**\n     * Get an IDirectory within the directory, in order to use relative paths from that location.\n     * @param relativePath - Path of the IDirectory to get, relative to this IDirectory\n     * @returns The requested IDirectory\n     */\n    getWorkingDirectory(relativePath: string): IDirectory | undefined;\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.\n */\nexport interface ISharedDirectoryEvents extends ISharedObjectEvents {\n     /**\n     * Emitted when a key is set or deleted. This is emitted for any key in the {@link ISharedDirectory} or any\n     * subdirectory.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed, its value prior to the change, and the path to the\n     * key that changed.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IDirectoryValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when the {@link ISharedDirectory} is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the create originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n */\nexport interface IDirectoryEvents extends IEvent {\n    /**\n     * Emitted when a key is set or deleted. As opposed to the\n     * {@link SharedDirectory}'s valueChanged event, this is emitted only on the {@link IDirectory} that directly\n     * contains the key.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"containedValueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the creation originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when this sub directory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"disposed\", listener: (\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Provides a hierarchical organization of map-like data structures as SubDirectories.\n * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.\n * SubDirectories can be retrieved for use as working directories.\n */\nexport interface ISharedDirectory extends\n    ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,\n    Omit<IDirectory, \"on\" | \"once\" | \"off\"> {\n    // The Omit type excludes symbols, which we don't want to exclude.  Adding them back here manually.\n    // https://github.com/microsoft/TypeScript/issues/31671\n    [Symbol.iterator](): IterableIterator<[string, any]>;\n    readonly [Symbol.toStringTag]: string;\n}\n\n/**\n * Type of \"valueChanged\" event parameter for {@link ISharedDirectory}\n */\nexport interface IDirectoryValueChanged extends IValueChanged {\n    /**\n     * The absolute path to the IDirectory storing the key which changed.\n     */\n    path: string;\n}\n\n/**\n * Events emitted in response to changes to the {@link ISharedMap | map} data.\n */\nexport interface ISharedMapEvents extends ISharedObjectEvents {\n    /**\n     * Emitted when a key is set or deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n\n    /**\n     * Emitted when the map is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting\n * and retrieving values that JavaScript developers are accustomed to with the\n * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.\n * However, the keys of a SharedMap must be strings, and the values must either be a JSON-serializable object or a\n * {@link @fluidframework/datastore#FluidObjectHandle}.\n *\n * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.\n */\nexport interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {\n    /**\n     * Retrieves the given key from the map if it exists.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set\n     * @param value - Value to set\n     * @returns The {@link ISharedMap} itself\n     */\n    set<T = any>(key: string, value: T): this;\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * {@link ISerializableValue.\"type\"} to understand whether they're storing a Plain JavaScript object,\n * a {@link @fluidframework/shared-object-base#SharedObject}, or a value type.\n *\n * @remarks\n *\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead).  An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n *\n * If type is Plain, it must be a plain JS object that can survive a JSON.stringify/parse.  E.g. a URL object will\n * just get stringified to a URL string and not rehydrate as a URL object on the other side. It may contain members\n * that are ISerializedHandle (the serialized form of a handle).\n *\n * If type is a value type then it must be amongst the types registered via registerValueType or we won't know how\n * to serialize/deserialize it (we rely on its factory via .load() and .store()).  Its value will be type-dependent.\n * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a\n * channel ID.\n *\n * @deprecated This type is legacy and deprecated.\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\n/**\n * Serialized {@link ISerializableValue} counterpart.\n */\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     *\n     * @remarks Will be undefined if the original value was undefined.\n     */\n    value: string | undefined;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/map";
-export declare const pkgVersion = "2.0.0-internal.2.0.2";
+export declare const pkgVersion = "2.0.0-internal.2.1.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-internal.2.0.2";
+export const pkgVersion = "2.0.0-internal.2.1.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAC7C,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/map\";\nexport const pkgVersion = \"2.0.0-internal.2.0.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAC7C,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/map\";\nexport const pkgVersion = \"2.0.0-internal.2.1.0\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.0.0-internal.2.0.2",
+  "version": "2.0.0-internal.2.1.0",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,8 +37,6 @@
     "test:mocha": "mocha --unhandled-rejections=strict --recursive 'dist/test/mocha/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
-    "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace",
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "nyc": {
@@ -64,25 +62,26 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-utils": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/shared-object-base": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/shared-object-base": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
+    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@fluid-tools/benchmark": "^0.43.0",
-    "@fluidframework/build-common": "^1.0.0",
-    "@fluidframework/build-tools": "^0.4.6000",
-    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluid-tools/build-cli": "^0.5.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.5.0",
+    "@fluidframework/eslint-config-fluid": "^1.1.0",
     "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-internal.2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.2.0.2 <2.0.0-internal.3.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -94,11 +93,10 @@
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.0.1",
+    "version": "2.0.0-internal.2.1.0",
     "broken": {}
   }
 }

package/src/directory.ts

@@ -67,6 +67,8 @@ interface IDirectoryMessageHandler {
      * @param localOpMetadata - The metadata to be submitted with the message.
      */
     submit(op: IDirectoryOperation, localOpMetadata: unknown): void;
+
+    applyStashedOp(op: IDirectoryOperation): unknown;
 }
 
 /**
@@ -712,6 +714,12 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
                         subdir.resubmitClearMessage(op, localOpMetadata);
                     }
                 },
+                applyStashedOp: (op: IDirectoryClearOperation): IClearLocalOpMetadata | undefined => {
+                    const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
+                    if (subdir) {
+                        return subdir.applyStashedClearMessage(op);
+                    }
+                },
             },
         );
         this.messageHandlers.set(
@@ -729,6 +737,12 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
                         subdir.resubmitKeyMessage(op, localOpMetadata);
                     }
                 },
+                applyStashedOp: (op: IDirectoryDeleteOperation): IKeyEditLocalOpMetadata | undefined => {
+                    const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
+                    if (subdir) {
+                        return subdir.applyStashedDeleteMessage(op);
+                    }
+                },
             },
         );
         this.messageHandlers.set(
@@ -747,6 +761,13 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
                         subdir.resubmitKeyMessage(op, localOpMetadata);
                     }
                 },
+                applyStashedOp: (op: IDirectorySetOperation): IKeyEditLocalOpMetadata | undefined => {
+                    const subdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
+                    if (subdir) {
+                        const context = this.makeLocal(op.key, op.path, op.value);
+                        return subdir.applyStashedSetMessage(op, context);
+                    }
+                },
             },
         );
 
@@ -766,6 +787,13 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
                         parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                     }
                 },
+                // eslint-disable-next-line max-len
+                applyStashedOp: (op: IDirectoryCreateSubDirectoryOperation): ICreateSubDirLocalOpMetadata | undefined => {
+                    const parentSubdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
+                    if (parentSubdir) {
+                        return parentSubdir.applyStashedCreateSubDirMessage(op);
+                    }
+                },
             },
         );
 
@@ -785,6 +813,13 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
                         parentSubdir.resubmitSubDirectoryMessage(op, localOpMetadata);
                     }
                 },
+                // eslint-disable-next-line max-len
+                applyStashedOp: (op: IDirectoryDeleteSubDirectoryOperation): IDeleteSubDirLocalOpMetadata | undefined => {
+                    const parentSubdir = this.getWorkingDirectory(op.path) as SubDirectory | undefined;
+                    if (parentSubdir) {
+                        return parentSubdir.applyStashedDeleteSubDirMessage(op);
+                    }
+                },
             },
         );
     }
@@ -792,8 +827,12 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
     /**
      * @internal
      */
-    protected applyStashedOp() {
-        throw new Error("not implemented");
+    protected applyStashedOp(op) {
+        const handler = this.messageHandlers.get(op.type);
+        if (handler === undefined) {
+            throw new Error("no apply stashed op handler");
+        }
+        return handler.applyStashedOp(op as IDirectoryOperation);
     }
 
     private serializeDirectory(
@@ -1296,7 +1335,26 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
                 0x32a /* pendingMessageId does not match */);
             return;
         }
-        this.clearExceptPendingKeys();
+        this.clearExceptPendingKeys(false);
+    }
+
+    /**
+     * Apply clear operation locally and generate metadata
+     * @param op - Op to apply
+     * @returns metadata generated for stahed op
+     */
+    public applyStashedClearMessage(op: IDirectoryClearOperation): IClearLocalOpMetadata {
+        this.throwIfDisposed();
+        const previousValue = new Map<string, ILocalValue>(this._storage);
+        this.clearExceptPendingKeys(true);
+        const pendingMsgId = ++this.pendingMessageId;
+        this.pendingClearMessageIds.push(pendingMsgId);
+        const metadata: IClearLocalOpMetadata = {
+            type: "clear",
+            pendingMessageId: pendingMsgId,
+            previousStorage: previousValue,
+        };
+        return metadata;
     }
 
     /**
@@ -1319,6 +1377,19 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         this.deleteCore(op.key, local);
     }
 
+    /**
+     * Apply delete operation locally and generate metadata
+     * @param op - Op to apply
+     * @returns metadata generated for stahed op
+     */
+    public applyStashedDeleteMessage(op: IDirectoryDeleteOperation): IKeyEditLocalOpMetadata {
+        this.throwIfDisposed();
+        const previousValue = this.deleteCore(op.key, true);
+        const pendingMessageId = this.getKeyMessageId(op);
+        const localMetadata: IKeyEditLocalOpMetadata = { type: "edit", pendingMessageId, previousValue };
+        return localMetadata;
+    }
+
     /**
      * Process a set operation.
      * @param op - The op to process
@@ -1345,6 +1416,25 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         this.setCore(op.key, context!, local);
     }
 
+    /**
+     * Apply set operation locally and generate metadata
+     * @param op - Op to apply
+     * @returns metadata generated for stahed op
+     */
+    public applyStashedSetMessage(op: IDirectorySetOperation, context: ILocalValue): IKeyEditLocalOpMetadata {
+        this.throwIfDisposed();
+        // Set the value locally.
+        const previousValue = this.setCore(
+            op.key,
+            context,
+            true,
+        );
+
+        // Create metadata
+        const pendingMessageId = this.getKeyMessageId(op);
+        const localMetadata: IKeyEditLocalOpMetadata = { type: "edit", pendingMessageId, previousValue };
+        return localMetadata;
+    }
     /**
      * Process a create subdirectory operation.
      * @param op - The op to process
@@ -1365,6 +1455,26 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         this.createSubDirectoryCore(op.subdirName, local);
     }
 
+    /**
+     * Apply createSubDirectory operation locally and generate metadata
+     * @param op - Op to apply
+     * @returns metadata generated for stahed op
+     */
+    public applyStashedCreateSubDirMessage(op: IDirectoryCreateSubDirectoryOperation):
+    ICreateSubDirLocalOpMetadata {
+        this.throwIfDisposed();
+        // Create the sub directory locally first.
+        const isNew = this.createSubDirectoryCore(op.subdirName, true);
+        const newMessageId = this.getSubDirMessageId(op);
+
+        const localOpMetadata: ICreateSubDirLocalOpMetadata = {
+            type: "createSubDir",
+            pendingMessageId: newMessageId,
+            previouslyExisted: !isNew,
+        };
+        return localOpMetadata;
+    }
+
     /**
      * Process a delete subdirectory operation.
      * @param op - The op to process
@@ -1385,6 +1495,23 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         this.deleteSubDirectoryCore(op.subdirName, local);
     }
 
+    /**
+     * Apply deleteSubDirectory operation locally and generate metadata
+     * @param op - Op to apply
+     * @returns metadata generated for stahed op
+     */
+    public applyStashedDeleteSubDirMessage(op: IDirectoryDeleteSubDirectoryOperation): IDeleteSubDirLocalOpMetadata {
+        this.throwIfDisposed();
+        const subDir = this.deleteSubDirectoryCore(op.subdirName, true);
+        const newMessageId = this.getSubDirMessageId(op);
+        const metadata: IDeleteSubDirLocalOpMetadata = {
+            type: "deleteSubDir",
+            pendingMessageId: newMessageId,
+            subDirectory: subDir,
+        };
+        return metadata;
+    }
+
     /**
      * Submit a clear operation.
      * @param op - The operation
@@ -1744,7 +1871,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     /**
      * Clear all keys in memory in response to a remote clear, but retain keys we have modified but not yet been ack'd.
      */
-    private clearExceptPendingKeys() {
+    private clearExceptPendingKeys(local: boolean) {
         // Assuming the pendingKeys is small and the map is large
         // we will get the value for the pendingKeys and clear the map
         const temp = new Map<string, ILocalValue>();
@@ -1752,7 +1879,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             temp.set(key, this._storage.get(key)!);
         });
-        this.clearCore(false);
+        this.clearCore(local);
         temp.forEach((value, key, map) => {
             this.setCore(key, value, true);
         });

package/src/index.ts

@@ -15,7 +15,32 @@
  * @packageDocumentation
  */
 
-export * from "./interfaces";
-export * from "./map";
-export * from "./directory";
+export {
+	DirectoryFactory,
+	IDirectoryClearOperation,
+	IDirectoryCreateSubDirectoryOperation,
+	IDirectoryDataObject,
+	IDirectoryDeleteOperation,
+	IDirectoryDeleteSubDirectoryOperation,
+	IDirectoryKeyOperation,
+	IDirectoryNewStorageFormat,
+	IDirectoryOperation,
+	IDirectorySetOperation,
+	IDirectoryStorageOperation,
+	IDirectorySubDirectoryOperation,
+	SharedDirectory,
+} from "./directory";
+export {
+	IDirectory,
+	IDirectoryEvents,
+	IDirectoryValueChanged,
+	ISerializableValue,
+	ISerializedValue,
+	ISharedDirectory,
+	ISharedDirectoryEvents,
+	ISharedMap,
+	ISharedMapEvents,
+	IValueChanged,
+} from "./interfaces";
 export { LocalValueMaker, ILocalValue } from "./localValues";
+export { MapFactory, SharedMap } from "./map";

package/src/interfaces.ts

@@ -308,7 +308,7 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
  * and retrieving values that JavaScript developers are accustomed to with the
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.
  * However, the keys of a SharedMap must be strings, and the values must either be a JSON-serializable object or a
- * {@link @fluidframework/shared-object-base#SharedObjectHandle}.
+ * {@link @fluidframework/datastore#FluidObjectHandle}.
  *
  * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
  */

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-internal.2.0.2";
+export const pkgVersion = "2.0.0-internal.2.1.0";