@fluidframework/map 1.2.0-77818 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "1.2.0-77818",
+  "version": "1.2.1",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,24 +62,24 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-utils": "1.2.0-77818",
-    "@fluidframework/core-interfaces": "1.2.0-77818",
-    "@fluidframework/datastore-definitions": "1.2.0-77818",
-    "@fluidframework/driver-utils": "1.2.0-77818",
+    "@fluidframework/container-utils": "^1.2.1",
+    "@fluidframework/core-interfaces": "^1.2.1",
+    "@fluidframework/datastore-definitions": "^1.2.1",
+    "@fluidframework/driver-utils": "^1.2.1",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "1.2.0-77818",
-    "@fluidframework/runtime-utils": "1.2.0-77818",
-    "@fluidframework/shared-object-base": "1.2.0-77818",
+    "@fluidframework/runtime-definitions": "^1.2.1",
+    "@fluidframework/runtime-utils": "^1.2.1",
+    "@fluidframework/shared-object-base": "^1.2.1",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "1.2.0-77818",
+    "@fluid-internal/test-dds-utils": "^1.2.1",
     "@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.1.0",
-    "@fluidframework/mocha-test-setup": "1.2.0-77818",
-    "@fluidframework/test-runtime-utils": "1.2.0-77818",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@1.2.0",
+    "@fluidframework/mocha-test-setup": "^1.2.1",
+    "@fluidframework/test-runtime-utils": "^1.2.1",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -95,7 +95,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.0",
+    "version": "1.2.1",
     "broken": {}
   }
 }

package/src/directory.ts

@@ -72,7 +72,7 @@ interface IDirectoryMessageHandler {
 /**
  * Operation indicating a value should be set for a key.
  */
-interface IDirectorySetOperation {
+export interface IDirectorySetOperation {
     /**
      * String identifier of the operation type.
      */
@@ -97,7 +97,7 @@ interface IDirectorySetOperation {
 /**
  * Operation indicating a key should be deleted from the directory.
  */
-interface IDirectoryDeleteOperation {
+export interface IDirectoryDeleteOperation {
     /**
      * String identifier of the operation type.
      */
@@ -117,12 +117,12 @@ interface IDirectoryDeleteOperation {
 /**
  * An operation on a specific key within a directory
  */
-type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
+export type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
 
 /**
  * Operation indicating the directory should be cleared.
  */
-interface IDirectoryClearOperation {
+export interface IDirectoryClearOperation {
     /**
      * String identifier of the operation type.
      */
@@ -137,12 +137,12 @@ interface IDirectoryClearOperation {
 /**
  * An operation on one or more of the keys within a directory
  */
-type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
+export type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
 
 /**
  * Operation indicating a subdirectory should be created.
  */
-interface IDirectoryCreateSubDirectoryOperation {
+export interface IDirectoryCreateSubDirectoryOperation {
     /**
      * String identifier of the operation type.
      */
@@ -162,7 +162,7 @@ interface IDirectoryCreateSubDirectoryOperation {
 /**
  * Operation indicating a subdirectory should be deleted.
  */
-interface IDirectoryDeleteSubDirectoryOperation {
+export interface IDirectoryDeleteSubDirectoryOperation {
     /**
      * String identifier of the operation type.
      */
@@ -182,7 +182,8 @@ interface IDirectoryDeleteSubDirectoryOperation {
 /**
  * An operation on the subdirectories within a directory
  */
-type IDirectorySubDirectoryOperation = IDirectoryCreateSubDirectoryOperation | IDirectoryDeleteSubDirectoryOperation;
+export type IDirectorySubDirectoryOperation = IDirectoryCreateSubDirectoryOperation
+    | IDirectoryDeleteSubDirectoryOperation;
 
 /**
  * Any operation on a directory
@@ -268,7 +269,7 @@ export class DirectoryFactory {
  * SubDirectories can be retrieved for use as working directories.
  *
  * @example
- * ```ts
+ * ```typescript
  * mySharedDirectory.createSubDirectory("a").createSubDirectory("b").createSubDirectory("c").set("foo", val1);
  * const mySubDir = mySharedDirectory.getWorkingDirectory("/a/b/c");
  * mySubDir.get("foo"); // returns val1
@@ -1278,7 +1279,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
                 0x00f /* `pendingMessageId is missing from the local client's ${op.type} operation` */);
             const pendingClearMessageId = this.pendingClearMessageIds.shift();
             assert(pendingClearMessageId === localOpMetadata.pendingMessageId,
-                "pendingMessageId does not match");
+                0x32a /* pendingMessageId does not match */);
             return;
         }
         this.clearExceptPendingKeys();
@@ -1397,11 +1398,11 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public resubmitClearMessage(op: IDirectoryClearOperation, localOpMetadata: unknown): void {
-        assert(isClearLocalOpMetadata(localOpMetadata), "Invalid localOpMetadata for clear");
+        assert(isClearLocalOpMetadata(localOpMetadata), 0x32b /* Invalid localOpMetadata for clear */);
         // We don't reuse the metadata pendingMessageId but send a new one on each submit.
         const pendingClearMessageId = this.pendingClearMessageIds.shift();
         assert(pendingClearMessageId === localOpMetadata.pendingMessageId,
-            "pendingMessageId does not match");
+            0x32c /* pendingMessageId does not match */);
         this.submitClearMessage(op, localOpMetadata.previousStorage);
     }
 
@@ -1439,12 +1440,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public resubmitKeyMessage(op: IDirectoryKeyOperation, localOpMetadata: unknown): void {
-        assert(isKeyEditLocalOpMetadata(localOpMetadata), "Invalid localOpMetadata in submit");
+        assert(isKeyEditLocalOpMetadata(localOpMetadata), 0x32d /* Invalid localOpMetadata in submit */);
 
         // clear the old pending message id
         const pendingMessageIds = this.pendingKeys.get(op.key);
         assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId,
-            "Unexpected pending message received");
+            0x32e /* Unexpected pending message received */);
         pendingMessageIds.shift();
         if (pendingMessageIds.length === 0) {
             this.pendingKeys.delete(op.key);
@@ -1511,12 +1512,12 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
      * @internal
      */
     public resubmitSubDirectoryMessage(op: IDirectorySubDirectoryOperation, localOpMetadata: unknown): void {
-        assert(isSubDirLocalOpMetadata(localOpMetadata), "Invalid localOpMetadata for sub directory op");
+        assert(isSubDirLocalOpMetadata(localOpMetadata), 0x32f /* Invalid localOpMetadata for sub directory op */);
 
         // clear the old pending message id
         const pendingMessageIds = this.pendingSubDirectories.get(op.subdirName);
         assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId,
-            "Unexpected pending message received");
+            0x330 /* Unexpected pending message received */);
         pendingMessageIds.shift();
         if (pendingMessageIds.length === 0) {
             this.pendingSubDirectories.delete(op.subdirName);
@@ -1683,7 +1684,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
                     0x011 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageIds = this.pendingKeys.get(op.key);
                 assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId,
-                    "Unexpected pending message received");
+                    0x331 /* Unexpected pending message received */);
                 pendingMessageIds.shift();
                 if (pendingMessageIds.length === 0) {
                     this.pendingKeys.delete(op.key);
@@ -1718,7 +1719,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
                     0x012 /* pendingMessageId is missing from the local client's operation */);
                 const pendingMessageIds = this.pendingSubDirectories.get(op.subdirName);
                 assert(pendingMessageIds !== undefined && pendingMessageIds[0] === localOpMetadata.pendingMessageId,
-                    "Unexpected pending message received");
+                    0x332 /* Unexpected pending message received */);
                 pendingMessageIds.shift();
                 if (pendingMessageIds.length === 0) {
                     this.pendingSubDirectories.delete(op.subdirName);

package/src/index.ts

@@ -6,11 +6,11 @@
 /**
  * The `map` package 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 package:
  *
- * - {@link @fluidframework/map#SharedMap}
- * - {@link @fluidframework/map#SharedDirectory}
+ * - {@link SharedMap}
+ *
+ * - {@link SharedDirectory}
  *
  * @packageDocumentation
  */
@@ -18,4 +18,4 @@
 export * from "./interfaces";
 export * from "./map";
 export * from "./directory";
-export { LocalValueMaker } from "./localValues";
+export { LocalValueMaker, ILocalValue } from "./localValues";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "1.2.0-77818";
+export const pkgVersion = "1.2.1";