@fluidframework/map 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.217212",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,30 +35,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/merge-tree": "2.0.0-dev.7.4.0.215930",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/merge-tree": "2.0.0-dev.7.4.0.217212",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/shared-object-base": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/shared-object-base": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.217212",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-private/stochastic-test-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluid-private/test-dds-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluid-private/stochastic-test-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluid-private/test-dds-utils": "2.0.0-dev.7.4.0.217212",
     "@fluid-tools/benchmark": "^0.48.0",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
     "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-internal.7.2.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.217212",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.18.38",
@@ -102,12 +102,13 @@
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "build:genver": "gen-version",
     "build:test": "tsc-multi --config tsc-multi.test.json",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",

package/src/directory.ts

@@ -71,8 +71,7 @@ interface IDirectoryMessageHandler {
 
 /**
  * Operation indicating a value should be set for a key.
- *
- * @public
+ * @internal
  */
 export interface IDirectorySetOperation {
 	/**
@@ -99,8 +98,7 @@ export interface IDirectorySetOperation {
 
 /**
  * Operation indicating a key should be deleted from the directory.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryDeleteOperation {
 	/**
@@ -121,15 +119,13 @@ export interface IDirectoryDeleteOperation {
 
 /**
  * An operation on a specific key within a directory.
- *
- * @public
+ * @internal
  */
 export type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
 
 /**
  * Operation indicating the directory should be cleared.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryClearOperation {
 	/**
@@ -145,15 +141,13 @@ export interface IDirectoryClearOperation {
 
 /**
  * An operation on one or more of the keys within a directory.
- *
- * @public
+ * @internal
  */
 export type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
 
 /**
  * Operation indicating a subdirectory should be created.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryCreateSubDirectoryOperation {
 	/**
@@ -174,8 +168,7 @@ export interface IDirectoryCreateSubDirectoryOperation {
 
 /**
  * Operation indicating a subdirectory should be deleted.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryDeleteSubDirectoryOperation {
 	/**
@@ -196,8 +189,7 @@ export interface IDirectoryDeleteSubDirectoryOperation {
 
 /**
  * An operation on the subdirectories within a directory.
- *
- * @public
+ * @internal
  */
 export type IDirectorySubDirectoryOperation =
 	| IDirectoryCreateSubDirectoryOperation
@@ -205,15 +197,13 @@ export type IDirectorySubDirectoryOperation =
 
 /**
  * Any operation on a directory.
- *
- * @public
+ * @internal
  */
 export type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDirectoryOperation;
 
 /**
  * Create info for the subdirectory.
- *
- * @public
+ * @internal
  */
 export interface ICreateInfo {
 	/**
@@ -234,8 +224,7 @@ export interface ICreateInfo {
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
  * | JSON.stringify}, direct result from
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryDataObject {
 	/**
@@ -280,7 +269,7 @@ export interface IDirectoryNewStorageFormat {
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedDirectory}.
  *
  * @sealed
- * @public
+ * @internal
  */
 export class DirectoryFactory implements IChannelFactory {
 	/**
@@ -458,7 +447,7 @@ class DirectoryCreationTracker {
  * ```
  *
  * @sealed
- * @public
+ * @internal
  */
 export class SharedDirectory
 	extends SharedObject<ISharedDirectoryEvents>
@@ -496,9 +485,7 @@ export class SharedDirectory
 		return this.root.absolutePath;
 	}
 
-	/**
-	 * @internal
-	 */
+	/***/
 	public readonly localValueMaker: LocalValueMaker;
 
 	/**
@@ -715,7 +702,6 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-	 * @internal
 	 */
 	protected summarizeCore(
 		serializer: IFluidSerializer,
@@ -729,7 +715,6 @@ export class SharedDirectory
 	 * @param op - Op to submit
 	 * @param localOpMetadata - The local metadata associated with the op. We send a unique id that is used to track
 	 * this op while it has not been ack'd. This will be sent when we receive this op back from the server.
-	 * @internal
 	 */
 	public submitDirectoryMessage(op: IDirectoryOperation, localOpMetadata: unknown): void {
 		this.submitLocalMessage(op, localOpMetadata);
@@ -737,13 +722,11 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-	 * @internal
 	 */
 	protected onDisconnect(): void {}
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-	 * @internal
 	 */
 	protected reSubmitCore(content: unknown, localOpMetadata: unknown): void {
 		const message = content as IDirectoryOperation;
@@ -754,7 +737,6 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-	 * @internal
 	 */
 	protected async loadCore(storage: IChannelStorageService): Promise<void> {
 		const data = await readAndParse(storage, snapshotFileName);
@@ -777,7 +759,6 @@ export class SharedDirectory
 	/**
 	 * Populate the directory with the given directory data.
 	 * @param data - A JSON string containing serialized directory data
-	 * @internal
 	 */
 	protected populate(data: IDirectoryDataObject): void {
 		const stack: [SubDirectory, IDirectoryDataObject][] = [];
@@ -851,7 +832,6 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-	 * @internal
 	 */
 	protected processCore(
 		message: ISequencedDocumentMessage,
@@ -868,7 +848,6 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-	 * @internal
 	 */
 	protected rollback(content: unknown, localOpMetadata: unknown): void {
 		const op: IDirectoryOperation = content as IDirectoryOperation;
@@ -1092,7 +1071,6 @@ export class SharedDirectory
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-	 * @internal
 	 */
 	protected applyStashedOp(op: unknown): unknown {
 		const handler = this.messageHandlers.get((op as IDirectoryOperation).type);

package/src/interfaces.ts

@@ -13,8 +13,7 @@ import {
 
 /**
  * Type of "valueChanged" event parameter.
- *
- * @public
+ * @internal
  */
 export interface IValueChanged {
 	/**
@@ -34,8 +33,7 @@ export interface IValueChanged {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
- *
- * @public
+ * @internal
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -119,8 +117,7 @@ export interface IDirectory
  *
  * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
- *
- * @public
+ * @internal
  */
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	/**
@@ -193,8 +190,7 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 
 /**
  * Events emitted in response to changes to the directory data.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryEvents extends IEvent {
 	/**
@@ -275,8 +271,7 @@ export interface IDirectoryEvents extends IEvent {
  * 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.
- *
- * @public
+ * @internal
  */
 export interface ISharedDirectory
 	extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,
@@ -291,8 +286,7 @@ export interface ISharedDirectory
 
 /**
  * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
- *
- * @public
+ * @internal
  */
 export interface IDirectoryValueChanged extends IValueChanged {
 	/**
@@ -303,8 +297,7 @@ export interface IDirectoryValueChanged extends IValueChanged {
 
 /**
  * Events emitted in response to changes to the {@link ISharedMap | map} data.
- *
- * @public
+ * @internal
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
 	/**
@@ -343,8 +336,7 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
  * {@link @fluidframework/datastore#FluidObjectHandle}.
  *
  * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
- *
- * @public
+ * @internal
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -389,8 +381,7 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
  * channel ID.
  *
  * @deprecated This type is legacy and deprecated.
- *
- * @public
+ * @internal
  */
 export interface ISerializableValue {
 	/**
@@ -407,8 +398,7 @@ export interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
- *
- * @public
+ * @internal
  */
 export interface ISerializedValue {
 	/**

package/src/localValues.ts

@@ -16,8 +16,7 @@ import { ISerializableValue, ISerializedValue } from "./interfaces";
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).
- *
- * @public
+ * @internal
  */
 export interface ILocalValue {
 	/**
@@ -99,8 +98,7 @@ export class PlainLocalValue implements ILocalValue {
 /**
  * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local
  * values with minimal awareness of how those objects are stored, serialized, and deserialized.
- *
- * @public
+ * @internal
  */
 export class LocalValueMaker {
 	/**

package/src/map.ts

@@ -30,7 +30,7 @@ const snapshotFileName = "header";
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
  *
  * @sealed
- * @public
+ * @internal
  */
 export class MapFactory implements IChannelFactory {
 	/**
@@ -89,8 +89,7 @@ export class MapFactory implements IChannelFactory {
 
 /**
  * {@inheritDoc ISharedMap}
- *
- * @public
+ * @internal
  */
 export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
 	/**
@@ -250,7 +249,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-	 * @internal
 	 */
 	protected summarizeCore(
 		serializer: IFluidSerializer,
@@ -330,7 +328,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-	 * @internal
 	 */
 	protected async loadCore(storage: IChannelStorageService): Promise<void> {
 		const json = await readAndParse<object>(storage, snapshotFileName);
@@ -350,13 +347,11 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-	 * @internal
 	 */
 	protected onDisconnect(): void {}
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-	 * @internal
 	 */
 	protected reSubmitCore(content: unknown, localOpMetadata: unknown): void {
 		this.kernel.trySubmitMessage(content as IMapOperation, localOpMetadata);
@@ -364,7 +359,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-	 * @internal
 	 */
 	protected applyStashedOp(content: unknown): unknown {
 		return this.kernel.tryApplyStashedOp(content as IMapOperation);
@@ -372,7 +366,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-	 * @internal
 	 */
 	protected processCore(
 		message: ISequencedDocumentMessage,
@@ -390,7 +383,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-	 * @internal
 	 */
 	protected rollback(content: unknown, localOpMetadata: unknown): void {
 		this.kernel.rollback(content, localOpMetadata);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-dev.7.4.0.215930";
+export const pkgVersion = "2.0.0-dev.7.4.0.217212";