@fluid-experimental/property-dds 2.0.0-dev.7.2.0.204906 → 2.0.0-dev.7.3.0.206769

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