@fluid-experimental/property-dds 2.0.0-internal.7.3.0 → 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 +4 -0
- package/api-extractor-lint.json +13 -0
- package/api-extractor.json +2 -2
- package/api-report/property-dds.api.md +17 -17
- package/dist/property-dds-alpha.d.ts +46 -0
- package/dist/property-dds-beta.d.ts +62 -0
- package/dist/property-dds-public.d.ts +62 -0
- package/dist/property-dds-untrimmed.d.ts +306 -0
- package/dist/propertyTree.d.ts +29 -1
- package/dist/propertyTree.d.ts.map +1 -1
- package/dist/propertyTree.js +23 -7
- package/dist/propertyTree.js.map +1 -1
- package/dist/propertyTreeExt.d.ts +4 -0
- package/dist/propertyTreeExt.d.ts.map +1 -1
- package/dist/propertyTreeExt.js +4 -0
- package/dist/propertyTreeExt.js.map +1 -1
- package/dist/propertyTreeExtFactories.d.ts +9 -0
- package/dist/propertyTreeExtFactories.d.ts.map +1 -1
- package/dist/propertyTreeExtFactories.js +9 -0
- package/dist/propertyTreeExtFactories.js.map +1 -1
- package/dist/propertyTreeFactory.d.ts +1 -0
- package/dist/propertyTreeFactory.d.ts.map +1 -1
- package/dist/propertyTreeFactory.js +1 -0
- package/dist/propertyTreeFactory.js.map +1 -1
- package/lib/propertyTree.d.ts +29 -1
- package/lib/propertyTree.d.ts.map +1 -1
- package/lib/propertyTree.js +23 -7
- package/lib/propertyTree.js.map +1 -1
- package/lib/propertyTreeExt.d.ts +4 -0
- package/lib/propertyTreeExt.d.ts.map +1 -1
- package/lib/propertyTreeExt.js +4 -0
- package/lib/propertyTreeExt.js.map +1 -1
- package/lib/propertyTreeExtFactories.d.ts +9 -0
- package/lib/propertyTreeExtFactories.d.ts.map +1 -1
- package/lib/propertyTreeExtFactories.js +9 -0
- package/lib/propertyTreeExtFactories.js.map +1 -1
- package/lib/propertyTreeFactory.d.ts +1 -0
- package/lib/propertyTreeFactory.d.ts.map +1 -1
- package/lib/propertyTreeFactory.js +1 -0
- package/lib/propertyTreeFactory.js.map +1 -1
- package/package.json +25 -23
- package/src/propertyTree.ts +53 -5
- package/src/propertyTreeExt.ts +4 -0
- package/src/propertyTreeExtFactories.ts +9 -0
- package/src/propertyTreeFactory.ts +1 -0
package/CHANGELOG.md
CHANGED
|
@@ -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,11 +1,11 @@
|
|
|
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
4
|
|
|
5
5
|
// TODO: Fix violations and remove these rule overrides
|
|
6
6
|
"messages": {
|
|
7
7
|
"extractorMessageReporting": {
|
|
8
|
-
"ae-
|
|
8
|
+
"ae-undocumented": {
|
|
9
9
|
"logLevel": "none"
|
|
10
10
|
}
|
|
11
11
|
}
|
|
@@ -17,7 +17,7 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
|
17
17
|
import { NodeProperty } from '@fluid-experimental/property-properties';
|
|
18
18
|
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
19
19
|
|
|
20
|
-
// @
|
|
20
|
+
// @internal (undocumented)
|
|
21
21
|
export abstract class CompressedPropertyTreeFactory implements IChannelFactory {
|
|
22
22
|
// (undocumented)
|
|
23
23
|
abstract get attributes(): any;
|
|
@@ -37,7 +37,7 @@ export abstract class CompressedPropertyTreeFactory implements IChannelFactory {
|
|
|
37
37
|
abstract get type(): any;
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
-
// @
|
|
40
|
+
// @internal
|
|
41
41
|
export class DeflatedPropertyTree extends SharedPropertyTree {
|
|
42
42
|
// (undocumented)
|
|
43
43
|
static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
|
|
@@ -45,7 +45,7 @@ export class DeflatedPropertyTree extends SharedPropertyTree {
|
|
|
45
45
|
static getFactory(): IChannelFactory;
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
-
// @
|
|
48
|
+
// @internal (undocumented)
|
|
49
49
|
export class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
50
50
|
// (undocumented)
|
|
51
51
|
static readonly Attributes: IChannelAttributes;
|
|
@@ -67,13 +67,13 @@ export class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
|
67
67
|
get type(): string;
|
|
68
68
|
}
|
|
69
69
|
|
|
70
|
-
// @
|
|
70
|
+
// @internal (undocumented)
|
|
71
71
|
export interface IPropertyTreeConfig {
|
|
72
72
|
// (undocumented)
|
|
73
73
|
encDec: ISharedPropertyTreeEncDec;
|
|
74
74
|
}
|
|
75
75
|
|
|
76
|
-
// @
|
|
76
|
+
// @internal (undocumented)
|
|
77
77
|
export interface IPropertyTreeMessage {
|
|
78
78
|
// (undocumented)
|
|
79
79
|
changeSet: SerializedChangeSet;
|
|
@@ -95,13 +95,13 @@ export interface IPropertyTreeMessage {
|
|
|
95
95
|
useMH?: boolean;
|
|
96
96
|
}
|
|
97
97
|
|
|
98
|
-
// @
|
|
98
|
+
// @internal (undocumented)
|
|
99
99
|
export interface IRemotePropertyTreeMessage extends IPropertyTreeMessage {
|
|
100
100
|
// (undocumented)
|
|
101
101
|
sequenceNumber: number;
|
|
102
102
|
}
|
|
103
103
|
|
|
104
|
-
// @
|
|
104
|
+
// @internal (undocumented)
|
|
105
105
|
export interface ISharedPropertyTreeEncDec {
|
|
106
106
|
// (undocumented)
|
|
107
107
|
messageEncoder: {
|
|
@@ -115,7 +115,7 @@ export interface ISharedPropertyTreeEncDec {
|
|
|
115
115
|
};
|
|
116
116
|
}
|
|
117
117
|
|
|
118
|
-
// @
|
|
118
|
+
// @internal (undocumented)
|
|
119
119
|
export interface ISnapshotSummary {
|
|
120
120
|
// (undocumented)
|
|
121
121
|
remoteChanges?: IPropertyTreeMessage[];
|
|
@@ -127,7 +127,7 @@ export interface ISnapshotSummary {
|
|
|
127
127
|
unrebasedRemoteChanges?: Record<string, IRemotePropertyTreeMessage>;
|
|
128
128
|
}
|
|
129
129
|
|
|
130
|
-
// @
|
|
130
|
+
// @internal (undocumented)
|
|
131
131
|
export class LZ4PropertyTree extends SharedPropertyTree {
|
|
132
132
|
// (undocumented)
|
|
133
133
|
static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
|
|
@@ -135,7 +135,7 @@ export class LZ4PropertyTree extends SharedPropertyTree {
|
|
|
135
135
|
static getFactory(): IChannelFactory;
|
|
136
136
|
}
|
|
137
137
|
|
|
138
|
-
// @
|
|
138
|
+
// @internal (undocumented)
|
|
139
139
|
export class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
140
140
|
// (undocumented)
|
|
141
141
|
static readonly Attributes: IChannelAttributes;
|
|
@@ -157,16 +157,16 @@ export class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
|
157
157
|
get type(): string;
|
|
158
158
|
}
|
|
159
159
|
|
|
160
|
-
// @
|
|
160
|
+
// @internal (undocumented)
|
|
161
161
|
export type Metadata = any;
|
|
162
162
|
|
|
163
|
-
// @
|
|
163
|
+
// @internal (undocumented)
|
|
164
164
|
export const enum OpKind {
|
|
165
165
|
// (undocumented)
|
|
166
166
|
ChangeSet = 0
|
|
167
167
|
}
|
|
168
168
|
|
|
169
|
-
// @
|
|
169
|
+
// @internal
|
|
170
170
|
export class PropertyTreeFactory implements IChannelFactory {
|
|
171
171
|
// (undocumented)
|
|
172
172
|
static readonly Attributes: IChannelAttributes;
|
|
@@ -182,10 +182,10 @@ export class PropertyTreeFactory implements IChannelFactory {
|
|
|
182
182
|
get type(): string;
|
|
183
183
|
}
|
|
184
184
|
|
|
185
|
-
// @
|
|
185
|
+
// @internal (undocumented)
|
|
186
186
|
export type SerializedChangeSet = any;
|
|
187
187
|
|
|
188
|
-
// @
|
|
188
|
+
// @internal
|
|
189
189
|
export class SharedPropertyTree extends SharedObject {
|
|
190
190
|
constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig?: IPropertyTreeConfig);
|
|
191
191
|
// (undocumented)
|
|
@@ -223,7 +223,7 @@ export class SharedPropertyTree extends SharedObject {
|
|
|
223
223
|
// (undocumented)
|
|
224
224
|
propertyTreeConfig: IPropertyTreeConfig;
|
|
225
225
|
// (undocumented)
|
|
226
|
-
static prune(minimumSequenceNumber: number, remoteChanges: IPropertyTreeMessage[], unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage
|
|
226
|
+
static prune(minimumSequenceNumber: number, remoteChanges: IPropertyTreeMessage[], unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>, remoteHeadGuid: string): {
|
|
227
227
|
remoteChanges: IPropertyTreeMessage[];
|
|
228
228
|
unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
|
|
229
229
|
prunedCount: number;
|
|
@@ -259,7 +259,7 @@ export class SharedPropertyTree extends SharedObject {
|
|
|
259
259
|
useMH: boolean;
|
|
260
260
|
}
|
|
261
261
|
|
|
262
|
-
// @
|
|
262
|
+
// @internal (undocumented)
|
|
263
263
|
export interface SharedPropertyTreeOptions {
|
|
264
264
|
// (undocumented)
|
|
265
265
|
clientFiltering?: boolean;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
|
|
3
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
7
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
8
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { NodeProperty } from '@fluid-experimental/property-properties';
|
|
12
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: CompressedPropertyTreeFactory */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: DeflatedPropertyTree */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: DeflatedPropertyTreeFactory */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: IPropertyTreeConfig */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: IPropertyTreeMessage */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: IRemotePropertyTreeMessage */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: ISharedPropertyTreeEncDec */
|
|
27
|
+
|
|
28
|
+
/* Excluded from this release type: ISnapshotSummary */
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: LZ4PropertyTree */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: LZ4PropertyTreeFactory */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: Metadata */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: OpKind */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: PropertyTreeFactory */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: SerializedChangeSet */
|
|
41
|
+
|
|
42
|
+
/* Excluded from this release type: SharedPropertyTree */
|
|
43
|
+
|
|
44
|
+
/* Excluded from this release type: SharedPropertyTreeOptions */
|
|
45
|
+
|
|
46
|
+
export { }
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
|
|
3
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
7
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
8
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { NodeProperty } from '@fluid-experimental/property-properties';
|
|
12
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: CompressedPropertyTreeFactory */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: DeflatedPropertyTree */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: DeflatedPropertyTreeFactory */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: IChannelAttributes */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: IChannelFactory */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: IChannelServices */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: IChannelStorageService */
|
|
27
|
+
|
|
28
|
+
/* Excluded from this release type: IFluidDataStoreRuntime */
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: IFluidSerializer */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: IPropertyTreeConfig */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: IPropertyTreeMessage */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: IRemotePropertyTreeMessage */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: ISharedPropertyTreeEncDec */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: ISnapshotSummary */
|
|
41
|
+
|
|
42
|
+
/* Excluded from this release type: ISummaryTreeWithStats */
|
|
43
|
+
|
|
44
|
+
/* Excluded from this release type: LZ4PropertyTree */
|
|
45
|
+
|
|
46
|
+
/* Excluded from this release type: LZ4PropertyTreeFactory */
|
|
47
|
+
|
|
48
|
+
/* Excluded from this release type: Metadata */
|
|
49
|
+
|
|
50
|
+
/* Excluded from this release type: OpKind */
|
|
51
|
+
|
|
52
|
+
/* Excluded from this release type: PropertyTreeFactory */
|
|
53
|
+
|
|
54
|
+
/* Excluded from this release type: SerializedChangeSet */
|
|
55
|
+
|
|
56
|
+
/* Excluded from this release type: SharedObject */
|
|
57
|
+
|
|
58
|
+
/* Excluded from this release type: SharedPropertyTree */
|
|
59
|
+
|
|
60
|
+
/* Excluded from this release type: SharedPropertyTreeOptions */
|
|
61
|
+
|
|
62
|
+
export { }
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
|
|
3
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
7
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
8
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { NodeProperty } from '@fluid-experimental/property-properties';
|
|
12
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: CompressedPropertyTreeFactory */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: DeflatedPropertyTree */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: DeflatedPropertyTreeFactory */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: IChannelAttributes */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: IChannelFactory */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: IChannelServices */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: IChannelStorageService */
|
|
27
|
+
|
|
28
|
+
/* Excluded from this release type: IFluidDataStoreRuntime */
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: IFluidSerializer */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: IPropertyTreeConfig */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: IPropertyTreeMessage */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: IRemotePropertyTreeMessage */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: ISharedPropertyTreeEncDec */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: ISnapshotSummary */
|
|
41
|
+
|
|
42
|
+
/* Excluded from this release type: ISummaryTreeWithStats */
|
|
43
|
+
|
|
44
|
+
/* Excluded from this release type: LZ4PropertyTree */
|
|
45
|
+
|
|
46
|
+
/* Excluded from this release type: LZ4PropertyTreeFactory */
|
|
47
|
+
|
|
48
|
+
/* Excluded from this release type: Metadata */
|
|
49
|
+
|
|
50
|
+
/* Excluded from this release type: OpKind */
|
|
51
|
+
|
|
52
|
+
/* Excluded from this release type: PropertyTreeFactory */
|
|
53
|
+
|
|
54
|
+
/* Excluded from this release type: SerializedChangeSet */
|
|
55
|
+
|
|
56
|
+
/* Excluded from this release type: SharedObject */
|
|
57
|
+
|
|
58
|
+
/* Excluded from this release type: SharedPropertyTree */
|
|
59
|
+
|
|
60
|
+
/* Excluded from this release type: SharedPropertyTreeOptions */
|
|
61
|
+
|
|
62
|
+
export { }
|
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
|
|
3
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
7
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
8
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { NodeProperty } from '@fluid-experimental/property-properties';
|
|
12
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export declare abstract class CompressedPropertyTreeFactory implements IChannelFactory {
|
|
18
|
+
abstract get attributes(): any;
|
|
19
|
+
abstract get type(): any;
|
|
20
|
+
abstract getEncodeFce(): any;
|
|
21
|
+
abstract getDecodeFce(): any;
|
|
22
|
+
private createCompressionMethods;
|
|
23
|
+
getEncDec(): ISharedPropertyTreeEncDec;
|
|
24
|
+
abstract newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
|
|
25
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
|
|
26
|
+
create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* This class is the extension of SharedPropertyTree which compresses
|
|
31
|
+
* the deltas and summaries communicated to the server by Deflate.
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
export declare class DeflatedPropertyTree extends SharedPropertyTree {
|
|
35
|
+
static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
|
|
36
|
+
static getFactory(): IChannelFactory;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
export declare class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
43
|
+
static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
|
|
44
|
+
static readonly Attributes: IChannelAttributes;
|
|
45
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<DeflatedPropertyTree>;
|
|
46
|
+
create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree;
|
|
47
|
+
get type(): string;
|
|
48
|
+
get attributes(): IChannelAttributes;
|
|
49
|
+
getEncodeFce(): any;
|
|
50
|
+
getDecodeFce(): any;
|
|
51
|
+
newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* @internal
|
|
56
|
+
*/
|
|
57
|
+
export declare interface IPropertyTreeConfig {
|
|
58
|
+
encDec: ISharedPropertyTreeEncDec;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
|
+
export declare interface IPropertyTreeMessage {
|
|
65
|
+
op: OpKind;
|
|
66
|
+
changeSet: SerializedChangeSet;
|
|
67
|
+
metadata: Metadata;
|
|
68
|
+
guid: string;
|
|
69
|
+
referenceGuid: string;
|
|
70
|
+
remoteHeadGuid: string;
|
|
71
|
+
localBranchStart: string | undefined;
|
|
72
|
+
rebaseMetaInformation?: Map<any, any>;
|
|
73
|
+
useMH?: boolean;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
export declare interface IRemotePropertyTreeMessage extends IPropertyTreeMessage {
|
|
80
|
+
sequenceNumber: number;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
export declare interface ISharedPropertyTreeEncDec {
|
|
87
|
+
messageEncoder: {
|
|
88
|
+
encode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
|
|
89
|
+
decode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
|
|
90
|
+
};
|
|
91
|
+
summaryEncoder: {
|
|
92
|
+
encode: (ISnapshotSummary: any) => Buffer;
|
|
93
|
+
decode: (Buffer: any) => ISnapshotSummary;
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
export declare interface ISnapshotSummary {
|
|
101
|
+
remoteTipView?: SerializedChangeSet;
|
|
102
|
+
remoteChanges?: IPropertyTreeMessage[];
|
|
103
|
+
unrebasedRemoteChanges?: Record<string, IRemotePropertyTreeMessage>;
|
|
104
|
+
remoteHeadGuid: string;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
export declare class LZ4PropertyTree extends SharedPropertyTree {
|
|
111
|
+
static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
|
|
112
|
+
static getFactory(): IChannelFactory;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
export declare class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
|
|
119
|
+
static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
|
|
120
|
+
static readonly Attributes: IChannelAttributes;
|
|
121
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<LZ4PropertyTree>;
|
|
122
|
+
create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree;
|
|
123
|
+
get type(): string;
|
|
124
|
+
get attributes(): IChannelAttributes;
|
|
125
|
+
getEncodeFce(): any;
|
|
126
|
+
getDecodeFce(): any;
|
|
127
|
+
newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
133
|
+
export declare type Metadata = any;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* @internal
|
|
137
|
+
*/
|
|
138
|
+
export declare const enum OpKind {
|
|
139
|
+
ChangeSet = 0
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* The factory that defines the map
|
|
144
|
+
* @internal
|
|
145
|
+
*/
|
|
146
|
+
export declare class PropertyTreeFactory implements IChannelFactory {
|
|
147
|
+
static readonly Type = "PropertyTree:01EP5J4Y6C284JR6ATVPPHRJ4E";
|
|
148
|
+
static readonly Attributes: IChannelAttributes;
|
|
149
|
+
get type(): string;
|
|
150
|
+
get attributes(): IChannelAttributes;
|
|
151
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
|
|
152
|
+
create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* @internal
|
|
157
|
+
*/
|
|
158
|
+
export declare type SerializedChangeSet = any;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Silly DDS example that models a six sided die.
|
|
162
|
+
*
|
|
163
|
+
* Unlike the typical 'Dice Roller' example where clients clobber each other's last roll in a
|
|
164
|
+
* SharedMap, this 'SharedDie' DDS works by advancing an internal PRNG each time it sees a 'roll'
|
|
165
|
+
* operation.
|
|
166
|
+
*
|
|
167
|
+
* Because all clients are using the same PRNG starting in the same state, they arrive at
|
|
168
|
+
* consensus by simply applying the same number of rolls. (A fun addition would be logging
|
|
169
|
+
* who received which roll, which would need to change as clients learn how races are resolved
|
|
170
|
+
* in the total order)
|
|
171
|
+
* @internal
|
|
172
|
+
*/
|
|
173
|
+
export declare class SharedPropertyTree extends SharedObject {
|
|
174
|
+
tipView: SerializedChangeSet;
|
|
175
|
+
remoteTipView: SerializedChangeSet;
|
|
176
|
+
localChanges: IPropertyTreeMessage[];
|
|
177
|
+
remoteChanges: IPropertyTreeMessage[];
|
|
178
|
+
unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
|
|
179
|
+
transmissionsHaveBeenStopped: boolean;
|
|
180
|
+
enqueuedMessages: IPropertyTreeMessage[];
|
|
181
|
+
notificationDelayScope: number;
|
|
182
|
+
_root: any;
|
|
183
|
+
options: SharedPropertyTreeOptions;
|
|
184
|
+
skipSequenceNumber: number;
|
|
185
|
+
headCommitGuid: string;
|
|
186
|
+
useMH: boolean;
|
|
187
|
+
propertyTreeConfig: IPropertyTreeConfig;
|
|
188
|
+
constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig?: IPropertyTreeConfig);
|
|
189
|
+
/**
|
|
190
|
+
* Create a new shared cell
|
|
191
|
+
*
|
|
192
|
+
* @param runtime - data store runtime the new shared map belongs to
|
|
193
|
+
* @param id - optional name of the shared map
|
|
194
|
+
* @returns newly create shared map (but not attached yet)
|
|
195
|
+
*/
|
|
196
|
+
static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): SharedPropertyTree;
|
|
197
|
+
/**
|
|
198
|
+
* Get a factory for SharedDie to register with the data store.
|
|
199
|
+
*
|
|
200
|
+
* @returns a factory that creates and load SharedDie
|
|
201
|
+
*/
|
|
202
|
+
static getFactory(): IChannelFactory;
|
|
203
|
+
/**
|
|
204
|
+
* in case of partial checkout we want to send the paths we are interested in once we are connected
|
|
205
|
+
*/
|
|
206
|
+
protected onConnect(): void;
|
|
207
|
+
private scopeFutureDeltasToPaths;
|
|
208
|
+
_reportDirtinessToView(): void;
|
|
209
|
+
get changeSet(): SerializedChangeSet;
|
|
210
|
+
get activeCommit(): IPropertyTreeMessage;
|
|
211
|
+
get root(): NodeProperty;
|
|
212
|
+
commit(metadata?: Metadata, submitEmptyChange?: boolean): void;
|
|
213
|
+
/**
|
|
214
|
+
* This method encodes the given message to the transfer form
|
|
215
|
+
* @param change - The message to be encoded.
|
|
216
|
+
*/
|
|
217
|
+
private encodeMessage;
|
|
218
|
+
/**
|
|
219
|
+
* This method decodes message from the transfer form.
|
|
220
|
+
* @param transferChange - The message to be decoded.
|
|
221
|
+
*/
|
|
222
|
+
private decodeMessage;
|
|
223
|
+
private applyChangeSet;
|
|
224
|
+
stopTransmission(stop: boolean): void;
|
|
225
|
+
/**
|
|
226
|
+
* Delays notifications until popNotificationDelayScope has been called the same number of times as
|
|
227
|
+
* pushNotificationDelayScope.
|
|
228
|
+
*/
|
|
229
|
+
pushNotificationDelayScope(): void;
|
|
230
|
+
/**
|
|
231
|
+
* Re-enables notifications when popNotificationDelayScope has been called the same number of times as
|
|
232
|
+
* pushNotificationDelayScope.
|
|
233
|
+
*/
|
|
234
|
+
popNotificationDelayScope(): void;
|
|
235
|
+
/**
|
|
236
|
+
* Process an operation
|
|
237
|
+
*
|
|
238
|
+
* @param message - the message to prepare
|
|
239
|
+
* @param local - whether the message was sent by the local client
|
|
240
|
+
* @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
|
|
241
|
+
* For messages from a remote client, this will be undefined.
|
|
242
|
+
*/
|
|
243
|
+
protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
|
|
244
|
+
private addRemoteChange;
|
|
245
|
+
private updateRemoteHeadGuid;
|
|
246
|
+
static prune(minimumSequenceNumber: number, remoteChanges: IPropertyTreeMessage[], unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>, remoteHeadGuid: string): {
|
|
247
|
+
remoteChanges: IPropertyTreeMessage[];
|
|
248
|
+
unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
|
|
249
|
+
prunedCount: number;
|
|
250
|
+
};
|
|
251
|
+
pruneHistory(): void;
|
|
252
|
+
/**
|
|
253
|
+
* This method encodes the local summary (snapshot) object into the serialized form.
|
|
254
|
+
* @param summary - The local summary (snapshot)representation.
|
|
255
|
+
* @returns The serialized summary representation.
|
|
256
|
+
*/
|
|
257
|
+
private encodeSummary;
|
|
258
|
+
/**
|
|
259
|
+
* This method decodes the serialized form of the summary into the local summary (snapshot) object.
|
|
260
|
+
* @param serializedSummary - The serialized summary representation.
|
|
261
|
+
* @returns The local summary (snapshot)representation.
|
|
262
|
+
*/
|
|
263
|
+
private decodeSummary;
|
|
264
|
+
/**
|
|
265
|
+
* This method writes the log message if the logging is enabled in the extended DDS.
|
|
266
|
+
* The logging is not enabled in the default Property DDS
|
|
267
|
+
* @param message - The message to be logged.
|
|
268
|
+
*/
|
|
269
|
+
protected logIfEnabled(message: any): void;
|
|
270
|
+
/**
|
|
271
|
+
* This method encodes the binary representation of the
|
|
272
|
+
* blob.
|
|
273
|
+
* @param blob - The binary representation of the blob.
|
|
274
|
+
* @returns The encoded representation of the blob.
|
|
275
|
+
*/
|
|
276
|
+
private encodeSummaryBlob;
|
|
277
|
+
/**
|
|
278
|
+
* This method decodes the encoded representation of the
|
|
279
|
+
* blob.
|
|
280
|
+
* @param blob - The encoded representation of the blob.
|
|
281
|
+
* @returns The binary representation of the blob.
|
|
282
|
+
*/
|
|
283
|
+
private decodeSummaryBlob;
|
|
284
|
+
summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
|
|
285
|
+
protected loadCore(storage: IChannelStorageService): Promise<void>;
|
|
286
|
+
protected onDisconnect(): void;
|
|
287
|
+
private _applyLocalChangeSet;
|
|
288
|
+
private _applyRemoteChangeSet;
|
|
289
|
+
getUnrebasedChange(guid: string): IRemotePropertyTreeMessage;
|
|
290
|
+
getRebasedChanges(startGuid: string, endGuid?: string): IPropertyTreeMessage[];
|
|
291
|
+
private rebaseLocalChanges;
|
|
292
|
+
protected reSubmitCore(content: any, localOpMetadata: unknown): void;
|
|
293
|
+
protected applyStashedOp(): void;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* @internal
|
|
298
|
+
*/
|
|
299
|
+
export declare interface SharedPropertyTreeOptions {
|
|
300
|
+
paths?: string[];
|
|
301
|
+
clientFiltering?: boolean;
|
|
302
|
+
useMH?: boolean;
|
|
303
|
+
disablePartialCheckout?: boolean;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
export { }
|