@fluidframework/ordered-collection 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/src/consensusOrderedCollectionFactory.ts

@@ -4,9 +4,9 @@
  */
 
 import {
-    IChannelAttributes,
-    IFluidDataStoreRuntime,
-    IChannelServices,
+	IChannelAttributes,
+	IFluidDataStoreRuntime,
+	IChannelServices,
 } from "@fluidframework/datastore-definitions";
 import { ConsensusQueue } from "./consensusQueue";
 import { IConsensusOrderedCollection, IConsensusOrderedCollectionFactory } from "./interfaces";
@@ -16,38 +16,39 @@ import { pkgVersion } from "./packageVersion";
  * The factory that defines the consensus queue
  */
 export class ConsensusQueueFactory implements IConsensusOrderedCollectionFactory {
-    public static Type = "https://graph.microsoft.com/types/consensus-queue";
+	public static Type = "https://graph.microsoft.com/types/consensus-queue";
 
-    public static readonly Attributes: IChannelAttributes = {
-        type: ConsensusQueueFactory.Type,
-        snapshotFormatVersion: "0.1",
-        packageVersion: pkgVersion,
-    };
+	public static readonly Attributes: IChannelAttributes = {
+		type: ConsensusQueueFactory.Type,
+		snapshotFormatVersion: "0.1",
+		packageVersion: pkgVersion,
+	};
 
-    public get type() {
-        return ConsensusQueueFactory.Type;
-    }
+	public get type() {
+		return ConsensusQueueFactory.Type;
+	}
 
-    public get attributes() {
-        return ConsensusQueueFactory.Attributes;
-    }
+	public get attributes() {
+		return ConsensusQueueFactory.Attributes;
+	}
 
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    public async load(
-        runtime: IFluidDataStoreRuntime,
-        id: string,
-        services: IChannelServices,
-        attributes: IChannelAttributes): Promise<IConsensusOrderedCollection> {
-        const collection = new ConsensusQueue(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<IConsensusOrderedCollection> {
+		const collection = new ConsensusQueue(id, runtime, attributes);
+		await collection.load(services);
+		return collection;
+	}
 
-    public create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection {
-        const collection = new ConsensusQueue(id, document, this.attributes);
-        collection.initializeLocal();
-        return collection;
-    }
+	public create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection {
+		const collection = new ConsensusQueue(id, document, this.attributes);
+		collection.initializeLocal();
+		return collection;
+	}
 }

package/src/consensusQueue.ts

@@ -4,9 +4,9 @@
  */
 
 import {
-    IFluidDataStoreRuntime,
-    IChannelAttributes,
-    IChannelFactory,
+	IFluidDataStoreRuntime,
+	IChannelAttributes,
+	IChannelFactory,
 } from "@fluidframework/datastore-definitions";
 import { ConsensusOrderedCollection } from "./consensusOrderedCollection";
 import { ConsensusQueueFactory } from "./consensusOrderedCollectionFactory";
@@ -17,50 +17,54 @@ import { SnapshotableArray } from "./snapshotableArray";
  * An JS array based queue implementation that is the backing data structure for ConsensusQueue
  */
 class SnapshotableQueue<T> extends SnapshotableArray<T> implements IOrderedCollection<T> {
-    public add(value: T) {
-        this.data.push(value);
-    }
+	public add(value: T) {
+		this.data.push(value);
+	}
 
-    public remove(): T {
-        if (this.size() === 0) {
-            throw new Error("SnapshotableQueue is empty");
-        }
-        return this.data.shift() as T;
-    }
+	public remove(): T {
+		if (this.size() === 0) {
+			throw new Error("SnapshotableQueue is empty");
+		}
+		return this.data.shift() as T;
+	}
 }
 
 /**
  * Implementation of a consensus stack
  *
  * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
+ * @alpha
  */
 export class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {
-    /**
-     * Create a new consensus queue
-     *
-     * @param runtime - data store runtime the new consensus queue belongs to
-     * @param id - optional name of theconsensus queue
-     * @returns newly create consensus queue (but not attached yet)
-     */
-    // eslint-disable-next-line @typescript-eslint/no-shadow
-    public static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string) {
-        return runtime.createChannel(id, ConsensusQueueFactory.Type) as ConsensusQueue<T>;
-    }
+	/**
+	 * Create a new consensus queue
+	 *
+	 * @param runtime - data store runtime the new consensus queue belongs to
+	 * @param id - optional name of theconsensus queue
+	 * @returns newly create consensus queue (but not attached yet)
+	 */
+	public static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string) {
+		return runtime.createChannel(id, ConsensusQueueFactory.Type) as ConsensusQueue<T>;
+	}
 
-    /**
-     * Get a factory for ConsensusQueue to register with the data store.
-     *
-     * @returns a factory that creates and load ConsensusQueue
-     */
-    public static getFactory(): IChannelFactory {
-        return new ConsensusQueueFactory();
-    }
+	/**
+	 * Get a factory for ConsensusQueue to register with the data store.
+	 *
+	 * @returns a factory that creates and load ConsensusQueue
+	 */
+	public static getFactory(): IChannelFactory {
+		return new ConsensusQueueFactory();
+	}
 
-    /**
-     * Constructs a new consensus queue. If the object is non-local an id and service interfaces will
-     * be provided
-     */
-    public constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {
-        super(id, runtime, attributes, new SnapshotableQueue<T>());
-    }
+	/**
+	 * Constructs a new consensus queue. If the object is non-local an id and service interfaces will
+	 * be provided
+	 */
+	public constructor(
+		id: string,
+		runtime: IFluidDataStoreRuntime,
+		attributes: IChannelAttributes,
+	) {
+		super(id, runtime, attributes, new SnapshotableQueue<T>());
+	}
 }

package/src/index.ts

@@ -3,7 +3,15 @@
  * Licensed under the MIT License.
  */
 
-export * from "./consensusOrderedCollection";
-export * from "./consensusQueue";
-export * from "./interfaces";
-export * from "./testUtils";
+export {
+	ConsensusCallback,
+	ConsensusResult,
+	IConsensusOrderedCollection,
+	IConsensusOrderedCollectionEvents,
+	IConsensusOrderedCollectionFactory,
+	IOrderedCollection,
+	ISnapshotable,
+} from "./interfaces";
+export { ConsensusOrderedCollection } from "./consensusOrderedCollection";
+export { ConsensusQueue } from "./consensusQueue";
+export { acquireAndComplete, waitAcquireAndComplete } from "./testUtils";

package/src/interfaces.ts

@@ -4,21 +4,25 @@
  */
 
 import {
-    IFluidDataStoreRuntime,
-    IChannelServices,
-    IChannelAttributes,
-    IChannelFactory,
+	IFluidDataStoreRuntime,
+	IChannelServices,
+	IChannelAttributes,
+	IChannelFactory,
 } from "@fluidframework/datastore-definitions";
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 
+/**
+ * @alpha
+ */
 export enum ConsensusResult {
-    Release,
-    Complete,
+	Release,
+	Complete,
 }
 
 /**
  * Callback provided to acquire() and waitAndAcquire() methods.
  * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
+ * @alpha
  */
 export type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
 
@@ -27,47 +31,49 @@ export type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
  *
  * Extends the base IChannelFactory to return a more definite type of IConsensusOrderedCollection
  * Use for the runtime to create and load distributed data structure by type name of each channel
+ * @internal
  */
 export interface IConsensusOrderedCollectionFactory extends IChannelFactory {
-    load(
-        document: IFluidDataStoreRuntime,
-        id: string,
-        services: IChannelServices,
-        attributes: IChannelAttributes): Promise<IConsensusOrderedCollection>;
-
-    create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;
+	load(
+		document: IFluidDataStoreRuntime,
+		id: string,
+		services: IChannelServices,
+		attributes: IChannelAttributes,
+	): Promise<IConsensusOrderedCollection>;
+
+	create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;
 }
 
 /**
  * Events notifying about addition, acquisition, release and completion of items
+ * @alpha
  */
 export interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {
-
-    /**
-     * Event fires when new item is added to the queue or
-     * an item previously acquired is returned back to a queue (including client loosing connection)
-     * @param newlyAdded - indicates if it's newly added item of previously acquired item
-     */
-    (event: "add", listener: (value: T, newlyAdded: boolean) => void): this;
-    /**
-     * Event fires when a client acquired an item
-     * Fires both for locally acquired items, as well as items acquired by remote clients
-     */
-    (event: "acquire", listener: (value: T, clientId?: string) => void): this;
-
-    /**
-     * "Complete event fires when a client completes an item.
-     */
-    (event: "complete", listener: (value: T) => void): this;
-
-    /**
-     * Event fires when locally acquired item is being released back to the queue.
-     * Please note that release process is asynchronous, so it takes a while for it to happen
-     * ("add" event will be fired as result of it)
-     * @param intentional - indicates whether release was intentional (result of returning
-     * ConsensusResult.Release from callback) or it happened as result of lost connection.
-     */
-    (event: "localRelease", listener: (value: T, intentional: boolean) => void): this;
+	/**
+	 * Event fires when new item is added to the queue or
+	 * an item previously acquired is returned back to a queue (including client loosing connection)
+	 * @param newlyAdded - indicates if it's newly added item of previously acquired item
+	 */
+	(event: "add", listener: (value: T, newlyAdded: boolean) => void): this;
+	/**
+	 * Event fires when a client acquired an item
+	 * Fires both for locally acquired items, as well as items acquired by remote clients
+	 */
+	(event: "acquire", listener: (value: T, clientId?: string) => void): this;
+
+	/**
+	 * "Complete event fires when a client completes an item.
+	 */
+	(event: "complete", listener: (value: T) => void): this;
+
+	/**
+	 * Event fires when locally acquired item is being released back to the queue.
+	 * Please note that release process is asynchronous, so it takes a while for it to happen
+	 * ("add" event will be fired as result of it)
+	 * @param intentional - indicates whether release was intentional (result of returning
+	 * ConsensusResult.Release from callback) or it happened as result of lost connection.
+	 */
+	(event: "localRelease", listener: (value: T, intentional: boolean) => void): this;
 }
 
 /**
@@ -93,26 +99,27 @@ export interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvent
  * All objects added to the collection will be cloned (via JSON).
  * They will not be references to the original input object.  Thus changed to
  * the input object will not reflect the object in the collection.
+ * @alpha
  */
-export interface IConsensusOrderedCollection<T = any> extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
-
-    /**
-     * Adds a value to the collection
-     */
-    add(value: T): Promise<void>;
-
-    /**
-     * Retrieves a value from the collection.
-     * @returns Returns true (and calls callback with acquired value) if collection was not empty.
-     *          Otherwise returns false.
-     */
-    acquire(callback: ConsensusCallback<T>): Promise<boolean>;
-
-    /**
-     * Wait for a value to be available and remove it from the consensus collection
-     * Calls callback with retrieved value.
-     */
-    waitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;
+export interface IConsensusOrderedCollection<T = any>
+	extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
+	/**
+	 * Adds a value to the collection
+	 */
+	add(value: T): Promise<void>;
+
+	/**
+	 * Retrieves a value from the collection.
+	 * @returns Returns true (and calls callback with acquired value) if collection was not empty.
+	 * Otherwise returns false.
+	 */
+	acquire(callback: ConsensusCallback<T>): Promise<boolean>;
+
+	/**
+	 * Wait for a value to be available and remove it from the consensus collection
+	 * Calls callback with retrieved value.
+	 */
+	waitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;
 }
 
 /**
@@ -120,11 +127,12 @@ export interface IConsensusOrderedCollection<T = any> extends ISharedObject<ICon
  *
  * TODO: move this to be use in other place
  * TODO: currently input and output is not symmetrical, can they become symmetrical?
+ * @alpha
  */
 export interface ISnapshotable<T> {
-    asArray(): T[];
+	asArray(): T[];
 
-    loadFrom(values: T[]): void;
+	loadFrom(values: T[]): void;
 }
 
 /**
@@ -133,20 +141,21 @@ export interface ISnapshotable<T> {
  * Collection of objects that has deterministic add and remove ordering.
  * Object implementing this interface can be used as the data backing
  * for the ConsensusOrderedCollection
+ * @alpha
  */
 export interface IOrderedCollection<T = any> extends ISnapshotable<T> {
-    /**
-     * Adds a value to the collection
-     */
-    add(value: T);
-
-    /**
-     * Retrieves a value from the collection.
-     */
-    remove(): T;
-
-    /**
-     * Return the size of the collection
-     */
-    size(): number;
+	/**
+	 * Adds a value to the collection
+	 */
+	add(value: T);
+
+	/**
+	 * Retrieves a value from the collection.
+	 */
+	remove(): T;
+
+	/**
+	 * Return the size of the collection
+	 */
+	size(): number;
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/ordered-collection";
-export const pkgVersion = "1.4.0-121020";
+export const pkgVersion = "2.0.0-dev-rc.1.0.0.225277";

package/src/snapshotableArray.ts

@@ -3,21 +3,21 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 
 export class SnapshotableArray<T> extends Array {
-    protected data: T[] = [];
+	protected data: T[] = [];
 
-    public asArray() {
-        return this.data;
-    }
+	public asArray() {
+		return this.data;
+	}
 
-    public async loadFrom(from: T[]): Promise<void> {
-        assert(this.data.length === 0, 0x06b /* "Loading snapshot into a non-empty collection" */);
-        this.data = from;
-    }
+	public async loadFrom(from: T[]): Promise<void> {
+		assert(this.data.length === 0, 0x06b /* "Loading snapshot into a non-empty collection" */);
+		this.data = from;
+	}
 
-    public size(): number {
-        return this.data.length;
-    }
+	public size(): number {
+		return this.data.length;
+	}
 }

package/src/testUtils.ts

@@ -3,33 +3,36 @@
  * Licensed under the MIT License.
  */
 
-import {
-    ConsensusResult,
-    IConsensusOrderedCollection,
-} from "./interfaces";
+import { ConsensusResult, IConsensusOrderedCollection } from "./interfaces";
 
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
-export async function acquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T | undefined> {
-    let res: T | undefined;
-    await collection.acquire(async (value: T) => {
-        res = value;
-        return ConsensusResult.Complete;
-    });
-    return res;
+export async function acquireAndComplete<T>(
+	collection: IConsensusOrderedCollection<T>,
+): Promise<T | undefined> {
+	let res: T | undefined;
+	await collection.acquire(async (value: T) => {
+		res = value;
+		return ConsensusResult.Complete;
+	});
+	return res;
 }
 
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
-export async function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T> {
-    let res: T | undefined;
-    await collection.waitAndAcquire(async (value: T) => {
-        res = value;
-        return ConsensusResult.Complete;
-    });
-    return res as T;
+export async function waitAcquireAndComplete<T>(
+	collection: IConsensusOrderedCollection<T>,
+): Promise<T> {
+	let res: T | undefined;
+	await collection.waitAndAcquire(async (value: T) => {
+		res = value;
+		return ConsensusResult.Complete;
+	});
+	return res as T;
 }

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/consensusOrderedCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusOrderedCollection.js","sourceRoot":"","sources":["../src/consensusOrderedCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAuF;AACvF,+EAA8F;AAM9F,2EAAoF;AAEpF,iEAAmE;AACnE,+BAAkC;AAClC,6CAMsB;AAEtB,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AACtC,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAwD/C,MAAM,0BAA0B,GAAG,SAAS,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAa,0BACT,SAAQ,iCAAkD;IAM1D;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B,EACb,IAA2B;QAE5C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,mCAAmC,CAAC,CAAC;QAFnD,SAAI,GAAJ,IAAI,CAAuB;QAbhD;;WAEG;QACK,gBAAW,GAAuB,IAAI,GAAG,EAAE,CAAC;QAchD,4FAA4F;QAC5F,qDAAqD;QACrD,oFAAoF;QACpF,iFAAiF;QACjF,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACxD,IAAA,qBAAM,EAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,KAAQ;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,+DAA+D;YAC/D,gEAAgE;YAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAM,CAAC;YACvE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvB,OAAO;SACV;QAED,MAAM,IAAI,CAAC,MAAM,CAA0C;YACvD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,QAAQ;SAClB,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,QAA8B;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEzC,QAAQ,GAAG,EAAE;YACT,KAAK,4BAAe,CAAC,QAAQ;gBACzB,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACtC,MAAM;YACV,KAAK,4BAAe,CAAC,OAAO;gBACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAChE,MAAM;YACV,OAAO,CAAC,CAAC,IAAA,8BAAe,EAAC,GAAG,CAAC,CAAC;SACjC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAA8B;QACtD,GAAG;YACC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;gBACxB,oDAAoD;gBACpD,MAAM,IAAI,CAAC,kBAAkB,CAAI,CAAC,OAAO,EAAE,EAAE;oBACzC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC9B,CAAC,CAAC,CAAC;aACN;SACJ,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE;IAC9C,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,4DAA4D;QAC5D,2CAA2C;QAC3C,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC;QAE9C,MAAM,OAAO,GAAG,IAAI,kCAAkB,EAAE,CAAC;QACzC,IAAI,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QACvE,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QACnD,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,WAAW,CAAC,CAAC;QACvD,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAES,QAAQ;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;IACtE,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,SAAiB;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAC7B,OAAO;SACV;QAED,wFAAwF;QACxF,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACjB,MAAM,IAAI,CAAC,MAAM,CAA+C;gBAC5D,MAAM,EAAE,UAAU;gBAClB,SAAS;aACZ,CAAC,CAAC;SACN;IACL,CAAC;IAES,YAAY,CAAC,SAAiB;QACpC,yEAAyE;QACzE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACnB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;SACpC;IACL,CAAC;IAES,OAAO,CAAC,SAAiB;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAC5B,OAAO;SACV;QAED,wFAAwF;QACxF,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACjB,IAAI,CAAC,MAAM,CAA8C;gBACrD,MAAM,EAAE,SAAS;gBACjB,SAAS;aACZ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,wBAAwB,EAAE,EAAE,KAAK,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACN;IACL,CAAC;IAES,WAAW,CAAC,SAAiB;QACnC,yEAAyE;QACzE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACnB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;SACvD;IACL,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAC7G,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;QAC9D,MAAM,kBAAkB,GAAG,IAAA,6BAAc,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAuB,CAAC;QAE1D,IAAA,qBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAChG,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;QAC3D,MAAM,cAAc,GAAG,IAAA,6BAAc,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAQ,CAAC;QAC/E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAES,YAAY;QAClB,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpD,IAAI,QAAQ,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACpC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;aAC7D;SACJ;IACL,CAAC;IAES,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAyC,OAAO,CAAC,QAAQ,CAAC;YAClE,IAAI,KAAsD,CAAC;YAC3D,QAAQ,EAAE,CAAC,MAAM,EAAE;gBACf,KAAK,KAAK;oBACN,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAM,CAAC,CAAC;oBACpE,MAAM;gBAEV,KAAK,SAAS;oBACV,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzD,MAAM;gBAEV,KAAK,UAAU;oBACX,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAChC,MAAM;gBAEV,KAAK,SAAS;oBACV,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAC/B,MAAM;gBAEV,OAAO,CAAC,CAAC,IAAA,8BAAe,EAAC,EAAE,CAAC,CAAC;aAChC;YACD,IAAI,KAAK,EAAE;gBACP,0FAA0F;gBAC1F,MAAM,OAAO,GAAG,eAAoC,CAAC;gBACrD,OAAO,CAAC,KAAK,CAAC,CAAC;aAClB;SACJ;IACL,CAAC;IAEO,KAAK,CAAC,MAAM,CAChB,OAAiB;QAEjB,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC,kBAAkB,CAAkD,CAAC,OAAO,EAAE,EAAE;YACxF,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,sGAAsG;QAC1G,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEO,OAAO,CAAC,KAAQ;QACpB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAEO,WAAW,CAAC,SAAiB,EAAE,QAAiB;QACpD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACxB,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAEjC,MAAM,MAAM,GAAwC;YAChD,SAAS;YACT,KAAK;SACR,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE5D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,eAAe;QACzB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,qCAAqC;YACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAA,SAAI,GAAE,EAAE,0BAA0B,CAAC,CAAC;SAC/D;QAED,OAAO,IAAI,CAAC,MAAM,CAA8C;YAC5D,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,IAAA,SAAI,GAAE;SACpB,CAAC,CAAC;IACP,CAAC;IAEO,YAAY,CAAC,gBAAyB;QAC1C,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YAC7D,IAAI,QAAQ,KAAK,gBAAgB,EAAE;gBAC/B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACJ;QAED,+DAA+D;QAC/D,qFAAqF;QACrF,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC1E,CAAC;IAEO,cAAc,CAAC,KAAK,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,gBAAgB,CAAC,OAAe,EAAE,UAA4B;QAClE,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AA9RD,gEA8RC","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 { IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    ConsensusCallback,\n    ConsensusResult,\n    IConsensusOrderedCollection,\n    IOrderedCollection,\n    IConsensusOrderedCollectionEvents,\n} from \"./interfaces\";\n\nconst snapshotFileNameData = \"header\";\nconst snapshotFileNameTracking = \"jobTracking\";\n\ninterface IConsensusOrderedCollectionValue<T> {\n    // an ID used to indicate acquired item.\n    // Used in acquire/release/complete ops.\n    readonly acquireId: string;\n\n    // The actual value\n    readonly value: T;\n}\n\n/**\n * An operation for consensus ordered collection\n */\ninterface IConsensusOrderedCollectionAddOperation {\n    opName: \"add\";\n    // serialized value\n    value: string;\n}\n\ninterface IConsensusOrderedCollectionAcquireOperation {\n    opName: \"acquire\";\n    // an ID used to indicate acquired item.\n    // Used in acquire/release/complete ops.\n    acquireId: string;\n}\n\ninterface IConsensusOrderedCollectionCompleteOperation {\n    opName: \"complete\";\n    // an ID used to indicate acquired item.\n    // Used in acquire/release/complete ops.\n    acquireId: string;\n}\n\ninterface IConsensusOrderedCollectionReleaseOperation {\n    opName: \"release\";\n    // an ID used to indicate acquired item.\n    // Used in acquire/release/complete ops.\n    acquireId: string;\n}\n\ntype IConsensusOrderedCollectionOperation =\n    IConsensusOrderedCollectionAddOperation |\n    IConsensusOrderedCollectionAcquireOperation |\n    IConsensusOrderedCollectionCompleteOperation |\n    IConsensusOrderedCollectionReleaseOperation;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve<T> = (value: IConsensusOrderedCollectionValue<T> | undefined) => void;\n\n/**\n * For job tracking, we need to keep track of which client \"owns\" a given value.\n * Key is the acquireId from when it was acquired\n * Value is the acquired value, and the id of the client who acquired it, or undefined for unattached client\n */\ntype JobTrackingInfo<T> = Map<string, { value: T; clientId: string | undefined; }>;\nconst idForLocalUnattachedClient = undefined;\n\n/**\n * Implementation of a consensus collection shared object\n *\n * Implements the shared object's communication, and the semantics around the\n * release/complete mechanism following acquire.\n *\n * Generally not used directly. A derived type will pass in a backing data type\n * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.\n */\nexport class ConsensusOrderedCollection<T = any>\n    extends SharedObject<IConsensusOrderedCollectionEvents<T>> implements IConsensusOrderedCollection<T> {\n    /**\n     * The set of values that have been acquired but not yet completed or released\n     */\n    private jobTracking: JobTrackingInfo<T> = new Map();\n\n    /**\n     * Constructs a new consensus collection. If the object is non-local an id and service interfaces will\n     * be provided\n     */\n    protected constructor(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        private readonly data: IOrderedCollection<T>,\n    ) {\n        super(id, runtime, attributes, \"fluid_consensusOrderedCollection_\");\n\n        // We can't simply call this.removeClient(this.runtime.clientId) in on runtime disconnected,\n        // because other clients may disconnect concurrently.\n        // Disconnect order matters because it defines the order items go back to the queue.\n        // So we put items back to queue only when we process our own removeMember event.\n        runtime.getQuorum().on(\"removeMember\", (clientId: string) => {\n            assert(!!clientId, 0x067 /* \"Missing clientId for removal!\" */);\n            this.removeClient(clientId);\n        });\n    }\n\n    /**\n     * Add a value to the consensus collection.\n     */\n    public async add(value: T): Promise<void> {\n        const valueSer = this.serializeValue(value, this.serializer);\n\n        if (!this.isAttached()) {\n            // For the case where this is not attached yet, explicitly JSON\n            // clone the value to match the behavior of going thru the wire.\n            const addValue = this.deserializeValue(valueSer, this.serializer) as T;\n            this.addCore(addValue);\n            return;\n        }\n\n        await this.submit<IConsensusOrderedCollectionAddOperation>({\n            opName: \"add\",\n            value: valueSer,\n        });\n    }\n\n    /**\n     * Remove a value from the consensus collection.  If the collection is empty, returns false.\n     * Otherwise calls callback with the value\n     */\n    public async acquire(callback: ConsensusCallback<T>): Promise<boolean> {\n        const result = await this.acquireInternal();\n        if (result === undefined) {\n            return false;\n        }\n\n        const res = await callback(result.value);\n\n        switch (res) {\n            case ConsensusResult.Complete:\n                await this.complete(result.acquireId);\n                break;\n            case ConsensusResult.Release:\n                this.release(result.acquireId);\n                this.emit(\"localRelease\", result.value, true /* intentional */);\n                break;\n            default: unreachableCase(res);\n        }\n\n        return true;\n    }\n\n    /**\n     * Wait for a value to be available and acquire it from the consensus collection\n     */\n    public async waitAndAcquire(callback: ConsensusCallback<T>): Promise<void> {\n        do {\n            if (this.data.size() === 0) {\n                // Wait for new entry before trying to acquire again\n                await this.newAckBasedPromise<T>((resolve) => {\n                    this.once(\"add\", resolve);\n                });\n            }\n        } while (!(await this.acquire(callback)));\n    }\n\n    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n        // If we are transitioning from unattached to attached mode,\n        // then we are losing all checked out work!\n        this.removeClient(idForLocalUnattachedClient);\n\n        const builder = new SummaryTreeBuilder();\n        let blobContent = this.serializeValue(this.data.asArray(), serializer);\n        builder.addBlob(snapshotFileNameData, blobContent);\n        blobContent = this.serializeValue(Array.from(this.jobTracking.entries()), serializer);\n        builder.addBlob(snapshotFileNameTracking, blobContent);\n        return builder.getSummaryTree();\n    }\n\n    protected isActive() {\n        return this.runtime.connected && this.runtime.deltaManager.active;\n    }\n\n    protected async complete(acquireId: string) {\n        if (!this.isAttached()) {\n            this.completeCore(acquireId);\n            return;\n        }\n\n        // if not active, this item already was released to queue (as observed by other clients)\n        if (this.isActive()) {\n            await this.submit<IConsensusOrderedCollectionCompleteOperation>({\n                opName: \"complete\",\n                acquireId,\n            });\n        }\n    }\n\n    protected completeCore(acquireId: string) {\n        // Note: item may be no longer in jobTracking and returned back to queue!\n        const rec = this.jobTracking.get(acquireId);\n        if (rec !== undefined) {\n            this.jobTracking.delete(acquireId);\n            this.emit(\"complete\", rec.value);\n        }\n    }\n\n    protected release(acquireId: string) {\n        if (!this.isAttached()) {\n            this.releaseCore(acquireId);\n            return;\n        }\n\n        // if not active, this item already was released to queue (as observed by other clients)\n        if (this.isActive()) {\n            this.submit<IConsensusOrderedCollectionReleaseOperation>({\n                opName: \"release\",\n                acquireId,\n            }).catch((error) => {\n                this.runtime.logger.sendErrorEvent({ eventName: \"ConsensusQueue_release\" }, error);\n            });\n        }\n    }\n\n    protected releaseCore(acquireId: string) {\n        // Note: item may be no longer in jobTracking and returned back to queue!\n        const rec = this.jobTracking.get(acquireId);\n        if (rec !== undefined) {\n            this.jobTracking.delete(acquireId);\n            this.data.add(rec.value);\n            this.emit(\"add\", rec.value, false /* newlyAdded */);\n        }\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        assert(this.jobTracking.size === 0, 0x068 /* \"On consensusOrderedCollection load, job tracking size > 0\" */);\n        const blob = await storage.readBlob(snapshotFileNameTracking);\n        const rawContentTracking = bufferToString(blob, \"utf8\");\n        const content = this.deserializeValue(rawContentTracking, this.serializer);\n        this.jobTracking = new Map(content) as JobTrackingInfo<T>;\n\n        assert(this.data.size() === 0, 0x069 /* \"On consensusOrderedCollection load, data size > 0\" */);\n        const blob2 = await storage.readBlob(snapshotFileNameData);\n        const rawContentData = bufferToString(blob2, \"utf8\");\n        const content2 = this.deserializeValue(rawContentData, this.serializer) as T[];\n        this.data.loadFrom(content2);\n    }\n\n    protected onDisconnect() {\n        for (const [, { value, clientId }] of this.jobTracking) {\n            if (clientId === this.runtime.clientId) {\n                this.emit(\"localRelease\", value, false /* intentional */);\n            }\n        }\n    }\n\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation) {\n            const op: IConsensusOrderedCollectionOperation = message.contents;\n            let value: IConsensusOrderedCollectionValue<T> | undefined;\n            switch (op.opName) {\n                case \"add\":\n                    this.addCore(this.deserializeValue(op.value, this.serializer) as T);\n                    break;\n\n                case \"acquire\":\n                    value = this.acquireCore(op.acquireId, message.clientId);\n                    break;\n\n                case \"complete\":\n                    this.completeCore(op.acquireId);\n                    break;\n\n                case \"release\":\n                    this.releaseCore(op.acquireId);\n                    break;\n\n                default: unreachableCase(op);\n            }\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<T>;\n                resolve(value);\n            }\n        }\n    }\n\n    private async submit<TMessage extends IConsensusOrderedCollectionOperation>(\n        message: TMessage,\n    ): Promise<IConsensusOrderedCollectionValue<T> | undefined> {\n        assert(this.isAttached(), 0x06a /* \"Trying to submit message while detached!\" */);\n\n        return this.newAckBasedPromise<IConsensusOrderedCollectionValue<T> | undefined>((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 undefined then unhandled exception.\n        }).catch((error) => undefined);\n    }\n\n    private addCore(value: T) {\n        this.data.add(value);\n        this.emit(\"add\", value, true /* newlyAdded */);\n    }\n\n    private acquireCore(acquireId: string, clientId?: string): IConsensusOrderedCollectionValue<T> | undefined {\n        if (this.data.size() === 0) {\n            return undefined;\n        }\n        const value = this.data.remove();\n\n        const value2: IConsensusOrderedCollectionValue<T> = {\n            acquireId,\n            value,\n        };\n        this.jobTracking.set(value2.acquireId, { value, clientId });\n\n        this.emit(\"acquire\", value, clientId);\n        return value2;\n    }\n\n    private async acquireInternal(): Promise<IConsensusOrderedCollectionValue<T> | undefined> {\n        if (!this.isAttached()) {\n            // can be undefined if queue is empty\n            return this.acquireCore(uuid(), idForLocalUnattachedClient);\n        }\n\n        return this.submit<IConsensusOrderedCollectionAcquireOperation>({\n            opName: \"acquire\",\n            acquireId: uuid(),\n        });\n    }\n\n    private removeClient(clientIdToRemove?: string) {\n        const added: T[] = [];\n        for (const [acquireId, { value, clientId }] of this.jobTracking) {\n            if (clientId === clientIdToRemove) {\n                this.jobTracking.delete(acquireId);\n                this.data.add(value);\n                added.push(value);\n            }\n        }\n\n        // Raise all events only after all state changes are completed,\n        // to guarantee same ordering of operations if collection is manipulated from events.\n        added.map((value) => this.emit(\"add\", value, false /* newlyAdded */));\n    }\n\n    private serializeValue(value, serializer: IFluidSerializer) {\n        return serializer.stringify(value, this.handle);\n    }\n\n    private deserializeValue(content: string, serializer: IFluidSerializer) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return serializer.parse(content);\n    }\n\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}

package/dist/consensusOrderedCollectionFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusOrderedCollectionFactory.js","sourceRoot":"","sources":["../src/consensusOrderedCollectionFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,qDAAkD;AAElD,qDAA8C;AAE9C;;GAEG;AACH,MAAa,qBAAqB;IAS9B,IAAW,IAAI;QACX,OAAO,qBAAqB,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,qBAAqB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAC9B,MAAM,UAAU,GAAG,IAAI,+BAAc,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC/D,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,+BAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,UAAU,CAAC,eAAe,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC;IACtB,CAAC;;AAlCL,sDAmCC;AAlCiB,0BAAI,GAAG,mDAAmD,CAAC;AAElD,gCAAU,GAAuB;IACpD,IAAI,EAAE,qBAAqB,CAAC,IAAI;IAChC,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 { ConsensusQueue } from \"./consensusQueue\";\nimport { IConsensusOrderedCollection, IConsensusOrderedCollectionFactory } from \"./interfaces\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * The factory that defines the consensus queue\n */\nexport class ConsensusQueueFactory implements IConsensusOrderedCollectionFactory {\n    public static Type = \"https://graph.microsoft.com/types/consensus-queue\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: ConsensusQueueFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public get type() {\n        return ConsensusQueueFactory.Type;\n    }\n\n    public get attributes() {\n        return ConsensusQueueFactory.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<IConsensusOrderedCollection> {\n        const collection = new ConsensusQueue(id, runtime, attributes);\n        await collection.load(services);\n        return collection;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection {\n        const collection = new ConsensusQueue(id, document, this.attributes);\n        collection.initializeLocal();\n        return collection;\n    }\n}\n"]}

package/dist/consensusQueue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consensusQueue.js","sourceRoot":"","sources":["../src/consensusQueue.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,6EAA0E;AAC1E,2FAA4E;AAE5E,2DAAwD;AAExD;;GAEG;AACH,MAAM,iBAAqB,SAAQ,qCAAoB;IAC5C,GAAG,CAAC,KAAQ;QACf,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAEM,MAAM;QACT,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SACjD;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAO,CAAC;IAClC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAa,cAAwB,SAAQ,uDAA6B;IACtE;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAU,OAA+B,EAAE,EAAW;QACtE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,yDAAqB,CAAC,IAAI,CAAsB,CAAC;IACtF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,yDAAqB,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,YAAmB,EAAU,EAAE,OAA+B,EAAE,UAA8B;QAC1F,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,iBAAiB,EAAK,CAAC,CAAC;IAC/D,CAAC;CACJ;AA7BD,wCA6BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidDataStoreRuntime,\n    IChannelAttributes,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ConsensusOrderedCollection } from \"./consensusOrderedCollection\";\nimport { ConsensusQueueFactory } from \"./consensusOrderedCollectionFactory\";\nimport { IOrderedCollection } from \"./interfaces\";\nimport { SnapshotableArray } from \"./snapshotableArray\";\n\n/**\n * An JS array based queue implementation that is the backing data structure for ConsensusQueue\n */\nclass SnapshotableQueue<T> extends SnapshotableArray<T> implements IOrderedCollection<T> {\n    public add(value: T) {\n        this.data.push(value);\n    }\n\n    public remove(): T {\n        if (this.size() === 0) {\n            throw new Error(\"SnapshotableQueue is empty\");\n        }\n        return this.data.shift() as T;\n    }\n}\n\n/**\n * Implementation of a consensus stack\n *\n * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.\n */\nexport class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {\n    /**\n     * Create a new consensus queue\n     *\n     * @param runtime - data store runtime the new consensus queue belongs to\n     * @param id - optional name of theconsensus queue\n     * @returns newly create consensus queue (but not attached yet)\n     */\n    // eslint-disable-next-line @typescript-eslint/no-shadow\n    public static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, ConsensusQueueFactory.Type) as ConsensusQueue<T>;\n    }\n\n    /**\n     * Get a factory for ConsensusQueue to register with the data store.\n     *\n     * @returns a factory that creates and load ConsensusQueue\n     */\n    public static getFactory(): IChannelFactory {\n        return new ConsensusQueueFactory();\n    }\n\n    /**\n     * Constructs a new consensus queue. If the object is non-local an id and service interfaces will\n     * be provided\n     */\n    public constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n        super(id, runtime, attributes, new SnapshotableQueue<T>());\n    }\n}\n"]}

package/dist/index.js

@@ -1,21 +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("./consensusOrderedCollection"), exports);
-__exportStar(require("./consensusQueue"), exports);
-__exportStar(require("./interfaces"), exports);
-__exportStar(require("./testUtils"), exports);
-//# sourceMappingURL=index.js.map