@fluidframework/sequence 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.2.0.0.245554

package/dist/{defaultMap.d.ts → intervalCollectionMap.d.ts}

@@ -6,11 +6,13 @@ import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { ISerializableValue, ISerializedValue, IValueType, ISharedDefaultMapEvents, IMapMessageLocalMetadata, SequenceOptions, IValueTypeOperationValue } from "./defaultMapInterfaces";
+import { ISerializableIntervalCollection, IIntervalCollectionType, ISharedDefaultMapEvents, IMapMessageLocalMetadata, SequenceOptions, IIntervalCollectionTypeOperationValue } from "./intervalCollectionMapInterfaces.js";
+import { type ISerializableInterval } from "./intervals/index.js";
+import { type IntervalCollection } from "./intervalCollection.js";
 /**
- * Describes an operation specific to a value type.
+ * Description of a map delta operation
  */
-export interface IMapValueTypeOperation {
+export interface IMapOperation {
     /**
      * String identifier of the operation type.
      */
@@ -21,23 +23,15 @@ export interface IMapValueTypeOperation {
     key: string;
     /**
      * Value of the operation, specific to the value type.
-     * @alpha
      */
-    value: IValueTypeOperationValue;
+    value: IIntervalCollectionTypeOperationValue;
 }
-/**
- * Description of a map delta operation
- */
-export type IMapOperation = IMapValueTypeOperation;
 /**
  * Defines the in-memory object structure to be used for the conversion to/from serialized.
  * Directly used in JSON.stringify, direct result from JSON.parse
  */
 export interface IMapDataObjectSerializable {
-    [key: string]: ISerializableValue;
-}
-export interface IMapDataObjectSerialized {
-    [key: string]: ISerializedValue;
+    [key: string]: ISerializableIntervalCollection;
 }
 /**
  * A DefaultMap is a map-like distributed data structure, supporting operations on values stored by
@@ -46,7 +40,7 @@ export interface IMapDataObjectSerialized {
  * Creation of values is implicit on access (either via `get` or a remote op application referring to
  * a collection that wasn't previously known)
  */
-export declare class DefaultMap<T> {
+export declare class IntervalCollectionMap<T extends ISerializableInterval> {
     private readonly serializer;
     private readonly handle;
     private readonly submitMessage;
@@ -60,7 +54,7 @@ export declare class DefaultMap<T> {
     /**
      * Mapping of op types to message handlers.
      */
-    private readonly messageHandlers;
+    private readonly messageHandler;
     /**
      * The in-memory data the map is storing.
      */
@@ -73,56 +67,29 @@ export declare class DefaultMap<T> {
      * @param type - The value type to create at values of this map
      * @param eventEmitter - The object that will emit map events
      */
-    constructor(serializer: IFluidSerializer, handle: IFluidHandle, submitMessage: (op: IMapValueTypeOperation, localOpMetadata: IMapMessageLocalMetadata) => void, type: IValueType<T>, options?: Partial<SequenceOptions> | undefined, eventEmitter?: TypedEventEmitter<ISharedDefaultMapEvents>);
+    constructor(serializer: IFluidSerializer, handle: IFluidHandle, submitMessage: (op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata) => void, type: IIntervalCollectionType<T>, options?: Partial<SequenceOptions> | undefined, eventEmitter?: TypedEventEmitter<ISharedDefaultMapEvents>);
     /**
      * Get an iterator over the keys in this map.
      * @returns The iterator
      */
     keys(): IterableIterator<string>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    entries(): IterableIterator<[string, any]>;
     /**
      * Get an iterator over the values in this map.
      * @returns The iterator
      */
     values(): IterableIterator<any>;
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    [Symbol.iterator](): IterableIterator<[string, any]>;
-    /**
-     * Executes the given callback on each entry in the map.
-     * @param callbackFn - Callback function
-     */
-    forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void;
     /**
      * {@inheritDoc ISharedMap.get}
      */
-    get(key: string): T;
-    /**
-     * Check if a key exists in the map.
-     * @param key - The key to check
-     * @returns True if the key exists, false otherwise
-     */
-    has(key: string): boolean;
-    /**
-     * Serializes the data stored in the shared map to a JSON string
-     * @param serializer - The serializer to use to serialize handles in its values.
-     * @returns A JSON string containing serialized map data
-     */
-    getSerializedStorage(serializer: IFluidSerializer): IMapDataObjectSerialized;
+    get(key: string): IntervalCollection<T>;
     getSerializableStorage(serializer: IFluidSerializer): IMapDataObjectSerializable;
     serialize(serializer: IFluidSerializer): string;
     /**
      * Populate the kernel with the given map data.
-     * @param data - A JSON string containing serialized map data
+     *
+     * @param serialized - A JSON string containing serialized map data
      */
-    populateFromSerializable(json: IMapDataObjectSerializable): void;
-    populate(json: string): void;
+    populate(serialized: string): void;
     /**
      * Submit the given op if a handler is registered.
      * @param op - The operation to attempt to submit
@@ -131,8 +98,8 @@ export declare class DefaultMap<T> {
      * also sent if we are asked to resubmit the message.
      * @returns True if the operation was submitted, false otherwise.
      */
-    tryResubmitMessage(op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata): boolean;
-    tryGetStashedOpLocalMetadata(op: unknown): IMapMessageLocalMetadata | undefined;
+    tryResubmitMessage(op: unknown, localOpMetadata: IMapMessageLocalMetadata): boolean;
+    tryApplyStashedOp(op: unknown): boolean;
     /**
      * Process the given op if a handler is registered.
      * @param message - The message to process
@@ -141,7 +108,7 @@ export declare class DefaultMap<T> {
      * For messages from a remote client, this will be undefined.
      * @returns True if the operation was processed, false otherwise.
      */
-    tryProcessMessage(op: IMapOperation, local: boolean, message: ISequencedDocumentMessage | undefined, localOpMetadata: unknown): boolean;
+    tryProcessMessage(op: unknown, local: boolean, message: ISequencedDocumentMessage, localOpMetadata: unknown): boolean;
     /**
      * Initializes a default ValueType at the provided key.
      * Should be used when a map operation incurs creation.
@@ -160,17 +127,11 @@ export declare class DefaultMap<T> {
      * @returns The local value that was produced
      */
     private makeLocal;
-    /**
-     * Get the message handlers for the map.
-     * @returns A map of string op names to IMapMessageHandlers for those ops
-     */
-    private getMessageHandlers;
     /**
      * Create an emitter for a value type to emit ops from the given key.
-     * @alpha
      * @param key - The key of the map that the value type will be stored on
      * @returns A value op emitter for the given key
      */
     private makeMapValueOpEmitter;
 }
-//# sourceMappingURL=defaultMap.d.ts.map
+//# sourceMappingURL=intervalCollectionMap.d.ts.map

package/dist/intervalCollectionMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intervalCollectionMap.d.ts","sourceRoot":"","sources":["../src/intervalCollectionMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAa,MAAM,oCAAoC,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE,OAAO,EACN,+BAA+B,EAI/B,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EACf,qCAAqC,EACrC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAGN,KAAK,qBAAqB,EAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAIN,KAAK,kBAAkB,EACvB,MAAM,yBAAyB,CAAC;AAMjC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,qCAAqC,CAAC;CAC7C;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAC1C,CAAC,GAAG,EAAE,MAAM,GAAG,+BAA+B,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,qBAAa,qBAAqB,CAAC,CAAC,SAAS,qBAAqB;IAyDhE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAI9B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;aACT,YAAY;IAhE7B;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CA8B7B;IAEF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA0D;IAE/E;;;;;;;OAOG;gBAEe,UAAU,EAAE,gBAAgB,EAC5B,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,CAC/B,EAAE,EAAE,aAAa,EACjB,eAAe,EAAE,wBAAwB,KACrC,IAAI,EACQ,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,EAChC,OAAO,CAAC,sCAA0B,EACnC,YAAY,6CAAmD;IAGhF;;;OAGG;IACI,IAAI,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAetC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IAMvC,sBAAsB,CAAC,UAAU,EAAE,gBAAgB,GAAG,0BAA0B;IAQhF,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,MAAM;IAItD;;;;OAIG;IACI,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IA4BzC;;;;;;;OAOG;IACI,kBAAkB,CAAC,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,wBAAwB,GAAG,OAAO;IAQnF,iBAAiB,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO;IAsC9C;;;;;;;OAOG;IACI,iBAAiB,CACvB,EAAE,EAAE,OAAO,EACX,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,yBAAyB,EAClC,eAAe,EAAE,OAAO,GACtB,OAAO;IAaV;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAYlB;;;;;;;;;OASG;IACH,OAAO,CAAC,SAAS;IAkBjB;;;;OAIG;IAEH,OAAO,CAAC,qBAAqB;CAyB7B"}

package/dist/{defaultMap.js → intervalCollectionMap.js}

@@ -4,11 +4,12 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultMap = void 0;
+exports.IntervalCollectionMap = void 0;
 const shared_object_base_1 = require("@fluidframework/shared-object-base");
 const client_utils_1 = require("@fluid-internal/client-utils");
 const core_utils_1 = require("@fluidframework/core-utils");
-const localValues_1 = require("./localValues");
+const IntervalCollectionValues_js_1 = require("./IntervalCollectionValues.js");
+const intervalCollection_js_1 = require("./intervalCollection.js");
 function isMapOperation(op) {
     return typeof op === "object" && op !== null && "type" in op && op.type === "act";
 }
@@ -19,7 +20,7 @@ function isMapOperation(op) {
  * Creation of values is implicit on access (either via `get` or a remote op application referring to
  * a collection that wasn't previously known)
  */
-class DefaultMap {
+class IntervalCollectionMap {
     /**
      * The number of key/value pairs stored in the map.
      */
@@ -44,12 +45,34 @@ class DefaultMap {
         /**
          * Mapping of op types to message handlers.
          */
-        this.messageHandlers = new Map();
+        this.messageHandler = {
+            process: (op, local, message, localOpMetadata) => {
+                const localValue = this.data.get(op.key) ?? this.createCore(op.key, local);
+                const handler = localValue.getOpHandler(op.value.opName);
+                const previousValue = localValue.value;
+                const translatedValue = op.value.value;
+                handler.process(previousValue, translatedValue, local, message, localOpMetadata);
+                const event = { key: op.key, previousValue };
+                this.eventEmitter.emit("valueChanged", event, local, message, this.eventEmitter);
+            },
+            submit: (op, localOpMetadata) => {
+                this.submitMessage(op, localOpMetadata);
+            },
+            resubmit: (op, localOpMetadata) => {
+                const localValue = this.data.get(op.key);
+                (0, core_utils_1.assert)(localValue !== undefined, 0x3f8 /* Local value expected on resubmission */);
+                const handler = localValue.getOpHandler(op.value.opName);
+                const rebased = handler.rebase(localValue.value, op.value, localOpMetadata);
+                if (rebased !== undefined) {
+                    const { rebasedOp, rebasedLocalOpMetadata } = rebased;
+                    this.submitMessage({ ...op, value: rebasedOp }, rebasedLocalOpMetadata);
+                }
+            },
+        };
         /**
          * The in-memory data the map is storing.
          */
         this.data = new Map();
-        this.messageHandlers = this.getMessageHandlers();
     }
     /**
      * Get an iterator over the keys in this map.
@@ -58,25 +81,6 @@ class DefaultMap {
     keys() {
         return this.data.keys();
     }
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    entries() {
-        const localEntriesIterator = this.data.entries();
-        const iterator = {
-            next() {
-                const nextVal = localEntriesIterator.next();
-                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;
-            },
-        };
-        return iterator;
-    }
     /**
      * Get an iterator over the values in this map.
      * @returns The iterator
@@ -96,22 +100,6 @@ class DefaultMap {
         };
         return iterator;
     }
-    /**
-     * Get an iterator over the entries in this map.
-     * @returns The iterator
-     */
-    [Symbol.iterator]() {
-        return this.entries();
-    }
-    /**
-     * Executes the given callback on each entry in the map.
-     * @param callbackFn - Callback function
-     */
-    forEach(callbackFn) {
-        this.data.forEach((localValue, key, m) => {
-            callbackFn(localValue.value, key, m);
-        });
-    }
     /**
      * {@inheritDoc ISharedMap.get}
      */
@@ -119,30 +107,10 @@ class DefaultMap {
         const localValue = this.data.get(key) ?? this.createCore(key, true);
         return localValue.value;
     }
-    /**
-     * Check if a key exists in the map.
-     * @param key - The key to check
-     * @returns True if the key exists, false otherwise
-     */
-    has(key) {
-        return this.data.has(key);
-    }
-    /**
-     * Serializes the data stored in the shared map to a JSON string
-     * @param serializer - The serializer to use to serialize handles in its values.
-     * @returns A JSON string containing serialized map data
-     */
-    getSerializedStorage(serializer) {
-        const serializableMapData = {};
-        this.data.forEach((localValue, key) => {
-            serializableMapData[key] = localValue.makeSerialized(serializer, this.handle);
-        });
-        return serializableMapData;
-    }
     getSerializableStorage(serializer) {
         const serializableMapData = {};
         this.data.forEach((localValue, key) => {
-            serializableMapData[key] = (0, localValues_1.makeSerializable)(localValue, serializer, this.handle);
+            serializableMapData[key] = (0, IntervalCollectionValues_js_1.makeSerializable)(localValue, serializer, this.handle);
         });
         return serializableMapData;
     }
@@ -151,10 +119,12 @@ class DefaultMap {
     }
     /**
      * Populate the kernel with the given map data.
-     * @param data - A JSON string containing serialized map data
+     *
+     * @param serialized - A JSON string containing serialized map data
      */
-    populateFromSerializable(json) {
-        for (const [key, serializable] of Object.entries(json)) {
+    populate(serialized) {
+        const parsed = this.serializer.parse(serialized);
+        for (const [key, serializable] of Object.entries(parsed)) {
             // Back-compat: legacy documents may have handles to an intervalCollection map kernel.
             // These collections should be empty, and ValueTypes are no longer supported.
             if (serializable.type === shared_object_base_1.ValueType[shared_object_base_1.ValueType.Plain] ||
@@ -173,9 +143,6 @@ class DefaultMap {
             this.data.set(localValue.key, localValue.value);
         }
     }
-    populate(json) {
-        this.populateFromSerializable(JSON.parse(json));
-    }
     /**
      * Submit the given op if a handler is registered.
      * @param op - The operation to attempt to submit
@@ -185,20 +152,47 @@ class DefaultMap {
      * @returns True if the operation was submitted, false otherwise.
      */
     tryResubmitMessage(op, localOpMetadata) {
-        const type = op.type;
-        const handler = this.messageHandlers.get(type);
-        if (handler !== undefined) {
-            handler.resubmit(op, localOpMetadata);
+        if (isMapOperation(op)) {
+            this.messageHandler.resubmit(op, localOpMetadata);
             return true;
         }
         return false;
     }
-    tryGetStashedOpLocalMetadata(op) {
-        if (isMapOperation(op) && this.messageHandlers.has(op.type)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return this.messageHandlers.get(op.type).getStashedOpLocalMetadata(op);
+    tryApplyStashedOp(op) {
+        if (isMapOperation(op)) {
+            const { value, key } = op;
+            const map = this.get(key);
+            switch (value.opName) {
+                case "add": {
+                    map.add({
+                        // Todo: we should improve typing so we know add ops always have start and end
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                        start: (0, intervalCollection_js_1.toSequencePlace)(value.value.start, value.value.startSide),
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                        end: (0, intervalCollection_js_1.toSequencePlace)(value.value.end, value.value.endSide),
+                        props: value.value.properties,
+                    });
+                    return true;
+                }
+                case "change": {
+                    const { [intervalCollection_js_1.reservedIntervalIdKey]: id, ...props } = value.value.properties ?? {};
+                    map.change(id, {
+                        start: (0, intervalCollection_js_1.toOptionalSequencePlace)(value.value.start, value.value.startSide),
+                        end: (0, intervalCollection_js_1.toOptionalSequencePlace)(value.value.end, value.value.endSide),
+                        props,
+                    });
+                    return true;
+                }
+                case "delete": {
+                    const { [intervalCollection_js_1.reservedIntervalIdKey]: id } = value.value.properties ?? {};
+                    map.removeIntervalById(id);
+                    return true;
+                }
+                default:
+                    throw new Error("unknown ops should not be stashed");
+            }
         }
-        return undefined;
+        return false;
     }
     /**
      * Process the given op if a handler is registered.
@@ -209,9 +203,8 @@ class DefaultMap {
      * @returns True if the operation was processed, false otherwise.
      */
     tryProcessMessage(op, local, message, localOpMetadata) {
-        const handler = this.messageHandlers.get(op.type);
-        if (handler !== undefined) {
-            handler.process(op, local, message, localOpMetadata);
+        if (isMapOperation(op)) {
+            this.messageHandler.process(op, local, message, localOpMetadata);
             return true;
         }
         return false;
@@ -223,7 +216,7 @@ class DefaultMap {
      * @param local - Whether the message originated from the local client
      */
     createCore(key, local) {
-        const localValue = new localValues_1.ValueTypeLocalValue(this.type.factory.load(this.makeMapValueOpEmitter(key), undefined, this.options), this.type);
+        const localValue = new IntervalCollectionValues_js_1.IntervalCollectionTypeLocalValue(this.type.factory.load(this.makeMapValueOpEmitter(key), undefined, this.options), this.type);
         const previousValue = this.data.get(key);
         this.data.set(key, localValue);
         const event = { key, previousValue };
@@ -243,55 +236,11 @@ class DefaultMap {
     makeLocal(key, serializable) {
         (0, core_utils_1.assert)(serializable.type !== shared_object_base_1.ValueType[shared_object_base_1.ValueType.Plain] &&
             serializable.type !== shared_object_base_1.ValueType[shared_object_base_1.ValueType.Shared], 0x2e1 /* "Support for plain value types removed." */);
-        serializable.value = (0, shared_object_base_1.parseHandles)(serializable.value, this.serializer);
         const localValue = this.type.factory.load(this.makeMapValueOpEmitter(key), serializable.value, this.options);
-        return new localValues_1.ValueTypeLocalValue(localValue, this.type);
-    }
-    /**
-     * Get the message handlers for the map.
-     * @returns A map of string op names to IMapMessageHandlers for those ops
-     */
-    getMessageHandlers() {
-        const messageHandlers = new Map();
-        // Ops with type "act" describe actions taken by custom value type handlers of whatever item is
-        // being addressed.  These custom handlers can be retrieved from the ValueTypeLocalValue which has
-        // stashed its valueType (and therefore its handlers).  We also emit a valueChanged for anyone
-        // watching for manipulations of that item.
-        messageHandlers.set("act", {
-            process: (op, local, message, localOpMetadata) => {
-                const localValue = this.data.get(op.key) ?? this.createCore(op.key, local);
-                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, localOpMetadata);
-                const event = { key: op.key, previousValue };
-                this.eventEmitter.emit("valueChanged", event, local, message, this.eventEmitter);
-            },
-            submit: (op, localOpMetadata) => {
-                this.submitMessage(op, localOpMetadata);
-            },
-            resubmit: (op, localOpMetadata) => {
-                const localValue = this.data.get(op.key);
-                (0, core_utils_1.assert)(localValue !== undefined, 0x3f8 /* Local value expected on resubmission */);
-                const handler = localValue.getOpHandler(op.value.opName);
-                const rebased = handler.rebase(localValue.value, op.value, localOpMetadata);
-                if (rebased !== undefined) {
-                    const { rebasedOp, rebasedLocalOpMetadata } = rebased;
-                    this.submitMessage({ ...op, value: rebasedOp }, rebasedLocalOpMetadata);
-                }
-            },
-            getStashedOpLocalMetadata: (op) => {
-                const localValue = this.data.get(op.key) ?? this.createCore(op.key, true);
-                (0, core_utils_1.assert)(localValue !== undefined, 0x879 /* Local value expected on applying stashed op */);
-                const handler = localValue.getOpHandler(op.value.opName);
-                return handler.applyStashedOp(localValue.value, op.value);
-            },
-        });
-        return messageHandlers;
+        return new IntervalCollectionValues_js_1.IntervalCollectionTypeLocalValue(localValue, this.type);
     }
     /**
      * Create an emitter for a value type to emit ops from the given key.
-     * @alpha
      * @param key - The key of the map that the value type will be stored on
      * @returns A value op emitter for the given key
      */
@@ -299,13 +248,12 @@ class DefaultMap {
     makeMapValueOpEmitter(key) {
         // eslint-disable-next-line import/no-deprecated
         const emit = (opName, previousValue, params, localOpMetadata) => {
-            const translatedParams = (0, shared_object_base_1.makeHandlesSerializable)(params, this.serializer, this.handle);
             const op = {
                 key,
                 type: "act",
                 value: {
                     opName,
-                    value: translatedParams,
+                    value: params,
                 },
             };
             this.submitMessage(op, localOpMetadata);
@@ -315,5 +263,5 @@ class DefaultMap {
         return { emit };
     }
 }
-exports.DefaultMap = DefaultMap;
-//# sourceMappingURL=defaultMap.js.map
+exports.IntervalCollectionMap = IntervalCollectionMap;
+//# sourceMappingURL=intervalCollectionMap.js.map

package/dist/intervalCollectionMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intervalCollectionMap.js","sourceRoot":"","sources":["../src/intervalCollectionMap.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,2EAAiF;AACjF,+DAAiE;AACjE,2DAAoD;AACpD,+EAAmG;AAiBnG,mEAKiC;AAEjC,SAAS,cAAc,CAAC,EAAW;IAClC,OAAO,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,IAAI,IAAI,MAAM,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC;AACnF,CAAC;AA6BD;;;;;;GAMG;AACH,MAAa,qBAAqB;IACjC;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACvB,CAAC;IA0CD;;;;;;;OAOG;IACH,YACkB,UAA4B,EAC5B,MAAoB,EACpB,aAGR,EACQ,IAAgC,EAChC,OAAkC,EACnC,eAAe,IAAI,gCAAiB,EAA2B;QAR9D,eAAU,GAAV,UAAU,CAAkB;QAC5B,WAAM,GAAN,MAAM,CAAc;QACpB,kBAAa,GAAb,aAAa,CAGrB;QACQ,SAAI,GAAJ,IAAI,CAA4B;QAChC,YAAO,GAAP,OAAO,CAA2B;QACnC,iBAAY,GAAZ,YAAY,CAAmD;QAzDhF;;WAEG;QACc,mBAAc,GAAG;YACjC,OAAO,EAAE,CACR,EAAiB,EACjB,KAAc,EACd,OAAkC,EAClC,eAAyC,EACxC,EAAE;gBACH,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,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,EAAE,CAAC,KAAK,CAAC,KAAY,CAAC;gBAC9C,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;YAClF,CAAC;YACD,MAAM,EAAE,CAAC,EAAiB,EAAE,eAAyC,EAAE,EAAE;gBACxE,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;YACzC,CAAC;YACD,QAAQ,EAAE,CAAC,EAAiB,EAAE,eAAyC,EAAE,EAAE;gBAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAEzC,IAAA,mBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAEnF,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;gBAC5E,IAAI,OAAO,KAAK,SAAS,EAAE;oBAC1B,MAAM,EAAE,SAAS,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC;oBACtD,IAAI,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,sBAAsB,CAAC,CAAC;iBACxE;YACF,CAAC;SACD,CAAC;QAEF;;WAEG;QACc,SAAI,GAAG,IAAI,GAAG,EAA+C,CAAC;IAoB5E,CAAC;IAEJ;;;OAGG;IACI,IAAI;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,MAAM;QACZ,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YAChB,IAAI;gBACH,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC;gBAC3C,OAAO,OAAO,CAAC,IAAI;oBAClB,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;YAC3E,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAChB,OAAO,IAAI,CAAC;YACb,CAAC;SACD,CAAC;QACF,OAAO,QAAQ,CAAC;IACjB,CAAC;IACD;;OAEG;IACI,GAAG,CAAC,GAAW;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEpE,OAAO,UAAU,CAAC,KAAK,CAAC;IACzB,CAAC;IAEM,sBAAsB,CAAC,UAA4B;QACzD,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YACrC,mBAAmB,CAAC,GAAG,CAAC,GAAG,IAAA,8CAAgB,EAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAEM,SAAS,CAAC,UAA4B;QAC5C,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,UAAkB;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAA+B,CAAC;QAE/E,KAAK,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzD,sFAAsF;YACtF,6EAA6E;YAC7E,IACC,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC;gBAChD,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EAChD;gBACD,SAAS;aACT;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;gBAClB,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,CAAC;aACxC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;SAChD;IACF,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,EAAW,EAAE,eAAyC;QAC/E,IAAI,cAAc,CAAC,EAAE,CAAC,EAAE;YACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAC,EAAW;QACnC,IAAI,cAAc,CAAC,EAAE,CAAC,EAAE;YACvB,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE1B,QAAQ,KAAK,CAAC,MAAM,EAAE;gBACrB,KAAK,KAAK,CAAC,CAAC;oBACX,GAAG,CAAC,GAAG,CAAC;wBACP,8EAA8E;wBAC9E,oEAAoE;wBACpE,KAAK,EAAE,IAAA,uCAAe,EAAC,KAAK,CAAC,KAAK,CAAC,KAAM,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;wBACjE,oEAAoE;wBACpE,GAAG,EAAE,IAAA,uCAAe,EAAC,KAAK,CAAC,KAAK,CAAC,GAAI,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;wBAC3D,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU;qBAC7B,CAAC,CAAC;oBACH,OAAO,IAAI,CAAC;iBACZ;gBACD,KAAK,QAAQ,CAAC,CAAC;oBACd,MAAM,EAAE,CAAC,6CAAqB,CAAC,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;oBAC/E,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE;wBACd,KAAK,EAAE,IAAA,+CAAuB,EAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;wBACxE,GAAG,EAAE,IAAA,+CAAuB,EAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;wBAClE,KAAK;qBACL,CAAC,CAAC;oBACH,OAAO,IAAI,CAAC;iBACZ;gBACD,KAAK,QAAQ,CAAC,CAAC;oBACd,MAAM,EAAE,CAAC,6CAAqB,CAAC,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;oBACrE,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;oBAC3B,OAAO,IAAI,CAAC;iBACZ;gBACD;oBACC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACtD;SACD;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CACvB,EAAW,EACX,KAAc,EACd,OAAkC,EAClC,eAAwB;QAExB,IAAI,cAAc,CAAC,EAAE,CAAC,EAAE;YACvB,IAAI,CAAC,cAAc,CAAC,OAAO,CAC1B,EAAE,EACF,KAAK,EACL,OAAO,EACP,eAA2C,CAC3C,CAAC;YACF,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,GAAW,EAAE,KAAc;QAC7C,MAAM,UAAU,GAAG,IAAI,8DAAgC,CACtD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,EAChF,IAAI,CAAC,IAAI,CACT,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;IACnB,CAAC;IAED;;;;;;;;;OASG;IACK,SAAS,CAChB,GAAW,EACX,YAA6C;QAE7C,IAAA,mBAAM,EACL,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,KAAK,CAAC;YAC/C,YAAY,CAAC,IAAI,KAAK,8BAAS,CAAC,8BAAS,CAAC,MAAM,CAAC,EAClD,KAAK,CAAC,8CAA8C,CACpD,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CACxC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAC/B,YAAY,CAAC,KAAK,EAClB,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,OAAO,IAAI,8DAAgC,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,gDAAgD;IACxC,qBAAqB,CAAC,GAAW;QACxC,gDAAgD;QAChD,MAAM,IAAI,GAA4B,CACrC,MAA2B,EAC3B,aAAsB,EACtB,MAA+B,EAC/B,eAAyC,EAClC,EAAE;YACT,MAAM,EAAE,GAAkB;gBACzB,GAAG;gBACH,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACN,MAAM;oBACN,KAAK,EAAE,MAAM;iBACb;aACD,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;QAC9E,CAAC,CAAC;QAEF,OAAO,EAAE,IAAI,EAAE,CAAC;IACjB,CAAC;CACD;AAlTD,sDAkTC","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 { IFluidSerializer, ValueType } from \"@fluidframework/shared-object-base\";\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { makeSerializable, IntervalCollectionTypeLocalValue } from \"./IntervalCollectionValues.js\";\nimport {\n\tISerializableIntervalCollection,\n\tIValueChanged,\n\t// eslint-disable-next-line import/no-deprecated\n\tIValueOpEmitter,\n\tIIntervalCollectionType,\n\tISharedDefaultMapEvents,\n\tIMapMessageLocalMetadata,\n\tSequenceOptions,\n\tIIntervalCollectionTypeOperationValue,\n} from \"./intervalCollectionMapInterfaces.js\";\nimport {\n\tSerializedIntervalDelta,\n\tIntervalDeltaOpType,\n\ttype ISerializableInterval,\n} from \"./intervals/index.js\";\nimport {\n\ttoSequencePlace,\n\ttoOptionalSequencePlace,\n\treservedIntervalIdKey,\n\ttype IntervalCollection,\n} from \"./intervalCollection.js\";\n\nfunction isMapOperation(op: unknown): op is IMapOperation {\n\treturn typeof op === \"object\" && op !== null && \"type\" in op && op.type === \"act\";\n}\n\n/**\n * Description of a map delta operation\n */\nexport interface IMapOperation {\n\t/**\n\t * String identifier of the operation type.\n\t */\n\ttype: \"act\";\n\n\t/**\n\t * Map key being modified.\n\t */\n\tkey: string;\n\n\t/**\n\t * Value of the operation, specific to the value type.\n\t */\n\tvalue: IIntervalCollectionTypeOperationValue;\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\t[key: string]: ISerializableIntervalCollection;\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 IntervalCollectionMap<T extends ISerializableInterval> {\n\t/**\n\t * The number of key/value pairs stored in the map.\n\t */\n\tpublic get size(): number {\n\t\treturn this.data.size;\n\t}\n\n\t/**\n\t * Mapping of op types to message handlers.\n\t */\n\tprivate readonly messageHandler = {\n\t\tprocess: (\n\t\t\top: IMapOperation,\n\t\t\tlocal: boolean,\n\t\t\tmessage: ISequencedDocumentMessage,\n\t\t\tlocalOpMetadata: IMapMessageLocalMetadata,\n\t\t) => {\n\t\t\tconst localValue = this.data.get(op.key) ?? this.createCore(op.key, local);\n\t\t\tconst handler = localValue.getOpHandler(op.value.opName);\n\t\t\tconst previousValue = localValue.value;\n\t\t\tconst translatedValue = op.value.value as any;\n\t\t\thandler.process(previousValue, translatedValue, local, message, localOpMetadata);\n\t\t\tconst event: IValueChanged = { key: op.key, previousValue };\n\t\t\tthis.eventEmitter.emit(\"valueChanged\", event, local, message, this.eventEmitter);\n\t\t},\n\t\tsubmit: (op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata) => {\n\t\t\tthis.submitMessage(op, localOpMetadata);\n\t\t},\n\t\tresubmit: (op: IMapOperation, localOpMetadata: IMapMessageLocalMetadata) => {\n\t\t\tconst localValue = this.data.get(op.key);\n\n\t\t\tassert(localValue !== undefined, 0x3f8 /* Local value expected on resubmission */);\n\n\t\t\tconst handler = localValue.getOpHandler(op.value.opName);\n\t\t\tconst rebased = handler.rebase(localValue.value, op.value, localOpMetadata);\n\t\t\tif (rebased !== undefined) {\n\t\t\t\tconst { rebasedOp, rebasedLocalOpMetadata } = rebased;\n\t\t\t\tthis.submitMessage({ ...op, value: rebasedOp }, rebasedLocalOpMetadata);\n\t\t\t}\n\t\t},\n\t};\n\n\t/**\n\t * The in-memory data the map is storing.\n\t */\n\tprivate readonly data = new Map<string, IntervalCollectionTypeLocalValue<T>>();\n\n\t/**\n\t * Create a new default map.\n\t * @param serializer - The serializer to serialize / parse handles\n\t * @param handle - The handle of the shared object using the kernel\n\t * @param submitMessage - A callback to submit a message through the shared object\n\t * @param type - The value type to create at values of this map\n\t * @param eventEmitter - The object that will emit map events\n\t */\n\tconstructor(\n\t\tprivate readonly serializer: IFluidSerializer,\n\t\tprivate readonly handle: IFluidHandle,\n\t\tprivate readonly submitMessage: (\n\t\t\top: IMapOperation,\n\t\t\tlocalOpMetadata: IMapMessageLocalMetadata,\n\t\t) => void,\n\t\tprivate readonly type: IIntervalCollectionType<T>,\n\t\tprivate readonly options?: Partial<SequenceOptions>,\n\t\tpublic readonly eventEmitter = new TypedEventEmitter<ISharedDefaultMapEvents>(),\n\t) {}\n\n\t/**\n\t * Get an iterator over the keys in this map.\n\t * @returns The iterator\n\t */\n\tpublic keys(): IterableIterator<string> {\n\t\treturn this.data.keys();\n\t}\n\n\t/**\n\t * Get an iterator over the values in this map.\n\t * @returns The iterator\n\t */\n\tpublic values(): IterableIterator<any> {\n\t\tconst localValuesIterator = this.data.values();\n\t\tconst iterator = {\n\t\t\tnext(): IteratorResult<any> {\n\t\t\t\tconst nextVal = localValuesIterator.next();\n\t\t\t\treturn nextVal.done\n\t\t\t\t\t? { value: undefined, done: true }\n\t\t\t\t\t: { value: nextVal.value.value, done: false }; // Unpack the stored value\n\t\t\t},\n\t\t\t[Symbol.iterator]() {\n\t\t\t\treturn this;\n\t\t\t},\n\t\t};\n\t\treturn iterator;\n\t}\n\t/**\n\t * {@inheritDoc ISharedMap.get}\n\t */\n\tpublic get(key: string): IntervalCollection<T> {\n\t\tconst localValue = this.data.get(key) ?? this.createCore(key, true);\n\n\t\treturn localValue.value;\n\t}\n\n\tpublic getSerializableStorage(serializer: IFluidSerializer): IMapDataObjectSerializable {\n\t\tconst serializableMapData: IMapDataObjectSerializable = {};\n\t\tthis.data.forEach((localValue, key) => {\n\t\t\tserializableMapData[key] = makeSerializable(localValue, serializer, this.handle);\n\t\t});\n\t\treturn serializableMapData;\n\t}\n\n\tpublic serialize(serializer: IFluidSerializer): string {\n\t\treturn JSON.stringify(this.getSerializableStorage(serializer));\n\t}\n\n\t/**\n\t * Populate the kernel with the given map data.\n\t *\n\t * @param serialized - A JSON string containing serialized map data\n\t */\n\tpublic populate(serialized: string): void {\n\t\tconst parsed = this.serializer.parse(serialized) as IMapDataObjectSerializable;\n\n\t\tfor (const [key, serializable] of Object.entries(parsed)) {\n\t\t\t// Back-compat: legacy documents may have handles to an intervalCollection map kernel.\n\t\t\t// These collections should be empty, and ValueTypes are no longer supported.\n\t\t\tif (\n\t\t\t\tserializable.type === ValueType[ValueType.Plain] ||\n\t\t\t\tserializable.type === ValueType[ValueType.Shared]\n\t\t\t) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\t// Back-compat: Sequence previously arbitrarily prefixed all interval collection keys with\n\t\t\t// \"intervalCollections/\". This would burden users trying to iterate the collection and\n\t\t\t// access its value, as well as those trying to match a create message to its underlying\n\t\t\t// collection. See https://github.com/microsoft/FluidFramework/issues/10557 for more context.\n\t\t\tconst normalizedKey = key.startsWith(\"intervalCollections/\") ? key.substring(20) : key;\n\n\t\t\tconst localValue = {\n\t\t\t\tkey: normalizedKey,\n\t\t\t\tvalue: this.makeLocal(key, serializable),\n\t\t\t};\n\n\t\t\tthis.data.set(localValue.key, localValue.value);\n\t\t}\n\t}\n\n\t/**\n\t * Submit the given op if a handler is registered.\n\t * @param op - The operation to attempt to submit\n\t * @param localOpMetadata - The local metadata associated with the op. This is kept locally by the runtime\n\t * and not sent to the server. This will be sent back when this message is received back from the server. This is\n\t * also sent if we are asked to resubmit the message.\n\t * @returns True if the operation was submitted, false otherwise.\n\t */\n\tpublic tryResubmitMessage(op: unknown, localOpMetadata: IMapMessageLocalMetadata): boolean {\n\t\tif (isMapOperation(op)) {\n\t\t\tthis.messageHandler.resubmit(op, localOpMetadata);\n\t\t\treturn true;\n\t\t}\n\t\treturn false;\n\t}\n\n\tpublic tryApplyStashedOp(op: unknown): boolean {\n\t\tif (isMapOperation(op)) {\n\t\t\tconst { value, key } = op;\n\t\t\tconst map = this.get(key);\n\n\t\t\tswitch (value.opName) {\n\t\t\t\tcase \"add\": {\n\t\t\t\t\tmap.add({\n\t\t\t\t\t\t// Todo: we should improve typing so we know add ops always have start and end\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\t\tstart: toSequencePlace(value.value.start!, value.value.startSide),\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\t\tend: toSequencePlace(value.value.end!, value.value.endSide),\n\t\t\t\t\t\tprops: value.value.properties,\n\t\t\t\t\t});\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tcase \"change\": {\n\t\t\t\t\tconst { [reservedIntervalIdKey]: id, ...props } = value.value.properties ?? {};\n\t\t\t\t\tmap.change(id, {\n\t\t\t\t\t\tstart: toOptionalSequencePlace(value.value.start, value.value.startSide),\n\t\t\t\t\t\tend: toOptionalSequencePlace(value.value.end, value.value.endSide),\n\t\t\t\t\t\tprops,\n\t\t\t\t\t});\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tcase \"delete\": {\n\t\t\t\t\tconst { [reservedIntervalIdKey]: id } = value.value.properties ?? {};\n\t\t\t\t\tmap.removeIntervalById(id);\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(\"unknown ops should not be stashed\");\n\t\t\t}\n\t\t}\n\t\treturn false;\n\t}\n\n\t/**\n\t * Process the given op if a handler is registered.\n\t * @param message - The message to process\n\t * @param local - Whether the message originated from the local client\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t * @returns True if the operation was processed, false otherwise.\n\t */\n\tpublic tryProcessMessage(\n\t\top: unknown,\n\t\tlocal: boolean,\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocalOpMetadata: unknown,\n\t): boolean {\n\t\tif (isMapOperation(op)) {\n\t\t\tthis.messageHandler.process(\n\t\t\t\top,\n\t\t\t\tlocal,\n\t\t\t\tmessage,\n\t\t\t\tlocalOpMetadata as IMapMessageLocalMetadata,\n\t\t\t);\n\t\t\treturn true;\n\t\t}\n\t\treturn false;\n\t}\n\n\t/**\n\t * Initializes a default ValueType at the provided key.\n\t * Should be used when a map operation incurs creation.\n\t * @param key - The key being initialized\n\t * @param local - Whether the message originated from the local client\n\t */\n\tprivate createCore(key: string, local: boolean): IntervalCollectionTypeLocalValue<T> {\n\t\tconst localValue = new IntervalCollectionTypeLocalValue(\n\t\t\tthis.type.factory.load(this.makeMapValueOpEmitter(key), undefined, this.options),\n\t\t\tthis.type,\n\t\t);\n\t\tconst previousValue = this.data.get(key);\n\t\tthis.data.set(key, localValue);\n\t\tconst event: IValueChanged = { key, previousValue };\n\t\tthis.eventEmitter.emit(\"create\", event, local, this.eventEmitter);\n\t\treturn localValue;\n\t}\n\n\t/**\n\t * The remote ISerializableValue we're receiving (either as a result of a load or an incoming set op) will\n\t * have the information we need to create a real object, but will not be the real object yet.  For example,\n\t * 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\t * job is to convert that information into a real object for local usage.\n\t * @param key - The key that the caller intends to store the local value into (used for ops later).  But\n\t * doesn't actually store the local value into that key.  So better not lie!\n\t * @param serializable - The remote information that we can convert into a real object\n\t * @returns The local value that was produced\n\t */\n\tprivate makeLocal(\n\t\tkey: string,\n\t\tserializable: ISerializableIntervalCollection,\n\t): IntervalCollectionTypeLocalValue<T> {\n\t\tassert(\n\t\t\tserializable.type !== ValueType[ValueType.Plain] &&\n\t\t\t\tserializable.type !== ValueType[ValueType.Shared],\n\t\t\t0x2e1 /* \"Support for plain value types removed.\" */,\n\t\t);\n\n\t\tconst localValue = this.type.factory.load(\n\t\t\tthis.makeMapValueOpEmitter(key),\n\t\t\tserializable.value,\n\t\t\tthis.options,\n\t\t);\n\t\treturn new IntervalCollectionTypeLocalValue(localValue, this.type);\n\t}\n\n\t/**\n\t * Create an emitter for a value type to emit ops from the given key.\n\t * @param key - The key of the map that the value type will be stored on\n\t * @returns A value op emitter for the given key\n\t */\n\t// eslint-disable-next-line import/no-deprecated\n\tprivate makeMapValueOpEmitter(key: string): IValueOpEmitter {\n\t\t// eslint-disable-next-line import/no-deprecated\n\t\tconst emit: IValueOpEmitter[\"emit\"] = (\n\t\t\topName: IntervalDeltaOpType,\n\t\t\tpreviousValue: unknown,\n\t\t\tparams: SerializedIntervalDelta,\n\t\t\tlocalOpMetadata: IMapMessageLocalMetadata,\n\t\t): void => {\n\t\t\tconst op: IMapOperation = {\n\t\t\t\tkey,\n\t\t\t\ttype: \"act\",\n\t\t\t\tvalue: {\n\t\t\t\t\topName,\n\t\t\t\t\tvalue: params,\n\t\t\t\t},\n\t\t\t};\n\n\t\t\tthis.submitMessage(op, localOpMetadata);\n\n\t\t\tconst event: IValueChanged = { key, previousValue };\n\t\t\tthis.eventEmitter.emit(\"valueChanged\", event, true, null, this.eventEmitter);\n\t\t};\n\n\t\treturn { emit };\n\t}\n}\n"]}

package/{lib/defaultMapInterfaces.d.mts → dist/intervalCollectionMapInterfaces.d.ts}

@@ -5,7 +5,8 @@
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { ISharedObjectEvents } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
-import { ISerializedInterval, IntervalOpType, SerializedIntervalDelta, IntervalDeltaOpType } from "./intervals/index.mjs";
+import { ISerializedInterval, IntervalOpType, SerializedIntervalDelta, IntervalDeltaOpType, type ISerializableInterval } from "./intervals/index.js";
+import type { IntervalCollection } from "./intervalCollection.js";
 /**
  * Type of "valueChanged" event parameter.
  */
@@ -75,30 +76,28 @@ export interface SequenceOptions {
  * A value factory is used to serialize/deserialize value types to a map
  * @alpha
  */
-export interface IValueFactory<T> {
+export interface IIntervalCollectionFactory<T extends ISerializableInterval> {
     /**
      * Create a new value type.  Used both in creation of new value types, as well as in loading existing ones
      * from remote.
      * @param emitter - Emitter object that the created value type will use to emit operations
      * @param raw - Initialization parameters as defined by the value type
      * @returns The new value type
-     * @alpha
      */
-    load(emitter: IValueOpEmitter, raw: any, options?: Partial<SequenceOptions>): T;
+    load(emitter: IValueOpEmitter, raw: any, options?: Partial<SequenceOptions>): IntervalCollection<T>;
     /**
      * Given a value type, provides a JSONable form of its data to be used for snapshotting.  This data must be
      * loadable using the load method of its factory.
      * @param value - The value type to serialize
      * @returns The JSONable form of the value type
-     * @alpha
      */
-    store(value: T): any;
+    store(value: IntervalCollection<T>): any;
 }
 /**
  * Defines an operation that a value type is able to handle.
  * @alpha
  */
-export interface IValueOperation<T> {
+export interface IIntervalCollectionOperation<T extends ISerializableInterval> {
     /**
      * Performs the actual processing on the incoming operation.
      * @param value - The current value stored at the given key, which should be the value type
@@ -106,9 +105,8 @@ export interface IValueOperation<T> {
      * @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: ISerializedInterval, local: boolean, message: ISequencedDocumentMessage | undefined, localOpMetadata: IMapMessageLocalMetadata | undefined): void;
+    process(value: IntervalCollection<T>, params: ISerializedInterval, local: boolean, message: ISequencedDocumentMessage | undefined, localOpMetadata: IMapMessageLocalMetadata | undefined): void;
     /**
      * Rebases an `op` on `value` from its original perspective (ref/local seq) to the current
      * perspective. Should be invoked on reconnection.
@@ -117,31 +115,27 @@ export interface IValueOperation<T> {
      * @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;
+    rebase(value: IntervalCollection<T>, op: IIntervalCollectionTypeOperationValue, localOpMetadata: IMapMessageLocalMetadata): {
+        rebasedOp: IIntervalCollectionTypeOperationValue;
         rebasedLocalOpMetadata: IMapMessageLocalMetadata;
     } | undefined;
-    applyStashedOp(value: T, op: IValueTypeOperationValue): IMapMessageLocalMetadata;
 }
 /**
  * Defines a value type that can be registered on a container type.
  */
-export interface IValueType<T> {
+export interface IIntervalCollectionType<T extends ISerializableInterval> {
     /**
      * Name of the value type.
-     * @alpha
      */
     name: string;
     /**
      * Factory method used to convert to/from a JSON form of the type.
-     * @alpha
      */
-    factory: IValueFactory<T>;
+    factory: IIntervalCollectionFactory<T>;
     /**
      * Operations that can be applied to the value type.
-     * @alpha
      */
-    ops: Map<IntervalOpType, IValueOperation<T>>;
+    ops: Map<IntervalOpType, IIntervalCollectionOperation<T>>;
 }
 export interface ISharedDefaultMapEvents extends ISharedObjectEvents {
     (event: "valueChanged" | "create", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): void;
@@ -157,7 +151,7 @@ export interface ISharedDefaultMapEvents extends ISharedObjectEvents {
  * The DefaultMap implementation for sequence has been specialized to only support a single ValueType, which serializes
  * and deserializes via .store() and .load().
  */
-export interface ISerializableValue {
+export interface ISerializableIntervalCollection {
     /**
      * A type annotation to help indicate how the value serializes.
      */
@@ -167,7 +161,7 @@ export interface ISerializableValue {
      */
     value: any;
 }
-export interface ISerializedValue {
+export interface ISerializedIntervalCollection {
     /**
      * A type annotation to help indicate how the value serializes.
      */
@@ -186,7 +180,7 @@ export interface ISerializedValue {
  * it just describes an operation to be applied to an already-in-memory value.
  * @alpha
  */
-export interface IValueTypeOperationValue {
+export interface IIntervalCollectionTypeOperationValue {
     /**
      * The name of the operation.
      */
@@ -196,4 +190,4 @@ export interface IValueTypeOperationValue {
      */
     value: SerializedIntervalDelta;
 }
-//# sourceMappingURL=defaultMapInterfaces.d.mts.map
+//# sourceMappingURL=intervalCollectionMapInterfaces.d.ts.map