DDS Migration Shim

PACKAGES.md

@@ -99,7 +99,7 @@ The dependencies between layers are enforced by the layer-check command._
 
 | Packages | Layer Dependencies |
 | --- | --- |
-| - [@fluid-experimental/attributable-map](/experimental/dds/attributable-map)</br>- [@fluid-experimental/ot](/experimental/dds/ot/ot)</br>- [@fluid-experimental/sharejs-json1](/experimental/dds/ot/sharejs/json1)</br>- [@fluid-experimental/sequence-deprecated](/experimental/dds/sequence-deprecated)</br>- [@fluid-experimental/tree](/experimental/dds/tree)</br>- [@fluidframework/cell](/packages/dds/cell)</br>- [@fluidframework/counter](/packages/dds/counter)</br>- [@fluid-experimental/ink](/packages/dds/ink)</br>- [@fluid-private/legacy-dds](/packages/dds/legacy-dds) (private)</br>- [@fluidframework/map](/packages/dds/map)</br>- [@fluidframework/matrix](/packages/dds/matrix)</br>- [@fluidframework/merge-tree](/packages/dds/merge-tree)</br>- [@fluidframework/ordered-collection](/packages/dds/ordered-collection)</br>- [@fluid-experimental/pact-map](/packages/dds/pact-map)</br>- [@fluidframework/register-collection](/packages/dds/register-collection)</br>- [@fluidframework/sequence](/packages/dds/sequence)</br>- [@fluidframework/shared-object-base](/packages/dds/shared-object-base)</br>- [@fluidframework/shared-summary-block](/packages/dds/shared-summary-block)</br>- [@fluidframework/task-manager](/packages/dds/task-manager)</br>- [@fluidframework/tree](/packages/dds/tree)</br>- [@fluidframework/container-runtime](/packages/runtime/container-runtime)</br>- [@fluidframework/container-runtime-definitions](/packages/runtime/container-runtime-definitions)</br>- [@fluidframework/datastore](/packages/runtime/datastore)</br>- [@fluidframework/datastore-definitions](/packages/runtime/datastore-definitions)</br>- [@fluidframework/id-compressor](/packages/runtime/id-compressor)</br>- [@fluidframework/runtime-definitions](/packages/runtime/runtime-definitions)</br>- [@fluidframework/runtime-utils](/packages/runtime/runtime-utils) | - [Core-Interfaces](#Core-Interfaces)</br>- [Driver-Definitions](#Driver-Definitions)</br>- [Container-Definitions](#Container-Definitions)</br>- [Core-Utils](#Core-Utils)</br>- [Client-Utils](#Client-Utils)</br>- [Telemetry-Utils](#Telemetry-Utils)</br>- [Driver-Utils](#Driver-Utils)</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp; |
+| - [@fluid-experimental/attributable-map](/experimental/dds/attributable-map)</br>- [@fluid-experimental/ot](/experimental/dds/ot/ot)</br>- [@fluid-experimental/sharejs-json1](/experimental/dds/ot/sharejs/json1)</br>- [@fluid-experimental/sequence-deprecated](/experimental/dds/sequence-deprecated)</br>- [@fluid-experimental/tree](/experimental/dds/tree)</br>- [@fluidframework/cell](/packages/dds/cell)</br>- [@fluidframework/counter](/packages/dds/counter)</br>- [@fluid-experimental/ink](/packages/dds/ink)</br>- [@fluid-private/legacy-dds](/packages/dds/legacy-dds) (private)</br>- [@fluidframework/map](/packages/dds/map)</br>- [@fluidframework/matrix](/packages/dds/matrix)</br>- [@fluidframework/merge-tree](/packages/dds/merge-tree)</br>- [@fluidframework/migration-shim](/packages/dds/migration-shim)</br>- [@fluidframework/ordered-collection](/packages/dds/ordered-collection)</br>- [@fluid-experimental/pact-map](/packages/dds/pact-map)</br>- [@fluidframework/register-collection](/packages/dds/register-collection)</br>- [@fluidframework/sequence](/packages/dds/sequence)</br>- [@fluidframework/shared-object-base](/packages/dds/shared-object-base)</br>- [@fluidframework/shared-summary-block](/packages/dds/shared-summary-block)</br>- [@fluidframework/task-manager](/packages/dds/task-manager)</br>- [@fluidframework/tree](/packages/dds/tree)</br>- [@fluidframework/container-runtime](/packages/runtime/container-runtime)</br>- [@fluidframework/container-runtime-definitions](/packages/runtime/container-runtime-definitions)</br>- [@fluidframework/datastore](/packages/runtime/datastore)</br>- [@fluidframework/datastore-definitions](/packages/runtime/datastore-definitions)</br>- [@fluidframework/id-compressor](/packages/runtime/id-compressor)</br>- [@fluidframework/runtime-definitions](/packages/runtime/runtime-definitions)</br>- [@fluidframework/runtime-utils](/packages/runtime/runtime-utils) | - [Core-Interfaces](#Core-Interfaces)</br>- [Driver-Definitions](#Driver-Definitions)</br>- [Container-Definitions](#Container-Definitions)</br>- [Core-Utils](#Core-Utils)</br>- [Client-Utils](#Client-Utils)</br>- [Telemetry-Utils](#Telemetry-Utils)</br>- [Driver-Utils](#Driver-Utils)</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp;</br>&nbsp; |
 
 ### Framework
 

feeds/internal-build.txt

@@ -59,6 +59,7 @@ fluid-framework
 @fluidframework/register-collection
 @fluid-experimental/pact-map
 @fluidframework/ordered-collection
+@fluidframework/migration-shim
 @fluidframework/merge-tree
 @fluidframework/matrix
 @fluidframework/map

feeds/internal-test.txt

@@ -66,6 +66,7 @@ fluid-framework
 @fluidframework/register-collection
 @fluid-experimental/pact-map
 @fluidframework/ordered-collection
+@fluidframework/migration-shim
 @fluidframework/merge-tree
 @fluidframework/matrix
 @fluidframework/map

feeds/public.txt

@@ -58,6 +58,7 @@ fluid-framework
 @fluidframework/register-collection
 @fluid-experimental/pact-map
 @fluidframework/ordered-collection
+@fluidframework/migration-shim
 @fluidframework/merge-tree
 @fluidframework/matrix
 @fluidframework/map

packages/dds/map/api-report/map.legacy.alpha.api.md

@@ -84,7 +84,11 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 }
 
 // @alpha @sealed @legacy
-export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
+export interface ISharedMap extends ISharedObject<ISharedMapEvents>, ISharedMapCore {
+}
+
+// @alpha @sealed @legacy @system
+export interface ISharedMapCore extends Map<string, any> {
     get<T = any>(key: string): T | undefined;
     set<T = unknown>(key: string, value: T): this;
 }
@@ -102,14 +106,19 @@ export interface IValueChanged {
 }
 
 // @alpha @sealed @legacy
-export class MapFactory implements IChannelFactory<ISharedMap> {
-    static readonly Attributes: IChannelAttributes;
-    get attributes(): IChannelAttributes;
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedMap;
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedMap>;
-    static readonly Type = "https://graph.microsoft.com/types/map";
-    get type(): string;
-}
+export const MapFactory: {
+    new (): {
+        readonly type: string;
+        readonly attributes: IChannelAttributes;
+        load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedMap & IChannel>;
+        create(runtime: IFluidDataStoreRuntime, id: string): ISharedMap & IChannel;
+    };
+    readonly Type: string;
+    readonly Attributes: IChannelAttributes;
+};
+
+// @alpha @sealed @legacy
+export type MapFactory = InstanceType<typeof MapFactory>;
 
 // @alpha @legacy
 export const SharedDirectory: ISharedObjectKind<ISharedDirectory> & SharedObjectKind<ISharedDirectory>;

packages/dds/map/package.json

@@ -174,7 +174,11 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"ClassStatics_MapFactory": {
+				"backCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }

packages/dds/map/src/index.ts

@@ -24,6 +24,7 @@ export type {
 	ISharedMap,
 	ISharedMapEvents,
 	IValueChanged,
+	ISharedMapCore,
 } from "./interfaces.js";
 export { SharedMap } from "./mapFactory.js";
 export { SharedDirectory } from "./directoryFactory.js";
@@ -37,3 +38,24 @@ export type {
 	IDirectoryNewStorageFormat,
 	IDirectoryDataObject,
 } from "./directory.js";
+
+// Internal
+export type { ILocalValue } from "./localValues.js";
+export type {
+	IMapClearLocalOpMetadata,
+	IMapKeyEditLocalOpMetadata,
+	IMapKeyAddLocalOpMetadata,
+	ISerializedValue,
+} from "./internalInterfaces.js";
+export {
+	type IMapOperation,
+	type IMapKeyOperation,
+	mapKernelFactory,
+	type MapLocalOpMetadata,
+	type MapKeyLocalOpMetadata,
+} from "./mapKernel.js";
+export type {
+	IMapClearOperation,
+	IMapDeleteOperation,
+	IMapSetOperation,
+} from "./internalInterfaces.js";

packages/dds/map/src/interfaces.ts

@@ -365,8 +365,28 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
  * @alpha
  */
 // TODO: Use `unknown` instead (breaking change).
+export interface ISharedMap extends ISharedObject<ISharedMapEvents>, ISharedMapCore {}
+
+/**
+ * The SharedMap distributed data structure can be used to store key-value pairs.
+ *
+ * @remarks
+ * SharedMap 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}.
+ *
+ * Note: unlike JavaScript maps, SharedMap does not make any guarantees regarding enumeration order.
+ *
+ * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
+ * @sealed
+ * @legacy
+ * @alpha
+ * @system
+ */
+// TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
+export interface ISharedMapCore extends Map<string, any> {
 	/**
 	 * Retrieves the given key from the map if it exists.
 	 * @param key - Key to retrieve from

packages/dds/map/src/internalInterfaces.ts

@@ -7,6 +7,7 @@ import type { ILocalValue } from "./localValues.js";
 
 /**
  * Operation indicating a value should be set for a key.
+ * @internal
  */
 export interface IMapSetOperation {
 	/**
@@ -27,6 +28,7 @@ export interface IMapSetOperation {
 
 /**
  * Operation indicating the map should be cleared.
+ * @internal
  */
 export interface IMapClearOperation {
 	/**
@@ -37,6 +39,7 @@ export interface IMapClearOperation {
 
 /**
  * Operation indicating a key should be deleted from the map.
+ * @internal
  */
 export interface IMapDeleteOperation {
 	/**
@@ -52,6 +55,7 @@ export interface IMapDeleteOperation {
 
 /**
  * Metadata for an local `edit` operation.
+ * @internal
  */
 export interface IMapKeyEditLocalOpMetadata {
 	/**
@@ -72,6 +76,7 @@ export interface IMapKeyEditLocalOpMetadata {
 
 /**
  * Metadata for an local `add` operation.
+ * @internal
  */
 export interface IMapKeyAddLocalOpMetadata {
 	/**
@@ -87,6 +92,7 @@ export interface IMapKeyAddLocalOpMetadata {
 
 /**
  * Metadata for an local `clear` operation.
+ * @internal
  */
 export interface IMapClearLocalOpMetadata {
 	/**
@@ -155,6 +161,7 @@ export interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
+ * @internal
  */
 export interface ISerializedValue {
 	/**

packages/dds/map/src/localValues.ts

@@ -17,6 +17,7 @@ import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).
+ * @internal
  */
 export interface ILocalValue {
 	/**