@fluidframework/ordered-collection 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

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

@@ -1,228 +0,0 @@
-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);
-}
-
-/* Excluded from this release type: ConsensusQueueFactory */
-
-/**
- * @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/dist/ordered-collection-beta.d.ts

@@ -1,39 +0,0 @@
-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: ConsensusQueueFactory */
-
-/* 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: SharedObject */
-
-/* Excluded from this release type: waitAcquireAndComplete */
-
-export { }

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

@@ -1,39 +0,0 @@
-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: ConsensusQueueFactory */
-
-/* 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: SharedObject */
-
-/* Excluded from this release type: waitAcquireAndComplete */
-
-export { }

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

@@ -1,263 +0,0 @@
-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.
- * @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);
-}
-
-/**
- * The factory that defines the consensus queue
- *
- * @internal
- */
-export declare class ConsensusQueueFactory implements IConsensusOrderedCollectionFactory {
-    static Type: string;
-    static readonly Attributes: IChannelAttributes;
-    get type(): string;
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusOrderedCollection>;
-    create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;
-}
-
-/**
- * @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;
-}
-
-/**
- * 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
- * @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;
-}
-
-/**
- * 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 { }