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

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluid-experimental/last-edited
 
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.1.0
 
 Dependency updates only.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/last-edited",
-  "version": "2.0.0-dev.7.2.0.204906",
+  "version": "2.0.0-dev.7.3.0.206769",
   "description": "Tracks the last edited information in the Container.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,20 +35,20 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@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/aqueduct": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/container-runtime": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.3.0.206769",
     "@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"
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/shared-summary-block": "2.0.0-dev.7.3.0.206769"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "0.26.0-203096",
-    "@fluidframework/build-common": "^2.0.2",
-    "@fluidframework/build-tools": "0.26.0-203096",
+    "@fluid-tools/build-cli": "^0.26.1",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.26.1",
     "@fluidframework/eslint-config-fluid": "^3.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.3.0.206769",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/node": "^16.18.38",
     "eslint": "~8.50.0",
@@ -67,7 +67,7 @@
     "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
+    "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",
     "format": "npm run prettier:fix",

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

@@ -1,103 +0,0 @@
-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

@@ -1,103 +0,0 @@
-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

@@ -1,103 +0,0 @@
-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

@@ -1,103 +0,0 @@
-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 { }