@fluid-experimental/attributor 2.0.0-internal.7.1.0 → 2.0.0-internal.7.2.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.
Files changed (6) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/dist/attributor.d.ts +56 -127
  3. package/package.json +21 -22
  4. package/dist/attributor-alpha.d.ts +0 -127
  5. package/dist/attributor-beta.d.ts +0 -27
  6. package/dist/attributor-public.d.ts +0 -27
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluid-experimental/attributor
2
2
 
3
+ ## 2.0.0-internal.7.2.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-internal.7.1.0
4
8
 
5
9
  Dependency updates only.
package/dist/attributor.d.ts CHANGED
@@ -1,127 +1,56 @@
1
- import { AttributionInfo } from '@fluidframework/runtime-definitions';
2
- import { AttributionKey } from '@fluidframework/runtime-definitions';
3
- import { ContainerRuntime } from '@fluidframework/container-runtime';
4
- import { IAudience } from '@fluidframework/container-definitions';
5
- import { IDeltaManager } from '@fluidframework/container-definitions';
6
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
-
9
- /**
10
- * {@inheritdoc IAttributor}
11
- * @alpha
12
- */
13
- export declare class Attributor implements IAttributor {
14
- protected readonly keyToInfo: Map<number, AttributionInfo>;
15
- /**
16
- * @param initialEntries - Any entries which should be populated on instantiation.
17
- */
18
- constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
19
- /**
20
- * {@inheritdoc IAttributor.getAttributionInfo}
21
- */
22
- getAttributionInfo(key: number): AttributionInfo;
23
- /**
24
- * {@inheritdoc IAttributor.tryGetAttributionInfo}
25
- */
26
- tryGetAttributionInfo(key: number): AttributionInfo | undefined;
27
- /**
28
- * {@inheritdoc IAttributor.entries}
29
- */
30
- entries(): IterableIterator<[number, AttributionInfo]>;
31
- }
32
-
33
- /**
34
- * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data
35
- * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.
36
- * @alpha
37
- */
38
- export declare function createRuntimeAttributor(): IRuntimeAttributor;
39
-
40
- /**
41
- * @alpha
42
- * Feature Gate Key -
43
- * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on
44
- * new files. See package README for more notes on integration.
45
- */
46
- export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
47
-
48
- /**
49
- * Provides lookup between attribution keys and their associated attribution information.
50
- * @alpha
51
- */
52
- export declare interface IAttributor {
53
- /**
54
- * Retrieves attribution information associated with a particular key.
55
- * @param key - Attribution key to look up.
56
- * @throws If no attribution information is recorded for that key.
57
- */
58
- getAttributionInfo(key: number): AttributionInfo;
59
- /**
60
- * @param key - Attribution key to look up.
61
- * @returns the attribution information associated with the provided key, or undefined if no information exists.
62
- */
63
- tryGetAttributionInfo(key: number): AttributionInfo | undefined;
64
- /**
65
- * @returns an iterable of (attribution key, attribution info) pairs for each stored key.
66
- */
67
- entries(): IterableIterator<[number, AttributionInfo]>;
68
- }
69
-
70
- /**
71
- * @alpha
72
- */
73
- export declare interface IProvideRuntimeAttributor {
74
- readonly IRuntimeAttributor: IRuntimeAttributor;
75
- }
76
-
77
- /**
78
- * @alpha
79
- */
80
- export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
81
-
82
- /**
83
- * Provides access to attribution information stored on the container runtime.
84
- *
85
- * Attributors are only populated after the container runtime they are injected into has initialized.
86
- * @sealed
87
- * @alpha
88
- */
89
- export declare interface IRuntimeAttributor extends IProvideRuntimeAttributor {
90
- /**
91
- * @throws - If no AttributionInfo exists for this key.
92
- */
93
- get(key: AttributionKey): AttributionInfo;
94
- /**
95
- * @returns Whether any AttributionInfo exists for the provided key.
96
- */
97
- has(key: AttributionKey): boolean;
98
- /**
99
- * @returns Whether the runtime is currently tracking attribution information for the loaded container.
100
- * See {@link mixinAttributor} for more details on when this happens.
101
- */
102
- readonly isEnabled: boolean;
103
- }
104
-
105
- /**
106
- * Mixes in logic to load and store runtime-based attribution functionality.
107
- *
108
- * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
109
- *
110
- * Existing documents without stored attributors will not start storing attribution information: if an
111
- * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
112
- * that attributor's `has` method will always return `false`.
113
- * @param Base - base class, inherits from FluidAttributorRuntime
114
- * @alpha
115
- */
116
- export declare const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
117
-
118
- /**
119
- * Attributor which listens to an op stream and records entries for each op.
120
- * Sequence numbers are used as attribution keys.
121
- * @alpha
122
- */
123
- export declare class OpStreamAttributor extends Attributor implements IAttributor {
124
- constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
125
- }
126
-
127
- export { }
1
+ import { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
2
+ import { AttributionInfo } from "@fluidframework/runtime-definitions";
3
+ import { IAudience, IDeltaManager } from "@fluidframework/container-definitions";
4
+ /**
5
+ * Provides lookup between attribution keys and their associated attribution information.
6
+ * @alpha
7
+ */
8
+ export interface IAttributor {
9
+ /**
10
+ * Retrieves attribution information associated with a particular key.
11
+ * @param key - Attribution key to look up.
12
+ * @throws If no attribution information is recorded for that key.
13
+ */
14
+ getAttributionInfo(key: number): AttributionInfo;
15
+ /**
16
+ * @param key - Attribution key to look up.
17
+ * @returns the attribution information associated with the provided key, or undefined if no information exists.
18
+ */
19
+ tryGetAttributionInfo(key: number): AttributionInfo | undefined;
20
+ /**
21
+ * @returns an iterable of (attribution key, attribution info) pairs for each stored key.
22
+ */
23
+ entries(): IterableIterator<[number, AttributionInfo]>;
24
+ }
25
+ /**
26
+ * {@inheritdoc IAttributor}
27
+ * @alpha
28
+ */
29
+ export declare class Attributor implements IAttributor {
30
+ protected readonly keyToInfo: Map<number, AttributionInfo>;
31
+ /**
32
+ * @param initialEntries - Any entries which should be populated on instantiation.
33
+ */
34
+ constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
35
+ /**
36
+ * {@inheritdoc IAttributor.getAttributionInfo}
37
+ */
38
+ getAttributionInfo(key: number): AttributionInfo;
39
+ /**
40
+ * {@inheritdoc IAttributor.tryGetAttributionInfo}
41
+ */
42
+ tryGetAttributionInfo(key: number): AttributionInfo | undefined;
43
+ /**
44
+ * {@inheritdoc IAttributor.entries}
45
+ */
46
+ entries(): IterableIterator<[number, AttributionInfo]>;
47
+ }
48
+ /**
49
+ * Attributor which listens to an op stream and records entries for each op.
50
+ * Sequence numbers are used as attribution keys.
51
+ * @alpha
52
+ */
53
+ export declare class OpStreamAttributor extends Attributor implements IAttributor {
54
+ constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
55
+ }
56
+ //# sourceMappingURL=attributor.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluid-experimental/attributor",
3
- "version": "2.0.0-internal.7.1.0",
3
+ "version": "2.0.0-internal.7.2.0",
4
4
  "description": "Operation attributor",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -35,35 +35,34 @@
35
35
  "temp-directory": "nyc/.nyc_output"
36
36
  },
37
37
  "dependencies": {
38
- "@fluid-internal/client-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
39
- "@fluidframework/container-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
40
- "@fluidframework/container-runtime": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
41
- "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
42
- "@fluidframework/core-interfaces": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
43
- "@fluidframework/core-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
44
- "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
38
+ "@fluid-internal/client-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
39
+ "@fluidframework/container-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
40
+ "@fluidframework/container-runtime": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
41
+ "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
42
+ "@fluidframework/core-interfaces": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
43
+ "@fluidframework/core-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
44
+ "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
45
45
  "@fluidframework/protocol-definitions": "^3.0.0",
46
- "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
47
- "@fluidframework/runtime-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
48
- "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
46
+ "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
47
+ "@fluidframework/runtime-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
48
+ "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
49
49
  "lz4js": "^0.2.0"
50
50
  },
51
51
  "devDependencies": {
52
- "@fluid-internal/stochastic-test-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
53
- "@fluid-tools/build-cli": "^0.25.0",
54
- "@fluidframework/build-common": "^2.0.1",
55
- "@fluidframework/build-tools": "^0.25.0",
56
- "@fluidframework/driver-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
52
+ "@fluid-internal/stochastic-test-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
53
+ "@fluid-tools/build-cli": "^0.26.1",
54
+ "@fluidframework/build-common": "^2.0.3",
55
+ "@fluidframework/build-tools": "^0.26.1",
56
+ "@fluidframework/driver-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
57
57
  "@fluidframework/eslint-config-fluid": "^3.0.0",
58
- "@fluidframework/merge-tree": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
59
- "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
60
- "@fluidframework/sequence": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
61
- "@fluidframework/test-runtime-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
58
+ "@fluidframework/merge-tree": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
59
+ "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
60
+ "@fluidframework/sequence": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
61
+ "@fluidframework/test-runtime-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
62
62
  "@microsoft/api-extractor": "^7.37.0",
63
63
  "@types/mocha": "^9.1.1",
64
64
  "@types/node": "^16.18.38",
65
65
  "c8": "^7.7.1",
66
- "copyfiles": "^2.4.1",
67
66
  "cross-env": "^7.0.3",
68
67
  "eslint": "~8.50.0",
69
68
  "mocha": "^10.2.0",
@@ -86,7 +85,7 @@
86
85
  "build:esnext": "tsc --project ./tsconfig.esnext.json",
87
86
  "build:test": "tsc --project ./src/test/tsconfig.json",
88
87
  "ci:build:docs": "api-extractor run",
89
- "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
88
+ "clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\" _api-extractor-temp nyc",
90
89
  "eslint": "eslint --format stylish src",
91
90
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
92
91
  "format": "npm run prettier:fix",
package/dist/attributor-alpha.d.ts DELETED
@@ -1,127 +0,0 @@
1
- import { AttributionInfo } from '@fluidframework/runtime-definitions';
2
- import { AttributionKey } from '@fluidframework/runtime-definitions';
3
- import { ContainerRuntime } from '@fluidframework/container-runtime';
4
- import { IAudience } from '@fluidframework/container-definitions';
5
- import { IDeltaManager } from '@fluidframework/container-definitions';
6
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
-
9
- /**
10
- * {@inheritdoc IAttributor}
11
- * @alpha
12
- */
13
- export declare class Attributor implements IAttributor {
14
- protected readonly keyToInfo: Map<number, AttributionInfo>;
15
- /**
16
- * @param initialEntries - Any entries which should be populated on instantiation.
17
- */
18
- constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
19
- /**
20
- * {@inheritdoc IAttributor.getAttributionInfo}
21
- */
22
- getAttributionInfo(key: number): AttributionInfo;
23
- /**
24
- * {@inheritdoc IAttributor.tryGetAttributionInfo}
25
- */
26
- tryGetAttributionInfo(key: number): AttributionInfo | undefined;
27
- /**
28
- * {@inheritdoc IAttributor.entries}
29
- */
30
- entries(): IterableIterator<[number, AttributionInfo]>;
31
- }
32
-
33
- /**
34
- * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data
35
- * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.
36
- * @alpha
37
- */
38
- export declare function createRuntimeAttributor(): IRuntimeAttributor;
39
-
40
- /**
41
- * @alpha
42
- * Feature Gate Key -
43
- * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on
44
- * new files. See package README for more notes on integration.
45
- */
46
- export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
47
-
48
- /**
49
- * Provides lookup between attribution keys and their associated attribution information.
50
- * @alpha
51
- */
52
- export declare interface IAttributor {
53
- /**
54
- * Retrieves attribution information associated with a particular key.
55
- * @param key - Attribution key to look up.
56
- * @throws If no attribution information is recorded for that key.
57
- */
58
- getAttributionInfo(key: number): AttributionInfo;
59
- /**
60
- * @param key - Attribution key to look up.
61
- * @returns the attribution information associated with the provided key, or undefined if no information exists.
62
- */
63
- tryGetAttributionInfo(key: number): AttributionInfo | undefined;
64
- /**
65
- * @returns an iterable of (attribution key, attribution info) pairs for each stored key.
66
- */
67
- entries(): IterableIterator<[number, AttributionInfo]>;
68
- }
69
-
70
- /**
71
- * @alpha
72
- */
73
- export declare interface IProvideRuntimeAttributor {
74
- readonly IRuntimeAttributor: IRuntimeAttributor;
75
- }
76
-
77
- /**
78
- * @alpha
79
- */
80
- export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
81
-
82
- /**
83
- * Provides access to attribution information stored on the container runtime.
84
- *
85
- * Attributors are only populated after the container runtime they are injected into has initialized.
86
- * @sealed
87
- * @alpha
88
- */
89
- export declare interface IRuntimeAttributor extends IProvideRuntimeAttributor {
90
- /**
91
- * @throws - If no AttributionInfo exists for this key.
92
- */
93
- get(key: AttributionKey): AttributionInfo;
94
- /**
95
- * @returns Whether any AttributionInfo exists for the provided key.
96
- */
97
- has(key: AttributionKey): boolean;
98
- /**
99
- * @returns Whether the runtime is currently tracking attribution information for the loaded container.
100
- * See {@link mixinAttributor} for more details on when this happens.
101
- */
102
- readonly isEnabled: boolean;
103
- }
104
-
105
- /**
106
- * Mixes in logic to load and store runtime-based attribution functionality.
107
- *
108
- * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
109
- *
110
- * Existing documents without stored attributors will not start storing attribution information: if an
111
- * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
112
- * that attributor's `has` method will always return `false`.
113
- * @param Base - base class, inherits from FluidAttributorRuntime
114
- * @alpha
115
- */
116
- export declare const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
117
-
118
- /**
119
- * Attributor which listens to an op stream and records entries for each op.
120
- * Sequence numbers are used as attribution keys.
121
- * @alpha
122
- */
123
- export declare class OpStreamAttributor extends Attributor implements IAttributor {
124
- constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
125
- }
126
-
127
- export { }
package/dist/attributor-beta.d.ts DELETED
@@ -1,27 +0,0 @@
1
- import { ContainerRuntime } from '@fluidframework/container-runtime';
2
- import { IAudience } from '@fluidframework/container-definitions';
3
- import { IDeltaManager } from '@fluidframework/container-definitions';
4
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
5
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
6
-
7
- /* Excluded from this release type: AttributionInfo */
8
-
9
- /* Excluded from this release type: AttributionKey */
10
-
11
- /* Excluded from this release type: Attributor */
12
-
13
- /* Excluded from this release type: createRuntimeAttributor */
14
-
15
- /* Excluded from this release type: enableOnNewFileKey */
16
-
17
- /* Excluded from this release type: IAttributor */
18
-
19
- /* Excluded from this release type: IProvideRuntimeAttributor */
20
-
21
- /* Excluded from this release type: IRuntimeAttributor */
22
-
23
- /* Excluded from this release type: mixinAttributor */
24
-
25
- /* Excluded from this release type: OpStreamAttributor */
26
-
27
- export { }
package/dist/attributor-public.d.ts DELETED
@@ -1,27 +0,0 @@
1
- import { ContainerRuntime } from '@fluidframework/container-runtime';
2
- import { IAudience } from '@fluidframework/container-definitions';
3
- import { IDeltaManager } from '@fluidframework/container-definitions';
4
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
5
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
6
-
7
- /* Excluded from this release type: AttributionInfo */
8
-
9
- /* Excluded from this release type: AttributionKey */
10
-
11
- /* Excluded from this release type: Attributor */
12
-
13
- /* Excluded from this release type: createRuntimeAttributor */
14
-
15
- /* Excluded from this release type: enableOnNewFileKey */
16
-
17
- /* Excluded from this release type: IAttributor */
18
-
19
- /* Excluded from this release type: IProvideRuntimeAttributor */
20
-
21
- /* Excluded from this release type: IRuntimeAttributor */
22
-
23
- /* Excluded from this release type: mixinAttributor */
24
-
25
- /* Excluded from this release type: OpStreamAttributor */
26
-
27
- export { }