@fluidframework/sequence 1.0.1 → 1.1.0

package/README.md

@@ -1,13 +1,13 @@
 # @fluidframework/sequence
 
-The **@fluidframework/sequence** packages supports distributed data structures which are list-like.  It includes
-SharedString for storing and simultaneously editing a sequence of text. Note that SharedString is a sequence
-DDS but it has additional specialized features and behaviors for working with text.
+The **@fluidframework/sequence** packages supports distributed data structures which are list-like.
+It includes [SharedString]({{< relref "string.md" >}}) for storing and simultaneously editing a sequence of text.
+Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for working with text.
 
-Sequence DDSes share a common base class, SharedSegmentSequence. For the remainder of this document, the term
-*sequence* refers to this base class.
+Sequence DDSes share a common base class, `SharedSegmentSequence`.
+For the remainder of this document, the term *sequence* will refer to this base class.
 
-*Item*s are the individual units that are stored within the sequence (e.g. in a SharedString the items are characters),
+*Item*s are the individual units that are stored within the sequence (e.g. in a SharedString, the items are characters),
 but regardless of the type of data stored in the sequence, every item in a sequence is at a specific *position* starting
 at 0, similar to an array. However, sequences differ from arrays in that the positions can move as local and remote
 editors make modifications to the sequence.
@@ -46,6 +46,8 @@ farther position is closer to the length. -->
 Sequences support three basic operations: insert, remove, and annotate. Insert and remove are used to add and remove
 items from the sequence, while annotate is used to add metadata to items.
 
+### Insert
+
 Insert operations on the sequence take a single position argument along with the content. This position is inclusive and
 can be any position in the sequence including 0, to insert at the beginning of the sequence, and the length of the
 sequence, to insert at the end.
@@ -74,6 +76,8 @@ sequence, to insert at the end.
     // positions: 012345678
 ```
 
+### Remove
+
 Remove operations take a start and an end position, referred to as a *range*. The start position is inclusive and can be
 any position in the sequence from 0 to its `length - 1`. The start position cannot be the length of the sequence like it
 can in insert, because there is nothing at that position. The end position is exclusive and must be greater than the
@@ -94,6 +98,8 @@ start, so it can be any value from 1 to *n* (where *n* is the length of the sequ
     // positions:
 ```
 
+### Annotate
+
 Annotate operations can add or remove map-like properties to or from items in the sequence. They can store any JSON
 serializable data and have the same merge behavior as a [SharedMap][] (last writer wins). Annotate takes a start and end
 position which work the same way as the start and end of the remove operation. In addition to start and end, annotate
@@ -137,6 +143,8 @@ specified range. Setting a property key to null will remove that property from t
     // props5 = { decoration: "underline" }
 ```
 
+### Sequence delta event
+
 Whenever an operation is performed on a sequence a *sequenceDelta* event will be raised. This event provides the ranges
 affected by the operation, the type of the operation, and the properties that were changes by the operation.
 
@@ -147,6 +155,8 @@ final state. However, the intermediate states seen by each collaborator may not
 intermediate states occur when two or more collaborators modify the same position in the sequence which results in a
 conflict.
 
+### Merge strategy for insert
+
 Consider a sequence like this:
 
 ```bash
@@ -229,6 +239,8 @@ Another way to consider this behavior is that a remove operation will only remov
 the order. Anything inserted after a remove operation will be ignored. The sequence also detects overlapping remove
 operations, and the merge resolution is straightforward -- the data is removed.
 
+### Merge strategy for annotate
+
 As mentioned above, annotate operations behave like operations on SharedMaps. The merge strategy used is last writer
 wins. If two collaborators set the same key on the annotate properties the operation that gets ordered last will
 determine the value.

package/dist/defaultMap.d.ts

@@ -6,10 +6,7 @@ import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { TypedEventEmitter } from "@fluidframework/common-utils";
-import { ISerializableValue, ISerializedValue, IValueType, IValueTypeOperationValue, ISharedDefaultMapEvents } from "./defaultMapInterfaces";
-export interface IMapMessageLocalMetadata {
-    lastProcessedSeq: number;
-}
+import { ISerializableValue, ISerializedValue, IValueType, IValueTypeOperationValue, ISharedDefaultMapEvents, IMapMessageLocalMetadata } from "./defaultMapInterfaces";
 /**
  * Describes an operation specific to a value type.
  */
@@ -67,7 +64,6 @@ export declare class DefaultMap<T> {
      * The in-memory data the map is storing.
      */
     private readonly data;
-    private lastProcessedSeq;
     /**
      * Create a new default map.
      * @param serializer - The serializer to serialize / parse handles
@@ -134,7 +130,7 @@ export declare class DefaultMap<T> {
      * also sent if we are asked to resubmit the message.
      * @returns True if the operation was submitted, false otherwise.
      */
-    trySubmitMessage(op: any, localOpMetadata: IMapMessageLocalMetadata): boolean;
+    tryResubmitMessage(op: any, localOpMetadata: IMapMessageLocalMetadata): boolean;
     tryGetStashedOpLocalMetadata(op: any): unknown;
     /**
      * Process the given op if a handler is registered.

package/dist/defaultMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultMap.d.ts","sourceRoot":"","sources":["../src/defaultMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,gBAAgB,EAInB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKzE,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAGhB,UAAU,EACV,wBAAwB,EACxB,uBAAuB,EAC1B,MAAM,wBAAwB,CAAC;AA8BhC,MAAM,WAAW,wBAAwB;IACrC,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,KAAK,EAAE,wBAAwB,CAAC;CACnC;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,sBAAsB,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC;CACrC;AAED,MAAM,WAAW,wBAAwB;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACnC;AAED;;;;;;GAMG;AACH,qBAAa,UAAU,CAAC,CAAC;IA6BjB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI;aACL,YAAY;IAhChC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsD;IAEtF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6C;IAElE,OAAO,CAAC,gBAAgB,CAAc;IAEtC;;;;;;;OAOG;gBAEkB,UAAU,EAAE,gBAAgB,EAC5B,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,wBAAwB,KAAK,IAAI,EAC3E,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACpB,YAAY,6CAAmD;IAKnF;;;OAGG;IACI,IAAI,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAmBjD;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAmBtC;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAI3D;;;OAGG;IACI,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,IAAI;IAM1F;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC;IAQ1B;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;OAIG;IACI,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,GAAG,wBAAwB;IAQ5E,sBAAsB,CAAC,UAAU,EAAE,gBAAgB,GAAG,0BAA0B;IAQhF,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,MAAM;IAItD;;;OAGG;IACI,wBAAwB,CAAC,IAAI,EAAE,0BAA0B,GAAG,IAAI;IAkBhE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;;;OAOG;IACI,gBAAgB,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,wBAAwB,GAAG,OAAO;IAgB7E,4BAA4B,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO;IASrD;;;;;;;OAOG;IACI,iBAAiB,CACpB,EAAE,EAAE,aAAa,EACjB,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,GAAG,SAAS,EAC9C,eAAe,EAAE,OAAO,GACzB,OAAO;IAYV;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAYlB;;;;;;;;;OASG;IACH,OAAO,CAAC,SAAS;IAYjB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAkC1B;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;CAwBhC"}
+{"version":3,"file":"defaultMap.d.ts","sourceRoot":"","sources":["../src/defaultMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,gBAAgB,EAInB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKzE,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAGhB,UAAU,EACV,wBAAwB,EACxB,uBAAuB,EACvB,wBAAwB,EAC3B,MAAM,wBAAwB,CAAC;AAgChC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,KAAK,EAAE,wBAAwB,CAAC;CACnC;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,sBAAsB,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC;CACrC;AAED,MAAM,WAAW,wBAAwB;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACnC;AAED;;;;;;GAMG;AACH,qBAAa,UAAU,CAAC,CAAC;IA2BjB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI;aACL,YAAY;IA9BhC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsD;IAEtF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6C;IAElE;;;;;;;OAOG;gBAEkB,UAAU,EAAE,gBAAgB,EAC5B,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,wBAAwB,KAAK,IAAI,EAC3E,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACpB,YAAY,6CAAmD;IAKnF;;;OAGG;IACI,IAAI,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAgBjD;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAgBtC;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAI3D;;;OAGG;IACI,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,IAAI;IAM1F;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC;IAM1B;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;OAIG;IACI,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,GAAG,wBAAwB;IAQ5E,sBAAsB,CAAC,UAAU,EAAE,gBAAgB,GAAG,0BAA0B;IAQhF,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,MAAM;IAItD;;;OAGG;IACI,wBAAwB,CAAC,IAAI,EAAE,0BAA0B,GAAG,IAAI;IAwBhE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;;;OAOG;IACI,kBAAkB,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,wBAAwB,GAAG,OAAO;IAU/E,4BAA4B,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO;IASrD;;;;;;;OAOG;IACI,iBAAiB,CACpB,EAAE,EAAE,aAAa,EACjB,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,GAAG,SAAS,EAC9C,eAAe,EAAE,OAAO,GACzB,OAAO;IASV;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAYlB;;;;;;;;;OASG;IACH,OAAO,CAAC,SAAS;IAYjB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA8C1B;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;CAwBhC"}

package/dist/defaultMap.js

@@ -38,7 +38,6 @@ class DefaultMap {
          * The in-memory data the map is storing.
          */
         this.data = new Map();
-        this.lastProcessedSeq = -1;
         this.messageHandlers = this.getMessageHandlers();
     }
     /**
@@ -63,13 +62,9 @@ class DefaultMap {
         const iterator = {
             next() {
                 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 }; // Unpack the stored value
             },
             [Symbol.iterator]() {
                 return this;
@@ -86,13 +81,9 @@ class DefaultMap {
         const iterator = {
             next() {
                 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 }; // Unpack the stored value
             },
             [Symbol.iterator]() {
                 return this;
@@ -120,10 +111,8 @@ class DefaultMap {
      * {@inheritDoc ISharedMap.get}
      */
     get(key) {
-        let localValue = this.data.get(key);
-        if (!this.data.has(key)) {
-            localValue = this.createCore(key, true);
-        }
+        var _a;
+        const localValue = (_a = this.data.get(key)) !== null && _a !== void 0 ? _a : this.createCore(key, true);
         return localValue.value;
     }
     /**
@@ -168,8 +157,13 @@ class DefaultMap {
                 || serializable.type === shared_object_base_1.ValueType[shared_object_base_1.ValueType.Shared]) {
                 continue;
             }
+            // Back-compat: Sequence previously arbitrarily prefixed all interval collection keys with
+            // "intervalCollections/". This would burden users trying to iterate the collection and
+            // access its value, as well as those trying to match a create message to its underlying
+            // collection. See https://github.com/microsoft/FluidFramework/issues/10557 for more context.
+            const normalizedKey = key.startsWith("intervalCollections/") ? key.substring(20) : key;
             const localValue = {
-                key,
+                key: normalizedKey,
                 value: this.makeLocal(key, serializable),
             };
             this.data.set(localValue.key, localValue.value);
@@ -186,17 +180,11 @@ class DefaultMap {
      * also sent if we are asked to resubmit the message.
      * @returns True if the operation was submitted, false otherwise.
      */
-    trySubmitMessage(op, localOpMetadata) {
+    tryResubmitMessage(op, localOpMetadata) {
         const type = op.type;
         const handler = this.messageHandlers.get(type);
         if (handler !== undefined) {
-            const mapLocalMetadata = localOpMetadata;
-            // we don't know how to rebase these operations, so if any other op has come in
-            // we will fail.
-            if (this.lastProcessedSeq !== (mapLocalMetadata === null || mapLocalMetadata === void 0 ? void 0 : mapLocalMetadata.lastProcessedSeq)) {
-                throw new Error("SharedInterval does not support reconnect in presence of external changes");
-            }
-            handler.submit(op);
+            handler.resubmit(op, localOpMetadata);
             return true;
         }
         return false;
@@ -218,9 +206,6 @@ class DefaultMap {
      * @returns True if the operation was processed, false otherwise.
      */
     tryProcessMessage(op, local, message, localOpMetadata) {
-        // track the seq of every incoming message, so we can detect if any
-        // changes happened during a resubmit
-        this.lastProcessedSeq = message.sequenceNumber;
         const handler = this.messageHandlers.get(op.type);
         if (handler !== undefined) {
             handler.process(op, local, message, localOpMetadata);
@@ -275,12 +260,18 @@ class DefaultMap {
                 const handler = localValue.getOpHandler(op.value.opName);
                 const previousValue = localValue.value;
                 const translatedValue = (0, shared_object_base_1.parseHandles)(op.value.value, this.serializer);
-                handler.process(previousValue, translatedValue, local, message);
+                handler.process(previousValue, translatedValue, local, message, localOpMetadata);
                 const event = { key: op.key, previousValue };
                 this.eventEmitter.emit("valueChanged", event, local, message, this.eventEmitter);
             },
-            submit: (op) => {
-                this.submitMessage(op, { lastProcessedSeq: this.lastProcessedSeq });
+            submit: (op, localOpMetadata) => {
+                this.submitMessage(op, localOpMetadata);
+            },
+            resubmit: (op, localOpMetadata) => {
+                const localValue = this.data.get(op.key);
+                const handler = localValue.getOpHandler(op.value.opName);
+                const { rebasedOp, rebasedLocalOpMetadata, } = handler.rebase(localValue.value, op.value, localOpMetadata);
+                this.submitMessage(Object.assign(Object.assign({}, op), { value: rebasedOp }), rebasedLocalOpMetadata);
             },
             getStashedOpLocalMetadata: (op) => {
                 (0, common_utils_1.assert)(false, 0x016 /* "apply stashed op not implemented for custom value type ops" */);
@@ -295,7 +286,7 @@ class DefaultMap {
      * @returns A value op emitter for the given key
      */
     makeMapValueOpEmitter(key) {
-        const emit = (opName, previousValue, params) => {
+        const emit = (opName, previousValue, params, localOpMetadata) => {
             const translatedParams = (0, shared_object_base_1.makeHandlesSerializable)(params, this.serializer, this.handle);
             const op = {
                 key,
@@ -305,8 +296,7 @@ class DefaultMap {
                     value: translatedParams,
                 },
             };
-            // Send the localOpMetadata as undefined because we don't care about the ack.
-            this.submitMessage(op, { lastProcessedSeq: this.lastProcessedSeq });
+            this.submitMessage(op, localOpMetadata);
             const event = { key, previousValue };
             this.eventEmitter.emit("valueChanged", event, true, null, this.eventEmitter);
         };

package/dist/defaultMap.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultMap.js","sourceRoot":"","sources":["../src/defaultMap.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,2EAK4C;AAC5C,+DAAyE;AACzE,+CAGuB;AAiFvB;;;;;;GAMG;AACH,MAAa,UAAU;IAoBnB;;;;;;;OAOG;IACH,YACqB,UAA4B,EAC5B,MAAoB,EACpB,aAA2E,EAC3E,IAAmB,EACpB,eAAe,IAAI,gCAAiB,EAA2B;QAJ9D,eAAU,GAAV,UAAU,CAAkB;QAC5B,WAAM,GAAN,MAAM,CAAc;QACpB,kBAAa,GAAb,aAAa,CAA8D;QAC3E,SAAI,GAAJ,IAAI,CAAe;QACpB,iBAAY,GAAZ,YAAY,CAAmD;QAzBnF;;WAEG;QACc,oBAAe,GAA4C,IAAI,GAAG,EAAE,CAAC;QAEtF;;WAEG;QACc,SAAI,GAAG,IAAI,GAAG,EAAkC,CAAC;QAE1D,qBAAgB,GAAW,CAAC,CAAC,CAAC;QAiBlC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACrD,CAAC;IAnCD;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IAgCD;;;OAGG;IACI,IAAI;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,OAAO;QACV,MAAM,oBAAoB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG;YACb,IAAI;gBACA,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,OAAO,CAAC,IAAI,EAAE;oBACd,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;iBAC3C;qBAAM;oBACH,0BAA0B;oBAC1B,OAAO,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBAC7E;YACL,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;QACF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM;QACT,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACb,IAAI;gBACA,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC;gBAC3C,IAAI,OAAO,CAAC,IAAI,EAAE;oBACd,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;iBAC3C;qBAAM;oBACH,0BAA0B;oBAC1B,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBACtD;YACL,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;QACF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAoE;QAC/E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YACrC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QAClB,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACrB,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SAC3C;QACD,OAAO,UAAU,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAW;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,UAA4B;QACpD,MAAM,mBAAmB,GAA6B,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAClC,mBAAmB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,sBAAsB,CAAC,UAA4B;QACtD,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAClC,mBAAmB,CAAC,GAAG,CAAC,GAAG,IAAA,8BAAgB,EAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,SAAS,CAAC,UAA4B;QACzC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,wBAAwB,CAAC,IAAgC;QAC5D,KAAK,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpD,sFAAsF;YACtF,6EAA6E;YAC7E,IAAI,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC;mBAC7C,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EAAE;gBACtD,SAAS;aACZ;YAED,MAAM,UAAU,GAAG;gBACf,GAAG;gBACH,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,CAAC;aAC3C,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;SACnD;IACL,CAAC;IAEM,QAAQ,CAAC,IAAY;QACxB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAA+B,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,EAAO,EAAE,eAAyC;QACtE,MAAM,IAAI,GAAW,EAAE,CAAC,IAAI,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,OAAO,KAAK,SAAS,EAAE;YACvB,MAAM,gBAAgB,GAAsC,eAAe,CAAC;YAC5E,+EAA+E;YAC/E,gBAAgB;YAChB,IAAI,IAAI,CAAC,gBAAgB,MAAK,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,CAAA,EAAE;gBAC9D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;aAChG;YACD,OAAO,CAAC,MAAM,CAAC,EAAmB,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEM,4BAA4B,CAAC,EAAO;QACvC,MAAM,IAAI,GAAW,EAAE,CAAC,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAChC,oEAAoE;YACpE,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,yBAAyB,CAAC,EAAmB,CAAC,CAAC;SACzF;QACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CACpB,EAAiB,EACjB,KAAc,EACd,OAA8C,EAC9C,eAAwB;QAExB,mEAAmE;QACnE,qCAAqC;QACrC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,SAAS,EAAE;YACvB,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,eAA2C,CAAC,CAAC;YACjF,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,GAAW,EAAE,KAAc;QAC1C,MAAM,UAAU,GAAG,IAAI,iCAAmB,CACtC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,EAClE,IAAI,CAAC,IAAI,CACZ,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;QACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAClE,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACK,SAAS,CAAC,GAAW,EAAE,YAAgC;QAC3D,IAAA,qBAAM,EAAC,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EACxG,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAE1D,YAAY,CAAC,KAAK,GAAG,IAAA,iCAAY,EAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CACrC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAC/B,YAAY,CAAC,KAAK,CACrB,CAAC;QACF,OAAO,IAAI,iCAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACK,kBAAkB;QACtB,MAAM,eAAe,GAAG,IAAI,GAAG,EAA8B,CAAC;QAC9D,+FAA+F;QAC/F,kGAAkG;QAClG,8FAA8F;QAC9F,2CAA2C;QAC3C,eAAe,CAAC,GAAG,CACf,KAAK,EACL;YACI,OAAO,EAAE,CAAC,EAA0B,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE;;gBACrE,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC;gBACvC,MAAM,eAAe,GAAG,IAAA,iCAAY,EAChC,EAAE,CAAC,KAAK,CAAC,KAAK,EACd,IAAI,CAAC,UAAU,CAAC,CAAC;gBACrB,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;gBAChE,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,CAAC;gBAC5D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACrF,CAAC;YACD,MAAM,EAAE,CAAC,EAA0B,EAAE,EAAE;gBACnC,IAAI,CAAC,aAAa,CACd,EAAE,EACF,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAC9C,CAAC;YACN,CAAC;YACD,yBAAyB,EAAE,CAAC,EAA0B,EAAE,EAAE;gBACtD,IAAA,qBAAM,EAAC,KAAK,EAAE,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAC5F,CAAC;SACJ,CAAC,CAAC;QAEP,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,GAAW;QACrC,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,aAAkB,EAAE,MAAW,EAAE,EAAE;YAC7D,MAAM,gBAAgB,GAAG,IAAA,4CAAuB,EAC5C,MAAM,EACN,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CAAC,CAAC;YAEjB,MAAM,EAAE,GAA2B;gBAC/B,GAAG;gBACH,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACH,MAAM;oBACN,KAAK,EAAE,gBAAgB;iBAC1B;aACJ,CAAC;YACF,6EAA6E;YAC7E,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAEpE,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;YACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACjF,CAAC,CAAC;QAEF,OAAO,EAAE,IAAI,EAAE,CAAC;IACpB,CAAC;CACJ;AA3VD,gCA2VC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidSerializer,\n    makeHandlesSerializable,\n    parseHandles,\n    ValueType,\n} from \"@fluidframework/shared-object-base\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport {\n    makeSerializable,\n    ValueTypeLocalValue,\n} from \"./localValues\";\nimport {\n    ISerializableValue,\n    ISerializedValue,\n    IValueChanged,\n    IValueOpEmitter,\n    IValueType,\n    IValueTypeOperationValue,\n    ISharedDefaultMapEvents,\n} from \"./defaultMapInterfaces\";\n\n/**\n * Defines the means to process and submit a given op on a map.\n */\ninterface IMapMessageHandler {\n    /**\n     * Apply the given operation.\n     * @param op - The map operation to apply\n     * @param local - Whether the message originated from the local client\n     * @param message - The full message. Not provided for stashed ops.\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    process(\n        op: IMapOperation,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined,\n        localOpMetadata: IMapMessageLocalMetadata,\n    ): void;\n\n    /**\n     * Communicate the operation to remote clients.\n     * @param op - The map operation to submit\n     */\n    submit(op: IMapOperation): void;\n\n    getStashedOpLocalMetadata(op: IMapOperation): unknown;\n}\n\nexport interface IMapMessageLocalMetadata {\n    lastProcessedSeq: number;\n}\n\n/**\n * Describes an operation specific to a value type.\n */\nexport interface IMapValueTypeOperation {\n    /**\n     * String identifier of the operation type.\n     */\n    type: \"act\";\n\n    /**\n     * Map key being modified.\n     */\n    key: string;\n\n    /**\n     * Value of the operation, specific to the value type.\n     * @alpha\n     */\n    value: IValueTypeOperationValue;\n}\n\n/**\n * Description of a map delta operation\n */\nexport type IMapOperation = IMapValueTypeOperation;\n\n/**\n * Defines the in-memory object structure to be used for the conversion to/from serialized.\n * Directly used in JSON.stringify, direct result from JSON.parse\n */\nexport interface IMapDataObjectSerializable {\n    [key: string]: ISerializableValue;\n}\n\nexport interface IMapDataObjectSerialized {\n    [key: string]: ISerializedValue;\n}\n\n/**\n * A DefaultMap is a map-like distributed data structure, supporting operations on values stored by\n * string key locations.\n *\n * Creation of values is implicit on access (either via `get` or a remote op application referring to\n * a collection that wasn't previously known)\n */\nexport class DefaultMap<T> {\n    /**\n     * The number of key/value pairs stored in the map.\n     */\n    public get size(): number {\n        return this.data.size;\n    }\n\n    /**\n     * Mapping of op types to message handlers.\n     */\n    private readonly messageHandlers: ReadonlyMap<string, IMapMessageHandler> = new Map();\n\n    /**\n     * The in-memory data the map is storing.\n     */\n    private readonly data = new Map<string, ValueTypeLocalValue<T>>();\n\n    private lastProcessedSeq: number = -1;\n\n    /**\n     * Create a new default map.\n     * @param serializer - The serializer to serialize / parse handles\n     * @param handle - The handle of the shared object using the kernel\n     * @param submitMessage - A callback to submit a message through the shared object\n     * @param type - The value type to create at values of this map\n     * @param eventEmitter - The object that will emit map events\n     */\n    constructor(\n        private readonly serializer: IFluidSerializer,\n        private readonly handle: IFluidHandle,\n        private readonly submitMessage: (op: any, localOpMetadata: IMapMessageLocalMetadata) => void,\n        private readonly type: IValueType<T>,\n        public readonly eventEmitter = new TypedEventEmitter<ISharedDefaultMapEvents>(),\n    ) {\n        this.messageHandlers = this.getMessageHandlers();\n    }\n\n    /**\n     * Get an iterator over the keys in this map.\n     * @returns The iterator\n     */\n    public keys(): IterableIterator<string> {\n        return this.data.keys();\n    }\n\n    /**\n     * Get an iterator over the entries in this map.\n     * @returns The iterator\n     */\n    public entries(): IterableIterator<[string, any]> {\n        const localEntriesIterator = this.data.entries();\n        const iterator = {\n            next(): IteratorResult<[string, any]> {\n                const nextVal = localEntriesIterator.next();\n                if (nextVal.done) {\n                    return { value: undefined, done: true };\n                } else {\n                    // Unpack the stored value\n                    return { value: [nextVal.value[0], nextVal.value[1].value], done: false };\n                }\n            },\n            [Symbol.iterator]() {\n                return this;\n            },\n        };\n        return iterator;\n    }\n\n    /**\n     * Get an iterator over the values in this map.\n     * @returns The iterator\n     */\n    public values(): IterableIterator<any> {\n        const localValuesIterator = this.data.values();\n        const iterator = {\n            next(): IteratorResult<any> {\n                const nextVal = localValuesIterator.next();\n                if (nextVal.done) {\n                    return { value: undefined, done: true };\n                } else {\n                    // Unpack the stored value\n                    return { value: nextVal.value.value, done: false };\n                }\n            },\n            [Symbol.iterator]() {\n                return this;\n            },\n        };\n        return iterator;\n    }\n\n    /**\n     * Get an iterator over the entries in this map.\n     * @returns The iterator\n     */\n    public [Symbol.iterator](): IterableIterator<[string, any]> {\n        return this.entries();\n    }\n\n    /**\n     * Executes the given callback on each entry in the map.\n     * @param callbackFn - Callback function\n     */\n    public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {\n        this.data.forEach((localValue, key, m) => {\n            callbackFn(localValue.value, key, m);\n        });\n    }\n\n    /**\n     * {@inheritDoc ISharedMap.get}\n     */\n    public get(key: string): T {\n        let localValue = this.data.get(key);\n        if (!this.data.has(key)) {\n            localValue = this.createCore(key, true);\n        }\n        return localValue.value;\n    }\n\n    /**\n     * Check if a key exists in the map.\n     * @param key - The key to check\n     * @returns True if the key exists, false otherwise\n     */\n    public has(key: string): boolean {\n        return this.data.has(key);\n    }\n\n    /**\n     * Serializes the data stored in the shared map to a JSON string\n     * @param serializer - The serializer to use to serialize handles in its values.\n     * @returns A JSON string containing serialized map data\n     */\n    public getSerializedStorage(serializer: IFluidSerializer): IMapDataObjectSerialized {\n        const serializableMapData: IMapDataObjectSerialized = {};\n        this.data.forEach((localValue, key) => {\n            serializableMapData[key] = localValue.makeSerialized(serializer, this.handle);\n        });\n        return serializableMapData;\n    }\n\n    public getSerializableStorage(serializer: IFluidSerializer): IMapDataObjectSerializable {\n        const serializableMapData: IMapDataObjectSerializable = {};\n        this.data.forEach((localValue, key) => {\n            serializableMapData[key] = makeSerializable(localValue, serializer, this.handle);\n        });\n        return serializableMapData;\n    }\n\n    public serialize(serializer: IFluidSerializer): string {\n        return JSON.stringify(this.getSerializableStorage(serializer));\n    }\n\n    /**\n     * Populate the kernel with the given map data.\n     * @param data - A JSON string containing serialized map data\n     */\n    public populateFromSerializable(json: IMapDataObjectSerializable): void {\n        for (const [key, serializable] of Object.entries(json)) {\n            // Back-compat: legacy documents may have handles to an intervalCollection map kernel.\n            // These collections should be empty, and ValueTypes are no longer supported.\n            if (serializable.type === ValueType[ValueType.Plain]\n                || serializable.type === ValueType[ValueType.Shared]) {\n                continue;\n            }\n\n            const localValue = {\n                key,\n                value: this.makeLocal(key, serializable),\n            };\n\n            this.data.set(localValue.key, localValue.value);\n        }\n    }\n\n    public populate(json: string): void {\n        this.populateFromSerializable(JSON.parse(json) as IMapDataObjectSerializable);\n    }\n\n    /**\n     * Submit the given op if a handler is registered.\n     * @param op - The operation to attempt to submit\n     * @param localOpMetadata - The local metadata associated with the op. This is kept locally by the runtime\n     * and not sent to the server. This will be sent back when this message is received back from the server. This is\n     * also sent if we are asked to resubmit the message.\n     * @returns True if the operation was submitted, false otherwise.\n     */\n    public trySubmitMessage(op: any, localOpMetadata: IMapMessageLocalMetadata): boolean {\n        const type: string = op.type;\n        const handler = this.messageHandlers.get(type);\n        if (handler !== undefined) {\n            const mapLocalMetadata: Partial<IMapMessageLocalMetadata> = localOpMetadata;\n            // we don't know how to rebase these operations, so if any other op has come in\n            // we will fail.\n            if (this.lastProcessedSeq !== mapLocalMetadata?.lastProcessedSeq) {\n                throw new Error(\"SharedInterval does not support reconnect in presence of external changes\");\n            }\n            handler.submit(op as IMapOperation);\n            return true;\n        }\n        return false;\n    }\n\n    public tryGetStashedOpLocalMetadata(op: any): unknown {\n        const type: string = op.type;\n        if (this.messageHandlers.has(type)) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            return this.messageHandlers.get(type)!.getStashedOpLocalMetadata(op as IMapOperation);\n        }\n        throw new Error(\"no apply stashed op handler\");\n    }\n\n    /**\n     * Process the given op if a handler is registered.\n     * @param message - The message to process\n     * @param local - Whether the message originated from the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     * @returns True if the operation was processed, false otherwise.\n     */\n    public tryProcessMessage(\n        op: IMapOperation,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined,\n        localOpMetadata: unknown,\n    ): boolean {\n        // track the seq of every incoming message, so we can detect if any\n        // changes happened during a resubmit\n        this.lastProcessedSeq = message.sequenceNumber;\n        const handler = this.messageHandlers.get(op.type);\n        if (handler !== undefined) {\n            handler.process(op, local, message, localOpMetadata as IMapMessageLocalMetadata);\n            return true;\n        }\n        return false;\n    }\n\n    /**\n     * Initializes a default ValueType at the provided key.\n     * Should be used when a map operation incurs creation.\n     * @param key - The key being initialized\n     * @param local - Whether the message originated from the local client\n     */\n    private createCore(key: string, local: boolean): ValueTypeLocalValue<T> {\n        const localValue = new ValueTypeLocalValue(\n            this.type.factory.load(this.makeMapValueOpEmitter(key), undefined),\n            this.type,\n        );\n        const previousValue = this.data.get(key);\n        this.data.set(key, localValue);\n        const event: IValueChanged = { key, previousValue };\n        this.eventEmitter.emit(\"create\", event, local, this.eventEmitter);\n        return localValue;\n    }\n\n    /**\n     * The remote ISerializableValue we're receiving (either as a result of a load or an incoming set op) will\n     * have the information we need to create a real object, but will not be the real object yet.  For example,\n     * we might know it's a map and the map's ID but not have the actual map or its data yet.  makeLocal's\n     * job is to convert that information into a real object for local usage.\n     * @param key - The key that the caller intends to store the local value into (used for ops later).  But\n     * doesn't actually store the local value into that key.  So better not lie!\n     * @param serializable - The remote information that we can convert into a real object\n     * @returns The local value that was produced\n     */\n    private makeLocal(key: string, serializable: ISerializableValue): ValueTypeLocalValue<T> {\n        assert(serializable.type !== ValueType[ValueType.Plain] && serializable.type !== ValueType[ValueType.Shared],\n            0x2e1 /* \"Support for plain value types removed.\" */);\n\n        serializable.value = parseHandles(serializable.value, this.serializer);\n        const localValue = this.type.factory.load(\n            this.makeMapValueOpEmitter(key),\n            serializable.value,\n        );\n        return new ValueTypeLocalValue(localValue, this.type);\n    }\n\n    /**\n     * Get the message handlers for the map.\n     * @returns A map of string op names to IMapMessageHandlers for those ops\n     */\n    private getMessageHandlers() {\n        const messageHandlers = new Map<string, IMapMessageHandler>();\n        // Ops with type \"act\" describe actions taken by custom value type handlers of whatever item is\n        // being addressed.  These custom handlers can be retrieved from the ValueTypeLocalValue which has\n        // stashed its valueType (and therefore its handlers).  We also emit a valueChanged for anyone\n        // watching for manipulations of that item.\n        messageHandlers.set(\n            \"act\",\n            {\n                process: (op: IMapValueTypeOperation, local, message, localOpMetadata) => {\n                    const localValue = this.data.get(op.key) ?? this.createCore(op.key, local);\n                    const handler = localValue.getOpHandler(op.value.opName);\n                    const previousValue = localValue.value;\n                    const translatedValue = parseHandles(\n                        op.value.value,\n                        this.serializer);\n                    handler.process(previousValue, translatedValue, local, message);\n                    const event: IValueChanged = { key: op.key, previousValue };\n                    this.eventEmitter.emit(\"valueChanged\", event, local, message, this.eventEmitter);\n                },\n                submit: (op: IMapValueTypeOperation) => {\n                    this.submitMessage(\n                        op,\n                        { lastProcessedSeq: this.lastProcessedSeq },\n                    );\n                },\n                getStashedOpLocalMetadata: (op: IMapValueTypeOperation) => {\n                    assert(false, 0x016 /* \"apply stashed op not implemented for custom value type ops\" */);\n                },\n            });\n\n        return messageHandlers;\n    }\n\n    /**\n     * Create an emitter for a value type to emit ops from the given key.\n     * @alpha\n     * @param key - The key of the map that the value type will be stored on\n     * @returns A value op emitter for the given key\n     */\n    private makeMapValueOpEmitter(key: string): IValueOpEmitter {\n        const emit = (opName: string, previousValue: any, params: any) => {\n            const translatedParams = makeHandlesSerializable(\n                params,\n                this.serializer,\n                this.handle);\n\n            const op: IMapValueTypeOperation = {\n                key,\n                type: \"act\",\n                value: {\n                    opName,\n                    value: translatedParams,\n                },\n            };\n            // Send the localOpMetadata as undefined because we don't care about the ack.\n            this.submitMessage(op, { lastProcessedSeq: this.lastProcessedSeq });\n\n            const event: IValueChanged = { key, previousValue };\n            this.eventEmitter.emit(\"valueChanged\", event, true, null, this.eventEmitter);\n        };\n\n        return { emit };\n    }\n}\n"]}
+{"version":3,"file":"defaultMap.js","sourceRoot":"","sources":["../src/defaultMap.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,2EAK4C;AAC5C,+DAAyE;AACzE,+CAGuB;AAgFvB;;;;;;GAMG;AACH,MAAa,UAAU;IAkBnB;;;;;;;OAOG;IACH,YACqB,UAA4B,EAC5B,MAAoB,EACpB,aAA2E,EAC3E,IAAmB,EACpB,eAAe,IAAI,gCAAiB,EAA2B;QAJ9D,eAAU,GAAV,UAAU,CAAkB;QAC5B,WAAM,GAAN,MAAM,CAAc;QACpB,kBAAa,GAAb,aAAa,CAA8D;QAC3E,SAAI,GAAJ,IAAI,CAAe;QACpB,iBAAY,GAAZ,YAAY,CAAmD;QAvBnF;;WAEG;QACc,oBAAe,GAA4C,IAAI,GAAG,EAAE,CAAC;QAEtF;;WAEG;QACc,SAAI,GAAG,IAAI,GAAG,EAAkC,CAAC;QAiB9D,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACrD,CAAC;IAjCD;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IA8BD;;;OAGG;IACI,IAAI;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,OAAO;QACV,MAAM,oBAAoB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG;YACb,IAAI;gBACA,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,EAAE,CAAC;gBAC5C,OAAO,OAAO,CAAC,IAAI;oBACf,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;oBAClC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,0BAA0B;YACxG,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;QACF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM;QACT,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACb,IAAI;gBACA,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC;gBAC3C,OAAO,OAAO,CAAC,IAAI;oBACf,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;oBAClC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,0BAA0B;YACjF,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;QACF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAoE;QAC/E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YACrC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;;QAClB,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEpE,OAAO,UAAU,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAW;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,UAA4B;QACpD,MAAM,mBAAmB,GAA6B,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAClC,mBAAmB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,sBAAsB,CAAC,UAA4B;QACtD,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAClC,mBAAmB,CAAC,GAAG,CAAC,GAAG,IAAA,8BAAgB,EAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,SAAS,CAAC,UAA4B;QACzC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,wBAAwB,CAAC,IAAgC;QAC5D,KAAK,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpD,sFAAsF;YACtF,6EAA6E;YAC7E,IAAI,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC;mBAC7C,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EAAE;gBACtD,SAAS;aACZ;YAED,0FAA0F;YAC1F,uFAAuF;YACvF,wFAAwF;YACxF,6FAA6F;YAC7F,MAAM,aAAa,GAAG,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YAEvF,MAAM,UAAU,GAAG;gBACf,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,CAAC;aAC3C,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;SACnD;IACL,CAAC;IAEM,QAAQ,CAAC,IAAY;QACxB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAA+B,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,EAAO,EAAE,eAAyC;QACxE,MAAM,IAAI,GAAW,EAAE,CAAC,IAAI,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,OAAO,KAAK,SAAS,EAAE;YACvB,OAAO,CAAC,QAAQ,CAAC,EAAmB,EAAE,eAAe,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEM,4BAA4B,CAAC,EAAO;QACvC,MAAM,IAAI,GAAW,EAAE,CAAC,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAChC,oEAAoE;YACpE,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,yBAAyB,CAAC,EAAmB,CAAC,CAAC;SACzF;QACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CACpB,EAAiB,EACjB,KAAc,EACd,OAA8C,EAC9C,eAAwB;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,SAAS,EAAE;YACvB,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,eAA2C,CAAC,CAAC;YACjF,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,GAAW,EAAE,KAAc;QAC1C,MAAM,UAAU,GAAG,IAAI,iCAAmB,CACtC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,EAClE,IAAI,CAAC,IAAI,CACZ,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;QACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAClE,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACK,SAAS,CAAC,GAAW,EAAE,YAAgC;QAC3D,IAAA,qBAAM,EAAC,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EACxG,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAE1D,YAAY,CAAC,KAAK,GAAG,IAAA,iCAAY,EAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CACrC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAC/B,YAAY,CAAC,KAAK,CACrB,CAAC;QACF,OAAO,IAAI,iCAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACK,kBAAkB;QACtB,MAAM,eAAe,GAAG,IAAI,GAAG,EAA8B,CAAC;QAC9D,+FAA+F;QAC/F,kGAAkG;QAClG,8FAA8F;QAC9F,2CAA2C;QAC3C,eAAe,CAAC,GAAG,CACf,KAAK,EACL;YACI,OAAO,EAAE,CAAC,EAA0B,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE;;gBACrE,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC;gBACvC,MAAM,eAAe,GAAG,IAAA,iCAAY,EAChC,EAAE,CAAC,KAAK,CAAC,KAAK,EACd,IAAI,CAAC,UAAU,CAAC,CAAC;gBACrB,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;gBACjF,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,CAAC;gBAC5D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACrF,CAAC;YACD,MAAM,EAAE,CAAC,EAA0B,EAAE,eAAyC,EAAE,EAAE;gBAC9E,IAAI,CAAC,aAAa,CACd,EAAE,EACF,eAAe,CAClB,CAAC;YACN,CAAC;YACD,QAAQ,EAAE,CAAC,EAA0B,EAAE,eAAyC,EAAE,EAAE;gBAChF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBACzC,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM,EACF,SAAS,EACT,sBAAsB,GACzB,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;gBAChE,IAAI,CAAC,aAAa,iCACT,EAAE,KAAE,KAAK,EAAE,SAAS,KACzB,sBAAsB,CACzB,CAAC;YACN,CAAC;YACD,yBAAyB,EAAE,CAAC,EAA0B,EAAE,EAAE;gBACtD,IAAA,qBAAM,EAAC,KAAK,EAAE,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAC5F,CAAC;SACJ,CAAC,CAAC;QAEP,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,GAAW;QACrC,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,aAAkB,EAAE,MAAW,EAAE,eAAyC,EAAE,EAAE;YACxG,MAAM,gBAAgB,GAAG,IAAA,4CAAuB,EAC5C,MAAM,EACN,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CAAC,CAAC;YAEjB,MAAM,EAAE,GAA2B;gBAC/B,GAAG;gBACH,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACH,MAAM;oBACN,KAAK,EAAE,gBAAgB;iBAC1B;aACJ,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;YAExC,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;YACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACjF,CAAC,CAAC;QAEF,OAAO,EAAE,IAAI,EAAE,CAAC;IACpB,CAAC;CACJ;AA1VD,gCA0VC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidSerializer,\n    makeHandlesSerializable,\n    parseHandles,\n    ValueType,\n} from \"@fluidframework/shared-object-base\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport {\n    makeSerializable,\n    ValueTypeLocalValue,\n} from \"./localValues\";\nimport {\n    ISerializableValue,\n    ISerializedValue,\n    IValueChanged,\n    IValueOpEmitter,\n    IValueType,\n    IValueTypeOperationValue,\n    ISharedDefaultMapEvents,\n    IMapMessageLocalMetadata,\n} from \"./defaultMapInterfaces\";\n\n/**\n * Defines the means to process and submit a given op on a map.\n */\ninterface IMapMessageHandler {\n    /**\n     * Apply the given operation.\n     * @param op - The map operation to apply\n     * @param local - Whether the message originated from the local client\n     * @param message - The full message. Not provided for stashed ops.\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    process(\n        op: IMapOperation,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined,\n        localOpMetadata: IMapMessageLocalMetadata,\n    ): void;\n\n    /**\n     * Communicate the operation to remote clients.\n     * @param op - The map operation to submit\n     */\n    submit(op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata): void;\n\n    resubmit(op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata): void;\n\n    getStashedOpLocalMetadata(op: IMapOperation): unknown;\n}\n\n/**\n * Describes an operation specific to a value type.\n */\nexport interface IMapValueTypeOperation {\n    /**\n     * String identifier of the operation type.\n     */\n    type: \"act\";\n\n    /**\n     * Map key being modified.\n     */\n    key: string;\n\n    /**\n     * Value of the operation, specific to the value type.\n     * @alpha\n     */\n    value: IValueTypeOperationValue;\n}\n\n/**\n * Description of a map delta operation\n */\nexport type IMapOperation = IMapValueTypeOperation;\n\n/**\n * Defines the in-memory object structure to be used for the conversion to/from serialized.\n * Directly used in JSON.stringify, direct result from JSON.parse\n */\nexport interface IMapDataObjectSerializable {\n    [key: string]: ISerializableValue;\n}\n\nexport interface IMapDataObjectSerialized {\n    [key: string]: ISerializedValue;\n}\n\n/**\n * A DefaultMap is a map-like distributed data structure, supporting operations on values stored by\n * string key locations.\n *\n * Creation of values is implicit on access (either via `get` or a remote op application referring to\n * a collection that wasn't previously known)\n */\nexport class DefaultMap<T> {\n    /**\n     * The number of key/value pairs stored in the map.\n     */\n    public get size(): number {\n        return this.data.size;\n    }\n\n    /**\n     * Mapping of op types to message handlers.\n     */\n    private readonly messageHandlers: ReadonlyMap<string, IMapMessageHandler> = new Map();\n\n    /**\n     * The in-memory data the map is storing.\n     */\n    private readonly data = new Map<string, ValueTypeLocalValue<T>>();\n\n    /**\n     * Create a new default map.\n     * @param serializer - The serializer to serialize / parse handles\n     * @param handle - The handle of the shared object using the kernel\n     * @param submitMessage - A callback to submit a message through the shared object\n     * @param type - The value type to create at values of this map\n     * @param eventEmitter - The object that will emit map events\n     */\n    constructor(\n        private readonly serializer: IFluidSerializer,\n        private readonly handle: IFluidHandle,\n        private readonly submitMessage: (op: any, localOpMetadata: IMapMessageLocalMetadata) => void,\n        private readonly type: IValueType<T>,\n        public readonly eventEmitter = new TypedEventEmitter<ISharedDefaultMapEvents>(),\n    ) {\n        this.messageHandlers = this.getMessageHandlers();\n    }\n\n    /**\n     * Get an iterator over the keys in this map.\n     * @returns The iterator\n     */\n    public keys(): IterableIterator<string> {\n        return this.data.keys();\n    }\n\n    /**\n     * Get an iterator over the entries in this map.\n     * @returns The iterator\n     */\n    public entries(): IterableIterator<[string, any]> {\n        const localEntriesIterator = this.data.entries();\n        const iterator = {\n            next(): IteratorResult<[string, any]> {\n                const nextVal = localEntriesIterator.next();\n                return nextVal.done\n                    ? { value: undefined, done: true }\n                    : { value: [nextVal.value[0], nextVal.value[1].value], done: false }; // Unpack the stored value\n            },\n            [Symbol.iterator]() {\n                return this;\n            },\n        };\n        return iterator;\n    }\n\n    /**\n     * Get an iterator over the values in this map.\n     * @returns The iterator\n     */\n    public values(): IterableIterator<any> {\n        const localValuesIterator = this.data.values();\n        const iterator = {\n            next(): IteratorResult<any> {\n                const nextVal = localValuesIterator.next();\n                return nextVal.done\n                    ? { value: undefined, done: true }\n                    : { value: nextVal.value.value, done: false }; // Unpack the stored value\n            },\n            [Symbol.iterator]() {\n                return this;\n            },\n        };\n        return iterator;\n    }\n\n    /**\n     * Get an iterator over the entries in this map.\n     * @returns The iterator\n     */\n    public [Symbol.iterator](): IterableIterator<[string, any]> {\n        return this.entries();\n    }\n\n    /**\n     * Executes the given callback on each entry in the map.\n     * @param callbackFn - Callback function\n     */\n    public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {\n        this.data.forEach((localValue, key, m) => {\n            callbackFn(localValue.value, key, m);\n        });\n    }\n\n    /**\n     * {@inheritDoc ISharedMap.get}\n     */\n    public get(key: string): T {\n        const localValue = this.data.get(key) ?? this.createCore(key, true);\n\n        return localValue.value;\n    }\n\n    /**\n     * Check if a key exists in the map.\n     * @param key - The key to check\n     * @returns True if the key exists, false otherwise\n     */\n    public has(key: string): boolean {\n        return this.data.has(key);\n    }\n\n    /**\n     * Serializes the data stored in the shared map to a JSON string\n     * @param serializer - The serializer to use to serialize handles in its values.\n     * @returns A JSON string containing serialized map data\n     */\n    public getSerializedStorage(serializer: IFluidSerializer): IMapDataObjectSerialized {\n        const serializableMapData: IMapDataObjectSerialized = {};\n        this.data.forEach((localValue, key) => {\n            serializableMapData[key] = localValue.makeSerialized(serializer, this.handle);\n        });\n        return serializableMapData;\n    }\n\n    public getSerializableStorage(serializer: IFluidSerializer): IMapDataObjectSerializable {\n        const serializableMapData: IMapDataObjectSerializable = {};\n        this.data.forEach((localValue, key) => {\n            serializableMapData[key] = makeSerializable(localValue, serializer, this.handle);\n        });\n        return serializableMapData;\n    }\n\n    public serialize(serializer: IFluidSerializer): string {\n        return JSON.stringify(this.getSerializableStorage(serializer));\n    }\n\n    /**\n     * Populate the kernel with the given map data.\n     * @param data - A JSON string containing serialized map data\n     */\n    public populateFromSerializable(json: IMapDataObjectSerializable): void {\n        for (const [key, serializable] of Object.entries(json)) {\n            // Back-compat: legacy documents may have handles to an intervalCollection map kernel.\n            // These collections should be empty, and ValueTypes are no longer supported.\n            if (serializable.type === ValueType[ValueType.Plain]\n                || serializable.type === ValueType[ValueType.Shared]) {\n                continue;\n            }\n\n            // Back-compat: Sequence previously arbitrarily prefixed all interval collection keys with\n            // \"intervalCollections/\". This would burden users trying to iterate the collection and\n            // access its value, as well as those trying to match a create message to its underlying\n            // collection. See https://github.com/microsoft/FluidFramework/issues/10557 for more context.\n            const normalizedKey = key.startsWith(\"intervalCollections/\") ? key.substring(20) : key;\n\n            const localValue = {\n                key: normalizedKey,\n                value: this.makeLocal(key, serializable),\n            };\n\n            this.data.set(localValue.key, localValue.value);\n        }\n    }\n\n    public populate(json: string): void {\n        this.populateFromSerializable(JSON.parse(json) as IMapDataObjectSerializable);\n    }\n\n    /**\n     * Submit the given op if a handler is registered.\n     * @param op - The operation to attempt to submit\n     * @param localOpMetadata - The local metadata associated with the op. This is kept locally by the runtime\n     * and not sent to the server. This will be sent back when this message is received back from the server. This is\n     * also sent if we are asked to resubmit the message.\n     * @returns True if the operation was submitted, false otherwise.\n     */\n    public tryResubmitMessage(op: any, localOpMetadata: IMapMessageLocalMetadata): boolean {\n        const type: string = op.type;\n        const handler = this.messageHandlers.get(type);\n        if (handler !== undefined) {\n            handler.resubmit(op as IMapOperation, localOpMetadata);\n            return true;\n        }\n        return false;\n    }\n\n    public tryGetStashedOpLocalMetadata(op: any): unknown {\n        const type: string = op.type;\n        if (this.messageHandlers.has(type)) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            return this.messageHandlers.get(type)!.getStashedOpLocalMetadata(op as IMapOperation);\n        }\n        throw new Error(\"no apply stashed op handler\");\n    }\n\n    /**\n     * Process the given op if a handler is registered.\n     * @param message - The message to process\n     * @param local - Whether the message originated from the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     * @returns True if the operation was processed, false otherwise.\n     */\n    public tryProcessMessage(\n        op: IMapOperation,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined,\n        localOpMetadata: unknown,\n    ): boolean {\n        const handler = this.messageHandlers.get(op.type);\n        if (handler !== undefined) {\n            handler.process(op, local, message, localOpMetadata as IMapMessageLocalMetadata);\n            return true;\n        }\n        return false;\n    }\n\n    /**\n     * Initializes a default ValueType at the provided key.\n     * Should be used when a map operation incurs creation.\n     * @param key - The key being initialized\n     * @param local - Whether the message originated from the local client\n     */\n    private createCore(key: string, local: boolean): ValueTypeLocalValue<T> {\n        const localValue = new ValueTypeLocalValue(\n            this.type.factory.load(this.makeMapValueOpEmitter(key), undefined),\n            this.type,\n        );\n        const previousValue = this.data.get(key);\n        this.data.set(key, localValue);\n        const event: IValueChanged = { key, previousValue };\n        this.eventEmitter.emit(\"create\", event, local, this.eventEmitter);\n        return localValue;\n    }\n\n    /**\n     * The remote ISerializableValue we're receiving (either as a result of a load or an incoming set op) will\n     * have the information we need to create a real object, but will not be the real object yet.  For example,\n     * we might know it's a map and the map's ID but not have the actual map or its data yet.  makeLocal's\n     * job is to convert that information into a real object for local usage.\n     * @param key - The key that the caller intends to store the local value into (used for ops later).  But\n     * doesn't actually store the local value into that key.  So better not lie!\n     * @param serializable - The remote information that we can convert into a real object\n     * @returns The local value that was produced\n     */\n    private makeLocal(key: string, serializable: ISerializableValue): ValueTypeLocalValue<T> {\n        assert(serializable.type !== ValueType[ValueType.Plain] && serializable.type !== ValueType[ValueType.Shared],\n            0x2e1 /* \"Support for plain value types removed.\" */);\n\n        serializable.value = parseHandles(serializable.value, this.serializer);\n        const localValue = this.type.factory.load(\n            this.makeMapValueOpEmitter(key),\n            serializable.value,\n        );\n        return new ValueTypeLocalValue(localValue, this.type);\n    }\n\n    /**\n     * Get the message handlers for the map.\n     * @returns A map of string op names to IMapMessageHandlers for those ops\n     */\n    private getMessageHandlers() {\n        const messageHandlers = new Map<string, IMapMessageHandler>();\n        // Ops with type \"act\" describe actions taken by custom value type handlers of whatever item is\n        // being addressed.  These custom handlers can be retrieved from the ValueTypeLocalValue which has\n        // stashed its valueType (and therefore its handlers).  We also emit a valueChanged for anyone\n        // watching for manipulations of that item.\n        messageHandlers.set(\n            \"act\",\n            {\n                process: (op: IMapValueTypeOperation, local, message, localOpMetadata) => {\n                    const localValue = this.data.get(op.key) ?? this.createCore(op.key, local);\n                    const handler = localValue.getOpHandler(op.value.opName);\n                    const previousValue = localValue.value;\n                    const translatedValue = parseHandles(\n                        op.value.value,\n                        this.serializer);\n                    handler.process(previousValue, translatedValue, local, message, localOpMetadata);\n                    const event: IValueChanged = { key: op.key, previousValue };\n                    this.eventEmitter.emit(\"valueChanged\", event, local, message, this.eventEmitter);\n                },\n                submit: (op: IMapValueTypeOperation, localOpMetadata: IMapMessageLocalMetadata) => {\n                    this.submitMessage(\n                        op,\n                        localOpMetadata,\n                    );\n                },\n                resubmit: (op: IMapValueTypeOperation, localOpMetadata: IMapMessageLocalMetadata) => {\n                    const localValue = this.data.get(op.key);\n                    const handler = localValue.getOpHandler(op.value.opName);\n                    const {\n                        rebasedOp,\n                        rebasedLocalOpMetadata,\n                    } = handler.rebase(localValue.value, op.value, localOpMetadata);\n                    this.submitMessage(\n                        { ...op, value: rebasedOp },\n                        rebasedLocalOpMetadata,\n                    );\n                },\n                getStashedOpLocalMetadata: (op: IMapValueTypeOperation) => {\n                    assert(false, 0x016 /* \"apply stashed op not implemented for custom value type ops\" */);\n                },\n            });\n\n        return messageHandlers;\n    }\n\n    /**\n     * Create an emitter for a value type to emit ops from the given key.\n     * @alpha\n     * @param key - The key of the map that the value type will be stored on\n     * @returns A value op emitter for the given key\n     */\n    private makeMapValueOpEmitter(key: string): IValueOpEmitter {\n        const emit = (opName: string, previousValue: any, params: any, localOpMetadata: IMapMessageLocalMetadata) => {\n            const translatedParams = makeHandlesSerializable(\n                params,\n                this.serializer,\n                this.handle);\n\n            const op: IMapValueTypeOperation = {\n                key,\n                type: \"act\",\n                value: {\n                    opName,\n                    value: translatedParams,\n                },\n            };\n\n            this.submitMessage(op, localOpMetadata);\n\n            const event: IValueChanged = { key, previousValue };\n            this.eventEmitter.emit(\"valueChanged\", event, true, null, this.eventEmitter);\n        };\n\n        return { emit };\n    }\n}\n"]}

package/dist/defaultMapInterfaces.d.ts

@@ -20,6 +20,7 @@ export interface IValueChanged {
 }
 /**
  * Value types are given an IValueOpEmitter to emit their ops through the container type that holds them.
+ * @internal
  */
 export interface IValueOpEmitter {
     /**
@@ -27,9 +28,16 @@ export interface IValueOpEmitter {
      * @param opName - Name of the emitted operation
      * @param previousValue - JSONable previous value as defined by the value type
      * @param params - JSONable params for the operation as defined by the value type
-     * @alpha
+     * @param localOpMetadata - JSONable local metadata which should be submitted with the op
+     * @internal
      */
-    emit(opName: string, previousValue: any, params: any): void;
+    emit(opName: string, previousValue: any, params: any, localOpMetadata: IMapMessageLocalMetadata): void;
+}
+/**
+ * @internal
+ */
+export interface IMapMessageLocalMetadata {
+    localSeq: number;
 }
 /**
  * A value factory is used to serialize/deserialize value types to a map
@@ -65,9 +73,22 @@ export interface IValueOperation<T> {
      * @param params - The params on the incoming operation
      * @param local - Whether the operation originated from this client
      * @param message - The operation itself
+     * @param localOpMetadata - any local metadata submitted by `IValueOpEmitter.emit`.
      * @alpha
      */
-    process(value: T, params: any, local: boolean, message: ISequencedDocumentMessage | undefined): any;
+    process(value: T, params: any, local: boolean, message: ISequencedDocumentMessage | undefined, localOpMetadata: IMapMessageLocalMetadata | undefined): any;
+    /**
+     * Rebases an `op` on `value` from its original perspective (ref/local seq) to the current
+     * perspective. Should be invoked on reconnection.
+     * @param value - The current value stored at the given key, which should be the value type.
+     * @param op - The op to be rebased.
+     * @param localOpMetadata - Any local metadata that was originally submitted with the op.
+     * @returns A rebased version of the op and any local metadata that should be submitted with it.
+     */
+    rebase(value: T, op: IValueTypeOperationValue, localOpMetadata: IMapMessageLocalMetadata): {
+        rebasedOp: IValueTypeOperationValue;
+        rebasedLocalOpMetadata: IMapMessageLocalMetadata;
+    };
 }
 /**
  * Defines a value type that can be registered on a container type.

package/dist/defaultMapInterfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultMapInterfaces.d.ts","sourceRoot":"","sources":["../src/defaultMapInterfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAC9B;;;;;;;OAOG;IACH,OAAO,CACH,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,GAAG,EACX,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,GAAG,SAAS,OAChD;CACL;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IACzB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1B;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAChE,CAAC,KAAK,EAAE,cAAc,GAAG,QAAQ,EAAE,QAAQ,EAAE,CACzC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC/C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd"}
+{"version":3,"file":"defaultMapInterfaces.d.ts","sourceRoot":"","sources":["../src/defaultMapInterfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC1G;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAC9B;;;;;;;;OAQG;IACH,OAAO,CACH,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,GAAG,EACX,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,GAAG,SAAS,EAC9C,eAAe,EAAE,wBAAwB,GAAG,SAAS,OACvD;IAEF;;;;;;;OAOG;IACH,MAAM,CACF,KAAK,EAAE,CAAC,EACR,EAAE,EAAE,wBAAwB,EAC5B,eAAe,EAAE,wBAAwB,GAC1C;QAAE,SAAS,EAAE,wBAAwB,CAAC;QAAC,sBAAsB,EAAE,wBAAwB,CAAC;KAAE,CAAC;CACjG;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IACzB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1B;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAChE,CAAC,KAAK,EAAE,cAAc,GAAG,QAAQ,EAAE,QAAQ,EAAE,CACzC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC/C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd"}

package/dist/defaultMapInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultMapInterfaces.js","sourceRoot":"","sources":["../src/defaultMapInterfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Value types are given an IValueOpEmitter to emit their ops through the container type that holds them.\n */\nexport interface IValueOpEmitter {\n    /**\n     * Called by the value type to emit a value type operation through the container type holding it.\n     * @param opName - Name of the emitted operation\n     * @param previousValue - JSONable previous value as defined by the value type\n     * @param params - JSONable params for the operation as defined by the value type\n     * @alpha\n     */\n    emit(opName: string, previousValue: any, params: any): void;\n}\n\n/**\n * A value factory is used to serialize/deserialize value types to a map\n * @alpha\n */\nexport interface IValueFactory<T> {\n    /**\n     * Create a new value type.  Used both in creation of new value types, as well as in loading existing ones\n     * from remote.\n     * @param emitter - Emitter object that the created value type will use to emit operations\n     * @param raw - Initialization parameters as defined by the value type\n     * @returns The new value type\n     * @alpha\n     */\n    load(emitter: IValueOpEmitter, raw: any): T;\n\n    /**\n     * Given a value type, provides a JSONable form of its data to be used for snapshotting.  This data must be\n     * loadable using the load method of its factory.\n     * @param value - The value type to serialize\n     * @returns The JSONable form of the value type\n     * @alpha\n     */\n    store(value: T): any;\n}\n\n/**\n * Defines an operation that a value type is able to handle.\n * @alpha\n */\nexport interface IValueOperation<T> {\n    /**\n     * Performs the actual processing on the incoming operation.\n     * @param value - The current value stored at the given key, which should be the value type\n     * @param params - The params on the incoming operation\n     * @param local - Whether the operation originated from this client\n     * @param message - The operation itself\n     * @alpha\n     */\n    process(\n        value: T,\n        params: any,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined\n    );\n}\n\n/**\n * Defines a value type that can be registered on a container type.\n */\nexport interface IValueType<T> {\n    /**\n     * Name of the value type.\n     * @alpha\n     */\n    name: string;\n\n    /**\n     * Factory method used to convert to/from a JSON form of the type.\n     * @alpha\n     */\n    factory: IValueFactory<T>;\n\n    /**\n     * Operations that can be applied to the value type.\n     * @alpha\n     */\n    ops: Map<string, IValueOperation<T>>;\n}\n\nexport interface ISharedDefaultMapEvents extends ISharedObjectEvents {\n    (event: \"valueChanged\" | \"create\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * ISerializableValue.type to understand whether they're storing a Plain JS object, a SharedObject, or a value type.\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead). An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n *\n * The DefaultMap impelmentation for sequence has been specialized to only support a single ValueType, which serializes\n * and deserializes via .store() and .load().\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     */\n    value: string | undefined;\n}\n\n/**\n * ValueTypes handle ops slightly differently from SharedObjects or plain JS objects.  Since the Map/Directory doesn't\n * know how to handle the ValueType's ops, those ops are instead passed along to the ValueType for processing.\n * IValueTypeOperationValue is that passed-along op.  The opName on it is the ValueType-specific operation and the\n * value is whatever params the ValueType needs to complete that operation.  Similar to ISerializableValue, it is\n * serializable via JSON.stringify/parse but differs in that it has no equivalency with an in-memory value - rather\n * it just describes an operation to be applied to an already-in-memory value.\n * @alpha\n */\nexport interface IValueTypeOperationValue {\n    /**\n     * The name of the operation.\n     */\n    opName: string;\n\n    /**\n     * The payload that is submitted along with the operation.\n     */\n    value: any;\n}\n"]}
+{"version":3,"file":"defaultMapInterfaces.js","sourceRoot":"","sources":["../src/defaultMapInterfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Value types are given an IValueOpEmitter to emit their ops through the container type that holds them.\n * @internal\n */\nexport interface IValueOpEmitter {\n    /**\n     * Called by the value type to emit a value type operation through the container type holding it.\n     * @param opName - Name of the emitted operation\n     * @param previousValue - JSONable previous value as defined by the value type\n     * @param params - JSONable params for the operation as defined by the value type\n     * @param localOpMetadata - JSONable local metadata which should be submitted with the op\n     * @internal\n     */\n    emit(opName: string, previousValue: any, params: any, localOpMetadata: IMapMessageLocalMetadata): void;\n}\n\n/**\n * @internal\n */\nexport interface IMapMessageLocalMetadata {\n    localSeq: number;\n}\n\n/**\n * A value factory is used to serialize/deserialize value types to a map\n * @alpha\n */\nexport interface IValueFactory<T> {\n    /**\n     * Create a new value type.  Used both in creation of new value types, as well as in loading existing ones\n     * from remote.\n     * @param emitter - Emitter object that the created value type will use to emit operations\n     * @param raw - Initialization parameters as defined by the value type\n     * @returns The new value type\n     * @alpha\n     */\n    load(emitter: IValueOpEmitter, raw: any): T;\n\n    /**\n     * Given a value type, provides a JSONable form of its data to be used for snapshotting.  This data must be\n     * loadable using the load method of its factory.\n     * @param value - The value type to serialize\n     * @returns The JSONable form of the value type\n     * @alpha\n     */\n    store(value: T): any;\n}\n\n/**\n * Defines an operation that a value type is able to handle.\n * @alpha\n */\nexport interface IValueOperation<T> {\n    /**\n     * Performs the actual processing on the incoming operation.\n     * @param value - The current value stored at the given key, which should be the value type\n     * @param params - The params on the incoming operation\n     * @param local - Whether the operation originated from this client\n     * @param message - The operation itself\n     * @param localOpMetadata - any local metadata submitted by `IValueOpEmitter.emit`.\n     * @alpha\n     */\n    process(\n        value: T,\n        params: any,\n        local: boolean,\n        message: ISequencedDocumentMessage | undefined,\n        localOpMetadata: IMapMessageLocalMetadata | undefined\n    );\n\n    /**\n     * Rebases an `op` on `value` from its original perspective (ref/local seq) to the current\n     * perspective. Should be invoked on reconnection.\n     * @param value - The current value stored at the given key, which should be the value type.\n     * @param op - The op to be rebased.\n     * @param localOpMetadata - Any local metadata that was originally submitted with the op.\n     * @returns A rebased version of the op and any local metadata that should be submitted with it.\n     */\n    rebase(\n        value: T,\n        op: IValueTypeOperationValue,\n        localOpMetadata: IMapMessageLocalMetadata\n    ): { rebasedOp: IValueTypeOperationValue; rebasedLocalOpMetadata: IMapMessageLocalMetadata; };\n}\n\n/**\n * Defines a value type that can be registered on a container type.\n */\nexport interface IValueType<T> {\n    /**\n     * Name of the value type.\n     * @alpha\n     */\n    name: string;\n\n    /**\n     * Factory method used to convert to/from a JSON form of the type.\n     * @alpha\n     */\n    factory: IValueFactory<T>;\n\n    /**\n     * Operations that can be applied to the value type.\n     * @alpha\n     */\n    ops: Map<string, IValueOperation<T>>;\n}\n\nexport interface ISharedDefaultMapEvents extends ISharedObjectEvents {\n    (event: \"valueChanged\" | \"create\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * ISerializableValue.type to understand whether they're storing a Plain JS object, a SharedObject, or a value type.\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead). An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n *\n * The DefaultMap impelmentation for sequence has been specialized to only support a single ValueType, which serializes\n * and deserializes via .store() and .load().\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     */\n    value: string | undefined;\n}\n\n/**\n * ValueTypes handle ops slightly differently from SharedObjects or plain JS objects.  Since the Map/Directory doesn't\n * know how to handle the ValueType's ops, those ops are instead passed along to the ValueType for processing.\n * IValueTypeOperationValue is that passed-along op.  The opName on it is the ValueType-specific operation and the\n * value is whatever params the ValueType needs to complete that operation.  Similar to ISerializableValue, it is\n * serializable via JSON.stringify/parse but differs in that it has no equivalency with an in-memory value - rather\n * it just describes an operation to be applied to an already-in-memory value.\n * @alpha\n */\nexport interface IValueTypeOperationValue {\n    /**\n     * The name of the operation.\n     */\n    opName: string;\n\n    /**\n     * The payload that is submitted along with the operation.\n     */\n    value: any;\n}\n"]}

package/dist/index.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { DeserializeCallback, IIntervalCollectionEvent, IIntervalHelpers, Interval, IntervalCollection, IntervalCollectionIterator, IntervalType, ISerializableInterval, ISerializedInterval, SequenceInterval, } from "./intervalCollection";
-export { IValueOpEmitter, } from "./defaultMapInterfaces";
+export { DeserializeCallback, IIntervalCollectionEvent, IIntervalHelpers, Interval, IntervalCollection, IntervalCollectionIterator, IntervalType, ISerializableInterval, ISerializedInterval, SequenceInterval, ISerializedIntervalCollectionV2, CompressedSerializedInterval, } from "./intervalCollection";
+export { IMapMessageLocalMetadata, IValueOpEmitter, } from "./defaultMapInterfaces";
 export * from "./sharedString";
 export * from "./sequence";
 export * from "./sequenceFactory";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,GACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,+BAA+B,EAC/B,4BAA4B,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,wBAAwB,EACxB,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH,2DAW8B;AAP1B,8GAAA,QAAQ,OAAA;AACR,wHAAA,kBAAkB,OAAA;AAClB,gIAAA,0BAA0B,OAAA;AAC1B,kHAAA,YAAY,OAAA;AAGZ,sHAAA,gBAAgB,OAAA;AAKpB,iDAA+B;AAC/B,6CAA2B;AAC3B,oDAAkC;AAClC,uDAAqC;AACrC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,6DAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n} from \"./intervalCollection\";\nexport {\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH,2DAa8B;AAT1B,8GAAA,QAAQ,OAAA;AACR,wHAAA,kBAAkB,OAAA;AAClB,gIAAA,0BAA0B,OAAA;AAC1B,kHAAA,YAAY,OAAA;AAGZ,sHAAA,gBAAgB,OAAA;AAQpB,iDAA+B;AAC/B,6CAA2B;AAC3B,oDAAkC;AAClC,uDAAqC;AACrC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,6DAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n    ISerializedIntervalCollectionV2,\n    CompressedSerializedInterval,\n} from \"./intervalCollection\";\nexport {\n    IMapMessageLocalMetadata,\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}