@fluidframework/ordered-collection 2.0.0-internal.8.0.1 → 2.0.0-rc.1.0.0

package/lib/{interfaces.d.ts → interfaces.d.mts}

@@ -5,7 +5,7 @@
 import { IFluidDataStoreRuntime, IChannelServices, IChannelAttributes, IChannelFactory } from "@fluidframework/datastore-definitions";
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 /**
- * @internal
+ * @alpha
  */
 export declare enum ConsensusResult {
     Release = 0,
@@ -14,7 +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
+ * @alpha
  */
 export type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
 /**
@@ -30,7 +30,7 @@ export interface IConsensusOrderedCollectionFactory extends IChannelFactory {
 }
 /**
  * Events notifying about addition, acquisition, release and completion of items
- * @internal
+ * @alpha
  */
 export interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {
     /**
@@ -80,7 +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
+ * @alpha
  */
 export interface IConsensusOrderedCollection<T = any> extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
     /**
@@ -104,7 +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
+ * @alpha
  */
 export interface ISnapshotable<T> {
     asArray(): T[];
@@ -116,7 +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
+ * @alpha
  */
 export interface IOrderedCollection<T = any> extends ISnapshotable<T> {
     /**
@@ -132,4 +132,4 @@ export interface IOrderedCollection<T = any> extends ISnapshotable<T> {
      */
     size(): number;
 }
-//# sourceMappingURL=interfaces.d.ts.map
+//# sourceMappingURL=interfaces.d.mts.map

package/lib/interfaces.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.mts","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.mjs

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 /**
- * @internal
+ * @alpha
  */
 export var ConsensusResult;
 (function (ConsensusResult) {

package/lib/interfaces.mjs.map

@@ -1 +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"]}
+{"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 * @alpha\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 * @alpha\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 * @alpha\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 * @alpha\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 * @alpha\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 * @alpha\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.mts

@@ -0,0 +1,226 @@
+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 */
+
+/**
+ * Callback provided to acquire() and waitAndAcquire() methods.
+ * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
+ * @alpha
+ */
+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.
+ * @alpha
+ */
+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.
+ * @alpha
+ */
+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);
+}
+
+/**
+ * @alpha
+ */
+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.
+ * @alpha
+ */
+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
+ * @alpha
+ */
+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;
+}
+
+/* Excluded from this release type: IConsensusOrderedCollectionFactory */
+
+/**
+ * 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
+ * @alpha
+ */
+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?
+ * @alpha
+ */
+export declare interface ISnapshotable<T> {
+    asArray(): T[];
+    loadFrom(values: T[]): void;
+}
+
+/* Excluded from this release type: waitAcquireAndComplete */
+
+export { }

package/lib/{ordered-collection-beta.d.ts → ordered-collection-public.d.mts}

@@ -20,36 +20,16 @@ import { SharedObject } from '@fluidframework/shared-object-base';
 
 /* 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 → ordered-collection-untrimmed.d.mts}

@@ -20,7 +20,7 @@ export declare function acquireAndComplete<T>(collection: IConsensusOrderedColle
 /**
  * Callback provided to acquire() and waitAndAcquire() methods.
  * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
- * @internal
+ * @alpha
  */
 export declare type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
 
@@ -32,7 +32,7 @@ export declare type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult
  *
  * 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
+ * @alpha
  */
 export declare class ConsensusOrderedCollection<T = any> extends SharedObject<IConsensusOrderedCollectionEvents<T>> implements IConsensusOrderedCollection<T> {
     private readonly data;
@@ -84,7 +84,7 @@ export declare class ConsensusOrderedCollection<T = any> extends SharedObject<IC
  * Implementation of a consensus stack
  *
  * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
- * @internal
+ * @alpha
  */
 export declare class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {
     /**
@@ -109,7 +109,7 @@ export declare class ConsensusQueue<T = any> extends ConsensusOrderedCollection<
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare enum ConsensusResult {
     Release = 0,
@@ -139,7 +139,7 @@ export declare enum ConsensusResult {
  * 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
+ * @alpha
  */
 export declare interface IConsensusOrderedCollection<T = any> extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
     /**
@@ -161,7 +161,7 @@ export declare interface IConsensusOrderedCollection<T = any> extends ISharedObj
 
 /**
  * Events notifying about addition, acquisition, release and completion of items
- * @internal
+ * @alpha
  */
 export declare interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {
     /**
@@ -207,7 +207,7 @@ export declare interface IConsensusOrderedCollectionFactory extends IChannelFact
  * 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
+ * @alpha
  */
 export declare interface IOrderedCollection<T = any> extends ISnapshotable<T> {
     /**
@@ -229,7 +229,7 @@ export declare interface IOrderedCollection<T = any> extends ISnapshotable<T> {
  *
  * TODO: move this to be use in other place
  * TODO: currently input and output is not symmetrical, can they become symmetrical?
- * @internal
+ * @alpha
  */
 export declare interface ISnapshotable<T> {
     asArray(): T[];

package/lib/{packageVersion.d.ts → packageVersion.d.mts}

@@ -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.8.0.1";
-//# sourceMappingURL=packageVersion.d.ts.map
+export declare const pkgVersion = "2.0.0-rc.1.0.0";
+//# sourceMappingURL=packageVersion.d.mts.map

package/lib/packageVersion.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.mts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,mBAAmB,CAAC"}

package/lib/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.8.0.1";
+export const pkgVersion = "2.0.0-rc.1.0.0";
 //# sourceMappingURL=packageVersion.mjs.map

package/lib/packageVersion.mjs.map

@@ -1 +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.8.0.1\";\n"]}
+{"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,gBAAgB,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-rc.1.0.0\";\n"]}

package/lib/{snapshotableArray.d.ts → snapshotableArray.d.mts}

@@ -8,4 +8,4 @@ export declare class SnapshotableArray<T> extends Array {
     loadFrom(from: T[]): Promise<void>;
     size(): number;
 }
-//# sourceMappingURL=snapshotableArray.d.ts.map
+//# sourceMappingURL=snapshotableArray.d.mts.map

package/lib/snapshotableArray.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotableArray.d.mts","sourceRoot":"","sources":["../src/snapshotableArray.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,qBAAa,iBAAiB,CAAC,CAAC,CAAE,SAAQ,KAAK;IAC9C,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,CAAM;IAElB,OAAO;IAID,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxC,IAAI,IAAI,MAAM;CAGrB"}

package/lib/{testUtils.d.ts → testUtils.d.mts}

@@ -15,4 +15,4 @@ export declare function acquireAndComplete<T>(collection: IConsensusOrderedColle
  * @internal
  */
 export declare function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T>;
-//# sourceMappingURL=testUtils.d.ts.map
+//# sourceMappingURL=testUtils.d.mts.map

package/lib/testUtils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.d.mts","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"}