@fluidframework/cell 2.0.0-internal.2.2.1 → 2.0.0-internal.2.3.1

package/.eslintrc.js

@@ -5,9 +5,13 @@
 
 module.exports = {
     "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid"), "prettier"
+        require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
     },
+    "rules": {
+        // TODO: consider re-enabling once we have addressed how this rule conflicts with our error codes.
+        "unicorn/numeric-separators-style": "off",
+    }
 }

package/README.md

@@ -1,3 +1,97 @@
 # @fluidframework/cell
 
-Documentation available at https://fluidframework.com/docs/apis/cell/.
+The `SharedCell` Distributed Data Structure (DDS)  stores a single, shared value that can be edited or deleted.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_INSTALLATION_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## Installation
+
+To get started, install the package by running the following command:
+
+```bash
+npm i @fluidframework/cell
+```
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## API Documentation
+
+API documentation for **@fluidframework/cell** is available at <https://fluidframework.com/docs/apis/cell>.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## Contribution Guidelines
+
+There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
+
+-   Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+-   [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
+-   Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+-   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
+
+Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## Help
+
+Not finding what you're looking for in this README?
+Check out our [GitHub Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
+
+Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+Thank you!
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/dist/cell.d.ts

@@ -8,65 +8,22 @@ import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
 import { ISharedCell, ISharedCellEvents } from "./interfaces";
 /**
- * The SharedCell distributed data structure can be used to store a single serializable value.
- *
- * @remarks
- * ### Creation
- *
- * To create a `SharedCell`, call the static create method:
- *
- * ```typescript
- * const myCell = SharedCell.create(this.runtime, id);
- * ```
- *
- * ### Usage
- *
- * The value stored in the cell can be set with the `.set()` method and retrieved with the `.get()` method:
- *
- * ```typescript
- * myCell.set(3);
- * console.log(myCell.get()); // 3
- * ```
- *
- * The value must only be plain JS objects or `SharedObject` handles (e.g. to another DDS or Fluid object).
- * In collaborative scenarios, the value is settled with a policy of _last write wins_.
- *
- * The `.delete()` method will delete the stored value from the cell:
- *
- * ```typescript
- * myCell.delete();
- * console.log(myCell.get()); // undefined
- * ```
- *
- * The `.empty()` method will check if the value is undefined.
- *
- * ```typescript
- * if (myCell.empty()) {
- *   // myCell.get() will return undefined
- * } else {
- *   // myCell.get() will return a non-undefined value
- * }
- * ```
- *
- * ### Eventing
- *
- * `SharedCell` is an `EventEmitter`, and will emit events when other clients make modifications. You should
- * register for these events and respond appropriately as the data is modified. `valueChanged` will be emitted
- * in response to a `set`, and `delete` will be emitted in response to a `delete`.
+ * {@inheritDoc ISharedCell}
  */
 export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<T>> implements ISharedCell<T> {
     /**
-     * Create a new shared cell
+     * Create a new `SharedCell`.
      *
-     * @param runtime - data store runtime the new shared map belongs to
-     * @param id - optional name of the shared map
-     * @returns newly create shared map (but not attached yet)
+     * @param runtime - The data store runtime to which the `SharedCell` belongs.
+     * @param id - Unique identifier for the `SharedCell`.
+     *
+     * @returns The newly create `SharedCell`. Note that it will not yet be attached.
      */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCell<any>;
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCell;
     /**
-     * Get a factory for SharedCell to register with the data store.
+     * Gets the factory for the `SharedCell` to register with the data store.
      *
-     * @returns a factory that creates and load SharedCell
+     * @returns A factory that creates and loads `SharedCell`s.
      */
     static getFactory(): IChannelFactory;
     /**
@@ -85,11 +42,11 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
     private messageIdObserved;
     private readonly pendingMessageIds;
     /**
-     * Constructs a new shared cell. If the object is non-local an id and service interfaces will
-     * be provided
+     * Constructs a new `SharedCell`.
+     * If the object is non-local an id and service interfaces will be provided.
      *
-     * @param runtime - data store runtime the shared map belongs to
-     * @param id - optional name of the shared map
+     * @param runtime - The data store runtime to which the `SharedCell` belongs.
+     * @param id - Unique identifier for the `SharedCell`.
      */
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
     /**
@@ -109,9 +66,9 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
      */
     empty(): boolean;
     /**
-     * Create a summary for the cell
+     * Creates a summary for the Cell.
      *
-     * @returns the summary of the current state of the cell
+     * @returns The summary of the current state of the Cell.
      */
     protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
     /**
@@ -119,25 +76,26 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
      */
     protected loadCore(storage: IChannelStorageService): Promise<void>;
     /**
-     * Initialize a local instance of cell
+     * Initialize a local instance of cell.
      */
     protected initializeLocalCore(): void;
     /**
-     * Call back on disconnect
+     * Call back on disconnect.
      */
     protected onDisconnect(): void;
     /**
-     * Apply inner op
+     * Apply inner op.
+     *
      * @param content - ICellOperation content
      */
     private applyInnerOp;
     /**
-     * Process a cell operation
+     * Process a cell operation (op).
      *
-     * @param message - the message to prepare
-     * @param local - whether the message was sent by the local client
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
-     * For messages from a remote client, this will be undefined.
+     * For messages from a remote client, this will be `undefined`.
      */
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
     private setCore;
@@ -146,19 +104,22 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
     private createLocalOpMetadata;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     *
      * @internal
      */
     protected applyStashedOp(content: unknown): unknown;
     /**
-     * Rollback a local op
-     * @param content - The operation to rollback
+     * Rollback a local op.
+     *
+     * @param content - The operation to rollback.
      * @param localOpMetadata - The local metadata associated with the op.
      */
     protected rollback(content: any, localOpMetadata: unknown): void;
     /**
     * Submit a cell message to remote clients.
-    * @param op - The cell message
-    * @param previousValue - The value of the cell before this op
+    *
+    * @param op - The cell message.
+    * @param previousValue - The value of the cell before this op.
     */
     private submitCellMessage;
 }

package/dist/cell.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cell.d.ts","sourceRoot":"","sources":["../src/cell.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,YAAY,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAE7G,OAAO,EACH,WAAW,EACX,iBAAiB,EAEpB,MAAM,cAAc,CAAC;AAuBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CACtE,YAAW,WAAW,CAAC,CAAC,CAAC;IACzB;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAG3C;;OAEG;IACH,OAAO,CAAC,IAAI,CAA8B;IAE1C;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAc;IAE/B;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAc;IAEvC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgB;IAElD;;;;;;OAMG;gBACS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,kBAAkB;IAIvF;;OAEG;IACI,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAIzC;;OAEG;IACI,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;IAqBjC;;OAEG;IACI,MAAM;IAeb;;OAEG;IACI,KAAK;IAIZ;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAK5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAapB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAwBlG,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,qBAAqB;IAS7B;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAMnD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAkBxD;;;;MAIE;IACH,OAAO,CAAC,iBAAiB;CAI5B"}
+{"version":3,"file":"cell.d.ts","sourceRoot":"","sources":["../src/cell.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,YAAY,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAE7G,OAAO,EACH,WAAW,EACX,iBAAiB,EAEpB,MAAM,cAAc,CAAC;AAyBtB;;GAEG;AAGH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAE,YAAW,WAAW,CAAC,CAAC,CAAC;IACjG;;;;;;;OAOG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU;IAI9E;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;OAEG;IACH,OAAO,CAAC,IAAI,CAA8B;IAE1C;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAc;IAE/B;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAc;IAEvC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgB;IAElD;;;;;;OAMG;gBACgB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,kBAAkB;IAI9F;;OAEG;IACI,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAIzC;;OAEG;IACI,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAqBxC;;OAEG;IACI,MAAM,IAAI,IAAI;IAerB;;OAEG;IACI,KAAK,IAAI,OAAO;IAIvB;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAK5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAE9B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAapB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAwBzG,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,qBAAqB;IAS7B;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAMnD;;;;;OAKG;IAGH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAmB/D;;;;;MAKE;IACH,OAAO,CAAC,iBAAiB;CAI5B"}

package/dist/cell.js

@@ -12,59 +12,17 @@ const shared_object_base_1 = require("@fluidframework/shared-object-base");
 const cellFactory_1 = require("./cellFactory");
 const snapshotFileName = "header";
 /**
- * The SharedCell distributed data structure can be used to store a single serializable value.
- *
- * @remarks
- * ### Creation
- *
- * To create a `SharedCell`, call the static create method:
- *
- * ```typescript
- * const myCell = SharedCell.create(this.runtime, id);
- * ```
- *
- * ### Usage
- *
- * The value stored in the cell can be set with the `.set()` method and retrieved with the `.get()` method:
- *
- * ```typescript
- * myCell.set(3);
- * console.log(myCell.get()); // 3
- * ```
- *
- * The value must only be plain JS objects or `SharedObject` handles (e.g. to another DDS or Fluid object).
- * In collaborative scenarios, the value is settled with a policy of _last write wins_.
- *
- * The `.delete()` method will delete the stored value from the cell:
- *
- * ```typescript
- * myCell.delete();
- * console.log(myCell.get()); // undefined
- * ```
- *
- * The `.empty()` method will check if the value is undefined.
- *
- * ```typescript
- * if (myCell.empty()) {
- *   // myCell.get() will return undefined
- * } else {
- *   // myCell.get() will return a non-undefined value
- * }
- * ```
- *
- * ### Eventing
- *
- * `SharedCell` is an `EventEmitter`, and will emit events when other clients make modifications. You should
- * register for these events and respond appropriately as the data is modified. `valueChanged` will be emitted
- * in response to a `set`, and `delete` will be emitted in response to a `delete`.
+ * {@inheritDoc ISharedCell}
  */
+// TODO: use `unknown` instead (breaking change).
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 class SharedCell extends shared_object_base_1.SharedObject {
     /**
-     * Constructs a new shared cell. If the object is non-local an id and service interfaces will
-     * be provided
+     * Constructs a new `SharedCell`.
+     * If the object is non-local an id and service interfaces will be provided.
      *
-     * @param runtime - data store runtime the shared map belongs to
-     * @param id - optional name of the shared map
+     * @param runtime - The data store runtime to which the `SharedCell` belongs.
+     * @param id - Unique identifier for the `SharedCell`.
      */
     constructor(id, runtime, attributes) {
         super(id, runtime, attributes, "fluid_cell_");
@@ -81,19 +39,20 @@ class SharedCell extends shared_object_base_1.SharedObject {
         this.pendingMessageIds = [];
     }
     /**
-     * Create a new shared cell
+     * Create a new `SharedCell`.
      *
-     * @param runtime - data store runtime the new shared map belongs to
-     * @param id - optional name of the shared map
-     * @returns newly create shared map (but not attached yet)
+     * @param runtime - The data store runtime to which the `SharedCell` belongs.
+     * @param id - Unique identifier for the `SharedCell`.
+     *
+     * @returns The newly create `SharedCell`. Note that it will not yet be attached.
      */
     static create(runtime, id) {
         return runtime.createChannel(id, cellFactory_1.CellFactory.Type);
     }
     /**
-     * Get a factory for SharedCell to register with the data store.
+     * Gets the factory for the `SharedCell` to register with the data store.
      *
-     * @returns a factory that creates and load SharedCell
+     * @returns A factory that creates and loads `SharedCell`s.
      */
     static getFactory() {
         return new cellFactory_1.CellFactory();
@@ -146,9 +105,9 @@ class SharedCell extends shared_object_base_1.SharedObject {
         return this.data === undefined;
     }
     /**
-     * Create a summary for the cell
+     * Creates a summary for the Cell.
      *
-     * @returns the summary of the current state of the cell
+     * @returns The summary of the current state of the Cell.
      */
     summarizeCore(serializer) {
         const content = { value: this.data };
@@ -162,17 +121,18 @@ class SharedCell extends shared_object_base_1.SharedObject {
         this.data = this.decode(content);
     }
     /**
-     * Initialize a local instance of cell
+     * Initialize a local instance of cell.
      */
     initializeLocalCore() {
         this.data = undefined;
     }
     /**
-     * Call back on disconnect
+     * Call back on disconnect.
      */
     onDisconnect() { }
     /**
-     * Apply inner op
+     * Apply inner op.
+     *
      * @param content - ICellOperation content
      */
     applyInnerOp(content) {
@@ -186,12 +146,12 @@ class SharedCell extends shared_object_base_1.SharedObject {
         }
     }
     /**
-     * Process a cell operation
+     * Process a cell operation (op).
      *
-     * @param message - the message to prepare
-     * @param local - whether the message was sent by the local client
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
      * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
-     * For messages from a remote client, this will be undefined.
+     * For messages from a remote client, this will be `undefined`.
      */
     processCore(message, local, localOpMetadata) {
         const cellOpMetadata = localOpMetadata;
@@ -227,7 +187,6 @@ class SharedCell extends shared_object_base_1.SharedObject {
     }
     decode(cellValue) {
         const value = cellValue.value;
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return this.serializer.decode(value);
     }
     createLocalOpMetadata(op, previousValue) {
@@ -240,6 +199,7 @@ class SharedCell extends shared_object_base_1.SharedObject {
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     *
      * @internal
      */
     applyStashedOp(content) {
@@ -248,12 +208,16 @@ class SharedCell extends shared_object_base_1.SharedObject {
         return this.createLocalOpMetadata(cellContent, previousValue);
     }
     /**
-     * Rollback a local op
-     * @param content - The operation to rollback
+     * Rollback a local op.
+     *
+     * @param content - The operation to rollback.
      * @param localOpMetadata - The local metadata associated with the op.
      */
+    // TODO: use `unknown` instead (breaking change).
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
     rollback(content, localOpMetadata) {
         const cellOpMetadata = localOpMetadata;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         if (content.type === "setCell" || content.type === "deleteCell") {
             if (cellOpMetadata.previousValue === undefined) {
                 this.deleteCore();
@@ -272,8 +236,9 @@ class SharedCell extends shared_object_base_1.SharedObject {
     }
     /**
     * Submit a cell message to remote clients.
-    * @param op - The cell message
-    * @param previousValue - The value of the cell before this op
+    *
+    * @param op - The cell message.
+    * @param previousValue - The value of the cell before this op.
     */
     submitCellMessage(op, previousValue) {
         const localMetadata = this.createLocalOpMetadata(op, previousValue);

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;AA0B5C,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,UAAoB,SAAQ,iCAAkC;IAwCvE;;;;;;OAMG;IACH,YAAY,EAAU,EAAE,OAA+B,EAAE,UAA8B;QACnF,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QAtBlD;;;WAGG;QACK,cAAS,GAAW,CAAC,CAAC,CAAC;QAE/B;;;WAGG;QACK,sBAAiB,GAAW,CAAC,CAAC,CAAC;QAEtB,sBAAiB,GAAa,EAAE,CAAC;IAWlD,CAAC;IA/CD;;;;;;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;IA+BD;;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,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE1C,+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,iBAAiB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM;QACT,4BAA4B;QAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAExC,+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,iBAAiB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9C,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,KAAK,CAAC;IAE5B;;;OAGG;IACK,YAAY,CAAC,OAAuB;QACxC,QAAQ,OAAO,CAAC,IAAI,EAAE;YAClB,KAAK,SAAS;gBACV,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAEpD,KAAK,YAAY;gBACb,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAE7B;gBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACL,CAAC;IAED;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,MAAM,cAAc,GAAG,eAAuC,CAAC;QAC/D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,EAAE;YAC3C,sGAAsG;YACtG,IAAI,KAAK,EAAE;gBACP,MAAM,iBAAiB,GAAG,cAAc,CAAC,gBAAgB,CAAC;gBAC1D,IAAA,qBAAM,EAAC,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EACzE,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAC3E,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,KAAK,SAAS;oBACvC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,gBAAgB,EAC7D,KAAK,CAAC,yCAAyC,CAAC,CAAC;gBACrD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;gBAC/B,2CAA2C;gBAC3C,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC,gBAAgB,CAAC;aAC5D;YACD,OAAO;SACV;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA0B,CAAC;YAC9C,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;SACzB;IACL,CAAC;IAEO,OAAO,CAAC,KAAsB;QAClC,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACjC,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEO,UAAU;QACd,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,OAAO,kBAAkB,CAAC;IAC9B,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;IAEO,qBAAqB,CAAC,EAAkB,EAAE,aAA+B;QAC7E,MAAM,gBAAgB,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,aAAa,GAAyB;YACxC,gBAAgB,EAAE,aAAa;SAClC,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,cAAc,CAAC,OAAgB;QACrC,MAAM,WAAW,GAAG,OAAyB,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACO,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,MAAM,cAAc,GAAG,eAAuC,CAAC;QAC/D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7D,IAAI,cAAc,CAAC,aAAa,KAAK,SAAS,EAAE;gBAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;aACrB;iBAAM;gBACH,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;aAC9C;YAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC;YAC1D,IAAI,oBAAoB,KAAK,cAAc,CAAC,gBAAgB,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;SACJ;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAClD;IACL,CAAC;IAEA;;;;MAIE;IACK,iBAAiB,CAAC,EAAkB,EAAE,aAAmB;QAC7D,MAAM,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACpE,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;CACJ;AAlQD,gCAkQC","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 {\n    ISharedCell,\n    ISharedCellEvents,\n    ICellLocalOpMetadata,\n} 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    private readonly pendingMessageIds: number[] = [];\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, \"fluid_cell_\");\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        const previousValue = 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.submitCellMessage(op, previousValue);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.delete}\n     */\n    public delete() {\n        // Delete the value locally.\n        const previousValue = 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.submitCellMessage(op, previousValue);\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     * Apply inner op\n     * @param content - ICellOperation content\n     */\n    private applyInnerOp(content: ICellOperation) {\n        switch (content.type) {\n            case \"setCell\":\n                return this.setCore(this.decode(content.value));\n\n            case \"deleteCell\":\n                return this.deleteCore();\n\n            default:\n                throw new Error(\"Unknown operation\");\n        }\n    }\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        const cellOpMetadata = localOpMetadata as ICellLocalOpMetadata;\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 = cellOpMetadata.pendingMessageId;\n                assert(messageIdReceived !== undefined && messageIdReceived <= this.messageId,\n                    0x00c /* \"messageId is incorrect from from the local client's ACK\" */);\n                assert(this.pendingMessageIds !== undefined &&\n                    this.pendingMessageIds[0] === cellOpMetadata.pendingMessageId,\n                    0x471 /* Unexpected pending message received */);\n                this.pendingMessageIds.shift();\n                // We got an ACK. Update messageIdObserved.\n                this.messageIdObserved = cellOpMetadata.pendingMessageId;\n            }\n            return;\n        }\n\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as ICellOperation;\n            this.applyInnerOp(op);\n        }\n    }\n\n    private setCore(value: Serializable<T>): Serializable<T> | undefined {\n        const previousLocalValue = this.get();\n        this.data = value;\n        this.emit(\"valueChanged\", value);\n        return previousLocalValue;\n    }\n\n    private deleteCore(): Serializable<T> | undefined {\n        const previousLocalValue = this.get();\n        this.data = undefined;\n        this.emit(\"delete\");\n        return previousLocalValue;\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    private createLocalOpMetadata(op: ICellOperation, previousValue?: Serializable<T>): ICellLocalOpMetadata {\n        const pendingMessageId = ++this.messageId;\n        this.pendingMessageIds.push(pendingMessageId);\n        const localMetadata: ICellLocalOpMetadata = {\n            pendingMessageId, previousValue,\n        };\n        return localMetadata;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}\n     * @internal\n     */\n    protected applyStashedOp(content: unknown): unknown {\n        const cellContent = content as ICellOperation;\n        const previousValue = this.applyInnerOp(cellContent);\n        return this.createLocalOpMetadata(cellContent, previousValue);\n    }\n\n    /**\n     * Rollback a local op\n     * @param content - The operation to rollback\n     * @param localOpMetadata - The local metadata associated with the op.\n     */\n    protected rollback(content: any, localOpMetadata: unknown) {\n        const cellOpMetadata = localOpMetadata as ICellLocalOpMetadata;\n        if (content.type === \"setCell\" || content.type === \"deleteCell\") {\n            if (cellOpMetadata.previousValue === undefined) {\n                this.deleteCore();\n            } else {\n                this.setCore(cellOpMetadata.previousValue);\n            }\n\n            const lastPendingMessageId = this.pendingMessageIds.pop();\n            if (lastPendingMessageId !== cellOpMetadata.pendingMessageId) {\n                throw new Error(\"Rollback op does not match last pending\");\n            }\n        } else {\n            throw new Error(\"Unsupported op for rollback\");\n        }\n    }\n\n     /**\n     * Submit a cell message to remote clients.\n     * @param op - The cell message\n     * @param previousValue - The value of the cell before this op\n     */\n    private submitCellMessage(op: ICellOperation, previousValue?: any): void {\n        const localMetadata = this.createLocalOpMetadata(op, previousValue);\n        this.submitLocalMessage(op, localMetadata);\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;AA4B5C,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,iDAAiD;AACjD,8DAA8D;AAC9D,MAAa,UAAoB,SAAQ,iCAAkC;IAyCvE;;;;;;OAMG;IACH,YAAmB,EAAU,EAAE,OAA+B,EAAE,UAA8B;QAC1F,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QAtBlD;;;WAGG;QACK,cAAS,GAAW,CAAC,CAAC,CAAC;QAE/B;;;WAGG;QACK,sBAAiB,GAAW,CAAC,CAAC,CAAC;QAEtB,sBAAiB,GAAa,EAAE,CAAC;IAWlD,CAAC;IAjDD;;;;;;;OAOG;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;IAgCD;;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,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE1C,+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,iBAAiB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM;QACT,4BAA4B;QAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAExC,+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,iBAAiB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9C,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,KAAW,CAAC;IAElC;;;;OAIG;IACK,YAAY,CAAC,OAAuB;QACxC,QAAQ,OAAO,CAAC,IAAI,EAAE;YAClB,KAAK,SAAS;gBACV,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAEpD,KAAK,YAAY;gBACb,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAE7B;gBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SAC5C;IACL,CAAC;IAED;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,MAAM,cAAc,GAAG,eAAuC,CAAC;QAC/D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,iBAAiB,EAAE;YAC3C,sGAAsG;YACtG,IAAI,KAAK,EAAE;gBACP,MAAM,iBAAiB,GAAG,cAAc,CAAC,gBAAgB,CAAC;gBAC1D,IAAA,qBAAM,EAAC,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EACzE,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAC3E,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,KAAK,SAAS;oBACvC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,gBAAgB,EAC7D,KAAK,CAAC,yCAAyC,CAAC,CAAC;gBACrD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;gBAC/B,2CAA2C;gBAC3C,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC,gBAAgB,CAAC;aAC5D;YACD,OAAO;SACV;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA0B,CAAC;YAC9C,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;SACzB;IACL,CAAC;IAEO,OAAO,CAAC,KAAsB;QAClC,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACjC,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEO,UAAU;QACd,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEO,MAAM,CAAC,SAAqB;QAChC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAoB,CAAE;IAC7D,CAAC;IAEO,qBAAqB,CAAC,EAAkB,EAAE,aAA+B;QAC7E,MAAM,gBAAgB,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,aAAa,GAAyB;YACxC,gBAAgB,EAAE,aAAa;SAClC,CAAC;QACF,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,OAAgB;QACrC,MAAM,WAAW,GAAG,OAAyB,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,iDAAiD;IACjD,iHAAiH;IACvG,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,MAAM,cAAc,GAAG,eAAuC,CAAC;QAC/D,sEAAsE;QACtE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE;YAC7D,IAAI,cAAc,CAAC,aAAa,KAAK,SAAS,EAAE;gBAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;aACrB;iBAAM;gBACH,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,aAAgC,CAAC,CAAC;aACjE;YAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC;YAC1D,IAAI,oBAAoB,KAAK,cAAc,CAAC,gBAAgB,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;SACJ;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAClD;IACL,CAAC;IAEA;;;;;MAKE;IACK,iBAAiB,CAAC,EAAkB,EAAE,aAA+B;QACzE,MAAM,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QACpE,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;CACJ;AAzQD,gCAyQC","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 {\n    ISharedCell,\n    ISharedCellEvents,\n    ICellLocalOpMetadata,\n} 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    /**\n     * The actual value contained in the `Cell`, which needs to be wrapped to handle `undefined`.\n     */\n    value: unknown;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * {@inheritDoc ISharedCell}\n */\n// TODO: use `unknown` instead (breaking change).\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class SharedCell<T = any> extends SharedObject<ISharedCellEvents<T>> implements ISharedCell<T> {\n    /**\n     * Create a new `SharedCell`.\n     *\n     * @param runtime - The data store runtime to which the `SharedCell` belongs.\n     * @param id - Unique identifier for the `SharedCell`.\n     *\n     * @returns The newly create `SharedCell`. Note that it will not yet be attached.\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCell {\n        return runtime.createChannel(id, CellFactory.Type) as SharedCell;\n    }\n\n    /**\n     * Gets the factory for the `SharedCell` to register with the data store.\n     *\n     * @returns A factory that creates and loads `SharedCell`s.\n     */\n    public static getFactory(): IChannelFactory {\n        return new CellFactory();\n    }\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    private readonly pendingMessageIds: number[] = [];\n\n    /**\n     * Constructs a new `SharedCell`.\n     * If the object is non-local an id and service interfaces will be provided.\n     *\n     * @param runtime - The data store runtime to which the `SharedCell` belongs.\n     * @param id - Unique identifier for the `SharedCell`.\n     */\n    public constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n        super(id, runtime, attributes, \"fluid_cell_\");\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>): void {\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        const previousValue = 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.submitCellMessage(op, previousValue);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.delete}\n     */\n    public delete(): void {\n        // Delete the value locally.\n        const previousValue = 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.submitCellMessage(op, previousValue);\n    }\n\n    /**\n     * {@inheritDoc ISharedCell.empty}\n     */\n    public empty(): boolean {\n        return this.data === undefined;\n    }\n\n    /**\n     * Creates 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(): void {\n        this.data = undefined;\n    }\n\n    /**\n     * Call back on disconnect.\n     */\n    protected onDisconnect(): void { }\n\n    /**\n     * Apply inner op.\n     *\n     * @param content - ICellOperation content\n     */\n    private applyInnerOp(content: ICellOperation): Serializable<T> | undefined {\n        switch (content.type) {\n            case \"setCell\":\n                return this.setCore(this.decode(content.value));\n\n            case \"deleteCell\":\n                return this.deleteCore();\n\n            default:\n                throw new Error(\"Unknown operation\");\n        }\n    }\n\n    /**\n     * Process a cell operation (op).\n     *\n     * @param message - The message to prepare.\n     * @param local - Whether or not 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): void {\n        const cellOpMetadata = localOpMetadata as ICellLocalOpMetadata;\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 = cellOpMetadata.pendingMessageId;\n                assert(messageIdReceived !== undefined && messageIdReceived <= this.messageId,\n                    0x00c /* \"messageId is incorrect from from the local client's ACK\" */);\n                assert(this.pendingMessageIds !== undefined &&\n                    this.pendingMessageIds[0] === cellOpMetadata.pendingMessageId,\n                    0x471 /* Unexpected pending message received */);\n                this.pendingMessageIds.shift();\n                // We got an ACK. Update messageIdObserved.\n                this.messageIdObserved = cellOpMetadata.pendingMessageId;\n            }\n            return;\n        }\n\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as ICellOperation;\n            this.applyInnerOp(op);\n        }\n    }\n\n    private setCore(value: Serializable<T>): Serializable<T> | undefined {\n        const previousLocalValue = this.get();\n        this.data = value;\n        this.emit(\"valueChanged\", value);\n        return previousLocalValue;\n    }\n\n    private deleteCore(): Serializable<T> | undefined {\n        const previousLocalValue = this.get();\n        this.data = undefined;\n        this.emit(\"delete\");\n        return previousLocalValue;\n    }\n\n    private decode(cellValue: ICellValue): Serializable<T> {\n        const value = cellValue.value;\n        return this.serializer.decode(value) as Serializable<T> ;\n    }\n\n    private createLocalOpMetadata(op: ICellOperation, previousValue?: Serializable<T>): ICellLocalOpMetadata {\n        const pendingMessageId = ++this.messageId;\n        this.pendingMessageIds.push(pendingMessageId);\n        const localMetadata: ICellLocalOpMetadata = {\n            pendingMessageId, previousValue,\n        };\n        return localMetadata;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}\n     *\n     * @internal\n     */\n    protected applyStashedOp(content: unknown): unknown {\n        const cellContent = content as ICellOperation;\n        const previousValue = this.applyInnerOp(cellContent);\n        return this.createLocalOpMetadata(cellContent, previousValue);\n    }\n\n    /**\n     * Rollback a local op.\n     *\n     * @param content - The operation to rollback.\n     * @param localOpMetadata - The local metadata associated with the op.\n     */\n    // TODO: use `unknown` instead (breaking change).\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types\n    protected rollback(content: any, localOpMetadata: unknown): void {\n        const cellOpMetadata = localOpMetadata as ICellLocalOpMetadata;\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n        if (content.type === \"setCell\" || content.type === \"deleteCell\") {\n            if (cellOpMetadata.previousValue === undefined) {\n                this.deleteCore();\n            } else {\n                this.setCore(cellOpMetadata.previousValue as Serializable<T>);\n            }\n\n            const lastPendingMessageId = this.pendingMessageIds.pop();\n            if (lastPendingMessageId !== cellOpMetadata.pendingMessageId) {\n                throw new Error(\"Rollback op does not match last pending\");\n            }\n        } else {\n            throw new Error(\"Unsupported op for rollback\");\n        }\n    }\n\n     /**\n     * Submit a cell message to remote clients.\n     *\n     * @param op - The cell message.\n     * @param previousValue - The value of the cell before this op.\n     */\n    private submitCellMessage(op: ICellOperation, previousValue?: Serializable<T>): void {\n        const localMetadata = this.createLocalOpMetadata(op, previousValue);\n        this.submitLocalMessage(op, localMetadata);\n    }\n}\n"]}

package/dist/cellFactory.d.ts

@@ -5,17 +5,34 @@
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices, IChannelFactory } from "@fluidframework/datastore-definitions";
 import { ISharedCell } from "./interfaces";
 /**
- * The factory that defines the map
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedCell}.
+ *
+ * @sealed
  */
 export declare class CellFactory implements IChannelFactory {
+    /**
+     * {@inheritDoc CellFactory."type"}
+     */
     static readonly Type = "https://graph.microsoft.com/types/cell";
+    /**
+     * {@inheritDoc CellFactory.attributes}
+     */
     static readonly Attributes: IChannelAttributes;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
+     */
     get type(): string;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
+     */
     get attributes(): IChannelAttributes;
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
      */
     load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedCell>;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
     create(document: IFluidDataStoreRuntime, id: string): ISharedCell;
 }
 //# sourceMappingURL=cellFactory.d.ts.map

package/dist/cellFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cellFactory.d.ts","sourceRoot":"","sources":["../src/cellFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;GAEG;AACH,qBAAa,WAAY,YAAW,eAAe;IAC/C,gBAAuB,IAAI,4CAA4C;IAEvE,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,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,GAAG,OAAO,CAAC,WAAW,CAAC;IAMlD,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW;CAK3E"}
+{"version":3,"file":"cellFactory.d.ts","sourceRoot":"","sources":["../src/cellFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;;;GAIG;AACH,qBAAa,WAAY,YAAW,eAAe;IAC/C;;OAEG;IACH,gBAAuB,IAAI,4CAA4C;IAEvE;;OAEG;IACH,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,kBAAkB,CAE1C;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAMzD;;OAEG;IACI,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW;CAK3E"}

package/dist/cellFactory.js

@@ -8,12 +8,20 @@ exports.CellFactory = void 0;
 const cell_1 = require("./cell");
 const packageVersion_1 = require("./packageVersion");
 /**
- * The factory that defines the map
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedCell}.
+ *
+ * @sealed
  */
 class CellFactory {
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
+     */
     get type() {
         return CellFactory.Type;
     }
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
+     */
     get attributes() {
         return CellFactory.Attributes;
     }
@@ -25,6 +33,9 @@ class CellFactory {
         await cell.load(services);
         return cell;
     }
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
     create(document, id) {
         const cell = new cell_1.SharedCell(id, document, this.attributes);
         cell.initializeLocal();
@@ -32,7 +43,13 @@ class CellFactory {
     }
 }
 exports.CellFactory = CellFactory;
+/**
+ * {@inheritDoc CellFactory."type"}
+ */
 CellFactory.Type = "https://graph.microsoft.com/types/cell";
+/**
+ * {@inheritDoc CellFactory.attributes}
+ */
 CellFactory.Attributes = {
     type: CellFactory.Type,
     snapshotFormatVersion: "0.1",