@fluidframework/cell 0.59.2000 → 0.59.3000-67119

package/dist/cell.js

@@ -151,13 +151,13 @@ class SharedCell extends shared_object_base_1.SharedObject {
      */
     summarizeCore(serializer) {
         const content = { value: this.data };
-        return shared_object_base_1.createSingleBlobSummary(snapshotFileName, serializer.stringify(content, this.handle));
+        return (0, shared_object_base_1.createSingleBlobSummary)(snapshotFileName, serializer.stringify(content, this.handle));
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      */
     async loadCore(storage) {
-        const content = await driver_utils_1.readAndParse(storage, snapshotFileName);
+        const content = await (0, driver_utils_1.readAndParse)(storage, snapshotFileName);
         this.data = this.decode(content);
     }
     /**
@@ -183,7 +183,7 @@ class SharedCell extends shared_object_base_1.SharedObject {
             // We are waiting for an ACK on our change to this cell - we will ignore all messages until we get it.
             if (local) {
                 const messageIdReceived = localOpMetadata;
-                common_utils_1.assert(messageIdReceived !== undefined && messageIdReceived <= this.messageId, 0x00c /* "messageId is incorrect from from the local client's ACK" */);
+                (0, common_utils_1.assert)(messageIdReceived !== undefined && messageIdReceived <= this.messageId, 0x00c /* "messageId is incorrect from from the local client's ACK" */);
                 // We got an ACK. Update messageIdObserved.
                 this.messageIdObserved = localOpMetadata;
             }

package/dist/cell.js.map

@@ -1 +1 @@
-{"version":3,"file":"cell.js","sourceRoot":"","sources":["../src/cell.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AACtD,+EAA8F;AAS9F,+DAA4D;AAC5D,2EAA6G;AAC7G,+CAA4C;AAsB5C,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,UAAoB,SAAQ,iCAAkC;IAsCvE;;;;;;OAMG;IACH,YAAY,EAAU,EAAE,OAA+B,EAAE,UAA8B;QACnF,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QApBnC;;;WAGG;QACK,cAAS,GAAW,CAAC,CAAC,CAAC;QAE/B;;;WAGG;QACK,sBAAiB,GAAW,CAAC,CAAC,CAAC;IAWvC,CAAC;IA7CD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,yBAAW,CAAC,IAAI,CAAe,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,yBAAW,EAAE,CAAC;IAC7B,CAAC;IA6BD;;OAEG;IACI,GAAG;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,KAAsB;QAC7B,mCAAmC;QACnC,MAAM,cAAc,GAAe;YAC/B,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;SACpD,CAAC;QAEF,yBAAyB;QACzB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEpB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,MAAM,EAAE,GAAsB;YAC1B,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,cAAc;SACxB,CAAC;QACF,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,MAAM;QACT,4BAA4B;QAC5B,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,MAAM,EAAE,GAAyB;YAC7B,IAAI,EAAE,YAAY;SACrB,CAAC;QACF,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK;QACR,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAe,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,4CAAuB,CAAC,gBAAgB,EAAE,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACjG,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,2BAAY,CAAa,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAE1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,mBAAmB;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,EAAE;YAC3C,sGAAsG;YACtG,IAAI,KAAK,EAAE;gBACP,MAAM,iBAAiB,GAAG,eAAyB,CAAC;gBACpD,qBAAM,CAAC,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EACzE,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAE3E,2CAA2C;gBAC3C,IAAI,CAAC,iBAAiB,GAAG,eAAyB,CAAC;aACtD;YACD,OAAO;SACV;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA0B,CAAC;YAE9C,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,SAAS;oBACV,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;oBACpC,MAAM;gBAEV,KAAK,YAAY;oBACb,IAAI,CAAC,UAAU,EAAE,CAAC;oBAClB,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAEO,OAAO,CAAC,KAAsB;QAClC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,UAAU;QACd,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,SAAqB;QAChC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;QAC9B,+DAA+D;QAC/D,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAES,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AAnMD,gCAmMC","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 { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n    Serializable,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CellFactory } from \"./cellFactory\";\nimport { ISharedCell, ISharedCellEvents } from \"./interfaces\";\n\n/**\n * Description of a cell delta operation\n */\ntype ICellOperation = ISetCellOperation | IDeleteCellOperation;\n\ninterface ISetCellOperation {\n    type: \"setCell\";\n    value: ICellValue;\n}\n\ninterface IDeleteCellOperation {\n    type: \"deleteCell\";\n}\n\ninterface ICellValue {\n    // The actual value contained in the cell which needs to be wrapped to handle undefined\n    value: any;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * The SharedCell distributed data structure can be used to store a single serializable value.\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCell`, call the static create method:\n *\n * ```typescript\n * const myCell = SharedCell.create(this.runtime, id);\n * ```\n *\n * ### Usage\n *\n * The value stored in the cell can be set with the `.set()` method and retrieved with the `.get()` method:\n *\n * ```typescript\n * myCell.set(3);\n * console.log(myCell.get()); // 3\n * ```\n *\n * The value must only be plain JS objects or `SharedObject` handles (e.g. to another DDS or Fluid object).\n * In collaborative scenarios, the value is settled with a policy of _last write wins_.\n *\n * The `.delete()` method will delete the stored value from the cell:\n *\n * ```typescript\n * myCell.delete();\n * console.log(myCell.get()); // undefined\n * ```\n *\n * The `.empty()` method will check if the value is undefined.\n *\n * ```typescript\n * if (myCell.empty()) {\n *   // myCell.get() will return undefined\n * } else {\n *   // myCell.get() will return a non-undefined value\n * }\n * ```\n *\n * ### Eventing\n *\n * `SharedCell` is an `EventEmitter`, and will emit events when other clients make modifications. You should\n * register for these events and respond appropriately as the data is modified. `valueChanged` will be emitted\n * in response to a `set`, and `delete` will be emitted in response to a `delete`.\n */\nexport class SharedCell<T = any> extends SharedObject<ISharedCellEvents<T>>\n    implements ISharedCell<T> {\n    /**\n     * Create a new shared cell\n     *\n     * @param runtime - data store runtime the new shared map belongs to\n     * @param id - optional name of the shared map\n     * @returns newly create shared map (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CellFactory.Type) as SharedCell;\n    }\n\n    /**\n     * Get a factory for SharedCell to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCell\n     */\n    public static getFactory(): IChannelFactory {\n        return new CellFactory();\n    }\n    /**\n     * The data held by this cell.\n     */\n    private data: Serializable<T> | undefined;\n\n    /**\n     * This is used to assign a unique id to outgoing messages. It is used to track messages until\n     * they are ack'd.\n     */\n    private messageId: number = -1;\n\n    /**\n     * This keeps track of the messageId of messages that have been ack'd. It is updated every time\n     * we a message is ack'd with it's messageId.\n     */\n    private messageIdObserved: number = -1;\n\n    /**\n     * Constructs a new shared cell. If the object is non-local an id and service interfaces will\n     * be provided\n     *\n     * @param runtime - data store runtime the shared map belongs to\n     * @param id - optional name of the shared map\n     */\n    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n        super(id, runtime, attributes);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.get}\n     */\n    public get(): Serializable<T> | undefined {\n        return this.data;\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.set}\n     */\n    public set(value: Serializable<T>) {\n        // Serialize the value if required.\n        const operationValue: ICellValue = {\n            value: this.serializer.encode(value, this.handle),\n        };\n\n        // Set the value locally.\n        this.setCore(value);\n\n        // If we are not attached, don't submit the op.\n        if (!this.isAttached()) {\n            return;\n        }\n\n        const op: ISetCellOperation = {\n            type: \"setCell\",\n            value: operationValue,\n        };\n        this.submitLocalMessage(op, ++this.messageId);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.delete}\n     */\n    public delete() {\n        // Delete the value locally.\n        this.deleteCore();\n\n        // If we are not attached, don't submit the op.\n        if (!this.isAttached()) {\n            return;\n        }\n\n        const op: IDeleteCellOperation = {\n            type: \"deleteCell\",\n        };\n        this.submitLocalMessage(op, ++this.messageId);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.empty}\n     */\n    public empty() {\n        return this.data === undefined;\n    }\n\n    /**\n     * Create a summary for the cell\n     *\n     * @returns the summary of the current state of the cell\n     */\n    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n        const content: ICellValue = { value: this.data };\n        return createSingleBlobSummary(snapshotFileName, serializer.stringify(content, this.handle));\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICellValue>(storage, snapshotFileName);\n\n        this.data = this.decode(content);\n    }\n\n    /**\n     * Initialize a local instance of cell\n     */\n    protected initializeLocalCore() {\n        this.data = undefined;\n    }\n\n    /**\n     * Call back on disconnect\n     */\n    protected onDisconnect() {}\n\n    /**\n     * Process a cell operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (this.messageId !== this.messageIdObserved) {\n            // We are waiting for an ACK on our change to this cell - we will ignore all messages until we get it.\n            if (local) {\n                const messageIdReceived = localOpMetadata as number;\n                assert(messageIdReceived !== undefined && messageIdReceived <= this.messageId,\n                    0x00c /* \"messageId is incorrect from from the local client's ACK\" */);\n\n                // We got an ACK. Update messageIdObserved.\n                this.messageIdObserved = localOpMetadata as number;\n            }\n            return;\n        }\n\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as ICellOperation;\n\n            switch (op.type) {\n                case \"setCell\":\n                    this.setCore(this.decode(op.value));\n                    break;\n\n                case \"deleteCell\":\n                    this.deleteCore();\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    private setCore(value: Serializable<T>) {\n        this.data = value;\n        this.emit(\"valueChanged\", value);\n    }\n\n    private deleteCore() {\n        this.data = undefined;\n        this.emit(\"delete\");\n    }\n\n    private decode(cellValue: ICellValue) {\n        const value = cellValue.value;\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return this.serializer.decode(value);\n    }\n\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}
+{"version":3,"file":"cell.js","sourceRoot":"","sources":["../src/cell.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AACtD,+EAA8F;AAS9F,+DAA4D;AAC5D,2EAA6G;AAC7G,+CAA4C;AAsB5C,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,UAAoB,SAAQ,iCAAkC;IAsCvE;;;;;;OAMG;IACH,YAAY,EAAU,EAAE,OAA+B,EAAE,UAA8B;QACnF,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QApBnC;;;WAGG;QACK,cAAS,GAAW,CAAC,CAAC,CAAC;QAE/B;;;WAGG;QACK,sBAAiB,GAAW,CAAC,CAAC,CAAC;IAWvC,CAAC;IA7CD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,yBAAW,CAAC,IAAI,CAAe,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,yBAAW,EAAE,CAAC;IAC7B,CAAC;IA6BD;;OAEG;IACI,GAAG;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,KAAsB;QAC7B,mCAAmC;QACnC,MAAM,cAAc,GAAe;YAC/B,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;SACpD,CAAC;QAEF,yBAAyB;QACzB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEpB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,MAAM,EAAE,GAAsB;YAC1B,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,cAAc;SACxB,CAAC;QACF,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,MAAM;QACT,4BAA4B;QAC5B,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,OAAO;SACV;QAED,MAAM,EAAE,GAAyB;YAC7B,IAAI,EAAE,YAAY;SACrB,CAAC;QACF,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK;QACR,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAe,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,IAAA,4CAAuB,EAAC,gBAAgB,EAAE,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACjG,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,IAAA,2BAAY,EAAa,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAE1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,mBAAmB;QACzB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,EAAE;YAC3C,sGAAsG;YACtG,IAAI,KAAK,EAAE;gBACP,MAAM,iBAAiB,GAAG,eAAyB,CAAC;gBACpD,IAAA,qBAAM,EAAC,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EACzE,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAE3E,2CAA2C;gBAC3C,IAAI,CAAC,iBAAiB,GAAG,eAAyB,CAAC;aACtD;YACD,OAAO;SACV;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA0B,CAAC;YAE9C,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,SAAS;oBACV,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;oBACpC,MAAM;gBAEV,KAAK,YAAY;oBACb,IAAI,CAAC,UAAU,EAAE,CAAC;oBAClB,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAEO,OAAO,CAAC,KAAsB;QAClC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,UAAU;QACd,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,SAAqB;QAChC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;QAC9B,+DAA+D;QAC/D,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAES,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AAnMD,gCAmMC","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 { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n    Serializable,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CellFactory } from \"./cellFactory\";\nimport { ISharedCell, ISharedCellEvents } from \"./interfaces\";\n\n/**\n * Description of a cell delta operation\n */\ntype ICellOperation = ISetCellOperation | IDeleteCellOperation;\n\ninterface ISetCellOperation {\n    type: \"setCell\";\n    value: ICellValue;\n}\n\ninterface IDeleteCellOperation {\n    type: \"deleteCell\";\n}\n\ninterface ICellValue {\n    // The actual value contained in the cell which needs to be wrapped to handle undefined\n    value: any;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * The SharedCell distributed data structure can be used to store a single serializable value.\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCell`, call the static create method:\n *\n * ```typescript\n * const myCell = SharedCell.create(this.runtime, id);\n * ```\n *\n * ### Usage\n *\n * The value stored in the cell can be set with the `.set()` method and retrieved with the `.get()` method:\n *\n * ```typescript\n * myCell.set(3);\n * console.log(myCell.get()); // 3\n * ```\n *\n * The value must only be plain JS objects or `SharedObject` handles (e.g. to another DDS or Fluid object).\n * In collaborative scenarios, the value is settled with a policy of _last write wins_.\n *\n * The `.delete()` method will delete the stored value from the cell:\n *\n * ```typescript\n * myCell.delete();\n * console.log(myCell.get()); // undefined\n * ```\n *\n * The `.empty()` method will check if the value is undefined.\n *\n * ```typescript\n * if (myCell.empty()) {\n *   // myCell.get() will return undefined\n * } else {\n *   // myCell.get() will return a non-undefined value\n * }\n * ```\n *\n * ### Eventing\n *\n * `SharedCell` is an `EventEmitter`, and will emit events when other clients make modifications. You should\n * register for these events and respond appropriately as the data is modified. `valueChanged` will be emitted\n * in response to a `set`, and `delete` will be emitted in response to a `delete`.\n */\nexport class SharedCell<T = any> extends SharedObject<ISharedCellEvents<T>>\n    implements ISharedCell<T> {\n    /**\n     * Create a new shared cell\n     *\n     * @param runtime - data store runtime the new shared map belongs to\n     * @param id - optional name of the shared map\n     * @returns newly create shared map (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CellFactory.Type) as SharedCell;\n    }\n\n    /**\n     * Get a factory for SharedCell to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCell\n     */\n    public static getFactory(): IChannelFactory {\n        return new CellFactory();\n    }\n    /**\n     * The data held by this cell.\n     */\n    private data: Serializable<T> | undefined;\n\n    /**\n     * This is used to assign a unique id to outgoing messages. It is used to track messages until\n     * they are ack'd.\n     */\n    private messageId: number = -1;\n\n    /**\n     * This keeps track of the messageId of messages that have been ack'd. It is updated every time\n     * we a message is ack'd with it's messageId.\n     */\n    private messageIdObserved: number = -1;\n\n    /**\n     * Constructs a new shared cell. If the object is non-local an id and service interfaces will\n     * be provided\n     *\n     * @param runtime - data store runtime the shared map belongs to\n     * @param id - optional name of the shared map\n     */\n    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n        super(id, runtime, attributes);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.get}\n     */\n    public get(): Serializable<T> | undefined {\n        return this.data;\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.set}\n     */\n    public set(value: Serializable<T>) {\n        // Serialize the value if required.\n        const operationValue: ICellValue = {\n            value: this.serializer.encode(value, this.handle),\n        };\n\n        // Set the value locally.\n        this.setCore(value);\n\n        // If we are not attached, don't submit the op.\n        if (!this.isAttached()) {\n            return;\n        }\n\n        const op: ISetCellOperation = {\n            type: \"setCell\",\n            value: operationValue,\n        };\n        this.submitLocalMessage(op, ++this.messageId);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.delete}\n     */\n    public delete() {\n        // Delete the value locally.\n        this.deleteCore();\n\n        // If we are not attached, don't submit the op.\n        if (!this.isAttached()) {\n            return;\n        }\n\n        const op: IDeleteCellOperation = {\n            type: \"deleteCell\",\n        };\n        this.submitLocalMessage(op, ++this.messageId);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.empty}\n     */\n    public empty() {\n        return this.data === undefined;\n    }\n\n    /**\n     * Create a summary for the cell\n     *\n     * @returns the summary of the current state of the cell\n     */\n    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n        const content: ICellValue = { value: this.data };\n        return createSingleBlobSummary(snapshotFileName, serializer.stringify(content, this.handle));\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICellValue>(storage, snapshotFileName);\n\n        this.data = this.decode(content);\n    }\n\n    /**\n     * Initialize a local instance of cell\n     */\n    protected initializeLocalCore() {\n        this.data = undefined;\n    }\n\n    /**\n     * Call back on disconnect\n     */\n    protected onDisconnect() {}\n\n    /**\n     * Process a cell operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (this.messageId !== this.messageIdObserved) {\n            // We are waiting for an ACK on our change to this cell - we will ignore all messages until we get it.\n            if (local) {\n                const messageIdReceived = localOpMetadata as number;\n                assert(messageIdReceived !== undefined && messageIdReceived <= this.messageId,\n                    0x00c /* \"messageId is incorrect from from the local client's ACK\" */);\n\n                // We got an ACK. Update messageIdObserved.\n                this.messageIdObserved = localOpMetadata as number;\n            }\n            return;\n        }\n\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as ICellOperation;\n\n            switch (op.type) {\n                case \"setCell\":\n                    this.setCore(this.decode(op.value));\n                    break;\n\n                case \"deleteCell\":\n                    this.deleteCore();\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    private setCore(value: Serializable<T>) {\n        this.data = value;\n        this.emit(\"valueChanged\", value);\n    }\n\n    private deleteCore() {\n        this.data = undefined;\n        this.emit(\"delete\");\n    }\n\n    private decode(cellValue: ICellValue) {\n        const value = cellValue.value;\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return this.serializer.decode(value);\n    }\n\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/cell";
-export declare const pkgVersion = "0.59.2000";
+export declare const pkgVersion = "0.59.3000-67119";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,yBAAyB,CAAC;AAC9C,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,yBAAyB,CAAC;AAC9C,eAAO,MAAM,UAAU,oBAAoB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/cell";
-exports.pkgVersion = "0.59.2000";
+exports.pkgVersion = "0.59.3000-67119";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sBAAsB,CAAC;AACjC,QAAA,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/cell\";\nexport const pkgVersion = \"0.59.2000\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sBAAsB,CAAC;AACjC,QAAA,UAAU,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/cell\";\nexport const pkgVersion = \"0.59.3000-67119\";\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/cell";
-export declare const pkgVersion = "0.59.2000";
+export declare const pkgVersion = "0.59.3000-67119";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,yBAAyB,CAAC;AAC9C,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,yBAAyB,CAAC;AAC9C,eAAO,MAAM,UAAU,oBAAoB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/cell";
-export const pkgVersion = "0.59.2000";
+export const pkgVersion = "0.59.3000-67119";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sBAAsB,CAAC;AAC9C,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/cell\";\nexport const pkgVersion = \"0.59.2000\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sBAAsB,CAAC;AAC9C,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/cell\";\nexport const pkgVersion = \"0.59.3000-67119\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/cell",
-  "version": "0.59.2000",
+  "version": "0.59.3000-67119",
   "description": "Distributed data structure for a single value",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,19 +62,20 @@
   "dependencies": {
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/datastore-definitions": "^0.59.2000",
-    "@fluidframework/driver-utils": "^0.59.2000",
+    "@fluidframework/datastore-definitions": "0.59.3000-67119",
+    "@fluidframework/driver-utils": "0.59.3000-67119",
     "@fluidframework/protocol-definitions": "^0.1028.1000",
-    "@fluidframework/runtime-definitions": "^0.59.2000",
-    "@fluidframework/shared-object-base": "^0.59.2000"
+    "@fluidframework/runtime-definitions": "0.59.3000-67119",
+    "@fluidframework/shared-object-base": "0.59.3000-67119"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "^0.59.2000",
+    "@fluid-internal/test-dds-utils": "0.59.3000-67119",
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/cell-previous": "npm:@fluidframework/cell@0.59.1000",
-    "@fluidframework/eslint-config-fluid": "^0.28.1000",
-    "@fluidframework/mocha-test-setup": "^0.59.2000",
-    "@fluidframework/test-runtime-utils": "^0.59.2000",
+    "@fluidframework/build-tools": "^0.2.66793",
+    "@fluidframework/cell-previous": "npm:@fluidframework/cell@0.59.2000",
+    "@fluidframework/eslint-config-fluid": "^0.28.2000-0",
+    "@fluidframework/mocha-test-setup": "0.59.3000-67119",
+    "@fluidframework/test-runtime-utils": "0.59.3000-67119",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
@@ -97,11 +98,11 @@
     "mocha": "^8.4.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.1.3",
+    "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.2000",
+    "version": "0.59.3000",
     "broken": {}
   }
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/cell";
-export const pkgVersion = "0.59.2000";
+export const pkgVersion = "0.59.3000-67119";