@fluidframework/matrix 2.0.0-dev.6.4.0.191515 → 2.0.0-dev.7.2.0.203917

package/dist/matrix-public.d.ts

@@ -0,0 +1,143 @@
+import { IChannel } from '@fluidframework/datastore-definitions';
+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 { IJSONSegment } from '@fluidframework/merge-tree';
+import { IMatrixConsumer } from '@tiny-calc/nano';
+import { IMatrixProducer } from '@tiny-calc/nano';
+import { IMatrixReader } from '@tiny-calc/nano';
+import { IMatrixWriter } from '@tiny-calc/nano';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { Serializable } from '@fluidframework/datastore-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+import { SummarySerializer } from '@fluidframework/shared-object-base';
+
+export declare interface IRevertible {
+    revert(): any;
+    discard(): any;
+}
+
+export declare interface IUndoConsumer {
+    pushToCurrentOperation(revertible: IRevertible): any;
+}
+
+/**
+ * A matrix cell value may be undefined (indicating an empty cell) or any serializable type,
+ * excluding null.  (However, nulls may be embedded inside objects and arrays.)
+ */
+export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
+
+/**
+ * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
+ * include setting values and inserting/removing rows and columns.
+ *
+ * Matrix values may be any Fluid serializable type, which is the set of JSON
+ * serializable types extended to include IFluidHandles.
+ *
+ * Fluid's SharedMatrix implementation works equally well for dense and sparse
+ * matrix data and physically stores data in Z-order to leverage CPU caches and
+ * prefetching when reading in either row or column major order.  (See README.md
+ * for more details.)
+ *
+ * @public
+ */
+export declare class SharedMatrix<T = any> extends SharedObject implements IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
+    id: string;
+    private readonly consumers;
+    static getFactory(): SharedMatrixFactory;
+    private readonly rows;
+    private readonly cols;
+    private cells;
+    private pending;
+    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
+    private undo?;
+    /**
+     * Subscribes the given IUndoConsumer to the matrix.
+     */
+    openUndo(consumer: IUndoConsumer): void;
+    private get rowHandles();
+    private get colHandles();
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
+    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedMatrix<T>;
+    openMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): IMatrixReader<MatrixItem<T>>;
+    closeMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): void;
+    get rowCount(): number;
+    get colCount(): number;
+    getCell(row: number, col: number): MatrixItem<T>;
+    get matrixProducer(): IMatrixProducer<MatrixItem<T>>;
+    setCell(row: number, col: number, value: MatrixItem<T>): void;
+    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
+    private setCellCore;
+    private sendSetCellOp;
+    private submitVectorMessage;
+    private submitColMessage;
+    insertCols(colStart: number, count: number): void;
+    removeCols(colStart: number, count: number): void;
+    private submitRowMessage;
+    insertRows(rowStart: number, count: number): void;
+    removeRows(rowStart: number, count: number): void;
+    /* Excluded from this release type: _undoRemoveRows */
+    /* Excluded from this release type: _undoRemoveCols */
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * Runs serializer on the GC data for this SharedMatrix.
+     * All the IFluidHandle's stored in the cells represent routes to other objects.
+     */
+    protected processGCDataCore(serializer: SummarySerializer): void;
+    /**
+     * Advances the 'localSeq' counter for the cell data operation currently being queued.
+     *
+     * Do not use with 'submitColMessage()/submitRowMessage()' as these helpers + the MergeTree will
+     * automatically advance 'localSeq'.
+     */
+    private nextLocalSeq;
+    protected submitLocalMessage(message: any, localOpMetadata?: any): void;
+    protected didAttach(): void;
+    protected onConnect(): void;
+    private rebasePosition;
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected processCore(rawMessage: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private readonly onRowDelta;
+    private readonly onColDelta;
+    private readonly onRowHandlesRecycled;
+    private readonly onColHandlesRecycled;
+    /**
+     * Returns true if the latest pending write to the cell indicated by the given row/col handles
+     * matches the given 'localSeq'.
+     *
+     * A return value of `true` indicates that there are no later local operations queued that will
+     * clobber the write op at the given 'localSeq'.  This includes later ops that overwrite the cell
+     * with a different value as well as row/col removals that might recycled the given row/col handles.
+     */
+    private isLatestPendingWrite;
+    toString(): string;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(content: any): unknown;
+}
+
+export declare class SharedMatrixFactory implements IChannelFactory {
+    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<IChannel>;
+    create(document: IFluidDataStoreRuntime, id: string): IChannel;
+}
+
+export { }

package/dist/matrix-untrimmed.d.ts

@@ -0,0 +1,143 @@
+import { IChannel } from '@fluidframework/datastore-definitions';
+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 { IJSONSegment } from '@fluidframework/merge-tree';
+import { IMatrixConsumer } from '@tiny-calc/nano';
+import { IMatrixProducer } from '@tiny-calc/nano';
+import { IMatrixReader } from '@tiny-calc/nano';
+import { IMatrixWriter } from '@tiny-calc/nano';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { Serializable } from '@fluidframework/datastore-definitions';
+import { SharedObject } from '@fluidframework/shared-object-base';
+import { SummarySerializer } from '@fluidframework/shared-object-base';
+
+export declare interface IRevertible {
+    revert(): any;
+    discard(): any;
+}
+
+export declare interface IUndoConsumer {
+    pushToCurrentOperation(revertible: IRevertible): any;
+}
+
+/**
+ * A matrix cell value may be undefined (indicating an empty cell) or any serializable type,
+ * excluding null.  (However, nulls may be embedded inside objects and arrays.)
+ */
+export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
+
+/**
+ * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
+ * include setting values and inserting/removing rows and columns.
+ *
+ * Matrix values may be any Fluid serializable type, which is the set of JSON
+ * serializable types extended to include IFluidHandles.
+ *
+ * Fluid's SharedMatrix implementation works equally well for dense and sparse
+ * matrix data and physically stores data in Z-order to leverage CPU caches and
+ * prefetching when reading in either row or column major order.  (See README.md
+ * for more details.)
+ *
+ * @public
+ */
+export declare class SharedMatrix<T = any> extends SharedObject implements IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
+    id: string;
+    private readonly consumers;
+    static getFactory(): SharedMatrixFactory;
+    private readonly rows;
+    private readonly cols;
+    private cells;
+    private pending;
+    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
+    private undo?;
+    /**
+     * Subscribes the given IUndoConsumer to the matrix.
+     */
+    openUndo(consumer: IUndoConsumer): void;
+    private get rowHandles();
+    private get colHandles();
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
+    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedMatrix<T>;
+    openMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): IMatrixReader<MatrixItem<T>>;
+    closeMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): void;
+    get rowCount(): number;
+    get colCount(): number;
+    getCell(row: number, col: number): MatrixItem<T>;
+    get matrixProducer(): IMatrixProducer<MatrixItem<T>>;
+    setCell(row: number, col: number, value: MatrixItem<T>): void;
+    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
+    private setCellCore;
+    private sendSetCellOp;
+    private submitVectorMessage;
+    private submitColMessage;
+    insertCols(colStart: number, count: number): void;
+    removeCols(colStart: number, count: number): void;
+    private submitRowMessage;
+    insertRows(rowStart: number, count: number): void;
+    removeRows(rowStart: number, count: number): void;
+    /** @internal */ _undoRemoveRows(rowStart: number, spec: IJSONSegment): void;
+    /** @internal */ _undoRemoveCols(colStart: number, spec: IJSONSegment): void;
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * Runs serializer on the GC data for this SharedMatrix.
+     * All the IFluidHandle's stored in the cells represent routes to other objects.
+     */
+    protected processGCDataCore(serializer: SummarySerializer): void;
+    /**
+     * Advances the 'localSeq' counter for the cell data operation currently being queued.
+     *
+     * Do not use with 'submitColMessage()/submitRowMessage()' as these helpers + the MergeTree will
+     * automatically advance 'localSeq'.
+     */
+    private nextLocalSeq;
+    protected submitLocalMessage(message: any, localOpMetadata?: any): void;
+    protected didAttach(): void;
+    protected onConnect(): void;
+    private rebasePosition;
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected processCore(rawMessage: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private readonly onRowDelta;
+    private readonly onColDelta;
+    private readonly onRowHandlesRecycled;
+    private readonly onColHandlesRecycled;
+    /**
+     * Returns true if the latest pending write to the cell indicated by the given row/col handles
+     * matches the given 'localSeq'.
+     *
+     * A return value of `true` indicates that there are no later local operations queued that will
+     * clobber the write op at the given 'localSeq'.  This includes later ops that overwrite the cell
+     * with a different value as well as row/col removals that might recycled the given row/col handles.
+     */
+    private isLatestPendingWrite;
+    toString(): string;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(content: any): unknown;
+}
+
+export declare class SharedMatrixFactory implements IChannelFactory {
+    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<IChannel>;
+    create(document: IFluidDataStoreRuntime, id: string): IChannel;
+}
+
+export { }

package/dist/matrix.d.ts

@@ -14,7 +14,7 @@ import { IUndoConsumer } from "./types";
  * A matrix cell value may be undefined (indicating an empty cell) or any serializable type,
  * excluding null.  (However, nulls may be embedded inside objects and arrays.)
  */
-export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
+export type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
 /**
  * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
  * include setting values and inserting/removing rows and columns.
@@ -26,6 +26,8 @@ export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
  * matrix data and physically stores data in Z-order to leverage CPU caches and
  * prefetching when reading in either row or column major order.  (See README.md
  * for more details.)
+ *
+ * @public
  */
 export declare class SharedMatrix<T = any> extends SharedObject implements IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
     id: string;

package/dist/matrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../src/matrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,YAAY,EACZ,kBAAkB,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACN,gBAAgB,EAGhB,YAAY,EACZ,iBAAiB,EACjB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAKN,YAAY,EACZ,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAIhD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAwBxC;;;GAGG;AAEH,oBAAY,UAAU,CAAC,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC;AAEvE;;;;;;;;;;;GAWG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,GAAG,CAChC,SAAQ,YACR,YACC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC9B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC5B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAgBrB,EAAE,EAAE,MAAM;IAdlB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6C;WAEzD,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IAEzC,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,OAAO,CAA+B;gBAG7C,OAAO,EAAE,sBAAsB,EACxB,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB;IAqB/B,OAAO,CAAC,IAAI,CAAC,CAAwB;IAErC;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,aAAa;IAWvC,OAAO,KAAK,UAAU,GAErB;IACD,OAAO,KAAK,UAAU,GAErB;IAED;;OAEG;WACW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAMpE,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAKlF,WAAW,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAQ3D,IAAW,QAAQ,WAElB;IACD,IAAW,QAAQ,WAElB;IAEM,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAqBvD,IAAW,cAAc,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAE1D;IAIM,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;IActD,QAAQ,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE;IAkCjC,OAAO,CAAC,WAAW;IAuBnB,OAAO,CAAC,aAAa;IAkCrB,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIjD,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIjD,gBAAgB,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAuB5E,gBAAgB,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAuB5E,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAiB5E;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAQzD;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAUpB,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG;IAoBhE,SAAS,CAAC,SAAS;IASnB,SAAS,CAAC,SAAS;IAWnB,OAAO,CAAC,cAAc;IAmBtB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAqD7D,SAAS,CAAC,YAAY;IAEtB;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAyBxD,SAAS,CAAC,WAAW,CACpB,UAAU,EAAE,yBAAyB,EACrC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IA+DzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAGF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAKnC;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAKnC;IAEF;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAiBrB,QAAQ;IAoBf;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CAiD/C"}
+{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../src/matrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,YAAY,EACZ,kBAAkB,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACN,gBAAgB,EAGhB,YAAY,EACZ,iBAAiB,EACjB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAKN,YAAY,EACZ,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAIhD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAwBxC;;;GAGG;AAEH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC;AAEvE;;;;;;;;;;;;;GAaG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,GAAG,CAChC,SAAQ,YACR,YACC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC9B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC5B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAgBrB,EAAE,EAAE,MAAM;IAdlB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6C;WAEzD,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IAEzC,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,OAAO,CAA+B;gBAG7C,OAAO,EAAE,sBAAsB,EACxB,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB;IAqB/B,OAAO,CAAC,IAAI,CAAC,CAAwB;IAErC;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,aAAa;IAWvC,OAAO,KAAK,UAAU,GAErB;IACD,OAAO,KAAK,UAAU,GAErB;IAED;;OAEG;WACW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAMpE,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAKlF,WAAW,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAQ3D,IAAW,QAAQ,WAElB;IACD,IAAW,QAAQ,WAElB;IAEM,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAqBvD,IAAW,cAAc,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAE1D;IAIM,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;IActD,QAAQ,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE;IAkCjC,OAAO,CAAC,WAAW;IAuBnB,OAAO,CAAC,aAAa;IAkCrB,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIjD,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIjD,gBAAgB,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAuB5E,gBAAgB,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAuB5E,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAiB5E;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAQzD;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAUpB,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG;IAoBhE,SAAS,CAAC,SAAS;IASnB,SAAS,CAAC,SAAS;IAWnB,OAAO,CAAC,cAAc;IAmBtB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAqD7D,SAAS,CAAC,YAAY;IAEtB;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAyBxD,SAAS,CAAC,WAAW,CACpB,UAAU,EAAE,yBAAyB,EACrC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IA+DzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAGF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAKnC;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAKnC;IAEF;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAiBrB,QAAQ;IAoBf;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;CA0D/C"}

package/dist/matrix.js

@@ -28,8 +28,13 @@ const undoprovider_1 = require("./undoprovider");
  * matrix data and physically stores data in Z-order to leverage CPU caches and
  * prefetching when reading in either row or column major order.  (See README.md
  * for more details.)
+ *
+ * @public
  */
 class SharedMatrix extends shared_object_base_1.SharedObject {
+    static getFactory() {
+        return new runtime_1.SharedMatrixFactory();
+    }
     constructor(runtime, id, attributes) {
         super(id, runtime, attributes, "fluid_matrix_");
         this.id = id;
@@ -60,11 +65,8 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
                 this.pending.clearCols(/* colStart: */ colHandle, /* colCount: */ 1);
             }
         };
-        this.rows = new permutationvector_1.PermutationVector("rows" /* rows */, this.logger, runtime, this.onRowDelta, this.onRowHandlesRecycled);
-        this.cols = new permutationvector_1.PermutationVector("cols" /* cols */, this.logger, runtime, this.onColDelta, this.onColHandlesRecycled);
-    }
-    static getFactory() {
-        return new runtime_1.SharedMatrixFactory();
+        this.rows = new permutationvector_1.PermutationVector("rows" /* SnapshotPath.rows */, this.logger, runtime, this.onRowDelta, this.onRowHandlesRecycled);
+        this.cols = new permutationvector_1.PermutationVector("cols" /* SnapshotPath.cols */, this.logger, runtime, this.onColDelta, this.onColHandlesRecycled);
     }
     /**
      * Subscribes the given IUndoConsumer to the matrix.
@@ -207,7 +209,7 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         }
     }
     submitColMessage(message) {
-        this.submitVectorMessage(this.cols, this.rows, "cols" /* cols */, message);
+        this.submitVectorMessage(this.cols, this.rows, "cols" /* SnapshotPath.cols */, message);
     }
     insertCols(colStart, count) {
         this.submitColMessage(this.cols.insert(colStart, count));
@@ -216,7 +218,7 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         this.submitColMessage(this.cols.remove(colStart, count));
     }
     submitRowMessage(message) {
-        this.submitVectorMessage(this.rows, this.cols, "rows" /* rows */, message);
+        this.submitVectorMessage(this.rows, this.cols, "rows" /* SnapshotPath.rows */, message);
     }
     insertRows(rowStart, count) {
         this.submitRowMessage(this.rows.insert(rowStart, count));
@@ -266,9 +268,9 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
     }
     summarizeCore(serializer) {
         const builder = new runtime_utils_1.SummaryTreeBuilder();
-        builder.addWithStats("rows" /* rows */, this.rows.summarize(this.runtime, this.handle, serializer));
-        builder.addWithStats("cols" /* cols */, this.cols.summarize(this.runtime, this.handle, serializer));
-        builder.addBlob("cells" /* cells */, serializer.stringify([this.cells.snapshot(), this.pending.snapshot()], this.handle));
+        builder.addWithStats("rows" /* SnapshotPath.rows */, this.rows.summarize(this.runtime, this.handle, serializer));
+        builder.addWithStats("cols" /* SnapshotPath.cols */, this.cols.summarize(this.runtime, this.handle, serializer));
+        builder.addBlob("cells" /* SnapshotPath.cells */, serializer.stringify([this.cells.snapshot(), this.pending.snapshot()], this.handle));
         return builder.getSummaryTree();
     }
     /**
@@ -328,10 +330,10 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
     }
     reSubmitCore(content, localOpMetadata) {
         switch (content.target) {
-            case "cols" /* cols */:
+            case "cols" /* SnapshotPath.cols */:
                 this.submitColMessage(this.cols.regeneratePendingOp(content, localOpMetadata));
                 break;
-            case "rows" /* rows */:
+            case "rows" /* SnapshotPath.rows */:
                 this.submitRowMessage(this.rows.regeneratePendingOp(content, localOpMetadata));
                 break;
             default: {
@@ -358,9 +360,9 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
      */
     async loadCore(storage) {
         try {
-            await this.rows.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "rows" /* rows */), this.serializer);
-            await this.cols.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "cols" /* cols */), this.serializer);
-            const [cellData, pendingCliSeqData] = await (0, serialization_1.deserializeBlob)(storage, "cells" /* cells */, this.serializer);
+            await this.rows.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "rows" /* SnapshotPath.rows */), this.serializer);
+            await this.cols.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, "cols" /* SnapshotPath.cols */), this.serializer);
+            const [cellData, pendingCliSeqData] = await (0, serialization_1.deserializeBlob)(storage, "cells" /* SnapshotPath.cells */, this.serializer);
             this.cells = sparsearray2d_1.SparseArray2D.load(cellData);
             this.pending = sparsearray2d_1.SparseArray2D.load(pendingCliSeqData);
         }
@@ -372,10 +374,10 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
         const msg = (0, shared_object_base_1.parseHandles)(rawMessage, this.serializer);
         const contents = msg.contents;
         switch (contents.target) {
-            case "cols" /* cols */:
+            case "cols" /* SnapshotPath.cols */:
                 this.cols.applyMsg(msg, local);
                 break;
-            case "rows" /* rows */:
+            case "rows" /* SnapshotPath.rows */:
                 this.rows.applyMsg(msg, local);
                 break;
             default: {
@@ -450,10 +452,12 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
     applyStashedOp(content) {
-        if (content.target === "cols" /* cols */ || content.target === "rows" /* rows */) {
-            const op = content;
-            const currentVector = content.target === "cols" /* cols */ ? this.cols : this.rows;
-            const oppositeVector = content.target === "cols" /* cols */ ? this.rows : this.cols;
+        const parsedContent = (0, shared_object_base_1.parseHandles)(content, this.serializer);
+        if (parsedContent.target === "cols" /* SnapshotPath.cols */ ||
+            parsedContent.target === "rows" /* SnapshotPath.rows */) {
+            const op = parsedContent;
+            const currentVector = parsedContent.target === "cols" /* SnapshotPath.cols */ ? this.cols : this.rows;
+            const oppositeVector = parsedContent.target === "cols" /* SnapshotPath.cols */ ? this.rows : this.cols;
             const metadata = currentVector.applyStashedOp(op);
             const localSeq = currentVector.getCollabWindow().localSeq;
             const oppositeWindow = oppositeVector.getCollabWindow();
@@ -462,8 +466,8 @@ class SharedMatrix extends shared_object_base_1.SharedObject {
             return metadata;
         }
         else {
-            (0, core_utils_1.assert)(content.type === ops_1.MatrixOp.set, 0x2da /* "Unknown SharedMatrix 'op' type." */);
-            const setOp = content;
+            (0, core_utils_1.assert)(parsedContent.type === ops_1.MatrixOp.set, 0x2da /* "Unknown SharedMatrix 'op' type." */);
+            const setOp = parsedContent;
             const rowHandle = this.rows.getAllocatedHandle(setOp.row);
             const colHandle = this.cols.getAllocatedHandle(setOp.col);
             const rowsRefSeq = this.rows.getCollabWindow().currentSeq;