@fluid-experimental/sequence-deprecated 2.0.0-dev.2.2.0.111723

package/lib/sparsematrix.d.ts

@@ -0,0 +1,152 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { BaseSegment, IJSONSegment, ISegment, PropertySet } from "@fluidframework/merge-tree";
+import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices, IChannelFactory, Serializable, Jsonable } from "@fluidframework/datastore-definitions";
+import { SharedSegmentSequence, SubSequence } from "@fluidframework/sequence";
+import { ISharedObject } from "@fluidframework/shared-object-base";
+/**
+ * An empty segment that occupies 'cachedLength' positions.
+ * {@link SparseMatrix} uses `PaddingSegment` to "pad" a run of unoccupied cells.
+ *
+ * @deprecated `PaddingSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare class PaddingSegment extends BaseSegment {
+    static readonly typeString = "PaddingSegment";
+    static is(segment: ISegment): segment is PaddingSegment;
+    static fromJSONObject(spec: any): PaddingSegment | undefined;
+    readonly type = "PaddingSegment";
+    constructor(size: number);
+    toJSONObject(): {
+        pad: number;
+        props: PropertySet | undefined;
+    };
+    clone(start?: number, end?: number): PaddingSegment;
+    canAppend(segment: ISegment): boolean;
+    toString(): string;
+    append(segment: ISegment): void;
+    removeRange(start: number, end: number): boolean;
+    protected createSplitSegmentAt(pos: number): PaddingSegment;
+}
+/**
+ * @deprecated `SparseMatrixItem` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare type SparseMatrixItem = Serializable;
+/**
+ * @deprecated `RunSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare class RunSegment extends SubSequence<SparseMatrixItem> {
+    items: SparseMatrixItem[];
+    static readonly typeString = "RunSegment";
+    static is(segment: ISegment): segment is RunSegment;
+    static fromJSONObject(spec: any): RunSegment | undefined;
+    readonly type = "RunSegment";
+    private tags;
+    constructor(items: SparseMatrixItem[]);
+    clone(start?: number, end?: number): RunSegment;
+    append(segment: ISegment): this;
+    removeRange(start: number, end: number): boolean;
+    getTag(pos: number): any;
+    setTag(pos: number, tag: any): void;
+    protected createSplitSegmentAt(pos: number): RunSegment | undefined;
+}
+/**
+ * @deprecated `MatrixSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare type MatrixSegment = RunSegment | PaddingSegment;
+/**
+ * @deprecated `maxCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const maxCol = 2097152;
+/**
+ * @deprecated `maxCols` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const maxCols: number;
+/**
+ * @deprecated `maxRow` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const maxRow = 4294967295;
+/**
+ * @deprecated `maxRows` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const maxRows: number;
+/**
+ * @deprecated `maxCellPosition` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const maxCellPosition: number;
+/**
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare const rowColToPosition: (row: number, col: number) => number;
+/**
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare function positionToRowCol(position: number): {
+    row: number;
+    col: number;
+};
+/**
+ * @deprecated `SparseMatrix` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export declare class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
+    id: string;
+    /**
+     * Create a new sparse matrix
+     *
+     * @param runtime - data store runtime the new sparse matrix belongs to
+     * @param id - optional name of the sparse matrix
+     * @returns newly create sparse matrix (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SparseMatrix;
+    /**
+     * Get a factory for SharedMap to register with the data store.
+     *
+     * @returns a factory that creates and load SharedMap
+     */
+    static getFactory(): IChannelFactory;
+    constructor(document: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
+    get numRows(): number;
+    setItems(row: number, col: number, values: SparseMatrixItem[], props?: PropertySet): void;
+    getItem(row: number, col: number): Jsonable<string | number | boolean | IFluidHandle> | undefined;
+    getTag(row: number, col: number): any;
+    setTag(row: number, col: number, tag: any): void;
+    insertRows(row: number, numRows: number): void;
+    removeRows(row: number, numRows: number): void;
+    insertCols(col: number, numCols: number): void;
+    removeCols(col: number, numCols: number): void;
+    annotatePosition(row: number, col: number, props: PropertySet): void;
+    getPositionProperties(row: number, col: number): PropertySet | undefined;
+    private moveAsPadding;
+    private getSegment;
+}
+/**
+ * @deprecated `SparseMatrixFactory` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.
+ */
+export declare class SparseMatrixFactory implements IChannelFactory {
+    static Type: string;
+    static Attributes: IChannelAttributes;
+    static segmentFromSpec(spec: IJSONSegment): ISegment;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
+    create(document: IFluidDataStoreRuntime, id: string): ISharedObject;
+}
+//# sourceMappingURL=sparsematrix.d.ts.map

package/lib/sparsematrix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sparsematrix.d.ts","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,WAAW,EAEX,YAAY,EAEZ,QAAQ,EACR,WAAW,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,QAAQ,EACX,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAGnE;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC3C,gBAAuB,UAAU,oBAAoB;WACvC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,cAAc;WAGhD,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,oBAA6B;gBAErC,IAAI,EAAE,MAAM;IAKjB,YAAY;;;;IAIZ,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAM7B,SAAS,CAAC,OAAO,EAAE,QAAQ;IAI3B,QAAQ;IAIR,MAAM,CAAC,OAAO,EAAE,QAAQ;IAMxB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAK7C,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAO7C;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,YAAY,CAAC;AAE5C;;;GAGG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,gBAAgB,CAAC;IAmBtC,KAAK,EAAE,gBAAgB,EAAE;IAlB5C,gBAAuB,UAAU,gBAAgB;WACnC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,UAAU;WAG5C,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,gBAAyB;IAE7C,OAAO,CAAC,IAAI,CAAQ;gBAED,KAAK,EAAE,gBAAgB,EAAE;IAKrC,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAS7B,MAAM,CAAC,OAAO,EAAE,QAAQ;IAexB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKtC,MAAM,CAAC,GAAG,EAAE,MAAM;IAKlB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IAInC,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAa7C;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,MAAM,UAAW,CAAC;AAE/B;;;GAGG;AACF,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAkB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,gBAAgB,QAAS,MAAM,OAAO,MAAM,WAAwB,CAAC;AAElF;;;GAGG;AACJ,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM;;;EAIhD;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,qBAAqB,CAAC,aAAa,CAAC;IAqBb,EAAE,EAAE,MAAM;IApB/D;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;gBAI/B,QAAQ,EAAE,sBAAsB,EAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAI/F,IAAW,OAAO,WAEjB;IAEM,QAAQ,CACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,gBAAgB,EAAE,EAC1B,KAAK,CAAC,EAAE,WAAW;IAYhB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAEnC,QAAQ,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,CAAC,GAAG,SAAS;IAa3D,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAS/B,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IASzC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAWvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAK7D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAOrD,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,UAAU;CAIrB;AAED;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACvD,OAAc,IAAI,SAA+D;IAEjF,OAAc,UAAU,EAAE,kBAAkB,CAI1C;WAEY,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ;IAc3D,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC/B,OAAO,CAAC,aAAa,CAAC;IAMlB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa;CAK7E"}

package/lib/sparsematrix.js

@@ -0,0 +1,336 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/common-utils";
+import { BaseSegment, createGroupOp, } from "@fluidframework/merge-tree";
+import { SharedSegmentSequence, SubSequence } from "@fluidframework/sequence";
+import { pkgVersion } from "./packageVersion";
+/**
+ * An empty segment that occupies 'cachedLength' positions.
+ * {@link SparseMatrix} uses `PaddingSegment` to "pad" a run of unoccupied cells.
+ *
+ * @deprecated `PaddingSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export class PaddingSegment extends BaseSegment {
+    constructor(size) {
+        super();
+        this.type = PaddingSegment.typeString;
+        this.cachedLength = size;
+    }
+    static is(segment) {
+        return segment.type === PaddingSegment.typeString;
+    }
+    static fromJSONObject(spec) {
+        if (spec && typeof spec === "object" && "pad" in spec) {
+            const segment = new PaddingSegment(spec.pad);
+            if (spec.props) {
+                segment.addProperties(spec.props);
+            }
+            return segment;
+        }
+        return undefined;
+    }
+    toJSONObject() {
+        return { pad: this.cachedLength, props: this.properties };
+    }
+    clone(start = 0, end) {
+        const b = new PaddingSegment(this.cachedLength);
+        this.cloneInto(b);
+        return b;
+    }
+    canAppend(segment) {
+        return PaddingSegment.is(segment);
+    }
+    toString() {
+        return `[padding: ${this.cachedLength}]`;
+    }
+    append(segment) {
+        assert(PaddingSegment.is(segment), "can only append padding segment");
+        super.append(segment);
+    }
+    // Returns true if entire run removed
+    removeRange(start, end) {
+        this.cachedLength -= (end - start);
+        return (this.cachedLength === 0);
+    }
+    createSplitSegmentAt(pos) {
+        const leftLength = pos;
+        const rightLength = this.cachedLength - pos;
+        this.cachedLength = leftLength;
+        return new PaddingSegment(rightLength);
+    }
+}
+PaddingSegment.typeString = "PaddingSegment";
+/**
+ * @deprecated `RunSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export class RunSegment extends SubSequence {
+    constructor(items) {
+        super(items);
+        this.items = items;
+        this.type = RunSegment.typeString;
+        this.tags = new Array(items.length).fill(undefined);
+    }
+    static is(segment) {
+        return segment.type === RunSegment.typeString;
+    }
+    static fromJSONObject(spec) {
+        if (spec && typeof spec === "object" && "items" in spec) {
+            const segment = new RunSegment(spec.items);
+            if (spec.props) {
+                segment.addProperties(spec.props);
+            }
+            return segment;
+        }
+        return undefined;
+    }
+    clone(start = 0, end) {
+        const b = new RunSegment(this.items.slice(start, end));
+        if (this.tags) {
+            b.tags = this.tags.slice(start, end);
+        }
+        this.cloneInto(b);
+        return b;
+    }
+    append(segment) {
+        super.append(segment);
+        const asRun = segment;
+        if (asRun.tags) {
+            if (this.tags) {
+                this.tags.splice(this.items.length, 0, ...asRun.tags);
+            }
+        }
+        return this;
+    }
+    // TODO: retain removed items for undo
+    // returns true if entire run removed
+    removeRange(start, end) {
+        this.tags.splice(start, end - start);
+        return super.removeRange(start, end);
+    }
+    getTag(pos) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return this.tags[pos];
+    }
+    setTag(pos, tag) {
+        this.tags[pos] = tag;
+    }
+    createSplitSegmentAt(pos) {
+        if (pos > 0) {
+            const remainingItems = this.items.slice(pos);
+            this.items = this.items.slice(0, pos);
+            this.cachedLength = this.items.length;
+            const leafSegment = new RunSegment(remainingItems);
+            leafSegment.tags = this.tags.slice(pos);
+            this.tags.length = pos;
+            return leafSegment;
+        }
+    }
+}
+RunSegment.typeString = "RunSegment";
+/**
+ * @deprecated `maxCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const maxCol = 0x200000; // X128 Excel maximum of 16,384 columns
+/**
+ * @deprecated `maxCols` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const maxCols = maxCol + 1;
+/**
+ * @deprecated `maxRow` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const maxRow = 0xFFFFFFFF; // X4096 Excel maximum of 1,048,576 rows
+/**
+ * @deprecated `maxRows` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const maxRows = maxRow + 1;
+/**
+ * @deprecated `maxCellPosition` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const maxCellPosition = maxCol * maxRow;
+/**
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export const rowColToPosition = (row, col) => row * maxCols + col;
+/**
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export function positionToRowCol(position) {
+    const row = Math.floor(position / maxCols);
+    const col = position - (row * maxCols);
+    return { row, col };
+}
+/**
+ * @deprecated `SparseMatrix` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+ */
+export class SparseMatrix extends SharedSegmentSequence {
+    constructor(document, id, attributes) {
+        super(document, id, attributes, SparseMatrixFactory.segmentFromSpec);
+        this.id = id;
+    }
+    /**
+     * Create a new sparse matrix
+     *
+     * @param runtime - data store runtime the new sparse matrix belongs to
+     * @param id - optional name of the sparse matrix
+     * @returns newly create sparse matrix (but not attached yet)
+     */
+    static create(runtime, id) {
+        return runtime.createChannel(id, SparseMatrixFactory.Type);
+    }
+    /**
+     * Get a factory for SharedMap to register with the data store.
+     *
+     * @returns a factory that creates and load SharedMap
+     */
+    static getFactory() {
+        return new SparseMatrixFactory();
+    }
+    get numRows() {
+        return positionToRowCol(this.getLength()).row;
+    }
+    setItems(row, col, values, props) {
+        const start = rowColToPosition(row, col);
+        const end = start + values.length;
+        const segment = new RunSegment(values);
+        if (props) {
+            segment.addProperties(props);
+        }
+        this.replaceRange(start, end, segment);
+    }
+    getItem(row, col) {
+        const pos = rowColToPosition(row, col);
+        const { segment, offset } = this.getContainingSegment(pos);
+        if (segment && RunSegment.is(segment)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return segment.items[offset !== null && offset !== void 0 ? offset : 0];
+        }
+        else if (segment && PaddingSegment.is(segment)) {
+            return undefined;
+        }
+        throw new Error(`Unrecognized Segment type`);
+    }
+    getTag(row, col) {
+        const { segment, offset } = this.getSegment(row, col);
+        if (segment && RunSegment.is(segment)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return segment.getTag(offset !== null && offset !== void 0 ? offset : 0);
+        }
+        return undefined;
+    }
+    setTag(row, col, tag) {
+        const { segment, offset } = this.getSegment(row, col);
+        if (segment && RunSegment.is(segment)) {
+            segment.setTag(offset !== null && offset !== void 0 ? offset : 0, tag);
+        }
+        else if (tag !== undefined) {
+            throw new Error(`Must not attempt to set tags on '${segment === null || segment === void 0 ? void 0 : segment.constructor.name}'.`);
+        }
+    }
+    insertRows(row, numRows) {
+        const pos = rowColToPosition(row, 0);
+        const size = maxCols * numRows;
+        const segment = new PaddingSegment(size);
+        const insertOp = this.client.insertSegmentLocal(pos, segment);
+        if (insertOp) {
+            this.submitSequenceMessage(insertOp);
+        }
+    }
+    removeRows(row, numRows) {
+        const pos = rowColToPosition(row, 0);
+        const size = maxCols * numRows;
+        this.removeRange(pos, pos + size);
+    }
+    insertCols(col, numCols) {
+        this.moveAsPadding(maxCol - numCols, col, numCols);
+    }
+    removeCols(col, numCols) {
+        this.moveAsPadding(col, maxCol - numCols, numCols);
+    }
+    annotatePosition(row, col, props) {
+        const pos = rowColToPosition(row, col);
+        this.annotateRange(pos, pos + 1, props);
+    }
+    getPositionProperties(row, col) {
+        const pos = rowColToPosition(row, col);
+        return this.getPropertiesAtPosition(pos);
+    }
+    // For each row, moves 'numCols' items starting from 'srcCol' and inserts 'numCols' padding
+    // at 'destCol'.  Used by insertCols and removeCols.
+    moveAsPadding(srcCol, destCol, numCols) {
+        const removeColStart = srcCol;
+        const removeColEnd = srcCol + numCols;
+        const ops = [];
+        for (let r = 0, rowStart = 0; r < this.numRows; r++, rowStart += maxCols) {
+            const removeMsg = this.client.removeRangeLocal(rowStart + removeColStart, rowStart + removeColEnd);
+            if (removeMsg) {
+                ops.push(removeMsg);
+            }
+            const insertPos = rowStart + destCol;
+            const segment = new PaddingSegment(numCols);
+            const insertMsg = this.client.insertSegmentLocal(insertPos, segment);
+            if (insertMsg) {
+                ops.push(insertMsg);
+            }
+        }
+        this.submitSequenceMessage(createGroupOp(...ops));
+    }
+    getSegment(row, col) {
+        const pos = rowColToPosition(row, col);
+        return this.getContainingSegment(pos);
+    }
+}
+/**
+ * @deprecated `SparseMatrixFactory` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.
+ */
+export class SparseMatrixFactory {
+    static segmentFromSpec(spec) {
+        const maybePadding = PaddingSegment.fromJSONObject(spec);
+        if (maybePadding) {
+            return maybePadding;
+        }
+        const maybeRun = RunSegment.fromJSONObject(spec);
+        if (maybeRun) {
+            return maybeRun;
+        }
+        throw new Error(`Unrecognized IJSONObject: '${JSON.stringify(spec)}'`);
+    }
+    get type() {
+        return SparseMatrixFactory.Type;
+    }
+    get attributes() {
+        return SparseMatrixFactory.Attributes;
+    }
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    async load(runtime, id, services, attributes) {
+        const sharedObject = new SparseMatrix(runtime, id, attributes);
+        await sharedObject.load(services);
+        return sharedObject;
+    }
+    create(document, id) {
+        const sharedObject = new SparseMatrix(document, id, this.attributes);
+        sharedObject.initializeLocal();
+        return sharedObject;
+    }
+}
+SparseMatrixFactory.Type = "https://graph.microsoft.com/types/mergeTree/sparse-matrix";
+SparseMatrixFactory.Attributes = {
+    type: SparseMatrixFactory.Type,
+    snapshotFormatVersion: "0.1",
+    packageVersion: pkgVersion,
+};
+//# sourceMappingURL=sparsematrix.js.map

package/lib/sparsematrix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sparsematrix.js","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAEtD,OAAO,EACH,WAAW,EACX,aAAa,GAKhB,MAAM,4BAA4B,CAAC;AASpC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE9E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAiB3C,YAAY,IAAY;QACpB,KAAK,EAAE,CAAC;QAHI,SAAI,GAAG,cAAc,CAAC,UAAU,CAAC;QAI7C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAlBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAQM,YAAY;QACf,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,SAAS,CAAC,OAAiB;QAC9B,OAAO,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,QAAQ;QACX,OAAO,aAAa,IAAI,CAAC,YAAY,GAAG,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACtE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,YAAY,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,MAAM,UAAU,GAAG,GAAG,CAAC;QACvB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAE5C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;QAC/B,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;;AAxDsB,yBAAU,GAAG,gBAAgB,CAAC;AAiEzD;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,WAA6B;IAmBzD,YAAmB,KAAyB;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QADE,UAAK,GAAL,KAAK,CAAoB;QAJ5B,SAAI,GAAG,UAAU,CAAC,UAAU,CAAC;QAMzC,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IApBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,UAAU,CAAC;IAClD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE;YACrD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAUM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,IAAI,EAAE;YACX,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEtB,MAAM,KAAK,GAAG,OAAqB,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,EAAE;YACZ,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;aACzD;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,sCAAsC;IACtC,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC;QACrC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,GAAW;QACrB,+DAA+D;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAQ;QAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACzB,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,IAAI,GAAG,GAAG,CAAC,EAAE;YACT,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEtC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC;YACnD,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAEvB,OAAO,WAAW,CAAC;SACtB;IACL,CAAC;;AAzEsB,qBAAU,GAAG,YAAY,CAAC;AAkFrD;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAS,uCAAuC;AAE/E;;;GAGG;AACF,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC,CAAO,wCAAwC;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;AAElF;;;GAGG;AACJ,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,QAAQ,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAAoC;IAqBlE,YAAY,QAAgC,EAAS,EAAU,EAAE,UAA8B;QAC3F,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;QADpB,OAAE,GAAF,EAAE,CAAQ;IAE/D,CAAC;IAtBD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,CAAC,IAAI,CAAiB,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACrC,CAAC;IAMD,IAAW,OAAO;QACd,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC;IAClD,CAAC;IAEM,QAAQ,CACX,GAAW,EACX,GAAW,EACX,MAA0B,EAC1B,KAAmB;QAEnB,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,GAAW;QAGnC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACnC,+DAA+D;YAC/D,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,CAAC,CAAC,CAAC;SACrC;aAAM,IAAI,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAC9C,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACnC,+DAA+D;YAC/D,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,CAAC,CAAC,CAAC;SACtC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW,EAAE,GAAQ;QAC5C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACnC,OAAO,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,CAAC,EAAE,GAAG,CAAC,CAAC;SACpC;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,oCAAoC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC;SACtF;IACL,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,gBAAgB,CAAC,GAAW,EAAE,GAAW,EAAE,KAAkB;QAChE,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,qBAAqB,CAAC,GAAW,EAAE,GAAW;QACjD,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,2FAA2F;IAC3F,oDAAoD;IAC5C,aAAa,CAAC,MAAc,EAAE,OAAe,EAAE,OAAe;QAClE,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QACtC,MAAM,GAAG,GAAwB,EAAE,CAAC;QAEpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,IAAI,OAAO,EAAE;YACtE,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,GAAG,cAAc,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;YACnG,IAAI,SAAS,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACvB;YACD,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;YAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACrE,IAAI,SAAS,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACvB;SACJ;QAED,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,UAAU,CAAC,GAAW,EAAE,GAAW;QACvC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IASrB,MAAM,CAAC,eAAe,CAAC,IAAkB;QAC5C,MAAM,YAAY,GAAG,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,YAAY,EAAE;YACd,OAAO,YAAY,CAAC;SACvB;QAED,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,QAAQ,EAAE;YACV,OAAO,QAAQ,CAAC;SACnB;QAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,IAAW,IAAI;QACX,OAAO,mBAAmB,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,mBAAmB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/D,MAAM,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,YAAY,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACtD,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,YAAY,CAAC,eAAe,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC;IACxB,CAAC;;AAhDa,wBAAI,GAAG,2DAA2D,CAAC;AAEnE,8BAAU,GAAuB;IAC3C,IAAI,EAAE,mBAAmB,CAAC,IAAI;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    BaseSegment,\n    createGroupOp,\n    IJSONSegment,\n    IMergeTreeDeltaOp,\n    ISegment,\n    PropertySet,\n} from \"@fluidframework/merge-tree\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n    Serializable,\n    Jsonable,\n} from \"@fluidframework/datastore-definitions\";\nimport { SharedSegmentSequence, SubSequence } from \"@fluidframework/sequence\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * An empty segment that occupies 'cachedLength' positions.\n * {@link SparseMatrix} uses `PaddingSegment` to \"pad\" a run of unoccupied cells.\n *\n * @deprecated `PaddingSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class PaddingSegment extends BaseSegment {\n    public static readonly typeString = \"PaddingSegment\";\n    public static is(segment: ISegment): segment is PaddingSegment {\n        return segment.type === PaddingSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"pad\" in spec) {\n            const segment = new PaddingSegment(spec.pad);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = PaddingSegment.typeString;\n\n    constructor(size: number) {\n        super();\n        this.cachedLength = size;\n    }\n\n    public toJSONObject() {\n        return { pad: this.cachedLength, props: this.properties };\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new PaddingSegment(this.cachedLength);\n        this.cloneInto(b);\n        return b;\n    }\n\n    public canAppend(segment: ISegment) {\n        return PaddingSegment.is(segment);\n    }\n\n    public toString() {\n        return `[padding: ${this.cachedLength}]`;\n    }\n\n    public append(segment: ISegment) {\n        assert(PaddingSegment.is(segment), \"can only append padding segment\");\n        super.append(segment);\n    }\n\n    // Returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.cachedLength -= (end - start);\n        return (this.cachedLength === 0);\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        const leftLength = pos;\n        const rightLength = this.cachedLength - pos;\n\n        this.cachedLength = leftLength;\n        return new PaddingSegment(rightLength);\n    }\n}\n\n/**\n * @deprecated `SparseMatrixItem` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport type SparseMatrixItem = Serializable;\n\n/**\n * @deprecated `RunSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class RunSegment extends SubSequence<SparseMatrixItem> {\n    public static readonly typeString = \"RunSegment\";\n    public static is(segment: ISegment): segment is RunSegment {\n        return segment.type === RunSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"items\" in spec) {\n            const segment = new RunSegment(spec.items);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = RunSegment.typeString;\n\n    private tags: any[];\n\n    constructor(public items: SparseMatrixItem[]) {\n        super(items);\n        this.tags = new Array(items.length).fill(undefined);\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new RunSegment(this.items.slice(start, end));\n        if (this.tags) {\n            b.tags = this.tags.slice(start, end);\n        }\n        this.cloneInto(b);\n        return b;\n    }\n\n    public append(segment: ISegment) {\n        super.append(segment);\n\n        const asRun = segment as RunSegment;\n        if (asRun.tags) {\n            if (this.tags) {\n                this.tags.splice(this.items.length, 0, ...asRun.tags);\n            }\n        }\n\n        return this;\n    }\n\n    // TODO: retain removed items for undo\n    // returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.tags.splice(start, end - start);\n        return super.removeRange(start, end);\n    }\n\n    public getTag(pos: number) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return this.tags[pos];\n    }\n\n    public setTag(pos: number, tag: any) {\n        this.tags[pos] = tag;\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        if (pos > 0) {\n            const remainingItems = this.items.slice(pos);\n            this.items = this.items.slice(0, pos);\n            this.cachedLength = this.items.length;\n\n            const leafSegment = new RunSegment(remainingItems);\n            leafSegment.tags = this.tags.slice(pos);\n            this.tags.length = pos;\n\n            return leafSegment;\n        }\n    }\n}\n\n/**\n * @deprecated `MatrixSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport type MatrixSegment = RunSegment | PaddingSegment;\n\n/**\n * @deprecated `maxCol` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport const maxCol = 0x200000;         // X128 Excel maximum of 16,384 columns\n\n/**\n * @deprecated `maxCols` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\n export const maxCols = maxCol + 1;\n\n /**\n  * @deprecated `maxRow` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxRow = 0xFFFFFFFF;       // X4096 Excel maximum of 1,048,576 rows\n\n /**\n  * @deprecated `maxRows` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxRows = maxRow + 1;\n\n /**\n  * @deprecated `maxCellPosition` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxCellPosition = maxCol * maxRow;\n\n /**\n  * @deprecated `positionToRowCol` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const rowColToPosition = (row: number, col: number) => row * maxCols + col;\n\n /**\n  * @deprecated `positionToRowCol` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\nexport function positionToRowCol(position: number) {\n    const row = Math.floor(position / maxCols);\n    const col = position - (row * maxCols);\n    return { row, col };\n}\n\n/**\n * @deprecated `SparseMatrix` is an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {\n    /**\n     * Create a new sparse matrix\n     *\n     * @param runtime - data store runtime the new sparse matrix belongs to\n     * @param id - optional name of the sparse matrix\n     * @returns newly create sparse matrix (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, SparseMatrixFactory.Type) as SparseMatrix;\n    }\n\n    /**\n     * Get a factory for SharedMap to register with the data store.\n     *\n     * @returns a factory that creates and load SharedMap\n     */\n    public static getFactory(): IChannelFactory {\n        return new SparseMatrixFactory();\n    }\n\n    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {\n        super(document, id, attributes, SparseMatrixFactory.segmentFromSpec);\n    }\n\n    public get numRows() {\n        return positionToRowCol(this.getLength()).row;\n    }\n\n    public setItems(\n        row: number,\n        col: number,\n        values: SparseMatrixItem[],\n        props?: PropertySet,\n    ) {\n        const start = rowColToPosition(row, col);\n        const end = start + values.length;\n        const segment = new RunSegment(values);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        this.replaceRange(start, end, segment);\n    }\n\n    public getItem(row: number, col: number):\n        // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports\n        Jsonable<string | number | boolean | IFluidHandle> | undefined {\n        const pos = rowColToPosition(row, col);\n        const { segment, offset } = this.getContainingSegment(pos);\n        if (segment && RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.items[offset ?? 0];\n        } else if (segment && PaddingSegment.is(segment)) {\n            return undefined;\n        }\n\n        throw new Error(`Unrecognized Segment type`);\n    }\n\n    public getTag(row: number, col: number) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (segment && RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.getTag(offset ?? 0);\n        }\n        return undefined;\n    }\n\n    public setTag(row: number, col: number, tag: any) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (segment && RunSegment.is(segment)) {\n            segment.setTag(offset ?? 0, tag);\n        } else if (tag !== undefined) {\n            throw new Error(`Must not attempt to set tags on '${segment?.constructor.name}'.`);\n        }\n    }\n\n    public insertRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        const segment = new PaddingSegment(size);\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    public removeRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        this.removeRange(pos, pos + size);\n    }\n\n    public insertCols(col: number, numCols: number) {\n        this.moveAsPadding(maxCol - numCols, col, numCols);\n    }\n\n    public removeCols(col: number, numCols: number) {\n        this.moveAsPadding(col, maxCol - numCols, numCols);\n    }\n\n    public annotatePosition(row: number, col: number, props: PropertySet) {\n        const pos = rowColToPosition(row, col);\n        this.annotateRange(pos, pos + 1, props);\n    }\n\n    public getPositionProperties(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getPropertiesAtPosition(pos);\n    }\n\n    // For each row, moves 'numCols' items starting from 'srcCol' and inserts 'numCols' padding\n    // at 'destCol'.  Used by insertCols and removeCols.\n    private moveAsPadding(srcCol: number, destCol: number, numCols: number) {\n        const removeColStart = srcCol;\n        const removeColEnd = srcCol + numCols;\n        const ops: IMergeTreeDeltaOp[] = [];\n\n        for (let r = 0, rowStart = 0; r < this.numRows; r++, rowStart += maxCols) {\n            const removeMsg = this.client.removeRangeLocal(rowStart + removeColStart, rowStart + removeColEnd);\n            if (removeMsg) {\n                ops.push(removeMsg);\n            }\n            const insertPos = rowStart + destCol;\n            const segment = new PaddingSegment(numCols);\n            const insertMsg = this.client.insertSegmentLocal(insertPos, segment);\n            if (insertMsg) {\n                ops.push(insertMsg);\n            }\n        }\n\n        this.submitSequenceMessage(createGroupOp(...ops));\n    }\n\n    private getSegment(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getContainingSegment(pos);\n    }\n}\n\n/**\n * @deprecated `SparseMatrixFactory` is an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.\n */\nexport class SparseMatrixFactory implements IChannelFactory {\n    public static Type = \"https://graph.microsoft.com/types/mergeTree/sparse-matrix\";\n\n    public static Attributes: IChannelAttributes = {\n        type: SparseMatrixFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public static segmentFromSpec(spec: IJSONSegment): ISegment {\n        const maybePadding = PaddingSegment.fromJSONObject(spec);\n        if (maybePadding) {\n            return maybePadding;\n        }\n\n        const maybeRun = RunSegment.fromJSONObject(spec);\n        if (maybeRun) {\n            return maybeRun;\n        }\n\n        throw new Error(`Unrecognized IJSONObject: '${JSON.stringify(spec)}'`);\n    }\n\n    public get type() {\n        return SparseMatrixFactory.Type;\n    }\n\n    public get attributes() {\n        return SparseMatrixFactory.Attributes;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n    ): Promise<ISharedObject> {\n        const sharedObject = new SparseMatrix(runtime, id, attributes);\n        await sharedObject.load(services);\n        return sharedObject;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): ISharedObject {\n        const sharedObject = new SparseMatrix(document, id, this.attributes);\n        sharedObject.initializeLocal();\n        return sharedObject;\n    }\n}\n"]}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@fluid-experimental/sequence-deprecated",
+  "version": "2.0.0-dev.2.2.0.111723",
+  "description": "Deprecated distributed sequences",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "experimental/dds/sequence-deprecated"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "lint": "npm run eslint",
+    "lint:fix": "npm run eslint:fix",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:mocha": "mocha --recursive dist/test/**/*.spec.js -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  },
+  "nyc": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.ts",
+      "dist/test/**/*.js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.ts",
+      "dist/**/*.js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/merge-tree": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/sequence": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/shared-object-base": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0"
+  },
+  "devDependencies": {
+    "@fluid-experimental/sequence-deprecated-previous": "npm:@fluid-experimental/sequence-deprecated@2.0.0-internal.2.0.0",
+    "@fluid-internal/test-dds-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.6.0-109663",
+    "@fluidframework/eslint-config-fluid": "^1.2.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-dev.2.2.0.111723 <2.0.0-dev.3.0.0",
+    "@microsoft/api-extractor": "^7.22.2",
+    "@rushstack/eslint-config": "^2.5.1",
+    "@types/diff": "^3.5.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^14.18.0",
+    "concurrently": "^6.2.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.2",
+    "diff": "^3.5.0",
+    "eslint": "~8.6.0",
+    "mocha": "^10.0.0",
+    "nyc": "^15.0.0",
+    "rimraf": "^2.6.2",
+    "typescript": "~4.5.5"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "version": "2.0.0-internal.2.1.0",
+    "broken": {}
+  }
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { SharedNumberSequence } from "./sharedNumberSequence";
+export { SharedObjectSequence } from "./sharedObjectSequence";
+export {
+	MatrixSegment,
+	maxCellPosition,
+	maxCol,
+	maxCols,
+	maxRow,
+	maxRows,
+	PaddingSegment,
+	positionToRowCol,
+	rowColToPosition,
+	RunSegment,
+	SparseMatrix,
+	SparseMatrixFactory,
+	SparseMatrixItem,
+} from "./sparsematrix";