@fluidframework/map 2.0.0-rc.1.0.6 → 2.0.0-rc.2.0.1

package/lib/{localValues.mjs → localValues.js}

@@ -58,17 +58,15 @@ export class PlainLocalValue {
 export class LocalValueMaker {
     /**
      * Create a new LocalValueMaker.
-     * @param serializer - The serializer to serialize / parse handles.
      */
-    constructor(serializer) {
-        this.serializer = serializer;
-    }
+    constructor() { }
     /**
      * Create a new local value from an incoming serialized value.
      * @param serializable - The serializable value to make local
      */
+    fromSerializable(
     // eslint-disable-next-line import/no-deprecated
-    fromSerializable(serializable) {
+    serializable, serializer, bind) {
         // Migrate from old shared value to handles
         if (serializable.type === ValueType[ValueType.Shared]) {
             serializable.type = ValueType[ValueType.Plain];
@@ -76,10 +74,13 @@ export class LocalValueMaker {
                 type: "__fluid_handle__",
                 url: serializable.value,
             };
-            serializable.value = handle;
+            // NOTE: here we require the use of `parseHandles` because the roundtrip
+            // through a string is necessary to resolve the absolute path of
+            // legacy handles (`ValueType.Shared`)
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            serializable.value = serializer.encode(parseHandles(handle, serializer), bind);
         }
-        const translatedValue = parseHandles(serializable.value, this.serializer);
-        return new PlainLocalValue(translatedValue);
+        return new PlainLocalValue(serializable.value);
     }
     /**
      * Create a new local value containing a given plain object.
@@ -90,4 +91,4 @@ export class LocalValueMaker {
         return new PlainLocalValue(value);
     }
 }
-//# sourceMappingURL=localValues.mjs.map
+//# sourceMappingURL=localValues.js.map

package/lib/localValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localValues.js","sourceRoot":"","sources":["../src/localValues.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,YAAY,EACZ,gBAAgB,EAChB,SAAS,GACT,MAAM,oCAAoC,CAAC;AA+B5C;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC/B,UAAuB,EACvB,UAA4B,EAC5B,IAAkB;IAGlB,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1D,OAAO;QACN,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,mEAAmE;QACnE,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;KAC7C,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;;OAGG;IACH,YAAmC,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;IAAG,CAAC;IAErD;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAA4B,EAAE,IAAkB;QACrE,2FAA2F;QAC3F,oBAAoB;QACpB,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAE7D,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK;SACL,CAAC;IACH,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAC3B;;OAEG;IACH,gBAAsB,CAAC;IAEvB;;;OAGG;IACI,gBAAgB;IACtB,gDAAgD;IAChD,YAAgC,EAChC,UAA4B,EAC5B,IAAkB;QAElB,2CAA2C;QAC3C,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACtD,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAsB;gBACjC,IAAI,EAAE,kBAAkB;gBACxB,GAAG,EAAE,YAAY,CAAC,KAAe;aACjC,CAAC;YACF,wEAAwE;YACxE,gEAAgE;YAChE,sCAAsC;YACtC,mEAAmE;YACnE,YAAY,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;SAC/E;QAED,OAAO,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,KAAc;QACjC,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n\tIFluidSerializer,\n\tparseHandles,\n\tserializeHandles,\n\tValueType,\n} from \"@fluidframework/shared-object-base\";\nimport { ISerializedHandle } from \"@fluidframework/runtime-utils\";\n// eslint-disable-next-line import/no-deprecated\nimport { ISerializableValue, ISerializedValue } from \"./interfaces.js\";\n\n/**\n * A local value to be stored in a container type Distributed Data Store (DDS).\n * @alpha\n */\nexport interface ILocalValue {\n\t/**\n\t * Type indicator of the value stored within.\n\t */\n\treadonly type: string;\n\n\t/**\n\t * The in-memory value stored within.\n\t */\n\t// TODO: Use `unknown` instead (breaking change).\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treadonly value: any;\n\n\t/**\n\t * Retrieve the serialized form of the value stored within.\n\t * @param serializer - Data store runtime's serializer\n\t * @param bind - Container type's handle\n\t * @returns The serialized form of the contained value\n\t */\n\tmakeSerialized(serializer: IFluidSerializer, bind: IFluidHandle): ISerializedValue;\n}\n\n/**\n * Converts the provided `localValue` to its serialized form.\n *\n * @param localValue - The value to serialize.\n * @param serializer - Data store runtime's serializer.\n * @param bind - Container type's handle.\n *\n * @see {@link ILocalValue.makeSerialized}\n */\nexport function makeSerializable(\n\tlocalValue: ILocalValue,\n\tserializer: IFluidSerializer,\n\tbind: IFluidHandle,\n\t// eslint-disable-next-line import/no-deprecated\n): ISerializableValue {\n\tconst value = localValue.makeSerialized(serializer, bind);\n\treturn {\n\t\ttype: value.type,\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\tvalue: value.value && JSON.parse(value.value),\n\t};\n}\n\n/**\n * Manages a contained plain value.  May also contain shared object handles.\n */\nexport class PlainLocalValue implements ILocalValue {\n\t/**\n\t * Create a new PlainLocalValue.\n\t * @param value - The value to store, which may contain shared object handles\n\t */\n\tpublic constructor(public readonly value: unknown) {}\n\n\t/**\n\t * {@inheritDoc ILocalValue.\"type\"}\n\t */\n\tpublic get type(): string {\n\t\treturn ValueType[ValueType.Plain];\n\t}\n\n\t/**\n\t * {@inheritDoc ILocalValue.makeSerialized}\n\t */\n\tpublic makeSerialized(serializer: IFluidSerializer, bind: IFluidHandle): ISerializedValue {\n\t\t// Stringify to convert to the serialized handle values - and then parse in order to create\n\t\t// a POJO for the op\n\t\tconst value = serializeHandles(this.value, serializer, bind);\n\n\t\treturn {\n\t\t\ttype: this.type,\n\t\t\tvalue,\n\t\t};\n\t}\n}\n\n/**\n * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local\n * values with minimal awareness of how those objects are stored, serialized, and deserialized.\n * @alpha\n */\nexport class LocalValueMaker {\n\t/**\n\t * Create a new LocalValueMaker.\n\t */\n\tpublic constructor() {}\n\n\t/**\n\t * Create a new local value from an incoming serialized value.\n\t * @param serializable - The serializable value to make local\n\t */\n\tpublic fromSerializable(\n\t\t// eslint-disable-next-line import/no-deprecated\n\t\tserializable: ISerializableValue,\n\t\tserializer: IFluidSerializer,\n\t\tbind: IFluidHandle,\n\t): ILocalValue {\n\t\t// Migrate from old shared value to handles\n\t\tif (serializable.type === ValueType[ValueType.Shared]) {\n\t\t\tserializable.type = ValueType[ValueType.Plain];\n\t\t\tconst handle: ISerializedHandle = {\n\t\t\t\ttype: \"__fluid_handle__\",\n\t\t\t\turl: serializable.value as string,\n\t\t\t};\n\t\t\t// NOTE: here we require the use of `parseHandles` because the roundtrip\n\t\t\t// through a string is necessary to resolve the absolute path of\n\t\t\t// legacy handles (`ValueType.Shared`)\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\tserializable.value = serializer.encode(parseHandles(handle, serializer), bind);\n\t\t}\n\n\t\treturn new PlainLocalValue(serializable.value);\n\t}\n\n\t/**\n\t * Create a new local value containing a given plain object.\n\t * @param value - The value to store\n\t * @returns An ILocalValue containing the value\n\t */\n\tpublic fromInMemory(value: unknown): ILocalValue {\n\t\treturn new PlainLocalValue(value);\n\t}\n}\n"]}

package/lib/{map-alpha.d.mts → map-alpha.d.ts}

@@ -1,3 +1,15 @@
+/**
+ * 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 { IChannelAttributes } from '@fluidframework/datastore-definitions';
 import { IChannelFactory } from '@fluidframework/datastore-definitions';
 import { IChannelServices } from '@fluidframework/datastore-definitions';
@@ -22,7 +34,7 @@ import { SharedObject } from '@fluidframework/shared-object-base';
  * @sealed
  * @alpha
  */
-export declare class DirectoryFactory implements IChannelFactory {
+export declare class DirectoryFactory implements IChannelFactory<ISharedDirectory> {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
      */
@@ -585,17 +597,15 @@ export declare interface IValueChanged {
  * @alpha
  */
 export declare class LocalValueMaker {
-    private readonly serializer;
     /**
      * Create a new LocalValueMaker.
-     * @param serializer - The serializer to serialize / parse handles.
      */
-    constructor(serializer: IFluidSerializer);
+    constructor();
     /**
      * Create a new local value from an incoming serialized value.
      * @param serializable - The serializable value to make local
      */
-    fromSerializable(serializable: ISerializableValue): ILocalValue;
+    fromSerializable(serializable: ISerializableValue, serializer: IFluidSerializer, bind: IFluidHandle): ILocalValue;
     /**
      * Create a new local value containing a given plain object.
      * @param value - The value to store
@@ -605,12 +615,12 @@ export declare class LocalValueMaker {
 }
 
 /**
- * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedMap}.
  *
  * @sealed
  * @alpha
  */
-export declare class MapFactory implements IChannelFactory {
+export declare class MapFactory implements IChannelFactory<ISharedMap> {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
      */
@@ -659,13 +669,13 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
      * @param id - Optional name of the shared directory
      * @returns Newly create shared directory (but not attached yet)
      */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedDirectory;
+    static create(runtime: IFluidDataStoreRuntime, id?: string): ISharedDirectory;
     /**
      * Get a factory for SharedDirectory to register with the data store.
      *
      * @returns A factory that creates and load SharedDirectory
      */
-    static getFactory(): IChannelFactory;
+    static getFactory(): IChannelFactory<ISharedDirectory>;
     /**
      * String representation for the class.
      */
@@ -840,7 +850,7 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
-    protected applyStashedOp(op: unknown): unknown;
+    protected applyStashedOp(op: unknown): void;
     private serializeDirectory;
 }
 
@@ -849,7 +859,12 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
  * @public
  * @deprecated Please use SharedTree for new containers.  SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
  */
-export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
+export declare const SharedMap: {
+    /**
+     * Get a factory for SharedMap to register with the data store.
+     * @returns A factory that creates SharedMaps and loads them from storage.
+     */
+    getFactory(): IChannelFactory<ISharedMap>;
     /**
      * Create a new shared map.
      * @param runtime - The data store runtime that the new shared map belongs to.
@@ -862,110 +877,22 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements
      * ```typescript
      * const myMap = SharedMap.create(this.runtime, id);
      * ```
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedMap;
-    /**
-     * Get a factory for SharedMap to register with the data store.
-     * @returns A factory that creates SharedMaps and loads them from storage.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * String representation for the class.
-     */
-    readonly [Symbol.toStringTag]: string;
-    /**
-     * MapKernel which manages actual map operations.
-     */
-    private readonly kernel;
-    /**
-     * Do not call the constructor. Instead, you should use the {@link SharedMap.create | create method}.
-     *
-     * @param id - String identifier.
-     * @param runtime - Data store runtime.
-     * @param attributes - The attributes for the map.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * Get an iterator over the keys in this map.
-     * @returns The iterator
-     */
-    keys(): IterableIterator<string>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    entries(): IterableIterator<[string, any]>;
-    /**
-     * Get an iterator over the values in this map.
-     * @returns The iterator
-     */
-    values(): IterableIterator<any>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    [Symbol.iterator](): IterableIterator<[string, any]>;
-    /**
-     * The number of key/value pairs stored in the map.
-     */
-    get size(): number;
-    /**
-     * Executes the given callback on each entry in the map.
-     * @param callbackFn - Callback function
-     */
-    forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void;
-    /**
-     * {@inheritDoc ISharedMap.get}
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Check if a key exists in the map.
-     * @param key - The key to check
-     * @returns True if the key exists, false otherwise
-     */
-    has(key: string): boolean;
-    /**
-     * {@inheritDoc ISharedMap.set}
-     */
-    set(key: string, value: unknown): this;
-    /**
-     * Delete a key from the map.
-     * @param key - Key to delete
-     * @returns True if the key existed and was deleted, false if it did not exist
-     */
-    delete(key: string): boolean;
-    /**
-     * Clear all data from the map.
-     */
-    clear(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-     */
-    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-     */
-    protected applyStashedOp(content: unknown): unknown;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-     */
-    protected rollback(content: unknown, localOpMetadata: unknown): void;
-}
+     * @privateRemarks
+     * TODO:
+     * Clarify how this differs from `MapFactory.create`.
+     * They are different since making this forward to MapFactory.create breaks some things,
+     * but the difference is unclear from the documentation.
+     */
+    create(runtime: IFluidDataStoreRuntime, id?: string): ISharedMap;
+};
+
+/**
+ * {@inheritDoc ISharedMap}
+ * @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/lib/{map-beta.d.mts → map-beta.d.ts}

@@ -1,3 +1,15 @@
+/**
+ * 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 { IChannelAttributes } from '@fluidframework/datastore-definitions';
 import { IChannelFactory } from '@fluidframework/datastore-definitions';
 import { IChannelServices } from '@fluidframework/datastore-definitions';
@@ -142,7 +154,12 @@ export declare interface IValueChanged {
  * @public
  * @deprecated Please use SharedTree for new containers.  SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
  */
-export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
+export declare const SharedMap: {
+    /**
+     * Get a factory for SharedMap to register with the data store.
+     * @returns A factory that creates SharedMaps and loads them from storage.
+     */
+    getFactory(): IChannelFactory<ISharedMap>;
     /**
      * Create a new shared map.
      * @param runtime - The data store runtime that the new shared map belongs to.
@@ -155,110 +172,24 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements
      * ```typescript
      * const myMap = SharedMap.create(this.runtime, id);
      * ```
+     * @privateRemarks
+     * TODO:
+     * Clarify how this differs from `MapFactory.create`.
+     * They are different since making this forward to MapFactory.create breaks some things,
+     * but the difference is unclear from the documentation.
      */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedMap;
-    /**
-     * Get a factory for SharedMap to register with the data store.
-     * @returns A factory that creates SharedMaps and loads them from storage.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * String representation for the class.
-     */
-    readonly [Symbol.toStringTag]: string;
-    /**
-     * MapKernel which manages actual map operations.
-     */
-    private readonly kernel;
-    /**
-     * Do not call the constructor. Instead, you should use the {@link SharedMap.create | create method}.
-     *
-     * @param id - String identifier.
-     * @param runtime - Data store runtime.
-     * @param attributes - The attributes for the map.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * Get an iterator over the keys in this map.
-     * @returns The iterator
-     */
-    keys(): IterableIterator<string>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    entries(): IterableIterator<[string, any]>;
-    /**
-     * Get an iterator over the values in this map.
-     * @returns The iterator
-     */
-    values(): IterableIterator<any>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    [Symbol.iterator](): IterableIterator<[string, any]>;
-    /**
-     * The number of key/value pairs stored in the map.
-     */
-    get size(): number;
-    /**
-     * Executes the given callback on each entry in the map.
-     * @param callbackFn - Callback function
-     */
-    forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void;
-    /**
-     * {@inheritDoc ISharedMap.get}
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Check if a key exists in the map.
-     * @param key - The key to check
-     * @returns True if the key exists, false otherwise
-     */
-    has(key: string): boolean;
-    /**
-     * {@inheritDoc ISharedMap.set}
-     */
-    set(key: string, value: unknown): this;
-    /**
-     * Delete a key from the map.
-     * @param key - Key to delete
-     * @returns True if the key existed and was deleted, false if it did not exist
-     */
-    delete(key: string): boolean;
-    /**
-     * Clear all data from the map.
-     */
-    clear(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-     */
-    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-     */
-    protected applyStashedOp(content: unknown): unknown;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-     */
-    protected rollback(content: unknown, localOpMetadata: unknown): void;
-}
+    create(runtime: IFluidDataStoreRuntime, id?: string): ISharedMap;
+};
+
+/**
+ * {@inheritDoc ISharedMap}
+ * @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;
+
+/* Excluded from this release type: SharedObject */
 
 export { }

package/lib/{map-public.d.mts → map-public.d.ts}

@@ -1,3 +1,15 @@
+/**
+ * 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 { IChannelAttributes } from '@fluidframework/datastore-definitions';
 import { IChannelFactory } from '@fluidframework/datastore-definitions';
 import { IChannelServices } from '@fluidframework/datastore-definitions';
@@ -142,7 +154,12 @@ export declare interface IValueChanged {
  * @public
  * @deprecated Please use SharedTree for new containers.  SharedMap is supported for loading preexisting Fluid Framework 1.0 containers only.
  */
-export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
+export declare const SharedMap: {
+    /**
+     * Get a factory for SharedMap to register with the data store.
+     * @returns A factory that creates SharedMaps and loads them from storage.
+     */
+    getFactory(): IChannelFactory<ISharedMap>;
     /**
      * Create a new shared map.
      * @param runtime - The data store runtime that the new shared map belongs to.
@@ -155,110 +172,24 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements
      * ```typescript
      * const myMap = SharedMap.create(this.runtime, id);
      * ```
+     * @privateRemarks
+     * TODO:
+     * Clarify how this differs from `MapFactory.create`.
+     * They are different since making this forward to MapFactory.create breaks some things,
+     * but the difference is unclear from the documentation.
      */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedMap;
-    /**
-     * Get a factory for SharedMap to register with the data store.
-     * @returns A factory that creates SharedMaps and loads them from storage.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * String representation for the class.
-     */
-    readonly [Symbol.toStringTag]: string;
-    /**
-     * MapKernel which manages actual map operations.
-     */
-    private readonly kernel;
-    /**
-     * Do not call the constructor. Instead, you should use the {@link SharedMap.create | create method}.
-     *
-     * @param id - String identifier.
-     * @param runtime - Data store runtime.
-     * @param attributes - The attributes for the map.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * Get an iterator over the keys in this map.
-     * @returns The iterator
-     */
-    keys(): IterableIterator<string>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    entries(): IterableIterator<[string, any]>;
-    /**
-     * Get an iterator over the values in this map.
-     * @returns The iterator
-     */
-    values(): IterableIterator<any>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    [Symbol.iterator](): IterableIterator<[string, any]>;
-    /**
-     * The number of key/value pairs stored in the map.
-     */
-    get size(): number;
-    /**
-     * Executes the given callback on each entry in the map.
-     * @param callbackFn - Callback function
-     */
-    forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void;
-    /**
-     * {@inheritDoc ISharedMap.get}
-     */
-    get<T = any>(key: string): T | undefined;
-    /**
-     * Check if a key exists in the map.
-     * @param key - The key to check
-     * @returns True if the key exists, false otherwise
-     */
-    has(key: string): boolean;
-    /**
-     * {@inheritDoc ISharedMap.set}
-     */
-    set(key: string, value: unknown): this;
-    /**
-     * Delete a key from the map.
-     * @param key - Key to delete
-     * @returns True if the key existed and was deleted, false if it did not exist
-     */
-    delete(key: string): boolean;
-    /**
-     * Clear all data from the map.
-     */
-    clear(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-     */
-    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-     */
-    protected applyStashedOp(content: unknown): unknown;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-     */
-    protected rollback(content: unknown, localOpMetadata: unknown): void;
-}
+    create(runtime: IFluidDataStoreRuntime, id?: string): ISharedMap;
+};
+
+/**
+ * {@inheritDoc ISharedMap}
+ * @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;
+
+/* Excluded from this release type: SharedObject */
 
 export { }