@fluidframework/map 2.0.0-rc.3.0.3 → 2.0.0-rc.4.0.1

package/src/directoryFactory.ts

@@ -10,6 +10,7 @@ import type {
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
 import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { SharedDirectory as SharedDirectoryInternal } from "./directory.js";
 import type { ISharedDirectory } from "./interfaces.js";
@@ -78,37 +79,10 @@ export class DirectoryFactory implements IChannelFactory<ISharedDirectory> {
 
 /**
  * Entrypoint for {@link ISharedDirectory} creation.
- * @sealed
  * @alpha
  */
-export const SharedDirectory: ISharedObjectKind<ISharedDirectory> = {
-	/**
-	 * Create a new shared directory
-	 *
-	 * @param runtime - Data store runtime the new shared directory belongs to
-	 * @param id - Optional name of the shared directory
-	 * @returns Newly create shared directory (but not attached yet)
-	 *
-	 * @example
-	 * To create a `SharedDirectory`, call the static create method:
-	 *
-	 * ```typescript
-	 * const myDirectory = SharedDirectory.create(this.runtime, id);
-	 * ```
-	 */
-	create(runtime: IFluidDataStoreRuntime, id?: string): ISharedDirectory {
-		return runtime.createChannel(id, DirectoryFactory.Type) as ISharedDirectory;
-	},
-
-	/**
-	 * Get a factory for SharedDirectory to register with the data store.
-	 *
-	 * @returns A factory that creates and load SharedDirectory
-	 */
-	getFactory(): IChannelFactory<ISharedDirectory> {
-		return new DirectoryFactory();
-	},
-};
+export const SharedDirectory: ISharedObjectKind<ISharedDirectory> =
+	createSharedObjectKind(DirectoryFactory);
 
 /**
  * Entrypoint for {@link ISharedDirectory} creation.

package/src/index.ts

@@ -15,7 +15,7 @@
  * @packageDocumentation
  */
 
-export {
+export type {
 	IDirectory,
 	IDirectoryEvents,
 	IDirectoryValueChanged,
@@ -27,3 +27,5 @@ export {
 } from "./interfaces.js";
 export { MapFactory, SharedMap } from "./mapFactory.js";
 export { DirectoryFactory, SharedDirectory } from "./directoryFactory.js";
+export type { ICreateInfo, IDirectoryNewStorageFormat, IDirectoryDataObject } from "./directory.js";
+export type { ISerializableValue } from "./internalInterfaces.js";

package/src/interfaces.ts

@@ -3,13 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IDisposable,
 	IEvent,
 	IEventProvider,
 	IEventThisPlaceHolder,
 } from "@fluidframework/core-interfaces";
-import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
+import type { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 
 /**
  * Type of "valueChanged" event parameter.

package/src/internalInterfaces.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ILocalValue } from "./localValues.js";
+import type { ILocalValue } from "./localValues.js";
 
 /**
  * Operation indicating a value should be set for a key.
@@ -22,7 +22,6 @@ export interface IMapSetOperation {
 	/**
 	 * Value to be set on the key.
 	 */
-	// eslint-disable-next-line import/no-deprecated
 	value: ISerializableValue;
 }
 
@@ -137,7 +136,7 @@ export type MapLocalOpMetadata = IMapClearLocalOpMetadata | MapKeyLocalOpMetadat
  * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a
  * channel ID.
  *
- * @deprecated This type is legacy and deprecated.
+ * @deprecated This type is legacy and deprecated(AB#8004).
  * @alpha
  */
 export interface ISerializableValue {

package/src/localValues.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import type { IFluidHandle } from "@fluidframework/core-interfaces";
+import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base";
 import {
 	ValueType,
 	parseHandles,
@@ -13,7 +13,7 @@ import {
 } from "@fluidframework/shared-object-base/internal";
 
 // eslint-disable-next-line import/no-deprecated
-import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
+import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).

package/src/map.ts

@@ -3,20 +3,20 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IChannelAttributes,
 	IChannelStorageService,
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
-import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
-import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
+import { MessageType, type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
 import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { SharedObject } from "@fluidframework/shared-object-base/internal";
 
-import { ISharedMap, ISharedMapEvents } from "./interfaces.js";
-import { IMapDataObjectSerializable, IMapOperation, MapKernel } from "./mapKernel.js";
+import type { ISharedMap, ISharedMapEvents } from "./interfaces.js";
+import { type IMapDataObjectSerializable, type IMapOperation, MapKernel } from "./mapKernel.js";
 
 interface IMapSerializationFormat {
 	blobs?: string[];
@@ -27,7 +27,6 @@ const snapshotFileName = "header";
 
 /**
  * {@inheritDoc ISharedMap}
- * @alpha
  */
 export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
 	/**
@@ -285,6 +284,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 		local: boolean,
 		localOpMetadata: unknown,
 	): void {
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
 		if (message.type === MessageType.Operation) {
 			this.kernel.tryProcessMessage(
 				message.contents as IMapOperation,

package/src/mapFactory.ts

@@ -3,8 +3,6 @@
  * Licensed under the MIT License.
  */
 
-/* eslint-disable import/no-deprecated */
-
 import type {
 	IChannelAttributes,
 	IChannelFactory,
@@ -12,6 +10,7 @@ import type {
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
 import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import type { ISharedMap } from "./interfaces.js";
 import { SharedMap as SharedMapInternal } from "./map.js";
@@ -82,15 +81,7 @@ export class MapFactory implements IChannelFactory<ISharedMap> {
  * 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;
-	},
-};
+export const SharedMap: ISharedObjectKind<ISharedMap> = createSharedObjectKind(MapFactory);
 
 /**
  * Entrypoint for {@link ISharedMap} creation.

package/src/mapKernel.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IFluidHandle } from "@fluidframework/core-interfaces";
+import type { TypedEventEmitter } from "@fluid-internal/client-utils";
+import type { IFluidHandle } from "@fluidframework/core-interfaces";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { ValueType, bindHandles } from "@fluidframework/shared-object-base/internal";
 
-import { ISharedMapEvents } from "./interfaces.js";
-import {
+import type { ISharedMapEvents } from "./interfaces.js";
+import type {
 	IMapClearLocalOpMetadata,
 	IMapClearOperation,
 	IMapDeleteOperation,
@@ -21,7 +21,7 @@ import {
 	ISerializableValue,
 	ISerializedValue,
 } from "./internalInterfaces.js";
-import { ILocalValue, LocalValueMaker, makeSerializable } from "./localValues.js";
+import { type ILocalValue, LocalValueMaker, makeSerializable } from "./localValues.js";
 
 /**
  * Defines the means to process and submit a given op on a map.
@@ -62,17 +62,13 @@ export type IMapOperation = IMapKeyOperation | IMapClearOperation;
  * | JSON.stringify}, direct result from
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
  */
-export interface IMapDataObjectSerializable {
-	// eslint-disable-next-line import/no-deprecated
-	[key: string]: ISerializableValue;
-}
+// eslint-disable-next-line import/no-deprecated
+export type IMapDataObjectSerializable = Record<string, ISerializableValue>;
 
 /**
  * Serialized key/value data.
  */
-export interface IMapDataObjectSerialized {
-	[key: string]: ISerializedValue;
-}
+export type IMapDataObjectSerialized = Record<string, ISerializedValue>;
 
 type MapKeyLocalOpMetadata = IMapKeyEditLocalOpMetadata | IMapKeyAddLocalOpMetadata;
 type MapLocalOpMetadata = IMapClearLocalOpMetadata | MapKeyLocalOpMetadata;
@@ -153,7 +149,7 @@ export class MapKernel {
 	/**
 	 * Keys that have been modified locally but not yet ack'd from the server.
 	 */
-	private readonly pendingKeys: Map<string, number[]> = new Map();
+	private readonly pendingKeys = new Map<string, number[]>();
 
 	/**
 	 * This is used to assign a unique id to every outgoing operation and helps in tracking unack'd ops.

package/src/packageVersion.ts

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