@fluidframework/legacy-dds 2.50.0-345060

package/lib/array/sharedArray.d.ts

@@ -0,0 +1,175 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { Serializable, IChannelAttributes, IFluidDataStoreRuntime, IChannelFactory, IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import { SharedObject } from "@fluidframework/shared-object-base/internal";
+import type { ISharedArrayEvents, ISharedArray, ISharedArrayRevertible, SerializableTypeForSharedArray } from "./interfaces.js";
+/**
+ * Represents a shared array that allows communication between distributed clients.
+ *
+ * @internal
+ */
+export declare class SharedArrayClass<T extends SerializableTypeForSharedArray> extends SharedObject<ISharedArrayEvents> implements ISharedArray<T>, ISharedArrayRevertible {
+    /**
+     * Stores the data held by this shared array.
+     */
+    private sharedArray;
+    /**
+     * Stores a map of entryid to entries of the sharedArray. This is meant of search optimizations and
+     * so shouldn't be snapshotted.
+     * Note: This map needs to be updated only when the sharedArray is being deserialized and when new entries are
+     * being added. New entries are added upon insert ops and the second leg of the move op.
+     * As we don't delete the entries once created, deletion or move to another position needs no special
+     * handling for this data structure
+     */
+    private readonly idToEntryMap;
+    /**
+     * Create a new shared array
+     *
+     * @param runtime - data store runtime the new shared array belongs to
+     * @param id - optional name of the shared array
+     * @returns newly create shared array (but not attached yet)
+     */
+    static create<T extends SerializableTypeForSharedArray>(runtime: IFluidDataStoreRuntime, id?: string): SharedArrayClass<T>;
+    /**
+     * Get a factory for SharedArray to register with the data store.
+     *
+     * @returns a factory that creates and load SharedArray
+     */
+    static getFactory<T extends SerializableTypeForSharedArray>(): IChannelFactory;
+    /**
+     * Constructs a new shared array. If the object is non-local an id and service interfaces will
+     * be provided
+     *
+     * @param id - optional name of the shared array
+     * @param runtime - data store runtime the shared array belongs to
+     * @param attributes - represents the attributes of a channel/DDS.
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Method that returns the ordered list of the items held in the DDS at this point in time.
+     * Note: This is only a snapshot of the array
+     */
+    get(): readonly T[];
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    insertBulkAfter<TWrite>(ref: T | undefined, values: (Serializable<TWrite> & T)[]): void;
+    insert<TWrite>(index: number, value: Serializable<TWrite> & T): void;
+    private insertCore;
+    delete(index: number): void;
+    rearrangeToFront(values: T[]): void;
+    /**
+     * Moves the DDS entry from one index to another
+     *
+     * @param fromIndex - User index of the element to be moved
+     * @param toIndex - User index to which the element should move to
+     */
+    move(fromIndex: number, toIndex: number): void;
+    private moveCore;
+    /**
+     * Method used to do undo/redo operation for the given entry id. This method is
+     * used for undo/redo of only insert and delete operations. Move operation is NOT handled
+     * by this method
+     *
+     * @param entryId - Entry Id for which the the undo/redo operation is to be applied
+     */
+    toggle(entryId: string): void;
+    /**
+     * Method to do undo/redo of move operation. All entries of the same payload/value are stored
+     * in the same doubly linked skip list. This skip list is updated upon every move by adding the
+     * new location as a new entry in the skip list and update the isDeleted flag to indicate the new
+     * entry is the cuurent live location for the user.
+     *
+     * @param oldEntryId - EntryId of the last live entry
+     * @param newEntryId - EntryId of the to be live entry
+     */
+    toggleMove(oldEntryId: string, newEntryId: string): void;
+    /**
+     * Load share array from snapshot
+     *
+     * @param storage - the storage to get the snapshot from
+     * @returns - promise that resolved when the load is completed
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Callback on disconnect
+     */
+    protected onDisconnect(): void;
+    /**
+     * Tracks the doubly linked skip list for the given entry to identify local pending counter attribute.
+     * It signifies if a local pending operation exists for the payload/value being tracked in the skip list
+     *
+     * returns true if counterAttribute's count \> 0
+     * @param entryId - id for which counter attribute is to be tracked in chian.
+     * @param counterAttribute - flag or property name from SharedArrayEntry whose counter is to be tracked.
+     */
+    private isLocalPending;
+    private getEntryForId;
+    /**
+     * Process a shared array operation
+     *
+     * @param message - the message to prepare
+     * @param local - whether the message was sent by the local client
+     * @param _localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, _localOpMetadata: unknown): void;
+    private findInternalIndex;
+    private findInternalInsertionIndex;
+    private findInternalDeletionIndex;
+    private createAddEntry;
+    private addEntry;
+    private emitValueChangedEvent;
+    private emitRevertibleEvent;
+    private deleteCore;
+    private createMoveEntry;
+    /**
+     * Creates new entry of type SharedArrayEntry interface.
+     * @param entryId - id for which new entry is created
+     * @param value - value for the new entry
+     * @param prevEntryId - prevEntryId if exists to update the previous pointer of double ended linked list
+     */
+    private createNewEntry;
+    /**
+     * Unsets all local flags used by the DDS. This method can be used after reading from snapshott to ensure
+     * local flags are initialized for use by the DDS.
+     * @param entry - Entry for which the local flags have to be cleaned up
+     */
+    private unsetLocalFlags;
+    /**
+     * Returns the index of the first entry starting with startIndex that does not have the isAckPending flag
+     */
+    private getInternalInsertIndexByIgnoringLocalPendingInserts;
+    private handleInsertOp;
+    private findIndexOfEntryId;
+    private prepareToMakeEntryIdLive;
+    /**
+     * Method that returns the live entry.
+     * The shared array internally can store a skip list of all related entries which got created
+     * due to move operations for the same payload/value. However, all elements except for one element
+     * can have isDeleted flag as false indicating this is the live entry for the value.
+     * Current implementation ensures that the last element in the skip list of entries is the liveEntry/
+     * last live entry
+     *
+     * @param entryId - Entry id of any node in the skip list for the same payload/value
+     */
+    private getLiveEntry;
+    /**
+     * We track sequence of moves for a entry in the shared array using doubly linked skip list.
+     * This utility function helps us keep track of the current position of an entry.value by marking the entry
+     * at previous position deleted and appending the entry at the new position at the end of the double linked
+     * list for that entry.value.
+     */
+    private updateLiveEntry;
+    /**
+     * We track sequence of moves for a entry in the shared array using doubly linked skip list.
+     * This utility function helps to insert the new entry as dead entry and reconnecting the double linked list with
+     * existingEntry -\> deadeEntry(appended) -\> existing chain(if any).
+     */
+    private updateDeadEntry;
+    protected applyStashedOp(_content: unknown): void;
+}
+//# sourceMappingURL=sharedArray.d.ts.map

package/lib/array/sharedArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedArray.d.ts","sourceRoot":"","sources":["../../src/array/sharedArray.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACX,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EACX,yBAAyB,EAEzB,MAAM,6CAA6C,CAAC;AAErD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAG3E,OAAO,KAAK,EACX,kBAAkB,EAClB,YAAY,EACZ,sBAAsB,EACtB,8BAA8B,EAI9B,MAAM,iBAAiB,CAAC;AAczB;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,8BAA8B,CACrE,SAAQ,YAAY,CAAC,kBAAkB,CACvC,YAAW,YAAY,CAAC,CAAC,CAAC,EAAE,sBAAsB;IAElD;;OAEG;IACH,OAAO,CAAC,WAAW,CAAwB;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmC;IAEhE;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,8BAA8B,EAC5D,OAAO,EAAE,sBAAsB,EAC/B,EAAE,CAAC,EAAE,MAAM,GACT,gBAAgB,CAAC,CAAC,CAAC;IAItB;;;;OAIG;WACW,UAAU,CAAC,CAAC,SAAS,8BAA8B,KAAK,eAAe;IAIrF;;;;;;;OAOG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAO/B;;;OAGG;IACI,GAAG,IAAI,SAAS,CAAC,EAAE;IAI1B,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IA0CrE,eAAe,CAAC,MAAM,EAC5B,GAAG,EAAE,CAAC,GAAG,SAAS,EAClB,MAAM,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAClC,IAAI;IAsBA,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;IAO3E,OAAO,CAAC,UAAU;IAuBX,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IA2B3B,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI;IAwB1C;;;;;OAKG;IACI,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAuBrD,OAAO,CAAC,QAAQ;IAwBhB;;;;;;OAMG;IACI,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IA0BpC;;;;;;;;OAQG;IACI,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IA0B/D;;;;;OAKG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBxE;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAE9B;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAsCtB,OAAO,CAAC,aAAa;IAIrB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,gBAAgB,EAAE,OAAO,GACvB,IAAI;IAyGP,OAAO,CAAC,iBAAiB;IAoBzB,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,yBAAyB;IAIjC,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,QAAQ;IAahB,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,eAAe;IAoBvB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAiBtB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAMvB;;OAEG;IACH,OAAO,CAAC,mDAAmD;IAgB3D,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,wBAAwB;IAiBhC;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY;IAQpB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAevB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAiBvB,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;CAGjD"}