@fluidframework/matrix 2.0.0-rc.3.0.2 → 2.0.0-rc.4.0.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @fluidframework/matrix
 
+## 2.0.0-rc.4.0.0
+
+### Minor Changes
+
+-   Deprecated members of IFluidHandle are split off into new IFluidHandleInternal interface [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
+
+    Split IFluidHandle into two interfaces, `IFluidHandle` and `IFluidHandleInternal`.
+    Code depending on the previously deprecated members of IFluidHandle can access them by using `toFluidHandleInternal` from `@fluidframework/runtime-utils/legacy`.
+
+    External implementation of the `IFluidHandle` interface are not supported: this change makes the typing better convey this using the `ErasedType` pattern.
+    Any existing and previously working, and now broken, external implementations of `IFluidHandle` should still work at runtime, but will need some unsafe type casts to compile.
+    Such handle implementation may break in the future and thus should be replaced with use of handles produced by the Fluid Framework client packages.
+
+-   matrix: SharedMatrix class hidden [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
+
+    The `SharedMatrix` class has been hidden from the alpha API.
+    In its place:
+
+    -   The constant `SharedMatrix` is exposed as the entrypoint for `SharedMatrix` creation. See documentation on `ISharedObjectKind`.
+    -   The type `SharedMatrix` is aliased to `ISharedMatrix`, which contains matrix's public API. This API has no semantic changes from previous versions.
+
+    Additionally, `SharedMatrixFactory` has been deprecated. Rather than construct the factory directly, use `SharedMatrix.getFactory()` (e.g. for usage in `DataObject` registries).
+
+    This change is part of a larger effort to clean up the API surface of various DDSes we have to leak less implementation details. See e.g. #20030.
+    Most code which uses `SharedMatrix` should continue to function without changes.
+
 ## 2.0.0-rc.3.0.0
 
 ### Major Changes

package/api-report/matrix.api.md

@@ -8,22 +8,15 @@ 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 { IEvent } from '@fluidframework/core-interfaces';
 import { IEventProvider } from '@fluidframework/core-interfaces';
 import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
 import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { IJSONSegment } from '@fluidframework/merge-tree/internal';
-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 { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import type { ISharedObjectKind } from '@fluidframework/shared-object-base';
 import { Serializable } from '@fluidframework/datastore-definitions/internal';
-import { SharedObject } from '@fluidframework/shared-object-base/internal';
 
 // @alpha (undocumented)
 export interface IRevertible {
@@ -34,17 +27,15 @@ export interface IRevertible {
 }
 
 // @alpha (undocumented)
-export interface ISharedMatrix<T = any> extends IEventProvider<ISharedMatrixEvents<T>>, IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
-    // (undocumented)
+export interface ISharedMatrix<T = any> extends IEventProvider<ISharedMatrixEvents<T>>, IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>>, IChannel {
     insertCols(colStart: number, count: number): void;
-    // (undocumented)
     insertRows(rowStart: number, count: number): void;
-    // (undocumented)
+    isSetCellConflictResolutionPolicyFWW(): boolean;
     openUndo(consumer: IUndoConsumer): void;
-    // (undocumented)
     removeCols(colStart: number, count: number): void;
-    // (undocumented)
     removeRows(rowStart: number, count: number): void;
+    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
+    switchSetCellPolicy(): void;
 }
 
 // @alpha
@@ -62,67 +53,12 @@ export interface IUndoConsumer {
 export type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;
 
 // @alpha
-export class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEvents<T> & ISharedObjectEvents> implements ISharedMatrix<T> {
-    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes, _isSetCellConflictResolutionPolicyFWW?: boolean);
-    protected applyStashedOp(_content: unknown): void;
-    // (undocumented)
-    closeMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): void;
-    // (undocumented)
-    get colCount(): number;
-    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedMatrix<T>;
-    // (undocumented)
-    protected didAttach(): void;
-    // (undocumented)
-    getCell(row: number, col: number): MatrixItem<T>;
-    // (undocumented)
-    static getFactory(): SharedMatrixFactory;
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    insertCols(colStart: number, count: number): void;
-    // (undocumented)
-    insertRows(rowStart: number, count: number): void;
-    // (undocumented)
-    isSetCellConflictResolutionPolicyFWW(): boolean;
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    // (undocumented)
-    get matrixProducer(): IMatrixProducer<MatrixItem<T>>;
-    // (undocumented)
-    protected onConnect(): void;
-    // (undocumented)
-    protected onDisconnect(): void;
-    // (undocumented)
-    openMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): IMatrixReader<MatrixItem<T>>;
-    openUndo(consumer: IUndoConsumer): void;
-    // (undocumented)
-    protected processCore(msg: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    protected processGCDataCore(serializer: IFluidSerializer): void;
-    // (undocumented)
-    removeCols(colStart: number, count: number): void;
-    // (undocumented)
-    removeRows(rowStart: number, count: number): void;
-    // (undocumented)
-    protected reSubmitCore(incoming: unknown, localOpMetadata: unknown): void;
-    // (undocumented)
-    get rowCount(): number;
-    // (undocumented)
-    setCell(row: number, col: number, value: MatrixItem<T>): void;
-    // (undocumented)
-    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
-    // (undocumented)
-    protected submitLocalMessage(message: any, localOpMetadata?: any): void;
-    // (undocumented)
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    switchSetCellPolicy(): void;
-    // (undocumented)
-    toString(): string;
-    // (undocumented)
-    _undoRemoveCols(colStart: number, spec: IJSONSegment): void;
-    // (undocumented)
-    _undoRemoveRows(rowStart: number, spec: IJSONSegment): void;
-}
+export const SharedMatrix: ISharedObjectKind<ISharedMatrix>;
 
 // @alpha
+export type SharedMatrix<T = any> = ISharedMatrix<T>;
+
+// @alpha @deprecated
 export class SharedMatrixFactory implements IChannelFactory<ISharedMatrix> {
     // (undocumented)
     static readonly Attributes: IChannelAttributes;

package/dist/index.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { ISharedMatrixEvents, SharedMatrix, ISharedMatrix } from "./matrix.js";
+export { ISharedMatrixEvents, ISharedMatrix } from "./matrix.js";
 export { MatrixItem } from "./ops.js";
-export { SharedMatrixFactory } from "./runtime.js";
+export { SharedMatrixFactory, SharedMatrix } from "./runtime.js";
 export { IUndoConsumer, IRevertible } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAInD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAIjE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -4,9 +4,8 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedMatrixFactory = exports.SharedMatrix = void 0;
-var matrix_js_1 = require("./matrix.js");
-Object.defineProperty(exports, "SharedMatrix", { enumerable: true, get: function () { return matrix_js_1.SharedMatrix; } });
+exports.SharedMatrix = exports.SharedMatrixFactory = void 0;
 var runtime_js_1 = require("./runtime.js");
 Object.defineProperty(exports, "SharedMatrixFactory", { enumerable: true, get: function () { return runtime_js_1.SharedMatrixFactory; } });
+Object.defineProperty(exports, "SharedMatrix", { enumerable: true, get: function () { return runtime_js_1.SharedMatrix; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yCAA+E;AAAjD,yGAAA,YAAY,OAAA;AAE1C,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ISharedMatrixEvents, SharedMatrix, ISharedMatrix } from \"./matrix.js\";\nexport { MatrixItem } from \"./ops.js\";\nexport { SharedMatrixFactory } from \"./runtime.js\";\n\n// TODO: We temporarily duplicate these contracts from 'framework/undo-redo' to unblock development\n//       of SharedMatrix undo while we decide on the correct layering for undo.\nexport { IUndoConsumer, IRevertible } from \"./types.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,2CAAiE;AAAxD,iHAAA,mBAAmB,OAAA;AAAE,0GAAA,YAAY,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ISharedMatrixEvents, ISharedMatrix } from \"./matrix.js\";\nexport { MatrixItem } from \"./ops.js\";\nexport { SharedMatrixFactory, SharedMatrix } from \"./runtime.js\";\n\n// TODO: We temporarily duplicate these contracts from 'framework/undo-redo' to unblock development\n//       of SharedMatrix undo while we decide on the correct layering for undo.\nexport { IUndoConsumer, IRevertible } from \"./types.js\";\n"]}

package/dist/legacy.d.ts

@@ -9,7 +9,7 @@
  */
 
 export {
-	// alpha APIs
+	// @alpha APIs
 	IRevertible, 
 	ISharedMatrix, 
 	ISharedMatrixEvents, 

package/dist/matrix.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
-import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
+import { IEvent, IEventThisPlaceHolder, type IEventProvider } from "@fluidframework/core-interfaces";
+import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime, type IChannel } from "@fluidframework/datastore-definitions";
 import { IJSONSegment } from "@fluidframework/merge-tree/internal";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
@@ -11,7 +11,6 @@ import { IFluidSerializer, ISharedObjectEvents } from "@fluidframework/shared-ob
 import { SharedObject } from "@fluidframework/shared-object-base/internal";
 import { IMatrixConsumer, IMatrixProducer, IMatrixReader, IMatrixWriter } from "@tiny-calc/nano";
 import { MatrixItem } from "./ops.js";
-import { SharedMatrixFactory } from "./runtime.js";
 import { IUndoConsumer } from "./types.js";
 /**
  * Events emitted by Shared Matrix.
@@ -35,17 +34,76 @@ export interface ISharedMatrixEvents<T> extends IEvent {
      *
      * - `conflictingValue` - The value that this client tried to set in the cell and got ignored due to conflict.
      *
-     * - `target` - The {@link SharedMatrix} itself.
+     * - `target` - The {@link ISharedMatrix} itself.
      */
     (event: "conflict", listener: (row: number, col: number, currentValue: MatrixItem<T>, conflictingValue: MatrixItem<T>, target: IEventThisPlaceHolder) => void): void;
 }
 /** @alpha */
-export interface ISharedMatrix<T = any> extends IEventProvider<ISharedMatrixEvents<T>>, IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
+export interface ISharedMatrix<T = any> extends IEventProvider<ISharedMatrixEvents<T>>, IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>>, IChannel {
+    /**
+     * Inserts columns into the matrix.
+     * @param colStart - Index of the first column to insert.
+     * @param count - Number of columns to insert.
+     * @remarks
+     * Inserting 0 columns is a noop.
+     */
     insertCols(colStart: number, count: number): void;
+    /**
+     * Removes columns from the matrix.
+     * @param colStart - Index of the first column to remove.
+     * @param count - Number of columns to remove.
+     * @remarks
+     * Removing 0 columns is a noop.
+     */
     removeCols(colStart: number, count: number): void;
+    /**
+     * Inserts rows into the matrix.
+     * @param rowStart - Index of the first row to insert.
+     * @param count - Number of rows to insert.
+     * @remarks
+     * Inserting 0 rows is a noop.
+     */
     insertRows(rowStart: number, count: number): void;
+    /**
+     * Removes rows from the matrix.
+     * @param rowStart - Index of the first row to remove.
+     * @param count - Number of rows to remove.
+     * @remarks
+     * Removing 0 rows is a noop.
+     */
     removeRows(rowStart: number, count: number): void;
+    /**
+     * Sets a range of cells in the matrix.
+     * Cells are set in consecutive columns between `colStart` and `colStart + colCount - 1`.
+     * When `values` has larger size than `colCount`, the extra values are inserted in subsequent rows
+     * a la text-wrapping.
+     * @param rowStart - Index of the row to start setting cells.
+     * @param colStart - Index of the column to start setting cells.
+     * @param colCount - Number of columns to set before wrapping to subsequent rows (if `values` has more items)
+     * @param values - Values to insert.
+     * @remarks
+     * This is not currently more efficient than calling `setCell` for each cell.
+     */
+    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
+    /**
+     * Attach an {@link IUndoConsumer} to the matrix.
+     * @param consumer - Undo consumer which will receive revertibles from the matrix.
+     */
     openUndo(consumer: IUndoConsumer): void;
+    /**
+     * Whether the current conflict resolution policy is first-write win (FWW).
+     * See {@link ISharedMatrix.switchSetCellPolicy} for more details.
+     */
+    isSetCellConflictResolutionPolicyFWW(): boolean;
+    /**
+     * Change the conflict resolution policy for setCell operations to first-write win (FWW).
+     *
+     * This API only switches from LWW to FWW and not from FWW to LWW.
+     *
+     * @privateRemarks
+     * The next SetOp which is sent will communicate this policy to other clients.
+     */
+    switchSetCellPolicy(): void;
 }
 /**
  * A SharedMatrix holds a rectangular 2D array of values.  Supported operations
@@ -63,7 +121,6 @@ export interface ISharedMatrix<T = any> extends IEventProvider<ISharedMatrixEven
 export declare class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEvents<T> & ISharedObjectEvents> implements ISharedMatrix<T> {
     id: string;
     private readonly consumers;
-    static getFactory(): SharedMatrixFactory;
     /**
      * Note: this field only provides a lower-bound on the reference sequence numbers for in-flight ops.
      * The exact reason isn't understood, but some e2e tests suggest that the runtime may sometimes process
@@ -90,7 +147,7 @@ export declare class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEve
      * @param _isSetCellConflictResolutionPolicyFWW - Conflict resolution for Matrix set op is First Writer Win in case of
      * race condition. Client can still overwrite values in case of no race.
      */
-    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes, _isSetCellConflictResolutionPolicyFWW?: boolean);
+    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
     private undo?;
     /**
      * Subscribes the given IUndoConsumer to the matrix.
@@ -98,10 +155,6 @@ export declare class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEve
     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;
@@ -165,10 +218,6 @@ export declare class SharedMatrix<T = any> extends SharedObject<ISharedMatrixEve
     private readonly onColDelta;
     private readonly onRowHandlesRecycled;
     private readonly onColHandlesRecycled;
-    /**
-     * Api to switch Set Op policy from Last Writer Win to First Writer Win. It only switches from LWW to FWW
-     * and not from FWW to LWW. The next SetOp which is sent will communicate this policy to other clients.
-     */
     switchSetCellPolicy(): void;
     /**
      * Returns true if the latest pending write to the cell indicated by the given row/col handles

package/dist/matrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../src/matrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAEhG,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAGN,YAAY,EAMZ,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIjG,OAAO,EAEN,UAAU,EAKV,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGnD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAY3C;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,CAAE,SAAQ,MAAM;IACrD;;;;;;;;;;;;;;;;;;OAkBG;IACH,CACC,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,CACT,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,EAC3B,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,EAC/B,MAAM,EAAE,qBAAqB,KACzB,IAAI,GACP,IAAI,CAAC;CACR;AAUD,aAAa;AACb,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,CACrC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAC7C,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC9B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC5B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7B,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAElD,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;CACxC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,GAAG,CAChC,SAAQ,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CACjE,YAAW,aAAa,CAAC,CAAC,CAAC;IA0CnB,EAAE,EAAE,MAAM;IAxClB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6C;WAEzD,UAAU;IAIxB;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IAEzC,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IACvD,OAAO,CAAC,oBAAoB,CAAiD;IAE7E,OAAO,CAAC,sCAAsC,CAAS;IACvD,OAAO,CAAC,yBAAyB,CAAS;IAG1C,OAAO,CAAC,cAAc,CAAa;IAEnC;;;;;;;OAOG;gBAEF,OAAO,EAAE,sBAAsB,EACxB,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB,EAC9B,qCAAqC,CAAC,EAAE,OAAO;IA0BhD,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,oCAAoC;IAIpC,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;IAQtD,QAAQ,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE;IA6BjC,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,wBAAwB;IAchC,OAAO,CAAC,aAAa;IAqCrB;;;;;;;OAOG;IACH,OAAO,CAAC,wBAAwB;IAQhC,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAc1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAYjD,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAc1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAY1C,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAwB3D,KAAK,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAwBjE,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IA2B5E;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB;IAQxD;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAUpB,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG;IAkBhE,SAAS,CAAC,SAAS;IASnB,SAAS,CAAC,SAAS;IAWnB,OAAO,CAAC,cAAc;IAsBtB,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAiElE,SAAS,CAAC,YAAY;IAEtB;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IA8BxD;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAoB/B,SAAS,CAAC,WAAW,CACpB,GAAG,EAAE,yBAAyB,EAC9B,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAqIzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAGF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAMnC;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAMnC;IAEF;;;OAGG;IACI,mBAAmB;IAU1B;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAiBrB,QAAQ;IAoBf;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;CAiBjD"}
+{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../src/matrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,MAAM,EACN,qBAAqB,EACrB,KAAK,cAAc,EACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,KAAK,QAAQ,EACb,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAGN,YAAY,EAOZ,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIjG,OAAO,EAEN,UAAU,EAKV,MAAM,UAAU,CAAC;AAKlB,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAY3C;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,CAAE,SAAQ,MAAM;IACrD;;;;;;;;;;;;;;;;;;OAkBG;IACH,CACC,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,CACT,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,EAC3B,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,EAC/B,MAAM,EAAE,qBAAqB,KACzB,IAAI,GACP,IAAI,CAAC;CACR;AAUD,aAAa;AACb,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,CACrC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAC7C,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC9B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC5B,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAC5B,QAAQ;IACT;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAElD;;;;;;;;;;;OAWG;IACH,QAAQ,CACP,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,GAC9B,IAAI,CAAC;IAER;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAExC;;;OAGG;IACH,oCAAoC,IAAI,OAAO,CAAC;IAEhD;;;;;;;OAOG;IACH,mBAAmB,IAAI,IAAI,CAAC;CAC5B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,GAAG,CAChC,SAAQ,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CACjE,YAAW,aAAa,CAAC,CAAC,CAAC;IAsCnB,EAAE,EAAE,MAAM;IApClB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6C;IAEvE;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IAEzC,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IACvD,OAAO,CAAC,oBAAoB,CAAiD;IAE7E,OAAO,CAAC,sCAAsC,CAAS;IACvD,OAAO,CAAC,yBAAyB,CAAS;IAG1C,OAAO,CAAC,cAAc,CAAa;IAEnC;;;;;;;OAOG;gBAEF,OAAO,EAAE,sBAAsB,EACxB,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB;IAyB/B,OAAO,CAAC,IAAI,CAAC,CAAwB;IAErC;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,aAAa;IAWvC,OAAO,KAAK,UAAU,GAErB;IACD,OAAO,KAAK,UAAU,GAErB;IAID,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,oCAAoC;IAIpC,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;IAQtD,QAAQ,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE;IA6BjC,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,wBAAwB;IAchC,OAAO,CAAC,aAAa;IAqCrB;;;;;;;OAOG;IACH,OAAO,CAAC,wBAAwB;IAiBhC,OAAO,CAAC,mBAAmB;IAoC3B,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAc1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAYjD,OAAO,CAAC,gBAAgB;IAIjB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAc1C,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAY1C,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAwB3D,KAAK,CAAQ,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAwBjE,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IA2B5E;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB;IAQxD;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAUpB,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG;IAkBhE,SAAS,CAAC,SAAS;IASnB,SAAS,CAAC,SAAS;IAWnB,OAAO,CAAC,cAAc;IAsBtB,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAmElE,SAAS,CAAC,YAAY;IAEtB;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IA8BxD;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAoB/B,SAAS,CAAC,WAAW,CACpB,GAAG,EAAE,yBAAyB,EAC9B,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAqIzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAGF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAQzB;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAMnC;IAEF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAMnC;IAEK,mBAAmB;IAU1B;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAiBrB,QAAQ;IAoBf;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;CAiBjD"}

package/dist/matrix.js

@@ -18,7 +18,6 @@ const handletable_js_1 = require("./handletable.js");
 const ops_js_1 = require("./ops.js");
 const permutationvector_js_1 = require("./permutationvector.js");
 const range_js_1 = require("./range.js");
-const runtime_js_1 = require("./runtime.js");
 const serialization_js_1 = require("./serialization.js");
 const sparsearray2d_js_1 = require("./sparsearray2d.js");
 const undoprovider_js_1 = require("./undoprovider.js");
@@ -36,9 +35,6 @@ const undoprovider_js_1 = require("./undoprovider.js");
  * @alpha
  */
 class SharedMatrix extends internal_4.SharedObject {
-    static getFactory() {
-        return new runtime_js_1.SharedMatrixFactory();
-    }
     /**
      * Constructor for the Shared Matrix
      * @param runtime - DataStore runtime.
@@ -47,7 +43,7 @@ class SharedMatrix extends internal_4.SharedObject {
      * @param _isSetCellConflictResolutionPolicyFWW - Conflict resolution for Matrix set op is First Writer Win in case of
      * race condition. Client can still overwrite values in case of no race.
      */
-    constructor(runtime, id, attributes, _isSetCellConflictResolutionPolicyFWW) {
+    constructor(runtime, id, attributes) {
         super(id, runtime, attributes, "fluid_matrix_");
         this.id = id;
         this.consumers = new Set();
@@ -93,8 +89,7 @@ class SharedMatrix extends internal_4.SharedObject {
                 this.cellLastWriteTracker.clearCols(/* colStart: */ colHandle, /* colCount: */ 1);
             }
         };
-        this.setCellLwwToFwwPolicySwitchOpSeqNumber =
-            _isSetCellConflictResolutionPolicyFWW === true ? 0 : -1;
+        this.setCellLwwToFwwPolicySwitchOpSeqNumber = -1;
         const getMinInFlightRefSeq = () => this.inFlightRefSeqs.get(0);
         this.rows = new permutationvector_js_1.PermutationVector(ops_js_1.SnapshotPath.rows, this.logger, runtime, this.onRowDelta, this.onRowHandlesRecycled, getMinInFlightRefSeq);
         this.cols = new permutationvector_js_1.PermutationVector(ops_js_1.SnapshotPath.cols, this.logger, runtime, this.onColDelta, this.onColHandlesRecycled, getMinInFlightRefSeq);
@@ -113,12 +108,6 @@ class SharedMatrix extends internal_4.SharedObject {
     get colHandles() {
         return this.cols.handleCache;
     }
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    static create(runtime, id) {
-        return runtime.createChannel(id, runtime_js_1.SharedMatrixFactory.Type);
-    }
     // #region IMatrixProducer
     openMatrix(consumer) {
         this.consumers.add(consumer);
@@ -228,7 +217,7 @@ class SharedMatrix extends internal_4.SharedObject {
             localSeq,
             rowsRef,
             colsRef,
-            referenceSeqNumber: this.runtime.deltaManager.lastSequenceNumber,
+            referenceSeqNumber: this.deltaManager.lastSequenceNumber,
         };
         this.submitLocalMessage(op, metadata);
         this.pending.setCell(rowHandle, colHandle, localSeq);
@@ -242,11 +231,18 @@ class SharedMatrix extends internal_4.SharedObject {
      * @param callback - code that needs to protected against reentrancy.
      */
     protectAgainstReentrancy(callback) {
-        (0, internal_1.assert)(this.reentrantCount === 0, 0x85d /* reentrant code */);
+        if (this.reentrantCount !== 0) {
+            // Validate that applications don't submit edits in response to matrix change notifications. This is unsupported.
+            throw new internal_5.UsageError("Reentrancy detected in SharedMatrix.");
+        }
         this.reentrantCount++;
-        callback();
-        this.reentrantCount--;
-        (0, internal_1.assert)(this.reentrantCount === 0, 0x85e /* reentrant code on exit */);
+        try {
+            callback();
+        }
+        finally {
+            this.reentrantCount--;
+        }
+        (0, internal_1.assert)(this.reentrantCount === 0, 0x85e /* indicates a problem with the reentrancy tracking code. */);
     }
     submitVectorMessage(currentVector, oppositeVector, target, message) {
         // Ideally, we would have a single 'localSeq' counter that is shared between both PermutationVectors
@@ -403,7 +399,7 @@ class SharedMatrix extends internal_4.SharedObject {
         // TODO: Recommend moving this assertion into SharedObject
         //       (See https://github.com/microsoft/FluidFramework/issues/2559)
         (0, internal_1.assert)(this.isAttached() === true, 0x01d /* "Trying to submit message to runtime while detached!" */);
-        this.inFlightRefSeqs.push(this.runtime.deltaManager.lastSequenceNumber);
+        this.inFlightRefSeqs.push(this.deltaManager.lastSequenceNumber);
         super.submitLocalMessage(message, localOpMetadata);
         // Ensure that row/col 'localSeq' are synchronized (see 'nextLocalSeq()').
         (0, internal_1.assert)(this.rows.getCollabWindow().localSeq === this.cols.getCollabWindow().localSeq, 0x01e /* "Row and col collab window 'localSeq' desynchronized!" */);
@@ -469,10 +465,14 @@ class SharedMatrix extends internal_4.SharedObject {
         else {
             switch (content.target) {
                 case ops_js_1.SnapshotPath.cols:
-                    this.submitColMessage(this.cols.regeneratePendingOp(content, localOpMetadata));
+                    this.submitColMessage(this.cols.regeneratePendingOp(content, 
+                    // eslint-disable-next-line import/no-deprecated
+                    localOpMetadata));
                     break;
                 case ops_js_1.SnapshotPath.rows:
-                    this.submitRowMessage(this.rows.regeneratePendingOp(content, localOpMetadata));
+                    this.submitRowMessage(this.rows.regeneratePendingOp(content, 
+                    // eslint-disable-next-line import/no-deprecated
+                    localOpMetadata));
                     break;
                 default: {
                     (0, internal_1.unreachableCase)(content);
@@ -618,10 +618,6 @@ class SharedMatrix extends internal_4.SharedObject {
                 (0, internal_1.unreachableCase)(target, "unknown target");
         }
     }
-    /**
-     * Api to switch Set Op policy from Last Writer Win to First Writer Win. It only switches from LWW to FWW
-     * and not from FWW to LWW. The next SetOp which is sent will communicate this policy to other clients.
-     */
     switchSetCellPolicy() {
         if (this.setCellLwwToFwwPolicySwitchOpSeqNumber === -1) {
             if (this.isAttached()) {