@fluidframework/ordered-collection 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

package/lib/interfaces.d.ts

@@ -4,6 +4,9 @@
  */
 import { IFluidDataStoreRuntime, IChannelServices, IChannelAttributes, IChannelFactory } from "@fluidframework/datastore-definitions";
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
+/**
+ * @internal
+ */
 export declare enum ConsensusResult {
     Release = 0,
     Complete = 1
@@ -11,6 +14,7 @@ export declare enum ConsensusResult {
 /**
  * Callback provided to acquire() and waitAndAcquire() methods.
  * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
+ * @internal
  */
 export type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
 /**
@@ -18,6 +22,7 @@ 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>;
@@ -25,6 +30,7 @@ export interface IConsensusOrderedCollectionFactory extends IChannelFactory {
 }
 /**
  * Events notifying about addition, acquisition, release and completion of items
+ * @internal
  */
 export interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {
     /**
@@ -74,6 +80,7 @@ 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.
+ * @internal
  */
 export interface IConsensusOrderedCollection<T = any> extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
     /**
@@ -97,6 +104,7 @@ 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?
+ * @internal
  */
 export interface ISnapshotable<T> {
     asArray(): T[];
@@ -108,6 +116,7 @@ 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
+ * @internal
  */
 export interface IOrderedCollection<T = any> extends ISnapshotable<T> {
     /**

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF,oBAAY,eAAe;IAC1B,OAAO,IAAA;IACP,QAAQ,IAAA;CACR;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,eAAe;IAC1E,IAAI,CACH,QAAQ,EAAE,sBAAsB,EAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAExC,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,2BAA2B,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC,CAAC,CAAC,CAAE,SAAQ,mBAAmB;IAChF;;;;OAIG;IACH,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACxE;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1E;;OAEG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAExD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;CAClF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,2BAA2B,CAAC,CAAC,GAAG,GAAG,CACnD,SAAQ,aAAa,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC;IAC3D;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1D;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IACpE;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,OAAE;IAEd;;OAEG;IACH,MAAM,IAAI,CAAC,CAAC;IAEZ;;OAEG;IACH,IAAI,IAAI,MAAM,CAAC;CACf"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,MAAM,uCAAuC;OACvC,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC;AAEvF;;GAEG;AACH,oBAAY,eAAe;IAC1B,OAAO,IAAA;IACP,QAAQ,IAAA;CACR;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,WAAW,kCAAmC,SAAQ,eAAe;IAC1E,IAAI,CACH,QAAQ,EAAE,sBAAsB,EAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAExC,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,2BAA2B,CAAC;CAClF;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC,CAAC,CAAC,CAAE,SAAQ,mBAAmB;IAChF;;;;OAIG;IACH,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACxE;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1E;;OAEG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAExD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;CAClF;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,2BAA2B,CAAC,CAAC,GAAG,GAAG,CACnD,SAAQ,aAAa,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC;IAC3D;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1D;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IACpE;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,OAAE;IAEd;;OAEG;IACH,MAAM,IAAI,CAAC,CAAC;IAEZ;;OAEG;IACH,IAAI,IAAI,MAAM,CAAC;CACf"}

package/lib/{interfaces.js → interfaces.mjs}

@@ -2,9 +2,12 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * @internal
+ */
 export var ConsensusResult;
 (function (ConsensusResult) {
     ConsensusResult[ConsensusResult["Release"] = 0] = "Release";
     ConsensusResult[ConsensusResult["Complete"] = 1] = "Complete";
 })(ConsensusResult || (ConsensusResult = {}));
-//# sourceMappingURL=interfaces.js.map
+//# sourceMappingURL=interfaces.mjs.map

package/lib/interfaces.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.mjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;GAEG;AACH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IAC1B,2DAAO,CAAA;IACP,6DAAQ,CAAA;AACT,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIFluidDataStoreRuntime,\n\tIChannelServices,\n\tIChannelAttributes,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * @internal\n */\nexport enum ConsensusResult {\n\tRelease,\n\tComplete,\n}\n\n/**\n * Callback provided to acquire() and waitAndAcquire() methods.\n * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.\n * @internal\n */\nexport type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;\n\n/**\n * Consensus Ordered Collection channel factory interface\n *\n * Extends the base IChannelFactory to return a more definite type of IConsensusOrderedCollection\n * Use for the runtime to create and load distributed data structure by type name of each channel\n * @internal\n */\nexport interface IConsensusOrderedCollectionFactory extends IChannelFactory {\n\tload(\n\t\tdocument: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<IConsensusOrderedCollection>;\n\n\tcreate(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;\n}\n\n/**\n * Events notifying about addition, acquisition, release and completion of items\n * @internal\n */\nexport interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {\n\t/**\n\t * Event fires when new item is added to the queue or\n\t * an item previously acquired is returned back to a queue (including client loosing connection)\n\t * @param newlyAdded - indicates if it's newly added item of previously acquired item\n\t */\n\t(event: \"add\", listener: (value: T, newlyAdded: boolean) => void): this;\n\t/**\n\t * Event fires when a client acquired an item\n\t * Fires both for locally acquired items, as well as items acquired by remote clients\n\t */\n\t(event: \"acquire\", listener: (value: T, clientId?: string) => void): this;\n\n\t/**\n\t * \"Complete event fires when a client completes an item.\n\t */\n\t(event: \"complete\", listener: (value: T) => void): this;\n\n\t/**\n\t * Event fires when locally acquired item is being released back to the queue.\n\t * Please note that release process is asynchronous, so it takes a while for it to happen\n\t * (\"add\" event will be fired as result of it)\n\t * @param intentional - indicates whether release was intentional (result of returning\n\t * ConsensusResult.Release from callback) or it happened as result of lost connection.\n\t */\n\t(event: \"localRelease\", listener: (value: T, intentional: boolean) => void): this;\n}\n\n/**\n * Consensus Ordered Collection interface\n *\n * An consensus ordered collection is a distributed data structure, which\n * holds a collection of JSON-able or handles, and has a\n * deterministic add/remove order.\n *\n * @remarks\n * The order the server receive the add/remove operation determines the\n * order those operation are applied to the collection. Different clients\n * issuing `add` or `acquire` operations at the same time will be sequenced.\n * The order dictates which `add` is done first, thus determining the order\n * in which it appears in the collection.  It also determines which client\n * will get the first removed item, etc. All operations are asynchronous.\n * A function `waitAndAcquire` is provided to wait for and remove an entry in the collection.\n *\n * As a client acquires an item, it processes it and then returns a value (via callback)\n * indicating whether it has completed processing the item, or whether the item should be\n * released back to the collection for another client to process.\n *\n * All objects added to the collection will be cloned (via JSON).\n * They will not be references to the original input object.  Thus changed to\n * the input object will not reflect the object in the collection.\n * @internal\n */\nexport interface IConsensusOrderedCollection<T = any>\n\textends ISharedObject<IConsensusOrderedCollectionEvents<T>> {\n\t/**\n\t * Adds a value to the collection\n\t */\n\tadd(value: T): Promise<void>;\n\n\t/**\n\t * Retrieves a value from the collection.\n\t * @returns Returns true (and calls callback with acquired value) if collection was not empty.\n\t * Otherwise returns false.\n\t */\n\tacquire(callback: ConsensusCallback<T>): Promise<boolean>;\n\n\t/**\n\t * Wait for a value to be available and remove it from the consensus collection\n\t * Calls callback with retrieved value.\n\t */\n\twaitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;\n}\n\n/**\n * Interface for object that can be snapshoted\n *\n * TODO: move this to be use in other place\n * TODO: currently input and output is not symmetrical, can they become symmetrical?\n * @internal\n */\nexport interface ISnapshotable<T> {\n\tasArray(): T[];\n\n\tloadFrom(values: T[]): void;\n}\n\n/**\n * Ordered Collection interface\n *\n * Collection of objects that has deterministic add and remove ordering.\n * Object implementing this interface can be used as the data backing\n * for the ConsensusOrderedCollection\n * @internal\n */\nexport interface IOrderedCollection<T = any> extends ISnapshotable<T> {\n\t/**\n\t * Adds a value to the collection\n\t */\n\tadd(value: T);\n\n\t/**\n\t * Retrieves a value from the collection.\n\t */\n\tremove(): T;\n\n\t/**\n\t * Return the size of the collection\n\t */\n\tsize(): number;\n}\n"]}

package/lib/ordered-collection-alpha.d.ts

@@ -0,0 +1,35 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+/* Excluded from this release type: acquireAndComplete */
+
+/* Excluded from this release type: ConsensusCallback */
+
+/* Excluded from this release type: ConsensusOrderedCollection */
+
+/* Excluded from this release type: ConsensusQueue */
+
+/* Excluded from this release type: ConsensusResult */
+
+/* Excluded from this release type: IConsensusOrderedCollection */
+
+/* Excluded from this release type: IConsensusOrderedCollectionEvents */
+
+/* Excluded from this release type: IConsensusOrderedCollectionFactory */
+
+/* Excluded from this release type: IOrderedCollection */
+
+/* Excluded from this release type: ISnapshotable */
+
+/* Excluded from this release type: waitAcquireAndComplete */
+
+export { }

package/lib/ordered-collection-beta.d.ts

@@ -0,0 +1,55 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+/* Excluded from this release type: acquireAndComplete */
+
+/* Excluded from this release type: ConsensusCallback */
+
+/* Excluded from this release type: ConsensusOrderedCollection */
+
+/* Excluded from this release type: ConsensusQueue */
+
+/* Excluded from this release type: ConsensusResult */
+
+/* Excluded from this release type: IChannelAttributes */
+
+/* Excluded from this release type: IChannelFactory */
+
+/* Excluded from this release type: IChannelServices */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IConsensusOrderedCollection */
+
+/* Excluded from this release type: IConsensusOrderedCollectionEvents */
+
+/* Excluded from this release type: IConsensusOrderedCollectionFactory */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: IOrderedCollection */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedObjectEvents */
+
+/* Excluded from this release type: ISnapshotable */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: SharedObject */
+
+/* Excluded from this release type: waitAcquireAndComplete */
+
+export { }

package/lib/ordered-collection-public.d.ts

@@ -0,0 +1,55 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+/* Excluded from this release type: acquireAndComplete */
+
+/* Excluded from this release type: ConsensusCallback */
+
+/* Excluded from this release type: ConsensusOrderedCollection */
+
+/* Excluded from this release type: ConsensusQueue */
+
+/* Excluded from this release type: ConsensusResult */
+
+/* Excluded from this release type: IChannelAttributes */
+
+/* Excluded from this release type: IChannelFactory */
+
+/* Excluded from this release type: IChannelServices */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IConsensusOrderedCollection */
+
+/* Excluded from this release type: IConsensusOrderedCollectionEvents */
+
+/* Excluded from this release type: IConsensusOrderedCollectionFactory */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: IOrderedCollection */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedObjectEvents */
+
+/* Excluded from this release type: ISnapshotable */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: SharedObject */
+
+/* Excluded from this release type: waitAcquireAndComplete */
+
+export { }

package/lib/ordered-collection-untrimmed.d.ts

@@ -0,0 +1,246 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+/**
+ * Helper method to acquire and complete an item
+ * Should be used in test code only
+ * @internal
+ */
+export declare function acquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T | undefined>;
+
+/**
+ * Callback provided to acquire() and waitAndAcquire() methods.
+ * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
+ * @internal
+ */
+export declare type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
+
+/**
+ * Implementation of a consensus collection shared object
+ *
+ * Implements the shared object's communication, and the semantics around the
+ * release/complete mechanism following acquire.
+ *
+ * Generally not used directly. A derived type will pass in a backing data type
+ * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.
+ * @internal
+ */
+export declare class ConsensusOrderedCollection<T = any> extends SharedObject<IConsensusOrderedCollectionEvents<T>> implements IConsensusOrderedCollection<T> {
+    private readonly data;
+    /**
+     * The set of values that have been acquired but not yet completed or released
+     */
+    private jobTracking;
+    /**
+     * Constructs a new consensus collection. If the object is non-local an id and service interfaces will
+     * be provided
+     */
+    protected constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, data: IOrderedCollection<T>);
+    /**
+     * Add a value to the consensus collection.
+     */
+    add(value: T): Promise<void>;
+    /**
+     * Remove a value from the consensus collection.  If the collection is empty, returns false.
+     * Otherwise calls callback with the value
+     */
+    acquire(callback: ConsensusCallback<T>): Promise<boolean>;
+    /**
+     * Wait for a value to be available and acquire it from the consensus collection
+     */
+    waitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    protected isActive(): boolean;
+    protected complete(acquireId: string): Promise<void>;
+    protected completeCore(acquireId: string): void;
+    protected release(acquireId: string): void;
+    protected releaseCore(acquireId: string): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected onDisconnect(): void;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private submit;
+    private addCore;
+    private acquireCore;
+    private acquireInternal;
+    private removeClient;
+    private serializeValue;
+    private deserializeValue;
+    protected applyStashedOp(): void;
+}
+
+/**
+ * Implementation of a consensus stack
+ *
+ * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
+ * @internal
+ */
+export declare 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)
+     */
+    static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string): ConsensusQueue<T>;
+    /**
+     * Get a factory for ConsensusQueue to register with the data store.
+     *
+     * @returns a factory that creates and load ConsensusQueue
+     */
+    static getFactory(): IChannelFactory;
+    /**
+     * Constructs a new consensus queue. If the object is non-local an id and service interfaces will
+     * be provided
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+}
+
+/**
+ * @internal
+ */
+export declare enum ConsensusResult {
+    Release = 0,
+    Complete = 1
+}
+
+/**
+ * Consensus Ordered Collection interface
+ *
+ * An consensus ordered collection is a distributed data structure, which
+ * holds a collection of JSON-able or handles, and has a
+ * deterministic add/remove order.
+ *
+ * @remarks
+ * The order the server receive the add/remove operation determines the
+ * order those operation are applied to the collection. Different clients
+ * issuing `add` or `acquire` operations at the same time will be sequenced.
+ * The order dictates which `add` is done first, thus determining the order
+ * in which it appears in the collection.  It also determines which client
+ * will get the first removed item, etc. All operations are asynchronous.
+ * A function `waitAndAcquire` is provided to wait for and remove an entry in the collection.
+ *
+ * As a client acquires an item, it processes it and then returns a value (via callback)
+ * indicating whether it has completed processing the item, or whether the item should be
+ * released back to the collection for another client to process.
+ *
+ * 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.
+ * @internal
+ */
+export declare 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>;
+}
+
+/**
+ * Events notifying about addition, acquisition, release and completion of items
+ * @internal
+ */
+export declare 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;
+}
+
+/**
+ * Consensus Ordered Collection channel factory interface
+ *
+ * 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 declare interface IConsensusOrderedCollectionFactory extends IChannelFactory {
+    load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusOrderedCollection>;
+    create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;
+}
+
+/**
+ * Ordered Collection interface
+ *
+ * Collection of objects that has deterministic add and remove ordering.
+ * Object implementing this interface can be used as the data backing
+ * for the ConsensusOrderedCollection
+ * @internal
+ */
+export declare interface IOrderedCollection<T = any> extends ISnapshotable<T> {
+    /**
+     * Adds a value to the collection
+     */
+    add(value: T): any;
+    /**
+     * Retrieves a value from the collection.
+     */
+    remove(): T;
+    /**
+     * Return the size of the collection
+     */
+    size(): number;
+}
+
+/**
+ * Interface for object that can be snapshoted
+ *
+ * TODO: move this to be use in other place
+ * TODO: currently input and output is not symmetrical, can they become symmetrical?
+ * @internal
+ */
+export declare interface ISnapshotable<T> {
+    asArray(): T[];
+    loadFrom(values: T[]): void;
+}
+
+/**
+ * Helper method to acquire and complete an item
+ * Should be used in test code only
+ * @internal
+ */
+export declare function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T>;
+
+export { }

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/ordered-collection";
-export declare const pkgVersion = "2.0.0-internal.7.2.2";
+export declare const pkgVersion = "2.0.0-internal.7.4.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/{packageVersion.js → packageVersion.mjs}

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/ordered-collection";
-export const pkgVersion = "2.0.0-internal.7.2.2";
-//# sourceMappingURL=packageVersion.js.map
+export const pkgVersion = "2.0.0-internal.7.4.0";
+//# sourceMappingURL=packageVersion.mjs.map

package/lib/packageVersion.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.mjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,oCAAoC,CAAC;AAC5D,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,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/ordered-collection\";\nexport const pkgVersion = \"2.0.0-internal.7.4.0\";\n"]}

package/lib/{snapshotableArray.js → snapshotableArray.mjs}

@@ -19,4 +19,4 @@ export class SnapshotableArray extends Array {
         return this.data.length;
     }
 }
-//# sourceMappingURL=snapshotableArray.js.map
+//# sourceMappingURL=snapshotableArray.mjs.map

package/lib/snapshotableArray.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotableArray.mjs","sourceRoot":"","sources":["../src/snapshotableArray.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,MAAM,EAAE,MAAM,4BAA4B;AAEnD,MAAM,OAAO,iBAAqB,SAAQ,KAAK;IAA/C;;QACW,SAAI,GAAQ,EAAE,CAAC;IAc1B,CAAC;IAZO,OAAO;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAS;QAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAC3F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAEM,IAAI;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\n\nexport class SnapshotableArray<T> extends Array {\n\tprotected data: T[] = [];\n\n\tpublic asArray() {\n\t\treturn this.data;\n\t}\n\n\tpublic async loadFrom(from: T[]): Promise<void> {\n\t\tassert(this.data.length === 0, 0x06b /* \"Loading snapshot into a non-empty collection\" */);\n\t\tthis.data = from;\n\t}\n\n\tpublic size(): number {\n\t\treturn this.data.length;\n\t}\n}\n"]}

package/lib/testUtils.d.ts

@@ -2,15 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IConsensusOrderedCollection } from "./interfaces";
+import { IConsensusOrderedCollection } from "./interfaces.mjs";
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
 export declare function acquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T | undefined>;
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
 export declare function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T>;
 //# sourceMappingURL=testUtils.d.ts.map

package/lib/testUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAmB,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE5E;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACzC,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAOxB;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAC7C,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,CAAC,CAOZ"}
+{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAmB,2BAA2B,EAAE;AAEvD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACzC,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAOxB;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAC7C,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,CAAC,CAOZ"}

package/lib/{testUtils.js → testUtils.mjs}

@@ -2,10 +2,11 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ConsensusResult } from "./interfaces";
+import { ConsensusResult } from "./interfaces.mjs";
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
 export async function acquireAndComplete(collection) {
     let res;
@@ -18,6 +19,7 @@ export async function acquireAndComplete(collection) {
 /**
  * Helper method to acquire and complete an item
  * Should be used in test code only
+ * @internal
  */
 export async function waitAcquireAndComplete(collection) {
     let res;
@@ -27,4 +29,4 @@ export async function waitAcquireAndComplete(collection) {
     });
     return res;
 }
-//# sourceMappingURL=testUtils.js.map
+//# sourceMappingURL=testUtils.mjs.map

package/lib/testUtils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.mjs","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,eAAe,EAA+B;AAEvD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,UAA0C;IAE1C,IAAI,GAAkB,CAAC;IACvB,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAQ,EAAE,EAAE;QAC3C,GAAG,GAAG,KAAK,CAAC;QACZ,OAAO,eAAe,CAAC,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC3C,UAA0C;IAE1C,IAAI,GAAkB,CAAC;IACvB,MAAM,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,KAAQ,EAAE,EAAE;QAClD,GAAG,GAAG,KAAK,CAAC;QACZ,OAAO,eAAe,CAAC,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,OAAO,GAAQ,CAAC;AACjB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ConsensusResult, IConsensusOrderedCollection } from \"./interfaces\";\n\n/**\n * Helper method to acquire and complete an item\n * Should be used in test code only\n * @internal\n */\nexport async function acquireAndComplete<T>(\n\tcollection: IConsensusOrderedCollection<T>,\n): Promise<T | undefined> {\n\tlet res: T | undefined;\n\tawait collection.acquire(async (value: T) => {\n\t\tres = value;\n\t\treturn ConsensusResult.Complete;\n\t});\n\treturn res;\n}\n\n/**\n * Helper method to acquire and complete an item\n * Should be used in test code only\n * @internal\n */\nexport async function waitAcquireAndComplete<T>(\n\tcollection: IConsensusOrderedCollection<T>,\n): Promise<T> {\n\tlet res: T | undefined;\n\tawait collection.waitAndAcquire(async (value: T) => {\n\t\tres = value;\n\t\treturn ConsensusResult.Complete;\n\t});\n\treturn res as T;\n}\n"]}