@fluidframework/map 1.2.7 → 2.0.0-dev.1.3.0.96595

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "1.2.7",
+  "version": "2.0.0-dev.1.3.0.96595",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -32,7 +32,9 @@
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:memory": "mocha --config ./src/test/memory/.mocharc.js",
+    "test:memory-profiling:report": "mocha --config ./src/test/memory/.mocharc.js",
+    "test:mocha": "mocha --unhandled-rejections=strict --recursive 'dist/test/mocha/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
@@ -61,31 +63,32 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-utils": "^1.2.7",
-    "@fluidframework/core-interfaces": "^1.2.7",
-    "@fluidframework/datastore-definitions": "^1.2.7",
-    "@fluidframework/driver-utils": "^1.2.7",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^1.2.7",
-    "@fluidframework/runtime-utils": "^1.2.7",
-    "@fluidframework/shared-object-base": "^1.2.7",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/core-interfaces": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/driver-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/runtime-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/shared-object-base": "2.0.0-dev.1.3.0.96595",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "^1.2.7",
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@1.2.1",
-    "@fluidframework/mocha-test-setup": "^1.2.7",
-    "@fluidframework/test-runtime-utils": "^1.2.7",
+    "@fluid-internal/test-dds-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluid-tools/benchmark": "^0.43.0",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.6000",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@^1.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.1.3.0.96595",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.18.0",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
     "mocha": "^10.0.0",
@@ -95,7 +98,44 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.2",
-    "broken": {}
+    "version": "2.0.0",
+    "broken": {
+      "RemovedInterfaceDeclaration_IDirectoryClearOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IDirectoryCreateSubDirectoryOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IDirectoryDeleteOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IDirectoryDeleteSubDirectoryOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_IDirectoryKeyOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IDirectorySetOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_IDirectoryStorageOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_IDirectorySubDirectoryOperation": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ILocalValue": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    }
   }
 }

package/src/directory.ts

@@ -192,24 +192,47 @@ export type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDire
 
 /**
  * Defines the in-memory object structure to be used for the conversion to/from serialized.
- * @privateRemarks
- * Directly used in JSON.stringify, direct result from JSON.parse.
+ *
+ * @remarks Directly used in
+ * {@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}.
  */
 export interface IDirectoryDataObject {
+    /**
+     * Key/value date set by the user.
+     */
     storage?: { [key: string]: ISerializableValue; };
+
+    /**
+     * Recursive sub-directories {@link IDirectoryDataObject | objects}.
+     */
     subdirectories?: { [subdirName: string]: IDirectoryDataObject; };
 }
 
+/**
+ * {@link IDirectory} storage format.
+ *
+ * @internal
+ */
 export interface IDirectoryNewStorageFormat {
+    /**
+     * Blob IDs representing larger directory data that was serialized.
+     */
     blobs: string[];
+
+    /**
+     * Storage content representing directory data that was not serialized.
+     */
     content: IDirectoryDataObject;
 }
 
 /**
- * The factory that defines the directory.
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedDirectory}.
+ *
  * @sealed
  */
-export class DirectoryFactory {
+export class DirectoryFactory implements IChannelFactory {
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
      */
@@ -264,9 +287,7 @@ export class DirectoryFactory {
 }
 
 /**
- * SharedDirectory 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.
+ * {@inheritDoc ISharedDirectory}
  *
  * @example
  * ```typescript
@@ -544,7 +565,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
      * @internal
      */
-    protected onDisconnect() {}
+    protected onDisconnect() { }
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
@@ -1203,12 +1224,9 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         const iterator = {
             next(): IteratorResult<[string, any]> {
                 const nextVal = localEntriesIterator.next();
-                if (nextVal.done) {
-                    return { value: undefined, done: true };
-                } else {
-                    // Unpack the stored value
-                    return { value: [nextVal.value[0], nextVal.value[1].value], done: false };
-                }
+                return nextVal.done
+                    ? { value: undefined, done: true }
+                    : { value: [nextVal.value[0], nextVal.value[1].value], done: false };
             },
             [Symbol.iterator]() {
                 return this;
@@ -1236,12 +1254,9 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         const iterator = {
             next(): IteratorResult<any> {
                 const nextVal = localValuesIterator.next();
-                if (nextVal.done) {
-                    return { value: undefined, done: true };
-                } else {
-                    // Unpack the stored value
-                    return { value: nextVal.value.value, done: false };
-                }
+                return nextVal.done
+                    ? { value: undefined, done: true }
+                    : { value: nextVal.value.value, done: false };
             },
             [Symbol.iterator]() {
                 return this;
@@ -1263,7 +1278,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Process a clear operation.
      * @param op - The op to process
      * @param local - Whether the message originated from the local client
-     * @param message - The message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      * @internal
@@ -1276,7 +1290,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
         this.throwIfDisposed();
         if (local) {
             assert(isClearLocalOpMetadata(localOpMetadata),
-                0x00f /* `pendingMessageId is missing from the local client's ${op.type} operation` */);
+                0x00f /* pendingMessageId is missing from the local client's operation */);
             const pendingClearMessageId = this.pendingClearMessageIds.shift();
             assert(pendingClearMessageId === localOpMetadata.pendingMessageId,
                 0x32a /* pendingMessageId does not match */);
@@ -1289,7 +1303,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Process a delete operation.
      * @param op - The op to process
      * @param local - Whether the message originated from the local client
-     * @param message - The message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      * @internal
@@ -1310,7 +1323,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Process a set operation.
      * @param op - The op to process
      * @param local - Whether the message originated from the local client
-     * @param message - The message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      * @internal
@@ -1337,7 +1349,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Process a create subdirectory operation.
      * @param op - The op to process
      * @param local - Whether the message originated from the local client
-     * @param message - The message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      * @internal
@@ -1358,7 +1369,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * Process a delete subdirectory operation.
      * @param op - The op to process
      * @param local - Whether the message originated from the local client
-     * @param message - The message
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
      * For messages from a remote client, this will be undefined.
      * @internal
@@ -1751,7 +1761,6 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
     /**
      * Clear implementation used for both locally sourced clears as well as incoming remote clears.
      * @param local - Whether the message originated from the local client
-     * @param op - The message if from a remote clear, or null if from a local clear
      */
     private clearCore(local: boolean) {
         this._storage.clear();

package/src/index.ts

@@ -4,9 +4,9 @@
  */
 
 /**
- * The `map` package provides interfaces and implementing classes for map-like distributed data structures.
+ * The `map` library provides interfaces and implementing classes for map-like distributed data structures.
  *
- * @remarks The following distributed data structures are defined in this package:
+ * @remarks The following distributed data structures are defined in this library:
  *
  * - {@link SharedMap}
  *