@fluid-experimental/last-edited 2.0.0-dev.6.4.0.192049 → 2.0.0-dev.7.2.0.204906

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @fluid-experimental/last-edited
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.6.3.0
 
 Dependency updates only.

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.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json"
 }

package/api-report/last-edited.api.md

@@ -0,0 +1,63 @@
+## API Report File for "@fluid-experimental/last-edited"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { DataObject } from '@fluidframework/aqueduct';
+import { DataObjectFactory } from '@fluidframework/aqueduct';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/protocol-definitions';
+import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
+
+// @public (undocumented)
+export const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+
+// @public (undocumented)
+export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
+    getLastEditDetails(): ILastEditDetails | undefined;
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+// @public (undocumented)
+export interface ILastEditDetails {
+    // (undocumented)
+    timestamp: number;
+    // (undocumented)
+    user: IUser;
+}
+
+// @public (undocumented)
+export interface IProvideFluidLastEditedTracker {
+    // (undocumented)
+    readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
+}
+
+// @public
+export class LastEditedTracker implements IFluidLastEditedTracker {
+    constructor(sharedSummaryBlock: SharedSummaryBlock);
+    getLastEditDetails(): ILastEditDetails | undefined;
+    // (undocumented)
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+// @public
+export class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
+    // (undocumented)
+    static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
+    // (undocumented)
+    protected hasInitialized(): Promise<void>;
+    // (undocumented)
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    // (undocumented)
+    protected initializingFirstTime(): Promise<void>;
+}
+
+// @public
+export function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/interfaces.d.ts

@@ -3,10 +3,19 @@
  * Licensed under the MIT License.
  */
 import { IUser } from "@fluidframework/protocol-definitions";
+/**
+ * @public
+ */
 export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+/**
+ * @public
+ */
 export interface IProvideFluidLastEditedTracker {
     readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
 }
+/**
+ * @public
+ */
 export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
     /**
      * Returns the details of the last edit to the container.
@@ -17,6 +26,9 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
      */
     updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
 }
+/**
+ * @public
+ */
 export interface ILastEditDetails {
     user: IUser;
     timestamp: number;

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAE7D,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAClB,CAAC;AAE3B,MAAM,WAAW,8BAA8B;IAC9C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC1D;AAED,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC9E;;OAEG;IACH,kBAAkB,IAAI,gBAAgB,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAClB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC9C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC9E;;OAEG;IACH,kBAAkB,IAAI,gBAAgB,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CAClB"}

package/dist/interfaces.js

@@ -5,5 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFluidLastEditedTracker = void 0;
+/**
+ * @public
+ */
 exports.IFluidLastEditedTracker = "IFluidLastEditedTracker";
 //# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIU,QAAA,uBAAuB,GACnC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IUser } from \"@fluidframework/protocol-definitions\";\n\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\nexport interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {\n\t/**\n\t * Returns the details of the last edit to the container.\n\t */\n\tgetLastEditDetails(): ILastEditDetails | undefined;\n\n\t/**\n\t * Updates the details of last edit to the container.\n\t */\n\tupdateLastEditDetails(lastEditDetails: ILastEditDetails): void;\n}\n\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,uBAAuB,GACnC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IUser } from \"@fluidframework/protocol-definitions\";\n\n/**\n * @public\n */\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\n/**\n * @public\n */\nexport interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {\n\t/**\n\t * Returns the details of the last edit to the container.\n\t */\n\tgetLastEditDetails(): ILastEditDetails | undefined;\n\n\t/**\n\t * Updates the details of last edit to the container.\n\t */\n\tupdateLastEditDetails(lastEditDetails: ILastEditDetails): void;\n}\n\n/**\n * @public\n */\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}

package/dist/last-edited-alpha.d.ts

@@ -0,0 +1,103 @@
+import { DataObject } from '@fluidframework/aqueduct';
+import { DataObjectFactory } from '@fluidframework/aqueduct';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/protocol-definitions';
+import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
+
+/**
+ * @public
+ */
+export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+
+/**
+ * @public
+ */
+export declare interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
+    /**
+     * Returns the details of the last edit to the container.
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * Updates the details of last edit to the container.
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ILastEditDetails {
+    user: IUser;
+    timestamp: number;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideFluidLastEditedTracker {
+    readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
+}
+
+/**
+ * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
+ * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
+ * as storage.
+ *
+ * @public
+ */
+export declare class LastEditedTracker implements IFluidLastEditedTracker {
+    private readonly sharedSummaryBlock;
+    private readonly lastEditedDetailsKey;
+    /**
+     * Creates a LastEditedTracker object.
+     * @param sharedSummaryBlock - The shared summary block where the details will be stored.
+     */
+    constructor(sharedSummaryBlock: SharedSummaryBlock);
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
+ */
+export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
+    private static readonly factory;
+    static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
+    private readonly sharedSummaryBlockId;
+    private _lastEditedTracker;
+    private get lastEditedTracker();
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    protected initializingFirstTime(): Promise<void>;
+    protected hasInitialized(): Promise<void>;
+}
+
+/**
+ * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.
+ *
+ * It does the following:
+ *
+ * - Registers an "op" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check
+ * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,
+ * it passes the last edited information from the message to the last edited tracker.
+ *
+ * - The last edited information from the last message received before the lastEditedTracker is
+ * loaded is stored and passed to the tracker once it loads.
+ * @param lastEditedTracker - The last edited tracker.
+ * @param runtime - The container runtime whose messages are to be tracked.
+ * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
+ */
+export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
+
+export { }

package/dist/last-edited-beta.d.ts

@@ -0,0 +1,103 @@
+import { DataObject } from '@fluidframework/aqueduct';
+import { DataObjectFactory } from '@fluidframework/aqueduct';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/protocol-definitions';
+import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
+
+/**
+ * @public
+ */
+export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+
+/**
+ * @public
+ */
+export declare interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
+    /**
+     * Returns the details of the last edit to the container.
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * Updates the details of last edit to the container.
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ILastEditDetails {
+    user: IUser;
+    timestamp: number;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideFluidLastEditedTracker {
+    readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
+}
+
+/**
+ * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
+ * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
+ * as storage.
+ *
+ * @public
+ */
+export declare class LastEditedTracker implements IFluidLastEditedTracker {
+    private readonly sharedSummaryBlock;
+    private readonly lastEditedDetailsKey;
+    /**
+     * Creates a LastEditedTracker object.
+     * @param sharedSummaryBlock - The shared summary block where the details will be stored.
+     */
+    constructor(sharedSummaryBlock: SharedSummaryBlock);
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
+ */
+export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
+    private static readonly factory;
+    static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
+    private readonly sharedSummaryBlockId;
+    private _lastEditedTracker;
+    private get lastEditedTracker();
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    protected initializingFirstTime(): Promise<void>;
+    protected hasInitialized(): Promise<void>;
+}
+
+/**
+ * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.
+ *
+ * It does the following:
+ *
+ * - Registers an "op" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check
+ * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,
+ * it passes the last edited information from the message to the last edited tracker.
+ *
+ * - The last edited information from the last message received before the lastEditedTracker is
+ * loaded is stored and passed to the tracker once it loads.
+ * @param lastEditedTracker - The last edited tracker.
+ * @param runtime - The container runtime whose messages are to be tracked.
+ * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
+ */
+export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
+
+export { }

package/dist/last-edited-public.d.ts

@@ -0,0 +1,103 @@
+import { DataObject } from '@fluidframework/aqueduct';
+import { DataObjectFactory } from '@fluidframework/aqueduct';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/protocol-definitions';
+import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
+
+/**
+ * @public
+ */
+export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+
+/**
+ * @public
+ */
+export declare interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
+    /**
+     * Returns the details of the last edit to the container.
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * Updates the details of last edit to the container.
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ILastEditDetails {
+    user: IUser;
+    timestamp: number;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideFluidLastEditedTracker {
+    readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
+}
+
+/**
+ * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
+ * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
+ * as storage.
+ *
+ * @public
+ */
+export declare class LastEditedTracker implements IFluidLastEditedTracker {
+    private readonly sharedSummaryBlock;
+    private readonly lastEditedDetailsKey;
+    /**
+     * Creates a LastEditedTracker object.
+     * @param sharedSummaryBlock - The shared summary block where the details will be stored.
+     */
+    constructor(sharedSummaryBlock: SharedSummaryBlock);
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
+ */
+export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
+    private static readonly factory;
+    static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
+    private readonly sharedSummaryBlockId;
+    private _lastEditedTracker;
+    private get lastEditedTracker();
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    protected initializingFirstTime(): Promise<void>;
+    protected hasInitialized(): Promise<void>;
+}
+
+/**
+ * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.
+ *
+ * It does the following:
+ *
+ * - Registers an "op" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check
+ * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,
+ * it passes the last edited information from the message to the last edited tracker.
+ *
+ * - The last edited information from the last message received before the lastEditedTracker is
+ * loaded is stored and passed to the tracker once it loads.
+ * @param lastEditedTracker - The last edited tracker.
+ * @param runtime - The container runtime whose messages are to be tracked.
+ * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
+ */
+export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
+
+export { }

package/dist/last-edited-untrimmed.d.ts

@@ -0,0 +1,103 @@
+import { DataObject } from '@fluidframework/aqueduct';
+import { DataObjectFactory } from '@fluidframework/aqueduct';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/protocol-definitions';
+import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
+
+/**
+ * @public
+ */
+export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+
+/**
+ * @public
+ */
+export declare interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
+    /**
+     * Returns the details of the last edit to the container.
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * Updates the details of last edit to the container.
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ILastEditDetails {
+    user: IUser;
+    timestamp: number;
+}
+
+/**
+ * @public
+ */
+export declare interface IProvideFluidLastEditedTracker {
+    readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
+}
+
+/**
+ * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
+ * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
+ * as storage.
+ *
+ * @public
+ */
+export declare class LastEditedTracker implements IFluidLastEditedTracker {
+    private readonly sharedSummaryBlock;
+    private readonly lastEditedDetailsKey;
+    /**
+     * Creates a LastEditedTracker object.
+     * @param sharedSummaryBlock - The shared summary block where the details will be stored.
+     */
+    constructor(sharedSummaryBlock: SharedSummaryBlock);
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}
+     */
+    getLastEditDetails(): ILastEditDetails | undefined;
+    /**
+     * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}
+     */
+    updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
+}
+
+/**
+ * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
+ */
+export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
+    private static readonly factory;
+    static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
+    private readonly sharedSummaryBlockId;
+    private _lastEditedTracker;
+    private get lastEditedTracker();
+    get IFluidLastEditedTracker(): LastEditedTracker;
+    protected initializingFirstTime(): Promise<void>;
+    protected hasInitialized(): Promise<void>;
+}
+
+/**
+ * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.
+ *
+ * It does the following:
+ *
+ * - Registers an "op" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check
+ * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,
+ * it passes the last edited information from the message to the last edited tracker.
+ *
+ * - The last edited information from the last message received before the lastEditedTracker is
+ * loaded is stored and passed to the tracker once it loads.
+ * @param lastEditedTracker - The last edited tracker.
+ * @param runtime - The container runtime whose messages are to be tracked.
+ * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
+ */
+export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
+
+export { }

package/dist/lastEditedTracker.d.ts

@@ -8,6 +8,8 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
  * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
  * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
  * as storage.
+ *
+ * @public
  */
 export declare class LastEditedTracker implements IFluidLastEditedTracker {
     private readonly sharedSummaryBlock;

package/dist/lastEditedTracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTracker.d.ts","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,uBAAuB;IAOpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAN/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAE7D;;;OAGG;gBAC0B,kBAAkB,EAAE,kBAAkB;IAEnE,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;IAED;;OAEG;IACI,kBAAkB,IAAI,gBAAgB,GAAG,SAAS;IAIzD;;OAEG;IACI,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI;CAGrE"}
+{"version":3,"file":"lastEditedTracker.d.ts","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzE;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,uBAAuB;IAOpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAN/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAE7D;;;OAGG;gBAC0B,kBAAkB,EAAE,kBAAkB;IAEnE,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;IAED;;OAEG;IACI,kBAAkB,IAAI,gBAAgB,GAAG,SAAS;IAIzD;;OAEG;IACI,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI;CAGrE"}

package/dist/lastEditedTracker.js

@@ -9,6 +9,8 @@ exports.LastEditedTracker = void 0;
  * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
  * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
  * as storage.
+ *
+ * @public
  */
 class LastEditedTracker {
     /**

package/dist/lastEditedTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;;GAIG;AACH,MAAa,iBAAiB;IAG7B;;;OAGG;IACH,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QANlD,yBAAoB,GAAG,oBAAoB,CAAC;IAMS,CAAC;IAEvE,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAmB,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,eAAiC;QAC7D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACD;AA1BD,8CA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { IFluidLastEditedTracker, ILastEditDetails } from \"./interfaces\";\n\n/**\n * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited\n * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block\n * as storage.\n */\nexport class LastEditedTracker implements IFluidLastEditedTracker {\n\tprivate readonly lastEditedDetailsKey = \"lastEditDetailsKey\";\n\n\t/**\n\t * Creates a LastEditedTracker object.\n\t * @param sharedSummaryBlock - The shared summary block where the details will be stored.\n\t */\n\tconstructor(private readonly sharedSummaryBlock: SharedSummaryBlock) {}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}\n\t */\n\tpublic getLastEditDetails(): ILastEditDetails | undefined {\n\t\treturn this.sharedSummaryBlock.get<ILastEditDetails>(this.lastEditedDetailsKey);\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}\n\t */\n\tpublic updateLastEditDetails(lastEditDetails: ILastEditDetails): void {\n\t\tthis.sharedSummaryBlock.set(this.lastEditedDetailsKey, lastEditDetails);\n\t}\n}\n"]}
+{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;;;;GAMG;AACH,MAAa,iBAAiB;IAG7B;;;OAGG;IACH,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QANlD,yBAAoB,GAAG,oBAAoB,CAAC;IAMS,CAAC;IAEvE,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAmB,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,eAAiC;QAC7D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACD;AA1BD,8CA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { IFluidLastEditedTracker, ILastEditDetails } from \"./interfaces\";\n\n/**\n * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited\n * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block\n * as storage.\n *\n * @public\n */\nexport class LastEditedTracker implements IFluidLastEditedTracker {\n\tprivate readonly lastEditedDetailsKey = \"lastEditDetailsKey\";\n\n\t/**\n\t * Creates a LastEditedTracker object.\n\t * @param sharedSummaryBlock - The shared summary block where the details will be stored.\n\t */\n\tconstructor(private readonly sharedSummaryBlock: SharedSummaryBlock) {}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}\n\t */\n\tpublic getLastEditDetails(): ILastEditDetails | undefined {\n\t\treturn this.sharedSummaryBlock.get<ILastEditDetails>(this.lastEditedDetailsKey);\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}\n\t */\n\tpublic updateLastEditDetails(lastEditDetails: ILastEditDetails): void {\n\t\tthis.sharedSummaryBlock.set(this.lastEditedDetailsKey, lastEditDetails);\n\t}\n}\n"]}

package/dist/lastEditedTrackerDataObject.d.ts

@@ -7,6 +7,8 @@ import { LastEditedTracker } from "./lastEditedTracker";
 import { IProvideFluidLastEditedTracker } from "./interfaces";
 /**
  * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
  */
 export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
     private static readonly factory;

package/dist/lastEditedTrackerDataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTrackerDataObject.d.ts","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAE9D;;GAEG;AACH,qBAAa,2BACZ,SAAQ,UACR,YAAW,8BAA8B;IAEzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAO5B;WAEW,UAAU,IAAI,iBAAiB,CAAC,2BAA2B,CAAC;IAI1E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA6B;IAClE,OAAO,CAAC,kBAAkB,CAAgC;IAE1D,OAAO,KAAK,iBAAiB,GAM5B;IAED,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;cAEe,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;cAKtC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAM/C"}
+{"version":3,"file":"lastEditedTrackerDataObject.d.ts","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAE9D;;;;GAIG;AACH,qBAAa,2BACZ,SAAQ,UACR,YAAW,8BAA8B;IAEzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAO5B;WAEW,UAAU,IAAI,iBAAiB,CAAC,2BAA2B,CAAC;IAI1E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA6B;IAClE,OAAO,CAAC,kBAAkB,CAAgC;IAE1D,OAAO,KAAK,iBAAiB,GAM5B;IAED,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;cAEe,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;cAKtC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAM/C"}

package/dist/lastEditedTrackerDataObject.js

@@ -10,6 +10,8 @@ const shared_summary_block_1 = require("@fluidframework/shared-summary-block");
 const lastEditedTracker_1 = require("./lastEditedTracker");
 /**
  * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
  */
 class LastEditedTrackerDataObject extends aqueduct_1.DataObject {
     constructor() {

package/dist/lastEditedTrackerDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAyE;AAEzE,+EAA0E;AAC1E,2DAAwD;AAGxD;;GAEG;AACH,MAAa,2BACZ,SAAQ,qBAAU;IADnB;;QAiBkB,yBAAoB,GAAG,yBAAyB,CAAC;IA0BnE,CAAC;IA9BO,MAAM,CAAC,UAAU;QACvB,OAAO,2BAA2B,CAAC,OAAO,CAAC;IAC5C,CAAC;IAKD,IAAY,iBAAiB;QAC5B,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC;IAChC,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;IAES,KAAK,CAAC,qBAAqB;QACpC,MAAM,kBAAkB,GAAG,yCAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,kBAAkB;QACvB,oEAAoE;QACpE,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmC,IAAI,CAAC,oBAAoB,CAAE,CAAC,GAAG,EAAE,CAAC;QACzF,IAAI,CAAC,kBAAkB,GAAG,IAAI,qCAAiB,CAAC,kBAAkB,CAAC,CAAC;IACrE,CAAC;;AA1CF,kEA2CC;AAvCwB,mCAAO,GAC9B,IAAI,4BAAiB,CACpB,iCAAiC,EACjC,2BAA2B,EAC3B,CAAC,yCAAkB,CAAC,UAAU,EAAE,CAAC,EACjC,EAAE,EACF,SAAS,CACT,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { LastEditedTracker } from \"./lastEditedTracker\";\nimport { IProvideFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.\n */\nexport class LastEditedTrackerDataObject\n\textends DataObject\n\timplements IProvideFluidLastEditedTracker\n{\n\tprivate static readonly factory: DataObjectFactory<LastEditedTrackerDataObject> =\n\t\tnew DataObjectFactory(\n\t\t\t\"@fluid-experimental/last-edited\",\n\t\t\tLastEditedTrackerDataObject,\n\t\t\t[SharedSummaryBlock.getFactory()],\n\t\t\t{},\n\t\t\tundefined,\n\t\t);\n\n\tpublic static getFactory(): DataObjectFactory<LastEditedTrackerDataObject> {\n\t\treturn LastEditedTrackerDataObject.factory;\n\t}\n\n\tprivate readonly sharedSummaryBlockId = \"shared-summary-block-id\";\n\tprivate _lastEditedTracker: LastEditedTracker | undefined;\n\n\tprivate get lastEditedTracker(): LastEditedTracker {\n\t\tif (this._lastEditedTracker === undefined) {\n\t\t\tthrow new Error(\"Last Edited tracker was not initialized properly\");\n\t\t}\n\n\t\treturn this._lastEditedTracker;\n\t}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this.lastEditedTracker;\n\t}\n\n\tprotected async initializingFirstTime(): Promise<void> {\n\t\tconst sharedSummaryBlock = SharedSummaryBlock.create(this.runtime);\n\t\tthis.root.set(this.sharedSummaryBlockId, sharedSummaryBlock.handle);\n\t}\n\n\tprotected async hasInitialized(): Promise<void> {\n\t\tconst sharedSummaryBlock =\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tawait this.root.get<IFluidHandle<SharedSummaryBlock>>(this.sharedSummaryBlockId)!.get();\n\t\tthis._lastEditedTracker = new LastEditedTracker(sharedSummaryBlock);\n\t}\n}\n"]}
+{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAyE;AAEzE,+EAA0E;AAC1E,2DAAwD;AAGxD;;;;GAIG;AACH,MAAa,2BACZ,SAAQ,qBAAU;IADnB;;QAiBkB,yBAAoB,GAAG,yBAAyB,CAAC;IA0BnE,CAAC;IA9BO,MAAM,CAAC,UAAU;QACvB,OAAO,2BAA2B,CAAC,OAAO,CAAC;IAC5C,CAAC;IAKD,IAAY,iBAAiB;QAC5B,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC;IAChC,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;IAES,KAAK,CAAC,qBAAqB;QACpC,MAAM,kBAAkB,GAAG,yCAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,kBAAkB;QACvB,oEAAoE;QACpE,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmC,IAAI,CAAC,oBAAoB,CAAE,CAAC,GAAG,EAAE,CAAC;QACzF,IAAI,CAAC,kBAAkB,GAAG,IAAI,qCAAiB,CAAC,kBAAkB,CAAC,CAAC;IACrE,CAAC;;AA1CF,kEA2CC;AAvCwB,mCAAO,GAC9B,IAAI,4BAAiB,CACpB,iCAAiC,EACjC,2BAA2B,EAC3B,CAAC,yCAAkB,CAAC,UAAU,EAAE,CAAC,EACjC,EAAE,EACF,SAAS,CACT,AAP6B,CAO5B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { LastEditedTracker } from \"./lastEditedTracker\";\nimport { IProvideFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.\n *\n * @public\n */\nexport class LastEditedTrackerDataObject\n\textends DataObject\n\timplements IProvideFluidLastEditedTracker\n{\n\tprivate static readonly factory: DataObjectFactory<LastEditedTrackerDataObject> =\n\t\tnew DataObjectFactory(\n\t\t\t\"@fluid-experimental/last-edited\",\n\t\t\tLastEditedTrackerDataObject,\n\t\t\t[SharedSummaryBlock.getFactory()],\n\t\t\t{},\n\t\t\tundefined,\n\t\t);\n\n\tpublic static getFactory(): DataObjectFactory<LastEditedTrackerDataObject> {\n\t\treturn LastEditedTrackerDataObject.factory;\n\t}\n\n\tprivate readonly sharedSummaryBlockId = \"shared-summary-block-id\";\n\tprivate _lastEditedTracker: LastEditedTracker | undefined;\n\n\tprivate get lastEditedTracker(): LastEditedTracker {\n\t\tif (this._lastEditedTracker === undefined) {\n\t\t\tthrow new Error(\"Last Edited tracker was not initialized properly\");\n\t\t}\n\n\t\treturn this._lastEditedTracker;\n\t}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this.lastEditedTracker;\n\t}\n\n\tprotected async initializingFirstTime(): Promise<void> {\n\t\tconst sharedSummaryBlock = SharedSummaryBlock.create(this.runtime);\n\t\tthis.root.set(this.sharedSummaryBlockId, sharedSummaryBlock.handle);\n\t}\n\n\tprotected async hasInitialized(): Promise<void> {\n\t\tconst sharedSummaryBlock =\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tawait this.root.get<IFluidHandle<SharedSummaryBlock>>(this.sharedSummaryBlockId)!.get();\n\t\tthis._lastEditedTracker = new LastEditedTracker(sharedSummaryBlock);\n\t}\n}\n"]}

package/dist/setup.d.ts

@@ -19,6 +19,8 @@ import { IFluidLastEditedTracker } from "./interfaces";
  * @param lastEditedTracker - The last edited tracker.
  * @param runtime - The container runtime whose messages are to be tracked.
  * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
  */
 export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
 //# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAkB,MAAM,sCAAsC,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAoB,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAoCzE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kCAAkC,CACjD,iBAAiB,EAAE,uBAAuB,EAC1C,OAAO,EAAE,iBAAiB,EAC1B,sBAAsB,GAAE,CACvB,OAAO,EAAE,yBAAyB,KAC9B,OAAqC,GACxC,IAAI,CAkBN"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAkB,MAAM,sCAAsC,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAoB,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAoCzE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kCAAkC,CACjD,iBAAiB,EAAE,uBAAuB,EAC1C,OAAO,EAAE,iBAAiB,EAC1B,sBAAsB,GAAE,CACvB,OAAO,EAAE,yBAAyB,KAC9B,OAAqC,GACxC,IAAI,CAkBN"}

package/dist/setup.js

@@ -48,6 +48,8 @@ function getLastEditDetailsFromMessage(message, quorum) {
  * @param lastEditedTracker - The last edited tracker.
  * @param runtime - The container runtime whose messages are to be tracked.
  * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
  */
 function setupLastEditedTrackerForContainer(lastEditedTracker, runtime, shouldDiscardMessageFn = shouldDiscardMessageDefault) {
     // Register an op listener on the runtime. If the lastEditedTracker has loaded,

package/dist/setup.js.map

@@ -1 +1 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yEAAyE;AAIzE;;;;;;GAMG;AACH,MAAM,2BAA2B,GAAG,CAAC,OAAkC,EAAW,EAAE,CACnF,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,MAAM;IAC5C,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,gBAAgB;IACtD,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,KAAK,CAAC;AAE7C;;;GAGG;AACH,SAAS,6BAA6B,CACrC,OAAkC,EAClC,MAAsB;IAEtB,+FAA+F;IAC/F,4EAA4E;IAC5E,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAkB,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,MAAM,eAAe,GAAqB;YACzC,IAAI;YACJ,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC;QACF,OAAO,eAAe,CAAC;KACvB;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,kCAAkC,CACjD,iBAA0C,EAC1C,OAA0B,EAC1B,yBAEe,2BAA2B;IAE1C,+EAA+E;IAC/E,+CAA+C;IAC/C,8GAA8G;IAC9G,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,cAAwB,EAAE,EAAE;QACjF,6EAA6E;QAC7E,IAAI,cAAc,KAAK,KAAK,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE;YAChE,OAAO;SACP;QAED,6EAA6E;QAC7E,MAAM,eAAe,GAAG,6BAA6B,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACpF,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,OAAO;SACP;QAED,iBAAiB,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACJ,CAAC;AAxBD,gFAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType } from \"@fluidframework/container-runtime\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { ILastEditDetails, IFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * Default implementation of {@link setupLastEditedTrackerForContainer}'s `shouldDiscardMessageFn` parameter,\n * which tells that all messages other than {@link @fluidframework/container-runtime#ContainerMessageType.Alias},\n * {@link @fluidframework/container-runtime#ContainerMessageType.Attach}, and\n * {@link @fluidframework/container-runtime#ContainerMessageType.FluidDataStoreOp} type messages should be\n * discarded.\n */\nconst shouldDiscardMessageDefault = (message: ISequencedDocumentMessage): boolean =>\n\tmessage.type !== ContainerMessageType.Attach &&\n\tmessage.type !== ContainerMessageType.FluidDataStoreOp &&\n\tmessage.type !== ContainerMessageType.Alias;\n\n/**\n * Extracts the user information and timestamp from a message. Returns undefined if the user information for the\n * client who sent the message doesn't exist in the quorum.\n */\nfunction getLastEditDetailsFromMessage(\n\tmessage: ISequencedDocumentMessage,\n\tquorum: IQuorumClients,\n): ILastEditDetails | undefined {\n\t// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)\n\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n\tconst sequencedClient = quorum.getMember(message.clientId as string);\n\tconst user = sequencedClient?.client.user;\n\tif (user !== undefined) {\n\t\tconst lastEditDetails: ILastEditDetails = {\n\t\t\tuser,\n\t\t\ttimestamp: message.timestamp,\n\t\t};\n\t\treturn lastEditDetails;\n\t}\n\treturn undefined;\n}\n\n/**\n * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.\n *\n * It does the following:\n *\n * - Registers an \"op\" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check\n * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,\n * it passes the last edited information from the message to the last edited tracker.\n *\n * - The last edited information from the last message received before the lastEditedTracker is\n * loaded is stored and passed to the tracker once it loads.\n * @param lastEditedTracker - The last edited tracker.\n * @param runtime - The container runtime whose messages are to be tracked.\n * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.\n */\nexport function setupLastEditedTrackerForContainer(\n\tlastEditedTracker: IFluidLastEditedTracker,\n\truntime: IContainerRuntime,\n\tshouldDiscardMessageFn: (\n\t\tmessage: ISequencedDocumentMessage,\n\t) => boolean = shouldDiscardMessageDefault,\n): void {\n\t// Register an op listener on the runtime. If the lastEditedTracker has loaded,\n\t// it passes the last edited information to its\n\t// last edited tracker. If the lastEditedTracker hasn't loaded, store the last edited information temporarily.\n\truntime.on(\"op\", (message: ISequencedDocumentMessage, runtimeMessage?: boolean) => {\n\t\t// If this message should be discarded as per shouldDiscardMessageFn, return.\n\t\tif (runtimeMessage === false || shouldDiscardMessageFn(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Get the last edited details from the message. If it doesn't exist, return.\n\t\tconst lastEditDetails = getLastEditDetailsFromMessage(message, runtime.getQuorum());\n\t\tif (lastEditDetails === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tlastEditedTracker.updateLastEditDetails(lastEditDetails);\n\t});\n}\n"]}
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yEAAyE;AAIzE;;;;;;GAMG;AACH,MAAM,2BAA2B,GAAG,CAAC,OAAkC,EAAW,EAAE,CACnF,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,MAAM;IAC5C,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,gBAAgB;IACtD,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC,KAAK,CAAC;AAE7C;;;GAGG;AACH,SAAS,6BAA6B,CACrC,OAAkC,EAClC,MAAsB;IAEtB,+FAA+F;IAC/F,4EAA4E;IAC5E,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAkB,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,MAAM,eAAe,GAAqB;YACzC,IAAI;YACJ,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC;QACF,OAAO,eAAe,CAAC;KACvB;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,kCAAkC,CACjD,iBAA0C,EAC1C,OAA0B,EAC1B,yBAEe,2BAA2B;IAE1C,+EAA+E;IAC/E,+CAA+C;IAC/C,8GAA8G;IAC9G,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,cAAwB,EAAE,EAAE;QACjF,6EAA6E;QAC7E,IAAI,cAAc,KAAK,KAAK,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE;YAChE,OAAO;SACP;QAED,6EAA6E;QAC7E,MAAM,eAAe,GAAG,6BAA6B,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACpF,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,OAAO;SACP;QAED,iBAAiB,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACJ,CAAC;AAxBD,gFAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType } from \"@fluidframework/container-runtime\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { ILastEditDetails, IFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * Default implementation of {@link setupLastEditedTrackerForContainer}'s `shouldDiscardMessageFn` parameter,\n * which tells that all messages other than {@link @fluidframework/container-runtime#ContainerMessageType.Alias},\n * {@link @fluidframework/container-runtime#ContainerMessageType.Attach}, and\n * {@link @fluidframework/container-runtime#ContainerMessageType.FluidDataStoreOp} type messages should be\n * discarded.\n */\nconst shouldDiscardMessageDefault = (message: ISequencedDocumentMessage): boolean =>\n\tmessage.type !== ContainerMessageType.Attach &&\n\tmessage.type !== ContainerMessageType.FluidDataStoreOp &&\n\tmessage.type !== ContainerMessageType.Alias;\n\n/**\n * Extracts the user information and timestamp from a message. Returns undefined if the user information for the\n * client who sent the message doesn't exist in the quorum.\n */\nfunction getLastEditDetailsFromMessage(\n\tmessage: ISequencedDocumentMessage,\n\tquorum: IQuorumClients,\n): ILastEditDetails | undefined {\n\t// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)\n\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n\tconst sequencedClient = quorum.getMember(message.clientId as string);\n\tconst user = sequencedClient?.client.user;\n\tif (user !== undefined) {\n\t\tconst lastEditDetails: ILastEditDetails = {\n\t\t\tuser,\n\t\t\ttimestamp: message.timestamp,\n\t\t};\n\t\treturn lastEditDetails;\n\t}\n\treturn undefined;\n}\n\n/**\n * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.\n *\n * It does the following:\n *\n * - Registers an \"op\" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check\n * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,\n * it passes the last edited information from the message to the last edited tracker.\n *\n * - The last edited information from the last message received before the lastEditedTracker is\n * loaded is stored and passed to the tracker once it loads.\n * @param lastEditedTracker - The last edited tracker.\n * @param runtime - The container runtime whose messages are to be tracked.\n * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.\n *\n * @public\n */\nexport function setupLastEditedTrackerForContainer(\n\tlastEditedTracker: IFluidLastEditedTracker,\n\truntime: IContainerRuntime,\n\tshouldDiscardMessageFn: (\n\t\tmessage: ISequencedDocumentMessage,\n\t) => boolean = shouldDiscardMessageDefault,\n): void {\n\t// Register an op listener on the runtime. If the lastEditedTracker has loaded,\n\t// it passes the last edited information to its\n\t// last edited tracker. If the lastEditedTracker hasn't loaded, store the last edited information temporarily.\n\truntime.on(\"op\", (message: ISequencedDocumentMessage, runtimeMessage?: boolean) => {\n\t\t// If this message should be discarded as per shouldDiscardMessageFn, return.\n\t\tif (runtimeMessage === false || shouldDiscardMessageFn(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Get the last edited details from the message. If it doesn't exist, return.\n\t\tconst lastEditDetails = getLastEditDetailsFromMessage(message, runtime.getQuorum());\n\t\tif (lastEditDetails === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tlastEditedTracker.updateLastEditDetails(lastEditDetails);\n\t});\n}\n"]}

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.9"
+      "packageVersion": "7.38.0"
     }
   ]
 }

package/lib/interfaces.d.ts

@@ -3,10 +3,19 @@
  * Licensed under the MIT License.
  */
 import { IUser } from "@fluidframework/protocol-definitions";
+/**
+ * @public
+ */
 export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
+/**
+ * @public
+ */
 export interface IProvideFluidLastEditedTracker {
     readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
 }
+/**
+ * @public
+ */
 export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
     /**
      * Returns the details of the last edit to the container.
@@ -17,6 +26,9 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
      */
     updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
 }
+/**
+ * @public
+ */
 export interface ILastEditDetails {
     user: IUser;
     timestamp: number;

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAE7D,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAClB,CAAC;AAE3B,MAAM,WAAW,8BAA8B;IAC9C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC1D;AAED,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC9E;;OAEG;IACH,kBAAkB,IAAI,gBAAgB,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAClB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC9C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC9E;;OAEG;IACH,kBAAkB,IAAI,gBAAgB,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CAClB"}

package/lib/interfaces.js

@@ -2,5 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * @public
+ */
 export const IFluidLastEditedTracker = "IFluidLastEditedTracker";
 //# sourceMappingURL=interfaces.js.map

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,CAAC,MAAM,uBAAuB,GACnC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IUser } from \"@fluidframework/protocol-definitions\";\n\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\nexport interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {\n\t/**\n\t * Returns the details of the last edit to the container.\n\t */\n\tgetLastEditDetails(): ILastEditDetails | undefined;\n\n\t/**\n\t * Updates the details of last edit to the container.\n\t */\n\tupdateLastEditDetails(lastEditDetails: ILastEditDetails): void;\n}\n\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GACnC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IUser } from \"@fluidframework/protocol-definitions\";\n\n/**\n * @public\n */\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\n/**\n * @public\n */\nexport interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {\n\t/**\n\t * Returns the details of the last edit to the container.\n\t */\n\tgetLastEditDetails(): ILastEditDetails | undefined;\n\n\t/**\n\t * Updates the details of last edit to the container.\n\t */\n\tupdateLastEditDetails(lastEditDetails: ILastEditDetails): void;\n}\n\n/**\n * @public\n */\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}

package/lib/lastEditedTracker.d.ts

@@ -8,6 +8,8 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
  * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
  * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
  * as storage.
+ *
+ * @public
  */
 export declare class LastEditedTracker implements IFluidLastEditedTracker {
     private readonly sharedSummaryBlock;

package/lib/lastEditedTracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTracker.d.ts","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,uBAAuB;IAOpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAN/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAE7D;;;OAGG;gBAC0B,kBAAkB,EAAE,kBAAkB;IAEnE,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;IAED;;OAEG;IACI,kBAAkB,IAAI,gBAAgB,GAAG,SAAS;IAIzD;;OAEG;IACI,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI;CAGrE"}
+{"version":3,"file":"lastEditedTracker.d.ts","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzE;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,uBAAuB;IAOpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAN/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAE7D;;;OAGG;gBAC0B,kBAAkB,EAAE,kBAAkB;IAEnE,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;IAED;;OAEG;IACI,kBAAkB,IAAI,gBAAgB,GAAG,SAAS;IAIzD;;OAEG;IACI,qBAAqB,CAAC,eAAe,EAAE,gBAAgB,GAAG,IAAI;CAGrE"}

package/lib/lastEditedTracker.js

@@ -6,6 +6,8 @@
  * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
  * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
  * as storage.
+ *
+ * @public
  */
 export class LastEditedTracker {
     /**

package/lib/lastEditedTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAG7B;;;OAGG;IACH,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QANlD,yBAAoB,GAAG,oBAAoB,CAAC;IAMS,CAAC;IAEvE,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAmB,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,eAAiC;QAC7D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { IFluidLastEditedTracker, ILastEditDetails } from \"./interfaces\";\n\n/**\n * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited\n * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block\n * as storage.\n */\nexport class LastEditedTracker implements IFluidLastEditedTracker {\n\tprivate readonly lastEditedDetailsKey = \"lastEditDetailsKey\";\n\n\t/**\n\t * Creates a LastEditedTracker object.\n\t * @param sharedSummaryBlock - The shared summary block where the details will be stored.\n\t */\n\tconstructor(private readonly sharedSummaryBlock: SharedSummaryBlock) {}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}\n\t */\n\tpublic getLastEditDetails(): ILastEditDetails | undefined {\n\t\treturn this.sharedSummaryBlock.get<ILastEditDetails>(this.lastEditedDetailsKey);\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}\n\t */\n\tpublic updateLastEditDetails(lastEditDetails: ILastEditDetails): void {\n\t\tthis.sharedSummaryBlock.set(this.lastEditedDetailsKey, lastEditDetails);\n\t}\n}\n"]}
+{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;;;GAMG;AACH,MAAM,OAAO,iBAAiB;IAG7B;;;OAGG;IACH,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QANlD,yBAAoB,GAAG,oBAAoB,CAAC;IAMS,CAAC;IAEvE,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAmB,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,eAAiC;QAC7D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { IFluidLastEditedTracker, ILastEditDetails } from \"./interfaces\";\n\n/**\n * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited\n * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block\n * as storage.\n *\n * @public\n */\nexport class LastEditedTracker implements IFluidLastEditedTracker {\n\tprivate readonly lastEditedDetailsKey = \"lastEditDetailsKey\";\n\n\t/**\n\t * Creates a LastEditedTracker object.\n\t * @param sharedSummaryBlock - The shared summary block where the details will be stored.\n\t */\n\tconstructor(private readonly sharedSummaryBlock: SharedSummaryBlock) {}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}\n\t */\n\tpublic getLastEditDetails(): ILastEditDetails | undefined {\n\t\treturn this.sharedSummaryBlock.get<ILastEditDetails>(this.lastEditedDetailsKey);\n\t}\n\n\t/**\n\t * {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}\n\t */\n\tpublic updateLastEditDetails(lastEditDetails: ILastEditDetails): void {\n\t\tthis.sharedSummaryBlock.set(this.lastEditedDetailsKey, lastEditDetails);\n\t}\n}\n"]}

package/lib/lastEditedTrackerDataObject.d.ts

@@ -7,6 +7,8 @@ import { LastEditedTracker } from "./lastEditedTracker";
 import { IProvideFluidLastEditedTracker } from "./interfaces";
 /**
  * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
  */
 export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
     private static readonly factory;

package/lib/lastEditedTrackerDataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTrackerDataObject.d.ts","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAE9D;;GAEG;AACH,qBAAa,2BACZ,SAAQ,UACR,YAAW,8BAA8B;IAEzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAO5B;WAEW,UAAU,IAAI,iBAAiB,CAAC,2BAA2B,CAAC;IAI1E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA6B;IAClE,OAAO,CAAC,kBAAkB,CAAgC;IAE1D,OAAO,KAAK,iBAAiB,GAM5B;IAED,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;cAEe,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;cAKtC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAM/C"}
+{"version":3,"file":"lastEditedTrackerDataObject.d.ts","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAE9D;;;;GAIG;AACH,qBAAa,2BACZ,SAAQ,UACR,YAAW,8BAA8B;IAEzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAO5B;WAEW,UAAU,IAAI,iBAAiB,CAAC,2BAA2B,CAAC;IAI1E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA6B;IAClE,OAAO,CAAC,kBAAkB,CAAgC;IAE1D,OAAO,KAAK,iBAAiB,GAM5B;IAED,IAAW,uBAAuB,IAAI,iBAAiB,CAEtD;cAEe,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;cAKtC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAM/C"}

package/lib/lastEditedTrackerDataObject.js

@@ -7,6 +7,8 @@ import { SharedSummaryBlock } from "@fluidframework/shared-summary-block";
 import { LastEditedTracker } from "./lastEditedTracker";
 /**
  * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
  */
 export class LastEditedTrackerDataObject extends DataObject {
     constructor() {

package/lib/lastEditedTrackerDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAO,2BACZ,SAAQ,UAAU;IADnB;;QAiBkB,yBAAoB,GAAG,yBAAyB,CAAC;IA0BnE,CAAC;IA9BO,MAAM,CAAC,UAAU;QACvB,OAAO,2BAA2B,CAAC,OAAO,CAAC;IAC5C,CAAC;IAKD,IAAY,iBAAiB;QAC5B,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC;IAChC,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;IAES,KAAK,CAAC,qBAAqB;QACpC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,kBAAkB;QACvB,oEAAoE;QACpE,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmC,IAAI,CAAC,oBAAoB,CAAE,CAAC,GAAG,EAAE,CAAC;QACzF,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IACrE,CAAC;;AAtCuB,mCAAO,GAC9B,IAAI,iBAAiB,CACpB,iCAAiC,EACjC,2BAA2B,EAC3B,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,EACjC,EAAE,EACF,SAAS,CACT,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { LastEditedTracker } from \"./lastEditedTracker\";\nimport { IProvideFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.\n */\nexport class LastEditedTrackerDataObject\n\textends DataObject\n\timplements IProvideFluidLastEditedTracker\n{\n\tprivate static readonly factory: DataObjectFactory<LastEditedTrackerDataObject> =\n\t\tnew DataObjectFactory(\n\t\t\t\"@fluid-experimental/last-edited\",\n\t\t\tLastEditedTrackerDataObject,\n\t\t\t[SharedSummaryBlock.getFactory()],\n\t\t\t{},\n\t\t\tundefined,\n\t\t);\n\n\tpublic static getFactory(): DataObjectFactory<LastEditedTrackerDataObject> {\n\t\treturn LastEditedTrackerDataObject.factory;\n\t}\n\n\tprivate readonly sharedSummaryBlockId = \"shared-summary-block-id\";\n\tprivate _lastEditedTracker: LastEditedTracker | undefined;\n\n\tprivate get lastEditedTracker(): LastEditedTracker {\n\t\tif (this._lastEditedTracker === undefined) {\n\t\t\tthrow new Error(\"Last Edited tracker was not initialized properly\");\n\t\t}\n\n\t\treturn this._lastEditedTracker;\n\t}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this.lastEditedTracker;\n\t}\n\n\tprotected async initializingFirstTime(): Promise<void> {\n\t\tconst sharedSummaryBlock = SharedSummaryBlock.create(this.runtime);\n\t\tthis.root.set(this.sharedSummaryBlockId, sharedSummaryBlock.handle);\n\t}\n\n\tprotected async hasInitialized(): Promise<void> {\n\t\tconst sharedSummaryBlock =\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tawait this.root.get<IFluidHandle<SharedSummaryBlock>>(this.sharedSummaryBlockId)!.get();\n\t\tthis._lastEditedTracker = new LastEditedTracker(sharedSummaryBlock);\n\t}\n}\n"]}
+{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;;GAIG;AACH,MAAM,OAAO,2BACZ,SAAQ,UAAU;IADnB;;QAiBkB,yBAAoB,GAAG,yBAAyB,CAAC;IA0BnE,CAAC;IA9BO,MAAM,CAAC,UAAU;QACvB,OAAO,2BAA2B,CAAC,OAAO,CAAC;IAC5C,CAAC;IAKD,IAAY,iBAAiB;QAC5B,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACpE;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC;IAChC,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;IAES,KAAK,CAAC,qBAAqB;QACpC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAES,KAAK,CAAC,cAAc;QAC7B,MAAM,kBAAkB;QACvB,oEAAoE;QACpE,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmC,IAAI,CAAC,oBAAoB,CAAE,CAAC,GAAG,EAAE,CAAC;QACzF,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IACrE,CAAC;;AAtCuB,mCAAO,GAC9B,IAAI,iBAAiB,CACpB,iCAAiC,EACjC,2BAA2B,EAC3B,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC,EACjC,EAAE,EACF,SAAS,CACT,AAP6B,CAO5B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { SharedSummaryBlock } from \"@fluidframework/shared-summary-block\";\nimport { LastEditedTracker } from \"./lastEditedTracker\";\nimport { IProvideFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.\n *\n * @public\n */\nexport class LastEditedTrackerDataObject\n\textends DataObject\n\timplements IProvideFluidLastEditedTracker\n{\n\tprivate static readonly factory: DataObjectFactory<LastEditedTrackerDataObject> =\n\t\tnew DataObjectFactory(\n\t\t\t\"@fluid-experimental/last-edited\",\n\t\t\tLastEditedTrackerDataObject,\n\t\t\t[SharedSummaryBlock.getFactory()],\n\t\t\t{},\n\t\t\tundefined,\n\t\t);\n\n\tpublic static getFactory(): DataObjectFactory<LastEditedTrackerDataObject> {\n\t\treturn LastEditedTrackerDataObject.factory;\n\t}\n\n\tprivate readonly sharedSummaryBlockId = \"shared-summary-block-id\";\n\tprivate _lastEditedTracker: LastEditedTracker | undefined;\n\n\tprivate get lastEditedTracker(): LastEditedTracker {\n\t\tif (this._lastEditedTracker === undefined) {\n\t\t\tthrow new Error(\"Last Edited tracker was not initialized properly\");\n\t\t}\n\n\t\treturn this._lastEditedTracker;\n\t}\n\n\tpublic get IFluidLastEditedTracker(): LastEditedTracker {\n\t\treturn this.lastEditedTracker;\n\t}\n\n\tprotected async initializingFirstTime(): Promise<void> {\n\t\tconst sharedSummaryBlock = SharedSummaryBlock.create(this.runtime);\n\t\tthis.root.set(this.sharedSummaryBlockId, sharedSummaryBlock.handle);\n\t}\n\n\tprotected async hasInitialized(): Promise<void> {\n\t\tconst sharedSummaryBlock =\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tawait this.root.get<IFluidHandle<SharedSummaryBlock>>(this.sharedSummaryBlockId)!.get();\n\t\tthis._lastEditedTracker = new LastEditedTracker(sharedSummaryBlock);\n\t}\n}\n"]}

package/lib/setup.d.ts

@@ -19,6 +19,8 @@ import { IFluidLastEditedTracker } from "./interfaces";
  * @param lastEditedTracker - The last edited tracker.
  * @param runtime - The container runtime whose messages are to be tracked.
  * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
  */
 export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
 //# sourceMappingURL=setup.d.ts.map

package/lib/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAkB,MAAM,sCAAsC,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAoB,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAoCzE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kCAAkC,CACjD,iBAAiB,EAAE,uBAAuB,EAC1C,OAAO,EAAE,iBAAiB,EAC1B,sBAAsB,GAAE,CACvB,OAAO,EAAE,yBAAyB,KAC9B,OAAqC,GACxC,IAAI,CAkBN"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAkB,MAAM,sCAAsC,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAoB,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAoCzE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kCAAkC,CACjD,iBAAiB,EAAE,uBAAuB,EAC1C,OAAO,EAAE,iBAAiB,EAC1B,sBAAsB,GAAE,CACvB,OAAO,EAAE,yBAAyB,KAC9B,OAAqC,GACxC,IAAI,CAkBN"}

package/lib/setup.js

@@ -45,6 +45,8 @@ function getLastEditDetailsFromMessage(message, quorum) {
  * @param lastEditedTracker - The last edited tracker.
  * @param runtime - The container runtime whose messages are to be tracked.
  * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
  */
 export function setupLastEditedTrackerForContainer(lastEditedTracker, runtime, shouldDiscardMessageFn = shouldDiscardMessageDefault) {
     // Register an op listener on the runtime. If the lastEditedTracker has loaded,

package/lib/setup.js.map

@@ -1 +1 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAIzE;;;;;;GAMG;AACH,MAAM,2BAA2B,GAAG,CAAC,OAAkC,EAAW,EAAE,CACnF,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,MAAM;IAC5C,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,gBAAgB;IACtD,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,KAAK,CAAC;AAE7C;;;GAGG;AACH,SAAS,6BAA6B,CACrC,OAAkC,EAClC,MAAsB;IAEtB,+FAA+F;IAC/F,4EAA4E;IAC5E,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAkB,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,MAAM,eAAe,GAAqB;YACzC,IAAI;YACJ,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC;QACF,OAAO,eAAe,CAAC;KACvB;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,kCAAkC,CACjD,iBAA0C,EAC1C,OAA0B,EAC1B,yBAEe,2BAA2B;IAE1C,+EAA+E;IAC/E,+CAA+C;IAC/C,8GAA8G;IAC9G,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,cAAwB,EAAE,EAAE;QACjF,6EAA6E;QAC7E,IAAI,cAAc,KAAK,KAAK,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE;YAChE,OAAO;SACP;QAED,6EAA6E;QAC7E,MAAM,eAAe,GAAG,6BAA6B,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACpF,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,OAAO;SACP;QAED,iBAAiB,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType } from \"@fluidframework/container-runtime\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { ILastEditDetails, IFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * Default implementation of {@link setupLastEditedTrackerForContainer}'s `shouldDiscardMessageFn` parameter,\n * which tells that all messages other than {@link @fluidframework/container-runtime#ContainerMessageType.Alias},\n * {@link @fluidframework/container-runtime#ContainerMessageType.Attach}, and\n * {@link @fluidframework/container-runtime#ContainerMessageType.FluidDataStoreOp} type messages should be\n * discarded.\n */\nconst shouldDiscardMessageDefault = (message: ISequencedDocumentMessage): boolean =>\n\tmessage.type !== ContainerMessageType.Attach &&\n\tmessage.type !== ContainerMessageType.FluidDataStoreOp &&\n\tmessage.type !== ContainerMessageType.Alias;\n\n/**\n * Extracts the user information and timestamp from a message. Returns undefined if the user information for the\n * client who sent the message doesn't exist in the quorum.\n */\nfunction getLastEditDetailsFromMessage(\n\tmessage: ISequencedDocumentMessage,\n\tquorum: IQuorumClients,\n): ILastEditDetails | undefined {\n\t// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)\n\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n\tconst sequencedClient = quorum.getMember(message.clientId as string);\n\tconst user = sequencedClient?.client.user;\n\tif (user !== undefined) {\n\t\tconst lastEditDetails: ILastEditDetails = {\n\t\t\tuser,\n\t\t\ttimestamp: message.timestamp,\n\t\t};\n\t\treturn lastEditDetails;\n\t}\n\treturn undefined;\n}\n\n/**\n * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.\n *\n * It does the following:\n *\n * - Registers an \"op\" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check\n * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,\n * it passes the last edited information from the message to the last edited tracker.\n *\n * - The last edited information from the last message received before the lastEditedTracker is\n * loaded is stored and passed to the tracker once it loads.\n * @param lastEditedTracker - The last edited tracker.\n * @param runtime - The container runtime whose messages are to be tracked.\n * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.\n */\nexport function setupLastEditedTrackerForContainer(\n\tlastEditedTracker: IFluidLastEditedTracker,\n\truntime: IContainerRuntime,\n\tshouldDiscardMessageFn: (\n\t\tmessage: ISequencedDocumentMessage,\n\t) => boolean = shouldDiscardMessageDefault,\n): void {\n\t// Register an op listener on the runtime. If the lastEditedTracker has loaded,\n\t// it passes the last edited information to its\n\t// last edited tracker. If the lastEditedTracker hasn't loaded, store the last edited information temporarily.\n\truntime.on(\"op\", (message: ISequencedDocumentMessage, runtimeMessage?: boolean) => {\n\t\t// If this message should be discarded as per shouldDiscardMessageFn, return.\n\t\tif (runtimeMessage === false || shouldDiscardMessageFn(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Get the last edited details from the message. If it doesn't exist, return.\n\t\tconst lastEditDetails = getLastEditDetailsFromMessage(message, runtime.getQuorum());\n\t\tif (lastEditDetails === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tlastEditedTracker.updateLastEditDetails(lastEditDetails);\n\t});\n}\n"]}
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAIzE;;;;;;GAMG;AACH,MAAM,2BAA2B,GAAG,CAAC,OAAkC,EAAW,EAAE,CACnF,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,MAAM;IAC5C,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,gBAAgB;IACtD,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,KAAK,CAAC;AAE7C;;;GAGG;AACH,SAAS,6BAA6B,CACrC,OAAkC,EAClC,MAAsB;IAEtB,+FAA+F;IAC/F,4EAA4E;IAC5E,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAkB,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,MAAM,eAAe,GAAqB;YACzC,IAAI;YACJ,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC;QACF,OAAO,eAAe,CAAC;KACvB;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kCAAkC,CACjD,iBAA0C,EAC1C,OAA0B,EAC1B,yBAEe,2BAA2B;IAE1C,+EAA+E;IAC/E,+CAA+C;IAC/C,8GAA8G;IAC9G,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,cAAwB,EAAE,EAAE;QACjF,6EAA6E;QAC7E,IAAI,cAAc,KAAK,KAAK,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE;YAChE,OAAO;SACP;QAED,6EAA6E;QAC7E,MAAM,eAAe,GAAG,6BAA6B,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACpF,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,OAAO;SACP;QAED,iBAAiB,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType } from \"@fluidframework/container-runtime\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { ILastEditDetails, IFluidLastEditedTracker } from \"./interfaces\";\n\n/**\n * Default implementation of {@link setupLastEditedTrackerForContainer}'s `shouldDiscardMessageFn` parameter,\n * which tells that all messages other than {@link @fluidframework/container-runtime#ContainerMessageType.Alias},\n * {@link @fluidframework/container-runtime#ContainerMessageType.Attach}, and\n * {@link @fluidframework/container-runtime#ContainerMessageType.FluidDataStoreOp} type messages should be\n * discarded.\n */\nconst shouldDiscardMessageDefault = (message: ISequencedDocumentMessage): boolean =>\n\tmessage.type !== ContainerMessageType.Attach &&\n\tmessage.type !== ContainerMessageType.FluidDataStoreOp &&\n\tmessage.type !== ContainerMessageType.Alias;\n\n/**\n * Extracts the user information and timestamp from a message. Returns undefined if the user information for the\n * client who sent the message doesn't exist in the quorum.\n */\nfunction getLastEditDetailsFromMessage(\n\tmessage: ISequencedDocumentMessage,\n\tquorum: IQuorumClients,\n): ILastEditDetails | undefined {\n\t// TODO: Verify whether this should be able to handle server-generated ops (with null clientId)\n\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n\tconst sequencedClient = quorum.getMember(message.clientId as string);\n\tconst user = sequencedClient?.client.user;\n\tif (user !== undefined) {\n\t\tconst lastEditDetails: ILastEditDetails = {\n\t\t\tuser,\n\t\t\ttimestamp: message.timestamp,\n\t\t};\n\t\treturn lastEditDetails;\n\t}\n\treturn undefined;\n}\n\n/**\n * Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.\n *\n * It does the following:\n *\n * - Registers an \"op\" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check\n * if the message should be discarded. It also discards all scheduler message. If a message is not discarded,\n * it passes the last edited information from the message to the last edited tracker.\n *\n * - The last edited information from the last message received before the lastEditedTracker is\n * loaded is stored and passed to the tracker once it loads.\n * @param lastEditedTracker - The last edited tracker.\n * @param runtime - The container runtime whose messages are to be tracked.\n * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.\n *\n * @public\n */\nexport function setupLastEditedTrackerForContainer(\n\tlastEditedTracker: IFluidLastEditedTracker,\n\truntime: IContainerRuntime,\n\tshouldDiscardMessageFn: (\n\t\tmessage: ISequencedDocumentMessage,\n\t) => boolean = shouldDiscardMessageDefault,\n): void {\n\t// Register an op listener on the runtime. If the lastEditedTracker has loaded,\n\t// it passes the last edited information to its\n\t// last edited tracker. If the lastEditedTracker hasn't loaded, store the last edited information temporarily.\n\truntime.on(\"op\", (message: ISequencedDocumentMessage, runtimeMessage?: boolean) => {\n\t\t// If this message should be discarded as per shouldDiscardMessageFn, return.\n\t\tif (runtimeMessage === false || shouldDiscardMessageFn(message)) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Get the last edited details from the message. If it doesn't exist, return.\n\t\tconst lastEditDetails = getLastEditDetailsFromMessage(message, runtime.getQuorum());\n\t\tif (lastEditDetails === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tlastEditedTracker.updateLastEditDetails(lastEditDetails);\n\t});\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/last-edited",
-  "version": "2.0.0-dev.6.4.0.192049",
+  "version": "2.0.0-dev.7.2.0.204906",
   "description": "Tracks the last edited information in the Container.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,27 +35,26 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/container-runtime": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/core-interfaces": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-utils": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/shared-summary-block": "2.0.0-dev.6.4.0.192049"
+    "@fluidframework/aqueduct": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/container-runtime": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/protocol-definitions": "^3.0.0",
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/shared-summary-block": "2.0.0-dev.7.2.0.204906"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.22.0",
-    "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.22.0",
-    "@fluidframework/eslint-config-fluid": "^2.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.6.4.0.192049",
-    "@microsoft/api-extractor": "^7.34.4",
+    "@fluid-tools/build-cli": "0.26.0-203096",
+    "@fluidframework/build-common": "^2.0.2",
+    "@fluidframework/build-tools": "0.26.0-203096",
+    "@fluidframework/eslint-config-fluid": "^3.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.204906",
+    "@microsoft/api-extractor": "^7.37.0",
     "@types/node": "^16.18.38",
-    "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
+    "eslint": "~8.50.0",
+    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "typescript": "~4.5.5"
+    "typescript": "~5.1.6"
   },
   "typeValidation": {
     "disabled": true,
@@ -65,9 +64,9 @@
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
     "build:compile:min": "npm run build:compile",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",

package/src/interfaces.ts

@@ -5,13 +5,22 @@
 
 import { IUser } from "@fluidframework/protocol-definitions";
 
+/**
+ * @public
+ */
 export const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =
 	"IFluidLastEditedTracker";
 
+/**
+ * @public
+ */
 export interface IProvideFluidLastEditedTracker {
 	readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
 }
 
+/**
+ * @public
+ */
 export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
 	/**
 	 * Returns the details of the last edit to the container.
@@ -24,6 +33,9 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
 	updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
 }
 
+/**
+ * @public
+ */
 export interface ILastEditDetails {
 	user: IUser;
 	timestamp: number;

package/src/lastEditedTracker.ts

@@ -10,6 +10,8 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
  * Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
  * details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
  * as storage.
+ *
+ * @public
  */
 export class LastEditedTracker implements IFluidLastEditedTracker {
 	private readonly lastEditedDetailsKey = "lastEditDetailsKey";

package/src/lastEditedTrackerDataObject.ts

@@ -11,6 +11,8 @@ import { IProvideFluidLastEditedTracker } from "./interfaces";
 
 /**
  * LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
+ *
+ * @public
  */
 export class LastEditedTrackerDataObject
 	extends DataObject

package/src/setup.ts

@@ -56,6 +56,8 @@ function getLastEditDetailsFromMessage(
  * @param lastEditedTracker - The last edited tracker.
  * @param runtime - The container runtime whose messages are to be tracked.
  * @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
+ *
+ * @public
  */
 export function setupLastEditedTrackerForContainer(
 	lastEditedTracker: IFluidLastEditedTracker,