@fluidframework/map 2.0.0-dev-rc.3.0.0.254274 → 2.0.0-dev-rc.3.0.0.254674

package/dist/map-alpha.d.ts

@@ -1,411 +0,0 @@
-/**
- * The `map` library provides interfaces and implementing classes for map-like distributed data structures.
- *
- * @remarks The following distributed data structures are defined in this library:
- *
- * - {@link SharedMap}
- *
- * - {@link SharedDirectory}
- *
- * @packageDocumentation
- */
-
-import type { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import type { IChannelFactory } from '@fluidframework/datastore-definitions';
-import type { IChannelServices } from '@fluidframework/datastore-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
-import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import type { ISharedObjectKind } from '@fluidframework/shared-object-base';
-
-/**
- * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedDirectory}.
- *
- * @sealed
- * @alpha
- */
-export declare class DirectoryFactory implements IChannelFactory<ISharedDirectory> {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    static readonly Type = "https://graph.microsoft.com/types/directory";
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    static readonly Attributes: IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    get type(): string;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedDirectory>;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedDirectory;
-}
-
-/**
- * Interface describing actions on a directory.
- *
- * @remarks When used as a Map, operates on its keys.
- * @alpha
- */
-export declare interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {
-    /**
-     * The absolute path of the directory.
-     */
-    readonly absolutePath: string;
-    /**
-     * Retrieves the value stored at the given key from the directory.
-     * @param key - Key to retrieve from
-     * @returns The stored value, or undefined if the key is not set
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set at
-     * @param value - Value to set
-     * @returns The IDirectory itself
-     */
-    set<T = unknown>(key: string, value: T): this;
-    /**
-     * Get the number of sub directory within the directory.
-     * @returns The number of sub directory within a directory.
-     */
-    countSubDirectory?(): number;
-    /**
-     * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the
-     * same name already exists.
-     * @param subdirName - Name of the new child directory to create
-     * @returns The IDirectory child that was created or retrieved
-     */
-    createSubDirectory(subdirName: string): IDirectory;
-    /**
-     * Gets an IDirectory child of this IDirectory, if it exists.
-     * @param subdirName - Name of the child directory to get
-     * @returns The requested IDirectory
-     */
-    getSubDirectory(subdirName: string): IDirectory | undefined;
-    /**
-     * Checks whether this directory has a child directory with the given name.
-     * @param subdirName - Name of the child directory to check
-     * @returns True if it exists, false otherwise
-     */
-    hasSubDirectory(subdirName: string): boolean;
-    /**
-     * Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.
-     * @param subdirName - Name of the child directory to delete
-     * @returns True if the IDirectory existed and was deleted, false if it did not exist
-     */
-    deleteSubDirectory(subdirName: string): boolean;
-    /**
-     * Gets an iterator over the IDirectory children of this IDirectory.
-     * @returns The IDirectory iterator
-     */
-    subdirectories(): IterableIterator<[string, IDirectory]>;
-    /**
-     * Get an IDirectory within the directory, in order to use relative paths from that location.
-     * @param relativePath - Path of the IDirectory to get, relative to this IDirectory
-     * @returns The requested IDirectory
-     */
-    getWorkingDirectory(relativePath: string): IDirectory | undefined;
-}
-
-/**
- * Events emitted in response to changes to the directory data.
- * @alpha
- */
-export declare interface IDirectoryEvents extends IEvent {
-    /**
-     * Emitted when a key is set or deleted. As opposed to the
-     * {@link ISharedDirectory}'s valueChanged event, this is emitted only on the {@link IDirectory} that directly
-     * contains the key.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `changed` - Information on the key that changed and its value prior to the change.
-     *
-     * - `local` - Whether the change originated from this client.
-     *
-     * - `target` - The {@link IDirectory} itself.
-     */
-    (event: "containedValueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when a subdirectory is created. Also emitted when a delete
-     * of a subdirectory is rolled back.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `path` - The relative path to the subdirectory that is created.
-     * It is relative from the object which raises the event.
-     *
-     * - `local` - Whether the creation originated from the this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when a subdirectory is deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `path` - The relative path to the subdirectory that is deleted.
-     * It is relative from the object which raises the event.
-     *
-     * - `local` - Whether the delete originated from the this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when this sub directory is deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `target` - The {@link IDirectory} itself.
-     */
-    (event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when this previously deleted sub directory is restored.
-     * This event only needs to be handled in the case of rollback. If your application does
-     * not use the local rollback feature, you can ignore this event.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `target` - The {@link IDirectory} itself.
-     */
-    (event: "undisposed", listener: (target: IEventThisPlaceHolder) => void): any;
-}
-
-/**
- * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
- * @alpha
- */
-export declare interface IDirectoryValueChanged extends IValueChanged {
-    /**
-     * The absolute path to the IDirectory storing the key which changed.
-     */
-    path: string;
-}
-
-/**
- * Provides a hierarchical organization of map-like data structures as SubDirectories.
- * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.
- * SubDirectories can be retrieved for use as working directories.
- * @alpha
- */
-export declare interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off"> {
-    [Symbol.iterator](): IterableIterator<[string, any]>;
-    readonly [Symbol.toStringTag]: string;
-}
-
-/**
- * Events emitted in response to changes to the directory data.
- *
- * @remarks
- * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
- * @alpha
- */
-export declare interface ISharedDirectoryEvents extends ISharedObjectEvents {
-    /**
-     * Emitted when a key is set or deleted. This is emitted for any key in the {@link ISharedDirectory} or any
-     * subdirectory.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `changed` - Information on the key that changed, its value prior to the change, and the path to the
-     * key that changed.
-     *
-     * - `local` - Whether the change originated from this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when the {@link ISharedDirectory} is cleared.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `local` - Whether the clear originated from this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when a subdirectory is created.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `path` - The relative path to the subdirectory that is created.
-     * It is relative from the object which raises the event.
-     *
-     * - `local` - Whether the create originated from the this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when a subdirectory is deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `path` - The relative path to the subdirectory that is deleted.
-     * It is relative from the object which raises the event.
-     *
-     * - `local` - Whether the delete originated from the this client.
-     *
-     * - `target` - The {@link ISharedDirectory} itself.
-     */
-    (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
-}
-
-/**
- * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
- * 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/datastore#FluidObjectHandle}.
- *
- * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
- * @sealed
- * @public
- */
-export declare interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
-    /**
-     * Retrieves the given key from the map if it exists.
-     * @param key - Key to retrieve from
-     * @returns The stored value, or undefined if the key is not set
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set
-     * @param value - Value to set
-     * @returns The {@link ISharedMap} itself
-     */
-    set<T = unknown>(key: string, value: T): this;
-}
-
-/**
- * Events emitted in response to changes to the {@link ISharedMap | map} data.
- * @sealed
- * @public
- */
-export declare interface ISharedMapEvents extends ISharedObjectEvents {
-    /**
-     * Emitted when a key is set or deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `changed` - Information on the key that changed and its value prior to the change.
-     *
-     * - `local` - Whether the change originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when the map is cleared.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `local` - Whether the clear originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
-}
-
-/**
- * Type of "valueChanged" event parameter.
- * @sealed
- * @public
- */
-export declare interface IValueChanged {
-    /**
-     * The key storing the value that changed.
-     */
-    readonly key: string;
-    /**
-     * The value that was stored at the key prior to the change.
-     */
-    readonly previousValue: any;
-}
-
-/**
- * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedMap}.
- *
- * @sealed
- * @alpha
- */
-export declare class MapFactory implements IChannelFactory<ISharedMap> {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    static readonly Type = "https://graph.microsoft.com/types/map";
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    static readonly Attributes: IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    get type(): string;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedMap>;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedMap;
-}
-
-/**
- * Entrypoint for {@link ISharedDirectory} creation.
- * @sealed
- * @alpha
- */
-export declare const SharedDirectory: ISharedObjectKind<ISharedDirectory>;
-
-/**
- * Entrypoint for {@link ISharedDirectory} creation.
- * @alpha
- * @deprecated Use ISharedDirectory instead.
- * @privateRemarks
- * This alias is for legacy compat from when the SharedDirectory class was exported as public.
- */
-export declare type SharedDirectory = ISharedDirectory;
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Please use SharedTree for new containers. SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
- */
-export declare const SharedMap: ISharedObjectKind<ISharedMap>;
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Use ISharedMap instead.
- * @privateRemarks
- * This alias is for legacy compat from when the SharedMap class was exported as public.
- */
-export declare type SharedMap = ISharedMap;
-
-export { }

package/dist/map-beta.d.ts

@@ -1,130 +0,0 @@
-/**
- * The `map` library provides interfaces and implementing classes for map-like distributed data structures.
- *
- * @remarks The following distributed data structures are defined in this library:
- *
- * - {@link SharedMap}
- *
- * - {@link SharedDirectory}
- *
- * @packageDocumentation
- */
-
-import type { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import type { IChannelFactory } from '@fluidframework/datastore-definitions';
-import type { IChannelServices } from '@fluidframework/datastore-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
-import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import type { ISharedObjectKind } from '@fluidframework/shared-object-base';
-
-/* Excluded from this release type: DirectoryFactory */
-
-/* Excluded from this release type: IDirectory */
-
-/* Excluded from this release type: IDirectoryEvents */
-
-/* Excluded from this release type: IDirectoryValueChanged */
-
-/* Excluded from this release type: ISharedDirectory */
-
-/* Excluded from this release type: ISharedDirectoryEvents */
-
-/**
- * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
- * 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/datastore#FluidObjectHandle}.
- *
- * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
- * @sealed
- * @public
- */
-export declare interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
-    /**
-     * Retrieves the given key from the map if it exists.
-     * @param key - Key to retrieve from
-     * @returns The stored value, or undefined if the key is not set
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set
-     * @param value - Value to set
-     * @returns The {@link ISharedMap} itself
-     */
-    set<T = unknown>(key: string, value: T): this;
-}
-
-/**
- * Events emitted in response to changes to the {@link ISharedMap | map} data.
- * @sealed
- * @public
- */
-export declare interface ISharedMapEvents extends ISharedObjectEvents {
-    /**
-     * Emitted when a key is set or deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `changed` - Information on the key that changed and its value prior to the change.
-     *
-     * - `local` - Whether the change originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when the map is cleared.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `local` - Whether the clear originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
-}
-
-/**
- * Type of "valueChanged" event parameter.
- * @sealed
- * @public
- */
-export declare interface IValueChanged {
-    /**
-     * The key storing the value that changed.
-     */
-    readonly key: string;
-    /**
-     * The value that was stored at the key prior to the change.
-     */
-    readonly previousValue: any;
-}
-
-/* Excluded from this release type: MapFactory */
-
-/* Excluded from this release type: SharedDirectory */
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Please use SharedTree for new containers. SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
- */
-export declare const SharedMap: ISharedObjectKind<ISharedMap>;
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Use ISharedMap instead.
- * @privateRemarks
- * This alias is for legacy compat from when the SharedMap class was exported as public.
- */
-export declare type SharedMap = ISharedMap;
-
-export { }

package/dist/map-public.d.ts

@@ -1,130 +0,0 @@
-/**
- * The `map` library provides interfaces and implementing classes for map-like distributed data structures.
- *
- * @remarks The following distributed data structures are defined in this library:
- *
- * - {@link SharedMap}
- *
- * - {@link SharedDirectory}
- *
- * @packageDocumentation
- */
-
-import type { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import type { IChannelFactory } from '@fluidframework/datastore-definitions';
-import type { IChannelServices } from '@fluidframework/datastore-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
-import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import type { ISharedObjectKind } from '@fluidframework/shared-object-base';
-
-/* Excluded from this release type: DirectoryFactory */
-
-/* Excluded from this release type: IDirectory */
-
-/* Excluded from this release type: IDirectoryEvents */
-
-/* Excluded from this release type: IDirectoryValueChanged */
-
-/* Excluded from this release type: ISharedDirectory */
-
-/* Excluded from this release type: ISharedDirectoryEvents */
-
-/**
- * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
- * 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/datastore#FluidObjectHandle}.
- *
- * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
- * @sealed
- * @public
- */
-export declare interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
-    /**
-     * Retrieves the given key from the map if it exists.
-     * @param key - Key to retrieve from
-     * @returns The stored value, or undefined if the key is not set
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set
-     * @param value - Value to set
-     * @returns The {@link ISharedMap} itself
-     */
-    set<T = unknown>(key: string, value: T): this;
-}
-
-/**
- * Events emitted in response to changes to the {@link ISharedMap | map} data.
- * @sealed
- * @public
- */
-export declare interface ISharedMapEvents extends ISharedObjectEvents {
-    /**
-     * Emitted when a key is set or deleted.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `changed` - Information on the key that changed and its value prior to the change.
-     *
-     * - `local` - Whether the change originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    /**
-     * Emitted when the map is cleared.
-     *
-     * @remarks Listener parameters:
-     *
-     * - `local` - Whether the clear originated from this client.
-     *
-     * - `target` - The {@link ISharedMap} itself.
-     */
-    (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
-}
-
-/**
- * Type of "valueChanged" event parameter.
- * @sealed
- * @public
- */
-export declare interface IValueChanged {
-    /**
-     * The key storing the value that changed.
-     */
-    readonly key: string;
-    /**
-     * The value that was stored at the key prior to the change.
-     */
-    readonly previousValue: any;
-}
-
-/* Excluded from this release type: MapFactory */
-
-/* Excluded from this release type: SharedDirectory */
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Please use SharedTree for new containers. SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
- */
-export declare const SharedMap: ISharedObjectKind<ISharedMap>;
-
-/**
- * Entrypoint for {@link ISharedMap} creation.
- * @public
- * @deprecated Use ISharedMap instead.
- * @privateRemarks
- * This alias is for legacy compat from when the SharedMap class was exported as public.
- */
-export declare type SharedMap = ISharedMap;
-
-export { }