@fluidframework/cell 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/.eslintrc.js

@@ -4,10 +4,12 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid"), "prettier"
-    ],
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-}
+	extends: [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/.mocharc.js

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-'use strict';
+"use strict";
 
-const getFluidTestMochaConfig = require('@fluidframework/mocha-test-setup/mocharc-common');
+const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
 
 const packageDir = __dirname;
 const config = getFluidTestMochaConfig(packageDir);

package/README.md

@@ -1,3 +1,93 @@
 # @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 -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## 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 -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## 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 -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## 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 -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## 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/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
 }

package/dist/cell.d.ts

@@ -4,69 +4,26 @@
  */
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelFactory, Serializable } from "@fluidframework/datastore-definitions";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { AttributionKey, 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;
     /**
@@ -84,12 +41,14 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
      */
     private messageIdObserved;
     private readonly pendingMessageIds;
+    private attribution;
+    private readonly options;
     /**
-     * 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 +68,19 @@ export declare class SharedCell<T = any> extends SharedObject<ISharedCellEvents<
      */
     empty(): boolean;
     /**
-     * Create a summary for the cell
+     * {@inheritDoc ISharedCell.getAttribution}
+     * @alpha
+     */
+    getAttribution(): AttributionKey | undefined;
+    /**
+     * Set the Op-based attribution through the SequencedDocumentMessage,
+     * or set the local/detached attribution.
+     */
+    private setAttribution;
+    /**
+     * 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 +88,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,20 +116,23 @@ 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
-    */
+     * Submit a cell message to remote clients.
+     *
+     * @param op - The cell message.
+     * @param previousValue - The value of the cell before this op.
+     */
     private submitCellMessage;
 }
 //# sourceMappingURL=cell.d.ts.map

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,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,YAAY,EACZ,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5F,OAAO,EAEN,gBAAgB,EAChB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAsC,MAAM,cAAc,CAAC;AA8BlG;;GAEG;AAGH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,CAC9B,SAAQ,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CACzC,YAAW,WAAW,CAAC,CAAC,CAAC;IAEzB;;;;;;;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,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD;;;;;;OAMG;gBAES,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,kBAAkB;IAMvF;;OAEG;IACI,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAIzC;;OAEG;IACI,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAsBxC;;OAEG;IACI,MAAM,IAAI,IAAI;IAgBrB;;OAEG;IACI,KAAK,IAAI,OAAO;IAIvB;;;OAGG;IACI,cAAc,IAAI,cAAc,GAAG,SAAS;IAInD;;;OAGG;IACH,OAAO,CAAC,cAAc;IAUtB;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAW5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxE;;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,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,GACtB,IAAI;IAgCP,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,MAAM;IAKd,OAAO,CAAC,qBAAqB;IAa7B;;;;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;IAmBhE;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAIzB"}

package/dist/cell.js

@@ -12,60 +12,19 @@ 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`.
      */
+    // eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
     constructor(id, runtime, attributes) {
         super(id, runtime, attributes, "fluid_cell_");
         /**
@@ -79,21 +38,23 @@ class SharedCell extends shared_object_base_1.SharedObject {
          */
         this.messageIdObserved = -1;
         this.pendingMessageIds = [];
+        this.options = runtime.options;
     }
     /**
-     * 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();
@@ -114,6 +75,7 @@ class SharedCell extends shared_object_base_1.SharedObject {
         };
         // Set the value locally.
         const previousValue = this.setCore(value);
+        this.setAttribution();
         // If we are not attached, don't submit the op.
         if (!this.isAttached()) {
             return;
@@ -130,6 +92,7 @@ class SharedCell extends shared_object_base_1.SharedObject {
     delete() {
         // Delete the value locally.
         const previousValue = this.deleteCore();
+        this.setAttribution();
         // If we are not attached, don't submit the op.
         if (!this.isAttached()) {
             return;
@@ -146,12 +109,36 @@ class SharedCell extends shared_object_base_1.SharedObject {
         return this.data === undefined;
     }
     /**
-     * Create a summary for the cell
+     * {@inheritDoc ISharedCell.getAttribution}
+     * @alpha
+     */
+    getAttribution() {
+        return this.attribution;
+    }
+    /**
+     * Set the Op-based attribution through the SequencedDocumentMessage,
+     * or set the local/detached attribution.
+     */
+    setAttribution(message) {
+        var _a, _b, _c;
+        if ((_c = (_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.attribution) === null || _b === void 0 ? void 0 : _b.track) !== null && _c !== void 0 ? _c : false) {
+            this.attribution = message
+                ? { type: "op", seq: message.sequenceNumber }
+                : this.isAttached()
+                    ? { type: "local" }
+                    : { type: "detached", id: 0 };
+        }
+    }
+    /**
+     * 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 };
+        var _a;
+        const content = ((_a = this.attribution) === null || _a === void 0 ? void 0 : _a.type) === "local"
+            ? { value: this.data, attribution: undefined }
+            : { value: this.data, attribution: this.attribution };
         return (0, shared_object_base_1.createSingleBlobSummary)(snapshotFileName, serializer.stringify(content, this.handle));
     }
     /**
@@ -160,19 +147,21 @@ class SharedCell extends shared_object_base_1.SharedObject {
     async loadCore(storage) {
         const content = await (0, driver_utils_1.readAndParse)(storage, snapshotFileName);
         this.data = this.decode(content);
+        this.attribution = content.attribution;
     }
     /**
-     * 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 +175,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;
@@ -205,11 +194,15 @@ class SharedCell extends shared_object_base_1.SharedObject {
                 this.pendingMessageIds.shift();
                 // We got an ACK. Update messageIdObserved.
                 this.messageIdObserved = cellOpMetadata.pendingMessageId;
+                // update the attributor
+                this.setAttribution(message);
             }
             return;
         }
         if (message.type === protocol_definitions_1.MessageType.Operation && !local) {
             const op = message.contents;
+            // update the attributor
+            this.setAttribution(message);
             this.applyInnerOp(op);
         }
     }
@@ -227,19 +220,20 @@ 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) {
         const pendingMessageId = ++this.messageId;
         this.pendingMessageIds.push(pendingMessageId);
         const localMetadata = {
-            pendingMessageId, previousValue,
+            pendingMessageId,
+            previousValue,
         };
         return localMetadata;
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     *
      * @internal
      */
     applyStashedOp(content) {
@@ -248,12 +242,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();
@@ -271,10 +269,11 @@ 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
-    */
+     * Submit a cell message to remote clients.
+     *
+     * @param op - The cell message.
+     * @param previousValue - The value of the cell before this op.
+     */
     submitCellMessage(op, previousValue) {
         const localMetadata = this.createLocalOpMetadata(op, previousValue);
         this.submitLocalMessage(op, localMetadata);