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

package/src/mapFactory.ts

@@ -0,0 +1,101 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/* eslint-disable import/no-deprecated */
+
+import type {
+	IChannelAttributes,
+	IChannelFactory,
+	IChannelServices,
+	IFluidDataStoreRuntime,
+} from "@fluidframework/datastore-definitions";
+import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+
+import type { ISharedMap } from "./interfaces.js";
+import { SharedMap as SharedMapInternal } from "./map.js";
+import { pkgVersion } from "./packageVersion.js";
+
+/**
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedMap}.
+ *
+ * @sealed
+ * @alpha
+ */
+export class MapFactory implements IChannelFactory<ISharedMap> {
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
+	 */
+	public static readonly Type = "https://graph.microsoft.com/types/map";
+
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
+	 */
+	public static readonly Attributes: IChannelAttributes = {
+		type: MapFactory.Type,
+		snapshotFormatVersion: "0.2",
+		packageVersion: pkgVersion,
+	};
+
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
+	 */
+	public get type(): string {
+		return MapFactory.Type;
+	}
+
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
+	 */
+	public get attributes(): IChannelAttributes {
+		return MapFactory.Attributes;
+	}
+
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+	 */
+	public async load(
+		runtime: IFluidDataStoreRuntime,
+		id: string,
+		services: IChannelServices,
+		attributes: IChannelAttributes,
+	): Promise<ISharedMap> {
+		const map = new SharedMapInternal(id, runtime, attributes);
+		await map.load(services);
+
+		return map;
+	}
+
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+	 */
+	public create(runtime: IFluidDataStoreRuntime, id: string): ISharedMap {
+		const map = new SharedMapInternal(id, runtime, MapFactory.Attributes);
+		map.initializeLocal();
+
+		return map;
+	}
+}
+
+/**
+ * Entrypoint for {@link ISharedMap} creation.
+ * @alpha
+ */
+export const SharedMap: ISharedObjectKind<ISharedMap> = {
+	getFactory(): IChannelFactory<ISharedMap> {
+		return new MapFactory();
+	},
+
+	create(runtime: IFluidDataStoreRuntime, id?: string): ISharedMap {
+		return runtime.createChannel(id, MapFactory.Type) as ISharedMap;
+	},
+};
+
+/**
+ * Entrypoint for {@link ISharedMap} creation.
+ * @alpha
+ * @privateRemarks
+ * This alias is for legacy compat from when the SharedMap class was exported as public.
+ */
+export type SharedMap = ISharedMap;

package/src/mapKernel.ts

@@ -3,19 +3,23 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import { IFluidSerializer, ValueType, bindHandles } from "@fluidframework/shared-object-base";
-import { assert, unreachableCase } from "@fluidframework/core-utils";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-// eslint-disable-next-line import/no-deprecated
-import { ISerializableValue, ISerializedValue, ISharedMapEvents } from "./interfaces.js";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
+import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import { ValueType, bindHandles } from "@fluidframework/shared-object-base/internal";
+
+import { ISharedMapEvents } from "./interfaces.js";
 import {
-	IMapSetOperation,
-	IMapDeleteOperation,
+	IMapClearLocalOpMetadata,
 	IMapClearOperation,
-	IMapKeyEditLocalOpMetadata,
+	IMapDeleteOperation,
 	IMapKeyAddLocalOpMetadata,
-	IMapClearLocalOpMetadata,
+	IMapKeyEditLocalOpMetadata,
+	IMapSetOperation,
+	// eslint-disable-next-line import/no-deprecated
+	ISerializableValue,
+	ISerializedValue,
 } from "./internalInterfaces.js";
 import { ILocalValue, LocalValueMaker, makeSerializable } from "./localValues.js";
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-rc.2.0.1";
+export const pkgVersion = "2.0.0-rc.3.0.0";

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}