@fluidframework/register-collection 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/src/consensusRegisterCollectionFactory.ts

@@ -4,50 +4,56 @@
  */
 
 import {
-    IChannelAttributes,
-    IFluidDataStoreRuntime,
-    IChannelServices,
+	IChannelAttributes,
+	IFluidDataStoreRuntime,
+	IChannelServices,
 } from "@fluidframework/datastore-definitions";
 import { ConsensusRegisterCollection } from "./consensusRegisterCollection";
 import { IConsensusRegisterCollection, IConsensusRegisterCollectionFactory } from "./interfaces";
 import { pkgVersion } from "./packageVersion";
 
 /**
- * The factory that defines the consensus queue
+ * The factory that defines the consensus queue.
+ * @alpha
  */
 export class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory {
-    public static Type = "https://graph.microsoft.com/types/consensus-register-collection";
+	public static Type = "https://graph.microsoft.com/types/consensus-register-collection";
 
-    public static readonly Attributes: IChannelAttributes = {
-        type: ConsensusRegisterCollectionFactory.Type,
-        snapshotFormatVersion: "0.1",
-        packageVersion: pkgVersion,
-    };
+	public static readonly Attributes: IChannelAttributes = {
+		type: ConsensusRegisterCollectionFactory.Type,
+		snapshotFormatVersion: "0.1",
+		packageVersion: pkgVersion,
+	};
 
-    public get type() {
-        return ConsensusRegisterCollectionFactory.Type;
-    }
+	public get type() {
+		return ConsensusRegisterCollectionFactory.Type;
+	}
 
-    public get attributes() {
-        return ConsensusRegisterCollectionFactory.Attributes;
-    }
+	public get attributes() {
+		return ConsensusRegisterCollectionFactory.Attributes;
+	}
 
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    public async load(
-        runtime: IFluidDataStoreRuntime,
-        id: string,
-        services: IChannelServices,
-        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection> {
-        const collection = new ConsensusRegisterCollection(id, runtime, attributes);
-        await collection.load(services);
-        return collection;
-    }
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+	 */
+	public async load(
+		runtime: IFluidDataStoreRuntime,
+		id: string,
+		services: IChannelServices,
+		attributes: IChannelAttributes,
+	): Promise<IConsensusRegisterCollection> {
+		const collection = new ConsensusRegisterCollection(id, runtime, attributes);
+		await collection.load(services);
+		return collection;
+	}
 
-    public create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection {
-        const collection = new ConsensusRegisterCollection(id, document, ConsensusRegisterCollectionFactory.Attributes);
-        collection.initializeLocal();
-        return collection;
-    }
+	public create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection {
+		const collection = new ConsensusRegisterCollection(
+			id,
+			document,
+			ConsensusRegisterCollectionFactory.Attributes,
+		);
+		collection.initializeLocal();
+		return collection;
+	}
 }

package/src/index.ts

@@ -3,6 +3,11 @@
  * Licensed under the MIT License.
  */
 
-export * from "./consensusRegisterCollection";
-export * from "./consensusRegisterCollectionFactory";
-export * from "./interfaces";
+export { ConsensusRegisterCollection } from "./consensusRegisterCollection";
+export { ConsensusRegisterCollectionFactory } from "./consensusRegisterCollectionFactory";
+export {
+	IConsensusRegisterCollection,
+	IConsensusRegisterCollectionEvents,
+	IConsensusRegisterCollectionFactory,
+	ReadPolicy,
+} from "./interfaces";

package/src/interfaces.ts

@@ -4,10 +4,10 @@
  */
 
 import {
-    IFluidDataStoreRuntime,
-    IChannelServices,
-    IChannelAttributes,
-    IChannelFactory,
+	IFluidDataStoreRuntime,
+	IChannelServices,
+	IChannelAttributes,
+	IChannelFactory,
 } from "@fluidframework/datastore-definitions";
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 
@@ -15,29 +15,36 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec
  * Consensus Register Collection channel factory interface
  *
  * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection
- * Use for the runtime to create and load distributed data structure by type name of each channel
+ * Use for the runtime to create and load distributed data structure by type name of each channel.
+ * @alpha
  */
 export interface IConsensusRegisterCollectionFactory extends IChannelFactory {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(
-        document: IFluidDataStoreRuntime,
-        id: string,
-        services: IChannelServices,
-        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+	 */
+	load(
+		document: IFluidDataStoreRuntime,
+		id: string,
+		services: IChannelServices,
+		attributes: IChannelAttributes,
+	): Promise<IConsensusRegisterCollection>;
 
-    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
+	create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
 }
 
+/**
+ * Events emitted by {@link IConsensusRegisterCollection}.
+ * @alpha
+ */
 export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {
-    (event: "atomicChanged" | "versionChanged", listener: (key: string, value: any, local: boolean) => void);
+	(
+		event: "atomicChanged" | "versionChanged",
+		listener: (key: string, value: any, local: boolean) => void,
+	);
 }
 
 /**
- * Consensus Register Collection.
- *
- * A consensus register collection is a distributed data structure, which holds a set of registers with update
+ * A distributed data structure that holds a set of registers with update
  * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference
  * sequence number of the incoming update.
  *
@@ -52,40 +59,42 @@ export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents
  * the value. So we can safely return the first value.
  *
  * LWW: The last write to a key always wins.
- *
+ * @alpha
  */
-export interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {
-    /**
-     * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.
-     * For a non existent register, it will attempt to create a new register with the specified value.
-     *
-     * @returns Promise<true> if write was non-concurrent
-     */
-    write(key: string, value: T): Promise<boolean>;
+export interface IConsensusRegisterCollection<T = any>
+	extends ISharedObject<IConsensusRegisterCollectionEvents> {
+	/**
+	 * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.
+	 * For a non existent register, it will attempt to create a new register with the specified value.
+	 *
+	 * @returns Promise<true> if write was non-concurrent
+	 */
+	write(key: string, value: T): Promise<boolean>;
 
-    /**
-     * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.
-     */
-    read(key: string, policy?: ReadPolicy): T | undefined;
+	/**
+	 * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.
+	 */
+	read(key: string, policy?: ReadPolicy): T | undefined;
 
-    /**
-     * Retrives all concurrent versions. Undefined if not present.
-     */
-    readVersions(key: string): T[] | undefined;
+	/**
+	 * Retrives all concurrent versions. Undefined if not present.
+	 */
+	readVersions(key: string): T[] | undefined;
 
-    /**
-     * Returns the keys.
-     */
-    keys(): string[];
+	/**
+	 * Returns the keys.
+	 */
+	keys(): string[];
 }
 
 /**
  * Read policies used when reading the map value.
+ * @alpha
  */
 export enum ReadPolicy {
-    // On a concurrent update, returns the first agreed upon value amongst all clients.
-    Atomic,
+	// On a concurrent update, returns the first agreed upon value amongst all clients.
+	Atomic,
 
-    // Last writer wins. Simply returns the last written value.
-    LWW,
+	// Last writer wins. Simply returns the last written value.
+	LWW,
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/register-collection";
-export const pkgVersion = "1.4.0-115997";
+export const pkgVersion = "2.0.0-dev-rc.1.0.0.224419";

package/tsc-multi.test.json

@@ -0,0 +1,4 @@
+{
+	"targets": [{ "extname": ".cjs", "module": "CommonJS", "moduleResolution": "Node10" }],
+	"projects": ["./tsconfig.json", "./src/test/tsconfig.json"]
+}

package/tsconfig.json

@@ -1,14 +1,12 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true
-    },
-    "include": [
-        "src/**/*"
-    ]
-}
+	"extends": [
+		"../../../common/build/build-common/tsconfig.base.json",
+		"../../../common/build/build-common/tsconfig.cjs.json",
+	],
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+	},
+}

package/dist/consensusRegisterCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAuF;AACvF,+EAA8F;AAO9F,2EAA6G;AAC7G,6FAA0F;AAC1F,6CAA4G;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAa,2BACT,SAAQ,iCAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,oCAAoC,CAAC,CAAC;QAXxD,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,uEAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,uEAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,uBAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,uBAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,IAAA,qBAAM,EAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAsC,EAAE,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,IAAA,4CAAuB,EAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,6BAAc,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,IAAA,qBAAM,EAAC,CAAA,MAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,IAAA,qBAAM,EAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,IAAA,8BAAe,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE,EAAE,qDAAqD;iBACtE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aAAM;YACH,IAAA,qBAAM,EAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,IAAA,qBAAM,EAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,IAAA,qBAAM,EAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ;AArPD,kEAqPC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n    // Atomic version\n    atomic: ILocalRegister<T>;\n\n    // All concurrent versions awaiting consensus\n    versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n    // Register value, wrapped for backwards compatibility with < 0.17\n    value: {\n        type: \"Plain\";\n        value: T;\n    };\n\n    // The sequence number when last consensus was reached\n    sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n    sequenceNumber,\n    value: {\n        type: \"Plain\",\n        value,\n    },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n    key: string;\n    type: \"write\";\n    serializedValue: string;\n\n    // Message can be delivered with delay - resubmitted on reconnect.\n    // As such, refSeq needs to reference seq # at the time op was created,\n    // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n    // as client can ingest ops in between.\n    refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions \\< 0.17\n */\ninterface IRegisterOperationOld<T> {\n    key: string;\n    type: \"write\";\n    value: {\n        type: \"Plain\";\n        value: T;\n    };\n    refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n    extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n    /**\n     * Create a new consensus register collection\n     *\n     * @param runtime - data store runtime the new consensus register collection belongs to\n     * @param id - optional name of the consensus register collection\n     * @returns newly create consensus register collection (but not attached yet)\n     */\n    // eslint-disable-next-line @typescript-eslint/no-shadow\n    public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n    }\n\n    /**\n     * Get a factory for ConsensusRegisterCollection to register with the data store.\n     *\n     * @returns a factory that creates and load ConsensusRegisterCollection\n     */\n    public static getFactory() {\n        return new ConsensusRegisterCollectionFactory();\n    }\n\n    private readonly data = new Map<string, ILocalData<T>>();\n\n    /**\n     * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n     * be provided\n     */\n    public constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n    ) {\n        super(id, runtime, attributes, \"fluid_consensusRegisterCollection_\");\n    }\n\n    /**\n     * Creates a new register or writes a new value.\n     * Returns a promise that will resolve when the write is acked.\n     *\n     * @returns Promise<true> if write was non-concurrent\n     */\n    public async write(key: string, value: T): Promise<boolean> {\n        const serializedValue = this.stringify(value, this.serializer);\n\n        if (!this.isAttached()) {\n            // JSON-roundtrip value for local writes to match the behavior of going through the wire\n            this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n            return true;\n        }\n\n        const message: IRegisterOperation = {\n            key,\n            type: \"write\",\n            serializedValue,\n            refSeq: this.runtime.deltaManager.lastSequenceNumber,\n        };\n\n        return this.newAckBasedPromise<boolean>((resolve) => {\n            // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n            // op is ack'd.\n            this.submitLocalMessage(message, resolve);\n            // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n        }).catch((error) => false);\n    }\n\n    /**\n     * Returns the most recent local value of a register.\n     * @param key - The key to read\n     * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n     */\n    public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n        if (readPolicy === ReadPolicy.Atomic) {\n            return this.readAtomic(key);\n        }\n\n        const versions = this.readVersions(key);\n\n        if (versions !== undefined) {\n            // We don't support deletion. So there should be at least one value.\n            assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n            return versions[versions.length - 1];\n        }\n    }\n\n    public readVersions(key: string): T[] | undefined {\n        const data = this.data.get(key);\n        return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n    }\n\n    public keys(): string[] {\n        return [...this.data.keys()];\n    }\n\n    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n        const dataObj: { [key: string]: ILocalData<T>; } = {};\n        this.data.forEach((v, k) => { dataObj[k] = v; });\n\n        return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const blob = await storage.readBlob(snapshotFileName);\n        const header = bufferToString(blob, \"utf8\");\n        const dataObj = this.parse(header, this.serializer);\n\n        for (const key of Object.keys(dataObj)) {\n            assert(dataObj[key].atomic?.value.type !== \"Shared\",\n                // eslint-disable-next-line max-len\n                0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n            this.data.set(key, dataObj[key]);\n        }\n    }\n\n    protected onDisconnect() {}\n\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation) {\n            const op: IIncomingRegisterOperation<T> = message.contents;\n            switch (op.type) {\n                case \"write\": {\n                    // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n                    // when the refSeq property didn't exist\n                    if (op.refSeq === undefined) {\n                        op.refSeq = message.referenceSequenceNumber;\n                    }\n                    // Message can be delivered with delay - e.g. resubmitted on reconnect.\n                    // Use the refSeq from when the op was created, not when it was transmitted\n                    const refSeqWhenCreated = op.refSeq;\n                    assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n                        0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n                    const value = incomingOpMatchesCurrentFormat(op)\n                        ? this.parse(op.serializedValue, this.serializer) as T\n                        : op.value.value;\n                    const winner = this.processInboundWrite(\n                        op.key,\n                        value,\n                        refSeqWhenCreated,\n                        message.sequenceNumber,\n                        local);\n                    if (local) {\n                        // Resolve the pending promise for this operation now that we have received an ack for it.\n                        const resolve = localOpMetadata as PendingResolve;\n                        resolve(winner);\n                    }\n                    break;\n                }\n                default: unreachableCase(op.type);\n            }\n        }\n    }\n\n    private readAtomic(key: string): T | undefined {\n        const data = this.data.get(key);\n        return data?.atomic.value.value;\n    }\n\n    /**\n     * Process an inbound write op\n     * @param key - Key that was written to\n     * @param value - Incoming value\n     * @param refSeq - RefSeq at the time of write on the remote client\n     * @param sequenceNumber - Sequence Number of this write op\n     * @param local - Did this write originate on this client\n     */\n    private processInboundWrite(\n        key: string,\n        value: T,\n        refSeq: number,\n        sequenceNumber: number,\n        local: boolean,\n    ): boolean {\n        let data = this.data.get(key);\n        // Atomic update if it's a new register or the write was not concurrent,\n        // meaning our state was known to the remote client at the time of write\n        const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n        if (winner) {\n            const atomicUpdate = newLocalRegister<T>(\n                sequenceNumber,\n                value,\n            );\n            if (data === undefined) {\n                data = {\n                    atomic: atomicUpdate,\n                    versions: [], // we'll update versions next, leave it empty for now\n                };\n                this.data.set(key, data);\n            } else {\n                data.atomic = atomicUpdate;\n            }\n        } else {\n            assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n        }\n\n        // Remove versions that were known to the remote client at the time of write\n        while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n            data.versions.shift();\n        }\n\n        const versionUpdate = newLocalRegister<T>(\n            sequenceNumber,\n            value,\n        );\n\n        // Asserts for data integrity\n        if (!this.isAttached()) {\n            assert(refSeq === 0 && sequenceNumber === 0,\n                0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n        } else if (data.versions.length > 0) {\n            assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n                0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n        }\n\n        // Push the new element.\n        data.versions.push(versionUpdate);\n\n        // Raise events at the end, to avoid reentrancy issues\n        if (winner) {\n            this.emit(\"atomicChanged\", key, value, local);\n        }\n        this.emit(\"versionChanged\", key, value, local);\n\n        return winner;\n    }\n\n    private stringify(value: any, serializer: IFluidSerializer): string {\n        return serializer.stringify(value, this.handle);\n    }\n\n    private parse(content: string, serializer: IFluidSerializer): any {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return serializer.parse(content);\n    }\n\n    protected applyStashedOp() {\n        // empty implementation\n        return () => { };\n    }\n}\n"]}

package/dist/consensusRegisterCollectionFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollectionFactory.js","sourceRoot":"","sources":["../src/consensusRegisterCollectionFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,+EAA4E;AAE5E,qDAA8C;AAE9C;;GAEG;AACH,MAAa,kCAAkC;IAS3C,IAAW,IAAI;QACX,OAAO,kCAAkC,CAAC,IAAI,CAAC;IACnD,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,kCAAkC,CAAC,UAAU,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAC9B,MAAM,UAAU,GAAG,IAAI,yDAA2B,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC5E,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACtD,MAAM,UAAU,GAAG,IAAI,yDAA2B,CAAC,EAAE,EAAE,QAAQ,EAAE,kCAAkC,CAAC,UAAU,CAAC,CAAC;QAChH,UAAU,CAAC,eAAe,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC;IACtB,CAAC;;AAlCL,gFAmCC;AAlCiB,uCAAI,GAAG,iEAAiE,CAAC;AAEhE,6CAAU,GAAuB;IACpD,IAAI,EAAE,kCAAkC,CAAC,IAAI;IAC7C,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,2BAAU;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ConsensusRegisterCollection } from \"./consensusRegisterCollection\";\nimport { IConsensusRegisterCollection, IConsensusRegisterCollectionFactory } from \"./interfaces\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * The factory that defines the consensus queue\n */\nexport class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory {\n    public static Type = \"https://graph.microsoft.com/types/consensus-register-collection\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: ConsensusRegisterCollectionFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public get type() {\n        return ConsensusRegisterCollectionFactory.Type;\n    }\n\n    public get attributes() {\n        return ConsensusRegisterCollectionFactory.Attributes;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection> {\n        const collection = new ConsensusRegisterCollection(id, runtime, attributes);\n        await collection.load(services);\n        return collection;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection {\n        const collection = new ConsensusRegisterCollection(id, document, ConsensusRegisterCollectionFactory.Attributes);\n        collection.initializeLocal();\n        return collection;\n    }\n}\n"]}

package/dist/index.js

@@ -1,20 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./consensusRegisterCollection"), exports);
-__exportStar(require("./consensusRegisterCollectionFactory"), exports);
-__exportStar(require("./interfaces"), exports);
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,gEAA8C;AAC9C,uEAAqD;AACrD,+CAA6B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./consensusRegisterCollection\";\nexport * from \"./consensusRegisterCollectionFactory\";\nexport * from \"./interfaces\";\n"]}

package/dist/interfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA8EH;;GAEG;AACH,IAAY,UAMX;AAND,WAAY,UAAU;IAClB,mFAAmF;IACnF,+CAAM,CAAA;IAEN,2DAA2D;IAC3D,yCAAG,CAAA;AACP,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelAttributes,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Consensus Register Collection channel factory interface\n *\n * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection\n * Use for the runtime to create and load distributed data structure by type name of each channel\n */\nexport interface IConsensusRegisterCollectionFactory extends IChannelFactory {\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    load(\n        document: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;\n\n    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;\n}\n\nexport interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {\n    (event: \"atomicChanged\" | \"versionChanged\", listener: (key: string, value: any, local: boolean) => void);\n}\n\n/**\n * Consensus Register Collection.\n *\n * A consensus register collection is a distributed data structure, which holds a set of registers with update\n * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference\n * sequence number of the incoming update.\n *\n * Using all the stored versions, we can then distinguish amongst different read policies. Below are the policies\n * we support:\n *\n * Atomic: Atomicity requires a linearizable register. A linearizable register behaves as if there is only a single\n * copy of the data, and that every operation appears to take effect atomically at one point in time. This definition\n * implies that operations are executed in an well-defined order. On a concurrent update, we perform a compare-and-set\n * operation, where we compare a register sequence number with the incoming reference sequence number.\n * The earliest operation overwriting prior sequence numbers wins since every client reaches to an agreement on\n * the value. So we can safely return the first value.\n *\n * LWW: The last write to a key always wins.\n *\n */\nexport interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {\n    /**\n     * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.\n     * For a non existent register, it will attempt to create a new register with the specified value.\n     *\n     * @returns Promise<true> if write was non-concurrent\n     */\n    write(key: string, value: T): Promise<boolean>;\n\n    /**\n     * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.\n     */\n    read(key: string, policy?: ReadPolicy): T | undefined;\n\n    /**\n     * Retrives all concurrent versions. Undefined if not present.\n     */\n    readVersions(key: string): T[] | undefined;\n\n    /**\n     * Returns the keys.\n     */\n    keys(): string[];\n}\n\n/**\n * Read policies used when reading the map value.\n */\nexport enum ReadPolicy {\n    // On a concurrent update, returns the first agreed upon value amongst all clients.\n    Atomic,\n\n    // Last writer wins. Simply returns the last written value.\n    LWW,\n}\n"]}

package/dist/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,qCAAqC,CAAC;AAChD,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/register-collection\";\nexport const pkgVersion = \"1.4.0-115997\";\n"]}

package/lib/consensusRegisterCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollection.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAoE5G;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACtC,SAAQ,YAAY,CAAC,kCAAkC,CAAE,YAAW,4BAA4B,CAAC,CAAC,CAAC;IACnG;;;;;;OAMG;WAEW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAKlC;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAO5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAqClG,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA4D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAKb,SAAS,CAAC,cAAc;CAI3B"}

package/lib/consensusRegisterCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAA6B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAO9F,OAAO,EAAE,uBAAuB,EAAoB,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAgC,UAAU,EAAsC,MAAM,cAAc,CAAC;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,2BACT,SAAQ,YAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,oCAAoC,CAAC,CAAC;QAXxD,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,kCAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,kCAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,UAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,UAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAsC,EAAE,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,MAAM,CAAC,CAAA,MAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE,EAAE,qDAAqD;iBACtE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aAAM;YACH,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n    // Atomic version\n    atomic: ILocalRegister<T>;\n\n    // All concurrent versions awaiting consensus\n    versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n    // Register value, wrapped for backwards compatibility with < 0.17\n    value: {\n        type: \"Plain\";\n        value: T;\n    };\n\n    // The sequence number when last consensus was reached\n    sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n    sequenceNumber,\n    value: {\n        type: \"Plain\",\n        value,\n    },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n    key: string;\n    type: \"write\";\n    serializedValue: string;\n\n    // Message can be delivered with delay - resubmitted on reconnect.\n    // As such, refSeq needs to reference seq # at the time op was created,\n    // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n    // as client can ingest ops in between.\n    refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions \\< 0.17\n */\ninterface IRegisterOperationOld<T> {\n    key: string;\n    type: \"write\";\n    value: {\n        type: \"Plain\";\n        value: T;\n    };\n    refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n    extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n    /**\n     * Create a new consensus register collection\n     *\n     * @param runtime - data store runtime the new consensus register collection belongs to\n     * @param id - optional name of the consensus register collection\n     * @returns newly create consensus register collection (but not attached yet)\n     */\n    // eslint-disable-next-line @typescript-eslint/no-shadow\n    public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n    }\n\n    /**\n     * Get a factory for ConsensusRegisterCollection to register with the data store.\n     *\n     * @returns a factory that creates and load ConsensusRegisterCollection\n     */\n    public static getFactory() {\n        return new ConsensusRegisterCollectionFactory();\n    }\n\n    private readonly data = new Map<string, ILocalData<T>>();\n\n    /**\n     * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n     * be provided\n     */\n    public constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n    ) {\n        super(id, runtime, attributes, \"fluid_consensusRegisterCollection_\");\n    }\n\n    /**\n     * Creates a new register or writes a new value.\n     * Returns a promise that will resolve when the write is acked.\n     *\n     * @returns Promise<true> if write was non-concurrent\n     */\n    public async write(key: string, value: T): Promise<boolean> {\n        const serializedValue = this.stringify(value, this.serializer);\n\n        if (!this.isAttached()) {\n            // JSON-roundtrip value for local writes to match the behavior of going through the wire\n            this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n            return true;\n        }\n\n        const message: IRegisterOperation = {\n            key,\n            type: \"write\",\n            serializedValue,\n            refSeq: this.runtime.deltaManager.lastSequenceNumber,\n        };\n\n        return this.newAckBasedPromise<boolean>((resolve) => {\n            // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n            // op is ack'd.\n            this.submitLocalMessage(message, resolve);\n            // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n        }).catch((error) => false);\n    }\n\n    /**\n     * Returns the most recent local value of a register.\n     * @param key - The key to read\n     * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n     */\n    public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n        if (readPolicy === ReadPolicy.Atomic) {\n            return this.readAtomic(key);\n        }\n\n        const versions = this.readVersions(key);\n\n        if (versions !== undefined) {\n            // We don't support deletion. So there should be at least one value.\n            assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n            return versions[versions.length - 1];\n        }\n    }\n\n    public readVersions(key: string): T[] | undefined {\n        const data = this.data.get(key);\n        return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n    }\n\n    public keys(): string[] {\n        return [...this.data.keys()];\n    }\n\n    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n        const dataObj: { [key: string]: ILocalData<T>; } = {};\n        this.data.forEach((v, k) => { dataObj[k] = v; });\n\n        return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const blob = await storage.readBlob(snapshotFileName);\n        const header = bufferToString(blob, \"utf8\");\n        const dataObj = this.parse(header, this.serializer);\n\n        for (const key of Object.keys(dataObj)) {\n            assert(dataObj[key].atomic?.value.type !== \"Shared\",\n                // eslint-disable-next-line max-len\n                0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n            this.data.set(key, dataObj[key]);\n        }\n    }\n\n    protected onDisconnect() {}\n\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation) {\n            const op: IIncomingRegisterOperation<T> = message.contents;\n            switch (op.type) {\n                case \"write\": {\n                    // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n                    // when the refSeq property didn't exist\n                    if (op.refSeq === undefined) {\n                        op.refSeq = message.referenceSequenceNumber;\n                    }\n                    // Message can be delivered with delay - e.g. resubmitted on reconnect.\n                    // Use the refSeq from when the op was created, not when it was transmitted\n                    const refSeqWhenCreated = op.refSeq;\n                    assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n                        0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n                    const value = incomingOpMatchesCurrentFormat(op)\n                        ? this.parse(op.serializedValue, this.serializer) as T\n                        : op.value.value;\n                    const winner = this.processInboundWrite(\n                        op.key,\n                        value,\n                        refSeqWhenCreated,\n                        message.sequenceNumber,\n                        local);\n                    if (local) {\n                        // Resolve the pending promise for this operation now that we have received an ack for it.\n                        const resolve = localOpMetadata as PendingResolve;\n                        resolve(winner);\n                    }\n                    break;\n                }\n                default: unreachableCase(op.type);\n            }\n        }\n    }\n\n    private readAtomic(key: string): T | undefined {\n        const data = this.data.get(key);\n        return data?.atomic.value.value;\n    }\n\n    /**\n     * Process an inbound write op\n     * @param key - Key that was written to\n     * @param value - Incoming value\n     * @param refSeq - RefSeq at the time of write on the remote client\n     * @param sequenceNumber - Sequence Number of this write op\n     * @param local - Did this write originate on this client\n     */\n    private processInboundWrite(\n        key: string,\n        value: T,\n        refSeq: number,\n        sequenceNumber: number,\n        local: boolean,\n    ): boolean {\n        let data = this.data.get(key);\n        // Atomic update if it's a new register or the write was not concurrent,\n        // meaning our state was known to the remote client at the time of write\n        const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n        if (winner) {\n            const atomicUpdate = newLocalRegister<T>(\n                sequenceNumber,\n                value,\n            );\n            if (data === undefined) {\n                data = {\n                    atomic: atomicUpdate,\n                    versions: [], // we'll update versions next, leave it empty for now\n                };\n                this.data.set(key, data);\n            } else {\n                data.atomic = atomicUpdate;\n            }\n        } else {\n            assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n        }\n\n        // Remove versions that were known to the remote client at the time of write\n        while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n            data.versions.shift();\n        }\n\n        const versionUpdate = newLocalRegister<T>(\n            sequenceNumber,\n            value,\n        );\n\n        // Asserts for data integrity\n        if (!this.isAttached()) {\n            assert(refSeq === 0 && sequenceNumber === 0,\n                0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n        } else if (data.versions.length > 0) {\n            assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n                0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n        }\n\n        // Push the new element.\n        data.versions.push(versionUpdate);\n\n        // Raise events at the end, to avoid reentrancy issues\n        if (winner) {\n            this.emit(\"atomicChanged\", key, value, local);\n        }\n        this.emit(\"versionChanged\", key, value, local);\n\n        return winner;\n    }\n\n    private stringify(value: any, serializer: IFluidSerializer): string {\n        return serializer.stringify(value, this.handle);\n    }\n\n    private parse(content: string, serializer: IFluidSerializer): any {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return serializer.parse(content);\n    }\n\n    protected applyStashedOp() {\n        // empty implementation\n        return () => { };\n    }\n}\n"]}

package/lib/consensusRegisterCollectionFactory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollectionFactory.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollectionFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,4BAA4B,EAAE,mCAAmC,EAAE,MAAM,cAAc,CAAC;AAGjG;;GAEG;AACH,qBAAa,kCAAmC,YAAW,mCAAmC;IAC1F,OAAc,IAAI,SAAqE;IAEvF,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAMnE,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,4BAA4B;CAK5F"}

package/lib/consensusRegisterCollectionFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusRegisterCollectionFactory.js","sourceRoot":"","sources":["../src/consensusRegisterCollectionFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;GAEG;AACH,MAAM,OAAO,kCAAkC;IAS3C,IAAW,IAAI;QACX,OAAO,kCAAkC,CAAC,IAAI,CAAC;IACnD,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,kCAAkC,CAAC,UAAU,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAC9B,MAAM,UAAU,GAAG,IAAI,2BAA2B,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC5E,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,UAAU,CAAC;IACtB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACtD,MAAM,UAAU,GAAG,IAAI,2BAA2B,CAAC,EAAE,EAAE,QAAQ,EAAE,kCAAkC,CAAC,UAAU,CAAC,CAAC;QAChH,UAAU,CAAC,eAAe,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC;IACtB,CAAC;;AAjCa,uCAAI,GAAG,iEAAiE,CAAC;AAEhE,6CAAU,GAAuB;IACpD,IAAI,EAAE,kCAAkC,CAAC,IAAI;IAC7C,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ConsensusRegisterCollection } from \"./consensusRegisterCollection\";\nimport { IConsensusRegisterCollection, IConsensusRegisterCollectionFactory } from \"./interfaces\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * The factory that defines the consensus queue\n */\nexport class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory {\n    public static Type = \"https://graph.microsoft.com/types/consensus-register-collection\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: ConsensusRegisterCollectionFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public get type() {\n        return ConsensusRegisterCollectionFactory.Type;\n    }\n\n    public get attributes() {\n        return ConsensusRegisterCollectionFactory.Attributes;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection> {\n        const collection = new ConsensusRegisterCollection(id, runtime, attributes);\n        await collection.load(services);\n        return collection;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection {\n        const collection = new ConsensusRegisterCollection(id, document, ConsensusRegisterCollectionFactory.Attributes);\n        collection.initializeLocal();\n        return collection;\n    }\n}\n"]}

package/lib/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export * from "./consensusRegisterCollection";
-export * from "./consensusRegisterCollectionFactory";
-export * from "./interfaces";
-//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,cAAc,CAAC"}

package/lib/index.js

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export * from "./consensusRegisterCollection";
-export * from "./consensusRegisterCollectionFactory";
-export * from "./interfaces";
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./consensusRegisterCollection\";\nexport * from \"./consensusRegisterCollectionFactory\";\nexport * from \"./interfaces\";\n"]}

package/lib/interfaces.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,WAAW,mCAAoC,SAAQ,eAAe;IACxE;;OAEG;IACH,IAAI,CACA,QAAQ,EAAE,sBAAsB,EAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE3E,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,4BAA4B,CAAC;CACtF;AAED,MAAM,WAAW,kCAAmC,SAAQ,mBAAmB;IAC3E,CAAC,KAAK,EAAE,eAAe,GAAG,gBAAgB,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAC5G;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,4BAA4B,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,kCAAkC,CAAC;IAC5G;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,CAAC,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,UAAU;IAElB,MAAM,IAAA;IAGN,GAAG,IAAA;CACN"}

package/lib/interfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8EH;;GAEG;AACH,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IAClB,mFAAmF;IACnF,+CAAM,CAAA;IAEN,2DAA2D;IAC3D,yCAAG,CAAA;AACP,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelAttributes,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Consensus Register Collection channel factory interface\n *\n * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection\n * Use for the runtime to create and load distributed data structure by type name of each channel\n */\nexport interface IConsensusRegisterCollectionFactory extends IChannelFactory {\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    load(\n        document: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;\n\n    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;\n}\n\nexport interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {\n    (event: \"atomicChanged\" | \"versionChanged\", listener: (key: string, value: any, local: boolean) => void);\n}\n\n/**\n * Consensus Register Collection.\n *\n * A consensus register collection is a distributed data structure, which holds a set of registers with update\n * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference\n * sequence number of the incoming update.\n *\n * Using all the stored versions, we can then distinguish amongst different read policies. Below are the policies\n * we support:\n *\n * Atomic: Atomicity requires a linearizable register. A linearizable register behaves as if there is only a single\n * copy of the data, and that every operation appears to take effect atomically at one point in time. This definition\n * implies that operations are executed in an well-defined order. On a concurrent update, we perform a compare-and-set\n * operation, where we compare a register sequence number with the incoming reference sequence number.\n * The earliest operation overwriting prior sequence numbers wins since every client reaches to an agreement on\n * the value. So we can safely return the first value.\n *\n * LWW: The last write to a key always wins.\n *\n */\nexport interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {\n    /**\n     * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.\n     * For a non existent register, it will attempt to create a new register with the specified value.\n     *\n     * @returns Promise<true> if write was non-concurrent\n     */\n    write(key: string, value: T): Promise<boolean>;\n\n    /**\n     * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.\n     */\n    read(key: string, policy?: ReadPolicy): T | undefined;\n\n    /**\n     * Retrives all concurrent versions. Undefined if not present.\n     */\n    readVersions(key: string): T[] | undefined;\n\n    /**\n     * Returns the keys.\n     */\n    keys(): string[];\n}\n\n/**\n * Read policies used when reading the map value.\n */\nexport enum ReadPolicy {\n    // On a concurrent update, returns the first agreed upon value amongst all clients.\n    Atomic,\n\n    // Last writer wins. Simply returns the last written value.\n    LWW,\n}\n"]}

package/lib/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qCAAqC,CAAC;AAC7D,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/register-collection\";\nexport const pkgVersion = \"1.4.0-115997\";\n"]}

package/tsconfig.esnext.json

@@ -1,7 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}