@fluid-experimental/last-edited 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +26 -6
- package/api-extractor-lint.json +13 -0
- package/api-extractor.json +9 -1
- package/api-report/last-edited.api.md +7 -7
- package/dist/interfaces.d.ts +4 -4
- package/dist/interfaces.js +1 -1
- package/dist/interfaces.js.map +1 -1
- package/dist/last-edited-alpha.d.ts +22 -0
- package/dist/last-edited-beta.d.ts +28 -0
- package/dist/last-edited-public.d.ts +28 -0
- package/dist/last-edited-untrimmed.d.ts +100 -0
- package/dist/lastEditedTracker.d.ts +1 -2
- package/dist/lastEditedTracker.d.ts.map +1 -1
- package/dist/lastEditedTracker.js +1 -2
- package/dist/lastEditedTracker.js.map +1 -1
- package/dist/lastEditedTrackerDataObject.d.ts +1 -2
- package/dist/lastEditedTrackerDataObject.d.ts.map +1 -1
- package/dist/lastEditedTrackerDataObject.js +1 -2
- package/dist/lastEditedTrackerDataObject.js.map +1 -1
- package/dist/setup.d.ts +1 -2
- package/dist/setup.d.ts.map +1 -1
- package/dist/setup.js +1 -2
- package/dist/setup.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/interfaces.d.ts +4 -4
- package/lib/interfaces.js +1 -1
- package/lib/interfaces.js.map +1 -1
- package/lib/lastEditedTracker.d.ts +1 -2
- package/lib/lastEditedTracker.d.ts.map +1 -1
- package/lib/lastEditedTracker.js +1 -2
- package/lib/lastEditedTracker.js.map +1 -1
- package/lib/lastEditedTrackerDataObject.d.ts +1 -2
- package/lib/lastEditedTrackerDataObject.d.ts.map +1 -1
- package/lib/lastEditedTrackerDataObject.js +1 -2
- package/lib/lastEditedTrackerDataObject.js.map +1 -1
- package/lib/setup.d.ts +1 -2
- package/lib/setup.d.ts.map +1 -1
- package/lib/setup.js +1 -2
- package/lib/setup.js.map +1 -1
- package/package.json +18 -17
- package/src/interfaces.ts +4 -4
- package/src/lastEditedTracker.ts +1 -2
- package/src/lastEditedTrackerDataObject.ts +1 -2
- package/src/setup.ts +1 -2
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# @fluid-experimental/last-edited
|
|
2
2
|
|
|
3
|
+
<!-- AUTO-GENERATED-CONTENT:START (README_PACKAGE_SCOPE_NOTICE) -->
|
|
4
|
+
|
|
5
|
+
**IMPORTANT: This package is experimental.**
|
|
6
|
+
**Its APIs may change without notice.**
|
|
7
|
+
|
|
8
|
+
**Do not use in production scenarios.**
|
|
9
|
+
|
|
10
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
11
|
+
|
|
3
12
|
LastEditedTracker tracks the last edit to a document, such as the client who last edited the document and the time it happened.
|
|
4
13
|
|
|
5
14
|
It is created by passing a `SharedSummaryBlock`:
|
|
@@ -26,13 +35,13 @@ The update should always be called in response to a remote op because:
|
|
|
26
35
|
|
|
27
36
|
The details returned in getLastEditDetails contain the `IUser` object and the `timestamp` of the last edit.
|
|
28
37
|
|
|
29
|
-
|
|
38
|
+
## Last Edited Tracker Data Store
|
|
30
39
|
|
|
31
40
|
LastEditedTrackerDataObject is a runtime data store built on top of the LastEditedTracker. It creates and manages the SharedSummaryBlock so that the developer doesn't have to know about it or manage it.
|
|
32
41
|
|
|
33
42
|
It implements IProvideFluidLastEditedTracker and returns an IFluidLastEditedTracker which is an instance of LastEditedTracker above.
|
|
34
43
|
|
|
35
|
-
|
|
44
|
+
## Setup
|
|
36
45
|
|
|
37
46
|
This package also provides a `setupLastEditedTrackerForContainer` method that can be used to set up a data store that provides IFluidLastEditedTracker to track last edited in a Container:
|
|
38
47
|
|
|
@@ -54,9 +63,9 @@ function shouldDiscardMessageDefault(message: ISequencedDocumentMessage) {
|
|
|
54
63
|
|
|
55
64
|
- To discard specific ops, provide the `shouldDiscardMessageFn` funtion that takes in the message and returns a boolean indicating if the message should be discarded.
|
|
56
65
|
|
|
57
|
-
|
|
66
|
+
## Usage
|
|
58
67
|
|
|
59
|
-
|
|
68
|
+
### For tracking the last edit on a Container:
|
|
60
69
|
|
|
61
70
|
In instantiateRuntime, create a data store that implements IFluidLastEditedTracker. Then call `setupLastEditedTrackerForContainer` with the id of the data store:
|
|
62
71
|
|
|
@@ -88,8 +97,19 @@ const root = response.value;
|
|
|
88
97
|
const lastEditedTracker = root.IFluidLastEditedTracker;
|
|
89
98
|
```
|
|
90
99
|
|
|
100
|
+
<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
|
|
101
|
+
|
|
102
|
+
<!-- prettier-ignore-start -->
|
|
103
|
+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
104
|
+
|
|
91
105
|
## Trademark
|
|
92
106
|
|
|
93
|
-
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
94
|
-
|
|
107
|
+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
108
|
+
|
|
109
|
+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
|
110
|
+
|
|
95
111
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
112
|
+
|
|
113
|
+
<!-- prettier-ignore-end -->
|
|
114
|
+
|
|
115
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-lint.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: remove once base config has this enabled as an error
|
|
7
|
+
"ae-incompatible-release-tags": {
|
|
8
|
+
"logLevel": "error",
|
|
9
|
+
"addToApiReportFile": false
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
package/api-extractor.json
CHANGED
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-base.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: Add missing documentation and remove this rule override
|
|
7
|
+
"ae-undocumented": {
|
|
8
|
+
"logLevel": "none"
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
}
|
|
4
12
|
}
|
|
@@ -11,16 +11,16 @@ import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions'
|
|
|
11
11
|
import { IUser } from '@fluidframework/protocol-definitions';
|
|
12
12
|
import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
|
|
13
13
|
|
|
14
|
-
// @
|
|
14
|
+
// @internal (undocumented)
|
|
15
15
|
export const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
|
|
16
16
|
|
|
17
|
-
// @
|
|
17
|
+
// @internal (undocumented)
|
|
18
18
|
export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
|
|
19
19
|
getLastEditDetails(): ILastEditDetails | undefined;
|
|
20
20
|
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
21
21
|
}
|
|
22
22
|
|
|
23
|
-
// @
|
|
23
|
+
// @internal (undocumented)
|
|
24
24
|
export interface ILastEditDetails {
|
|
25
25
|
// (undocumented)
|
|
26
26
|
timestamp: number;
|
|
@@ -28,13 +28,13 @@ export interface ILastEditDetails {
|
|
|
28
28
|
user: IUser;
|
|
29
29
|
}
|
|
30
30
|
|
|
31
|
-
// @
|
|
31
|
+
// @internal (undocumented)
|
|
32
32
|
export interface IProvideFluidLastEditedTracker {
|
|
33
33
|
// (undocumented)
|
|
34
34
|
readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
// @
|
|
37
|
+
// @internal
|
|
38
38
|
export class LastEditedTracker implements IFluidLastEditedTracker {
|
|
39
39
|
constructor(sharedSummaryBlock: SharedSummaryBlock);
|
|
40
40
|
getLastEditDetails(): ILastEditDetails | undefined;
|
|
@@ -43,7 +43,7 @@ export class LastEditedTracker implements IFluidLastEditedTracker {
|
|
|
43
43
|
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
44
44
|
}
|
|
45
45
|
|
|
46
|
-
// @
|
|
46
|
+
// @internal
|
|
47
47
|
export class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
|
|
48
48
|
// (undocumented)
|
|
49
49
|
static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
|
|
@@ -55,7 +55,7 @@ export class LastEditedTrackerDataObject extends DataObject implements IProvideF
|
|
|
55
55
|
protected initializingFirstTime(): Promise<void>;
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
// @
|
|
58
|
+
// @internal
|
|
59
59
|
export function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
|
|
60
60
|
|
|
61
61
|
// (No @packageDocumentation comment for this package)
|
package/dist/interfaces.d.ts
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { IUser } from "@fluidframework/protocol-definitions";
|
|
6
6
|
/**
|
|
7
|
-
* @
|
|
7
|
+
* @internal
|
|
8
8
|
*/
|
|
9
9
|
export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
|
|
10
10
|
/**
|
|
11
|
-
* @
|
|
11
|
+
* @internal
|
|
12
12
|
*/
|
|
13
13
|
export interface IProvideFluidLastEditedTracker {
|
|
14
14
|
readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @
|
|
17
|
+
* @internal
|
|
18
18
|
*/
|
|
19
19
|
export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
|
|
20
20
|
/**
|
|
@@ -27,7 +27,7 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
|
|
|
27
27
|
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
* @
|
|
30
|
+
* @internal
|
|
31
31
|
*/
|
|
32
32
|
export interface ILastEditDetails {
|
|
33
33
|
user: IUser;
|
package/dist/interfaces.js
CHANGED
package/dist/interfaces.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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 * @
|
|
1
|
+
{"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 * @internal\n */\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\n/**\n * @internal\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 * @internal\n */\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { DataObject } from '@fluidframework/aqueduct';
|
|
2
|
+
import { DataObjectFactory } from '@fluidframework/aqueduct';
|
|
3
|
+
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
4
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
5
|
+
import { IUser } from '@fluidframework/protocol-definitions';
|
|
6
|
+
import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
|
|
7
|
+
|
|
8
|
+
/* Excluded from this release type: IFluidLastEditedTracker */
|
|
9
|
+
|
|
10
|
+
/* Excluded from this release type: ILastEditDetails */
|
|
11
|
+
|
|
12
|
+
/* Excluded from this release type: IProvideFluidLastEditedTracker */
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: LastEditedTracker */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: LastEditedTrackerDataObject */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: setupLastEditedTrackerForContainer */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: SharedSummaryBlock */
|
|
21
|
+
|
|
22
|
+
export { }
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { DataObject } from '@fluidframework/aqueduct';
|
|
2
|
+
import { DataObjectFactory } from '@fluidframework/aqueduct';
|
|
3
|
+
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
4
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
5
|
+
import { IUser } from '@fluidframework/protocol-definitions';
|
|
6
|
+
import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
|
|
7
|
+
|
|
8
|
+
/* Excluded from this release type: DataObject */
|
|
9
|
+
|
|
10
|
+
/* Excluded from this release type: DataObjectFactory */
|
|
11
|
+
|
|
12
|
+
/* Excluded from this release type: IContainerRuntime */
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: IFluidLastEditedTracker */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: ILastEditDetails */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: IProvideFluidLastEditedTracker */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: LastEditedTracker */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: LastEditedTrackerDataObject */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: setupLastEditedTrackerForContainer */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: SharedSummaryBlock */
|
|
27
|
+
|
|
28
|
+
export { }
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { DataObject } from '@fluidframework/aqueduct';
|
|
2
|
+
import { DataObjectFactory } from '@fluidframework/aqueduct';
|
|
3
|
+
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
4
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
5
|
+
import { IUser } from '@fluidframework/protocol-definitions';
|
|
6
|
+
import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
|
|
7
|
+
|
|
8
|
+
/* Excluded from this release type: DataObject */
|
|
9
|
+
|
|
10
|
+
/* Excluded from this release type: DataObjectFactory */
|
|
11
|
+
|
|
12
|
+
/* Excluded from this release type: IContainerRuntime */
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: IFluidLastEditedTracker */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: ILastEditDetails */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: IProvideFluidLastEditedTracker */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: LastEditedTracker */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: LastEditedTrackerDataObject */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: setupLastEditedTrackerForContainer */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: SharedSummaryBlock */
|
|
27
|
+
|
|
28
|
+
export { }
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { DataObject } from '@fluidframework/aqueduct';
|
|
2
|
+
import { DataObjectFactory } from '@fluidframework/aqueduct';
|
|
3
|
+
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
4
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
5
|
+
import { IUser } from '@fluidframework/protocol-definitions';
|
|
6
|
+
import { SharedSummaryBlock } from '@fluidframework/shared-summary-block';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
|
|
17
|
+
/**
|
|
18
|
+
* Returns the details of the last edit to the container.
|
|
19
|
+
*/
|
|
20
|
+
getLastEditDetails(): ILastEditDetails | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* Updates the details of last edit to the container.
|
|
23
|
+
*/
|
|
24
|
+
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
export declare interface ILastEditDetails {
|
|
31
|
+
user: IUser;
|
|
32
|
+
timestamp: number;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
export declare interface IProvideFluidLastEditedTracker {
|
|
39
|
+
readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
44
|
+
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
45
|
+
* as storage.
|
|
46
|
+
* @internal
|
|
47
|
+
*/
|
|
48
|
+
export declare class LastEditedTracker implements IFluidLastEditedTracker {
|
|
49
|
+
private readonly sharedSummaryBlock;
|
|
50
|
+
private readonly lastEditedDetailsKey;
|
|
51
|
+
/**
|
|
52
|
+
* Creates a LastEditedTracker object.
|
|
53
|
+
* @param sharedSummaryBlock - The shared summary block where the details will be stored.
|
|
54
|
+
*/
|
|
55
|
+
constructor(sharedSummaryBlock: SharedSummaryBlock);
|
|
56
|
+
get IFluidLastEditedTracker(): LastEditedTracker;
|
|
57
|
+
/**
|
|
58
|
+
* {@inheritDoc (IFluidLastEditedTracker:interface).getLastEditDetails}
|
|
59
|
+
*/
|
|
60
|
+
getLastEditDetails(): ILastEditDetails | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* {@inheritDoc (IFluidLastEditedTracker:interface).updateLastEditDetails}
|
|
63
|
+
*/
|
|
64
|
+
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
|
|
72
|
+
private static readonly factory;
|
|
73
|
+
static getFactory(): DataObjectFactory<LastEditedTrackerDataObject>;
|
|
74
|
+
private readonly sharedSummaryBlockId;
|
|
75
|
+
private _lastEditedTracker;
|
|
76
|
+
private get lastEditedTracker();
|
|
77
|
+
get IFluidLastEditedTracker(): LastEditedTracker;
|
|
78
|
+
protected initializingFirstTime(): Promise<void>;
|
|
79
|
+
protected hasInitialized(): Promise<void>;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Helper function to set up a data object that provides IFluidLastEditedTracker to track last edited in a Container.
|
|
84
|
+
*
|
|
85
|
+
* It does the following:
|
|
86
|
+
*
|
|
87
|
+
* - Registers an "op" listener on the runtime. On each message, it calls the shouldDiscardMessageFn to check
|
|
88
|
+
* if the message should be discarded. It also discards all scheduler message. If a message is not discarded,
|
|
89
|
+
* it passes the last edited information from the message to the last edited tracker.
|
|
90
|
+
*
|
|
91
|
+
* - The last edited information from the last message received before the lastEditedTracker is
|
|
92
|
+
* loaded is stored and passed to the tracker once it loads.
|
|
93
|
+
* @param lastEditedTracker - The last edited tracker.
|
|
94
|
+
* @param runtime - The container runtime whose messages are to be tracked.
|
|
95
|
+
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
|
|
99
|
+
|
|
100
|
+
export { }
|
|
@@ -8,8 +8,7 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
|
|
|
8
8
|
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
9
9
|
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
10
10
|
* as storage.
|
|
11
|
-
*
|
|
12
|
-
* @public
|
|
11
|
+
* @internal
|
|
13
12
|
*/
|
|
14
13
|
export declare class LastEditedTracker implements IFluidLastEditedTracker {
|
|
15
14
|
private readonly sharedSummaryBlock;
|
|
@@ -1 +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
|
|
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;;;;;GAKG;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"}
|
|
@@ -9,8 +9,7 @@ exports.LastEditedTracker = void 0;
|
|
|
9
9
|
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
10
10
|
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
11
11
|
* as storage.
|
|
12
|
-
*
|
|
13
|
-
* @public
|
|
12
|
+
* @internal
|
|
14
13
|
*/
|
|
15
14
|
class LastEditedTracker {
|
|
16
15
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH
|
|
1
|
+
{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;;;GAKG;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 * @internal\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"]}
|
|
@@ -7,8 +7,7 @@ import { LastEditedTracker } from "./lastEditedTracker";
|
|
|
7
7
|
import { IProvideFluidLastEditedTracker } from "./interfaces";
|
|
8
8
|
/**
|
|
9
9
|
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
10
|
+
* @internal
|
|
12
11
|
*/
|
|
13
12
|
export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
|
|
14
13
|
private static readonly factory;
|
|
@@ -1 +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
|
|
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;;;GAGG;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"}
|
|
@@ -10,8 +10,7 @@ const shared_summary_block_1 = require("@fluidframework/shared-summary-block");
|
|
|
10
10
|
const lastEditedTracker_1 = require("./lastEditedTracker");
|
|
11
11
|
/**
|
|
12
12
|
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
13
|
-
*
|
|
14
|
-
* @public
|
|
13
|
+
* @internal
|
|
15
14
|
*/
|
|
16
15
|
class LastEditedTrackerDataObject extends aqueduct_1.DataObject {
|
|
17
16
|
constructor() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAyE;AAEzE,+EAA0E;AAC1E,2DAAwD;AAGxD
|
|
1
|
+
{"version":3,"file":"lastEditedTrackerDataObject.js","sourceRoot":"","sources":["../src/lastEditedTrackerDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAyE;AAEzE,+EAA0E;AAC1E,2DAAwD;AAGxD;;;GAGG;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 * @internal\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
CHANGED
|
@@ -19,8 +19,7 @@ import { IFluidLastEditedTracker } from "./interfaces";
|
|
|
19
19
|
* @param lastEditedTracker - The last edited tracker.
|
|
20
20
|
* @param runtime - The container runtime whose messages are to be tracked.
|
|
21
21
|
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
22
|
-
*
|
|
23
|
-
* @public
|
|
22
|
+
* @internal
|
|
24
23
|
*/
|
|
25
24
|
export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
|
|
26
25
|
//# sourceMappingURL=setup.d.ts.map
|
package/dist/setup.d.ts.map
CHANGED
|
@@ -1 +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
|
|
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;;;;;;;;;;;;;;;GAeG;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
CHANGED
|
@@ -48,8 +48,7 @@ function getLastEditDetailsFromMessage(message, quorum) {
|
|
|
48
48
|
* @param lastEditedTracker - The last edited tracker.
|
|
49
49
|
* @param runtime - The container runtime whose messages are to be tracked.
|
|
50
50
|
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
51
|
-
*
|
|
52
|
-
* @public
|
|
51
|
+
* @internal
|
|
53
52
|
*/
|
|
54
53
|
function setupLastEditedTrackerForContainer(lastEditedTracker, runtime, shouldDiscardMessageFn = shouldDiscardMessageDefault) {
|
|
55
54
|
// Register an op listener on the runtime. If the lastEditedTracker has loaded,
|
package/dist/setup.js.map
CHANGED
|
@@ -1 +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
|
|
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;;;;;;;;;;;;;;;GAeG;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 * @internal\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
CHANGED
package/lib/interfaces.d.ts
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { IUser } from "@fluidframework/protocol-definitions";
|
|
6
6
|
/**
|
|
7
|
-
* @
|
|
7
|
+
* @internal
|
|
8
8
|
*/
|
|
9
9
|
export declare const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker;
|
|
10
10
|
/**
|
|
11
|
-
* @
|
|
11
|
+
* @internal
|
|
12
12
|
*/
|
|
13
13
|
export interface IProvideFluidLastEditedTracker {
|
|
14
14
|
readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @
|
|
17
|
+
* @internal
|
|
18
18
|
*/
|
|
19
19
|
export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
|
|
20
20
|
/**
|
|
@@ -27,7 +27,7 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
|
|
|
27
27
|
updateLastEditDetails(lastEditDetails: ILastEditDetails): void;
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
* @
|
|
30
|
+
* @internal
|
|
31
31
|
*/
|
|
32
32
|
export interface ILastEditDetails {
|
|
33
33
|
user: IUser;
|
package/lib/interfaces.js
CHANGED
package/lib/interfaces.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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 * @
|
|
1
|
+
{"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 * @internal\n */\nexport const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =\n\t\"IFluidLastEditedTracker\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidLastEditedTracker {\n\treadonly IFluidLastEditedTracker: IFluidLastEditedTracker;\n}\n\n/**\n * @internal\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 * @internal\n */\nexport interface ILastEditDetails {\n\tuser: IUser;\n\ttimestamp: number;\n}\n"]}
|
|
@@ -8,8 +8,7 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
|
|
|
8
8
|
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
9
9
|
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
10
10
|
* as storage.
|
|
11
|
-
*
|
|
12
|
-
* @public
|
|
11
|
+
* @internal
|
|
13
12
|
*/
|
|
14
13
|
export declare class LastEditedTracker implements IFluidLastEditedTracker {
|
|
15
14
|
private readonly sharedSummaryBlock;
|
|
@@ -1 +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
|
|
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;;;;;GAKG;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
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
7
7
|
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
8
8
|
* as storage.
|
|
9
|
-
*
|
|
10
|
-
* @public
|
|
9
|
+
* @internal
|
|
11
10
|
*/
|
|
12
11
|
export class LastEditedTracker {
|
|
13
12
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH
|
|
1
|
+
{"version":3,"file":"lastEditedTracker.js","sourceRoot":"","sources":["../src/lastEditedTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;;GAKG;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 * @internal\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"]}
|
|
@@ -7,8 +7,7 @@ import { LastEditedTracker } from "./lastEditedTracker";
|
|
|
7
7
|
import { IProvideFluidLastEditedTracker } from "./interfaces";
|
|
8
8
|
/**
|
|
9
9
|
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
10
|
+
* @internal
|
|
12
11
|
*/
|
|
13
12
|
export declare class LastEditedTrackerDataObject extends DataObject implements IProvideFluidLastEditedTracker {
|
|
14
13
|
private static readonly factory;
|
|
@@ -1 +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
|
|
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;;;GAGG;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"}
|
|
@@ -7,8 +7,7 @@ import { SharedSummaryBlock } from "@fluidframework/shared-summary-block";
|
|
|
7
7
|
import { LastEditedTracker } from "./lastEditedTracker";
|
|
8
8
|
/**
|
|
9
9
|
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
10
|
+
* @internal
|
|
12
11
|
*/
|
|
13
12
|
export class LastEditedTrackerDataObject extends DataObject {
|
|
14
13
|
constructor() {
|
|
@@ -1 +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
|
|
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;;;GAGG;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 * @internal\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
CHANGED
|
@@ -19,8 +19,7 @@ import { IFluidLastEditedTracker } from "./interfaces";
|
|
|
19
19
|
* @param lastEditedTracker - The last edited tracker.
|
|
20
20
|
* @param runtime - The container runtime whose messages are to be tracked.
|
|
21
21
|
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
22
|
-
*
|
|
23
|
-
* @public
|
|
22
|
+
* @internal
|
|
24
23
|
*/
|
|
25
24
|
export declare function setupLastEditedTrackerForContainer(lastEditedTracker: IFluidLastEditedTracker, runtime: IContainerRuntime, shouldDiscardMessageFn?: (message: ISequencedDocumentMessage) => boolean): void;
|
|
26
25
|
//# sourceMappingURL=setup.d.ts.map
|
package/lib/setup.d.ts.map
CHANGED
|
@@ -1 +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
|
|
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;;;;;;;;;;;;;;;GAeG;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
CHANGED
|
@@ -45,8 +45,7 @@ function getLastEditDetailsFromMessage(message, quorum) {
|
|
|
45
45
|
* @param lastEditedTracker - The last edited tracker.
|
|
46
46
|
* @param runtime - The container runtime whose messages are to be tracked.
|
|
47
47
|
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
48
|
-
*
|
|
49
|
-
* @public
|
|
48
|
+
* @internal
|
|
50
49
|
*/
|
|
51
50
|
export function setupLastEditedTrackerForContainer(lastEditedTracker, runtime, shouldDiscardMessageFn = shouldDiscardMessageDefault) {
|
|
52
51
|
// Register an op listener on the runtime. If the lastEditedTracker has loaded,
|
package/lib/setup.js.map
CHANGED
|
@@ -1 +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
|
|
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;;;;;;;;;;;;;;;GAeG;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 * @internal\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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluid-experimental/last-edited",
|
|
3
|
-
"version": "2.0.0-internal.7.
|
|
3
|
+
"version": "2.0.0-internal.7.4.0",
|
|
4
4
|
"description": "Tracks the last edited information in the Container.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -35,22 +35,22 @@
|
|
|
35
35
|
"temp-directory": "nyc/.nyc_output"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@fluidframework/aqueduct": ">=2.0.0-internal.7.
|
|
39
|
-
"@fluidframework/container-runtime": ">=2.0.0-internal.7.
|
|
40
|
-
"@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.
|
|
41
|
-
"@fluidframework/core-interfaces": ">=2.0.0-internal.7.
|
|
38
|
+
"@fluidframework/aqueduct": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
39
|
+
"@fluidframework/container-runtime": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
40
|
+
"@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
41
|
+
"@fluidframework/core-interfaces": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
42
42
|
"@fluidframework/protocol-definitions": "^3.0.0",
|
|
43
|
-
"@fluidframework/runtime-utils": ">=2.0.0-internal.7.
|
|
44
|
-
"@fluidframework/shared-summary-block": ">=2.0.0-internal.7.
|
|
43
|
+
"@fluidframework/runtime-utils": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
44
|
+
"@fluidframework/shared-summary-block": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@fluid-tools/build-cli": "^0.
|
|
47
|
+
"@fluid-tools/build-cli": "^0.28.0",
|
|
48
48
|
"@fluidframework/build-common": "^2.0.3",
|
|
49
|
-
"@fluidframework/build-tools": "^0.
|
|
50
|
-
"@fluidframework/eslint-config-fluid": "^3.
|
|
51
|
-
"@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.
|
|
52
|
-
"@microsoft/api-extractor": "^7.
|
|
53
|
-
"@types/node": "^
|
|
49
|
+
"@fluidframework/build-tools": "^0.28.0",
|
|
50
|
+
"@fluidframework/eslint-config-fluid": "^3.1.0",
|
|
51
|
+
"@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.4.0 <2.0.0-internal.7.5.0",
|
|
52
|
+
"@microsoft/api-extractor": "^7.38.3",
|
|
53
|
+
"@types/node": "^18.19.0",
|
|
54
54
|
"eslint": "~8.50.0",
|
|
55
55
|
"prettier": "~3.0.3",
|
|
56
56
|
"rimraf": "^4.4.0",
|
|
@@ -66,15 +66,16 @@
|
|
|
66
66
|
"build:compile:min": "npm run build:compile",
|
|
67
67
|
"build:docs": "api-extractor run --local",
|
|
68
68
|
"build:esnext": "tsc --project ./tsconfig.esnext.json",
|
|
69
|
+
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
69
70
|
"ci:build:docs": "api-extractor run",
|
|
70
|
-
"clean": "rimraf --glob dist lib \"
|
|
71
|
+
"clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
|
|
71
72
|
"eslint": "eslint --format stylish src",
|
|
72
73
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
73
74
|
"format": "npm run prettier:fix",
|
|
74
|
-
"lint": "npm run prettier && npm run eslint",
|
|
75
|
+
"lint": "npm run prettier && npm run check:release-tags && npm run eslint",
|
|
75
76
|
"lint:fix": "npm run prettier:fix && npm run eslint:fix",
|
|
76
|
-
"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
|
|
77
|
-
"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
|
|
77
|
+
"prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
78
|
+
"prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
78
79
|
"tsc": "tsc"
|
|
79
80
|
}
|
|
80
81
|
}
|
package/src/interfaces.ts
CHANGED
|
@@ -6,20 +6,20 @@
|
|
|
6
6
|
import { IUser } from "@fluidframework/protocol-definitions";
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @
|
|
9
|
+
* @internal
|
|
10
10
|
*/
|
|
11
11
|
export const IFluidLastEditedTracker: keyof IProvideFluidLastEditedTracker =
|
|
12
12
|
"IFluidLastEditedTracker";
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
* @
|
|
15
|
+
* @internal
|
|
16
16
|
*/
|
|
17
17
|
export interface IProvideFluidLastEditedTracker {
|
|
18
18
|
readonly IFluidLastEditedTracker: IFluidLastEditedTracker;
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
* @
|
|
22
|
+
* @internal
|
|
23
23
|
*/
|
|
24
24
|
export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker {
|
|
25
25
|
/**
|
|
@@ -34,7 +34,7 @@ export interface IFluidLastEditedTracker extends IProvideFluidLastEditedTracker
|
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
|
-
* @
|
|
37
|
+
* @internal
|
|
38
38
|
*/
|
|
39
39
|
export interface ILastEditDetails {
|
|
40
40
|
user: IUser;
|
package/src/lastEditedTracker.ts
CHANGED
|
@@ -10,8 +10,7 @@ import { IFluidLastEditedTracker, ILastEditDetails } from "./interfaces";
|
|
|
10
10
|
* Tracks the last edit details such as the last edited user details and the last edited timestamp. The last edited
|
|
11
11
|
* details should be updated (via updateLastEditDetails) in response to a remote op since it uses shared summary block
|
|
12
12
|
* as storage.
|
|
13
|
-
*
|
|
14
|
-
* @public
|
|
13
|
+
* @internal
|
|
15
14
|
*/
|
|
16
15
|
export class LastEditedTracker implements IFluidLastEditedTracker {
|
|
17
16
|
private readonly lastEditedDetailsKey = "lastEditDetailsKey";
|
|
@@ -11,8 +11,7 @@ import { IProvideFluidLastEditedTracker } from "./interfaces";
|
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* LastEditedTrackerDataObject creates a LastEditedTracker that keeps track of the latest edits to the document.
|
|
14
|
-
*
|
|
15
|
-
* @public
|
|
14
|
+
* @internal
|
|
16
15
|
*/
|
|
17
16
|
export class LastEditedTrackerDataObject
|
|
18
17
|
extends DataObject
|
package/src/setup.ts
CHANGED
|
@@ -56,8 +56,7 @@ function getLastEditDetailsFromMessage(
|
|
|
56
56
|
* @param lastEditedTracker - The last edited tracker.
|
|
57
57
|
* @param runtime - The container runtime whose messages are to be tracked.
|
|
58
58
|
* @param shouldDiscardMessageFn - Function that tells if a message should not be considered in computing last edited.
|
|
59
|
-
*
|
|
60
|
-
* @public
|
|
59
|
+
* @internal
|
|
61
60
|
*/
|
|
62
61
|
export function setupLastEditedTrackerForContainer(
|
|
63
62
|
lastEditedTracker: IFluidLastEditedTracker,
|