@fluidframework/runtime-definitions 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.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 CHANGED
@@ -1,5 +1,91 @@
1
1
  # @fluidframework/runtime-definitions
2
2
 
3
+ ## 2.0.0-internal.7.1.0
4
+
5
+ Dependency updates only.
6
+
7
+ ## 2.0.0-internal.7.0.0
8
+
9
+ ### Major Changes
10
+
11
+ - Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
12
+
13
+ This included the following changes from the protocol-definitions release:
14
+
15
+ - Updating signal interfaces for some planned improvements. The intention is split the interface between signals
16
+ submitted by clients to the server and the resulting signals sent from the server to clients.
17
+ - A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
18
+ been added, which will be the typing for signals sent from the client to the server. Both extend a new
19
+ ISignalMessageBase interface that contains common members.
20
+ - The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
21
+
22
+ - runtime-definitions: `bindToContext` API removed [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
23
+
24
+ `bindToContext` has been removed from `FluidDataStoreRuntime`, `IFluidDataStoreContext` and
25
+ `MockFluidDataStoreContext`. This has been deprecated for several releases and cannot be used anymore.
26
+
27
+ - DEPRECATED: resolveHandle and IFluidHandleContext deprecated on IContainerRuntime [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
28
+
29
+ The `resolveHandle(...)` and `get IFluidHandleContext()` methods have been deprecated on the following interfaces:
30
+
31
+ - `IContainerRuntime`
32
+ - `IContainerRuntimeBase`
33
+
34
+ Requesting arbitrary URLs has been deprecated on `IContainerRuntime`. Please migrate all usage to the `IContainerRuntime.getEntryPoint()` method if trying to obtain the application-specified root object.
35
+
36
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
37
+
38
+ - container-definitions: IContainer's and IDataStore's IFluidRouter capabilities are deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
39
+
40
+ `IFluidRouter` and `request({ url: "/" })` on `IContainer` and `IDataStore` are deprecated and will be removed in a future major release. Please migrate all usage to the appropriate `getEntryPoint()` or `entryPoint` APIs.
41
+
42
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
43
+
44
+ - Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
45
+
46
+ Dependencies on the following Fluid server package have been updated to version 2.0.1:
47
+
48
+ - @fluidframework/gitresources: 2.0.1
49
+ - @fluidframework/server-kafka-orderer: 2.0.1
50
+ - @fluidframework/server-lambdas: 2.0.1
51
+ - @fluidframework/server-lambdas-driver: 2.0.1
52
+ - @fluidframework/server-local-server: 2.0.1
53
+ - @fluidframework/server-memory-orderer: 2.0.1
54
+ - @fluidframework/protocol-base: 2.0.1
55
+ - @fluidframework/server-routerlicious: 2.0.1
56
+ - @fluidframework/server-routerlicious-base: 2.0.1
57
+ - @fluidframework/server-services: 2.0.1
58
+ - @fluidframework/server-services-client: 2.0.1
59
+ - @fluidframework/server-services-core: 2.0.1
60
+ - @fluidframework/server-services-ordering-kafkanode: 2.0.1
61
+ - @fluidframework/server-services-ordering-rdkafka: 2.0.1
62
+ - @fluidframework/server-services-ordering-zookeeper: 2.0.1
63
+ - @fluidframework/server-services-shared: 2.0.1
64
+ - @fluidframework/server-services-telemetry: 2.0.1
65
+ - @fluidframework/server-services-utils: 2.0.1
66
+ - @fluidframework/server-test-utils: 2.0.1
67
+ - tinylicious: 2.0.1
68
+
69
+ - test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
70
+
71
+ The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
72
+
73
+ - `BaseContainerRuntimeFactory`
74
+ - `RuntimeFactory`
75
+ - `ContainerRuntime` (constructor and `loadRuntime`)
76
+ - `FluidDataStoreRuntime`
77
+
78
+ See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
79
+ See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
80
+
81
+ Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
82
+
83
+ For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
84
+
85
+ - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
86
+
87
+ The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
88
+
3
89
  ## 2.0.0-internal.6.4.0
4
90
 
5
91
  ### Minor Changes
@@ -1,4 +1,12 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "@fluidframework/build-common/api-extractor-common-report.json"
3
+ "extends": "@fluidframework/build-common/api-extractor-base.json",
4
+ "messages": {
5
+ "extractorMessageReporting": {
6
+ "ae-missing-release-tag": {
7
+ // TODO: Fix violations and remove this rule override
8
+ "logLevel": "none"
9
+ }
10
+ }
11
+ }
4
12
  }
@@ -0,0 +1,532 @@
1
+ ## API Report File for "@fluidframework/runtime-definitions"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { AttachState } from '@fluidframework/container-definitions';
8
+ import { FluidObject } from '@fluidframework/core-interfaces';
9
+ import { IAudience } from '@fluidframework/container-definitions';
10
+ import { IClientDetails } from '@fluidframework/protocol-definitions';
11
+ import { IDeltaManager } from '@fluidframework/container-definitions';
12
+ import { IDisposable } from '@fluidframework/core-interfaces';
13
+ import { IDocumentMessage } from '@fluidframework/protocol-definitions';
14
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
15
+ import { IEvent } from '@fluidframework/core-interfaces';
16
+ import { IEventProvider } from '@fluidframework/core-interfaces';
17
+ import { IFluidHandle } from '@fluidframework/core-interfaces';
18
+ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
19
+ import { IFluidRouter } from '@fluidframework/core-interfaces';
20
+ import { ILoaderOptions } from '@fluidframework/container-definitions';
21
+ import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
22
+ import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
+ import { IRequest } from '@fluidframework/core-interfaces';
24
+ import { IResponse } from '@fluidframework/core-interfaces';
25
+ import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
26
+ import { ISignalMessage } from '@fluidframework/protocol-definitions';
27
+ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
28
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
29
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
30
+ import { ITree } from '@fluidframework/protocol-definitions';
31
+ import type { IUser } from '@fluidframework/protocol-definitions';
32
+ import { SummaryTree } from '@fluidframework/protocol-definitions';
33
+ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
34
+
35
+ // @public
36
+ export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
37
+
38
+ // @alpha
39
+ export interface AttributionInfo {
40
+ timestamp: number;
41
+ user: IUser;
42
+ }
43
+
44
+ // @alpha
45
+ export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
46
+
47
+ // @public (undocumented)
48
+ export const blobCountPropertyName = "BlobCount";
49
+
50
+ // @public (undocumented)
51
+ export const channelsTreeName = ".channels";
52
+
53
+ // @public (undocumented)
54
+ export type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
55
+ getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
56
+
57
+ // @public (undocumented)
58
+ export type CreateChildSummarizerNodeParam = {
59
+ type: CreateSummarizerNodeSource.FromSummary;
60
+ } | {
61
+ type: CreateSummarizerNodeSource.FromAttach;
62
+ sequenceNumber: number;
63
+ snapshot: ITree;
64
+ } | {
65
+ type: CreateSummarizerNodeSource.Local;
66
+ };
67
+
68
+ // @public (undocumented)
69
+ export enum CreateSummarizerNodeSource {
70
+ // (undocumented)
71
+ FromAttach = 1,
72
+ // (undocumented)
73
+ FromSummary = 0,
74
+ // (undocumented)
75
+ Local = 2
76
+ }
77
+
78
+ // @alpha
79
+ export interface DetachedAttributionKey {
80
+ id: 0;
81
+ // (undocumented)
82
+ type: "detached";
83
+ }
84
+
85
+ // @public
86
+ export type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
87
+
88
+ // @public
89
+ export enum FlushMode {
90
+ Immediate = 0,
91
+ TurnBased = 1
92
+ }
93
+
94
+ // @public (undocumented)
95
+ export enum FlushModeExperimental {
96
+ Async = 2
97
+ }
98
+
99
+ // @public
100
+ export const gcBlobPrefix = "__gc";
101
+
102
+ // @public
103
+ export const gcDeletedBlobKey = "__deletedNodes";
104
+
105
+ // @public
106
+ export const gcTombstoneBlobKey = "__tombstones";
107
+
108
+ // @public
109
+ export const gcTreeKey = "gc";
110
+
111
+ // @public
112
+ export interface IAttachMessage {
113
+ id: string;
114
+ snapshot: ITree;
115
+ type: string;
116
+ }
117
+
118
+ // @public
119
+ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
120
+ // (undocumented)
121
+ readonly clientDetails: IClientDetails;
122
+ createDataStore(pkg: string | string[]): Promise<IDataStore>;
123
+ // @internal @deprecated (undocumented)
124
+ _createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
125
+ createDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;
126
+ getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
127
+ getAudience(): IAudience;
128
+ getQuorum(): IQuorumClients;
129
+ // @deprecated (undocumented)
130
+ readonly IFluidHandleContext: IFluidHandleContext;
131
+ // (undocumented)
132
+ readonly logger: ITelemetryBaseLogger;
133
+ orderSequentially(callback: () => void): void;
134
+ // @deprecated
135
+ request(request: IRequest): Promise<IResponse>;
136
+ submitSignal(type: string, content: any): void;
137
+ // (undocumented)
138
+ uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
139
+ }
140
+
141
+ // @public (undocumented)
142
+ export interface IContainerRuntimeBaseEvents extends IEvent {
143
+ // (undocumented)
144
+ (event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void): any;
145
+ // (undocumented)
146
+ (event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;
147
+ // (undocumented)
148
+ (event: "batchEnd", listener: (error: any, op: ISequencedDocumentMessage) => void): any;
149
+ // (undocumented)
150
+ (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
151
+ }
152
+
153
+ // @public
154
+ export interface IDataStore {
155
+ readonly entryPoint: IFluidHandle<FluidObject>;
156
+ // @deprecated (undocumented)
157
+ readonly IFluidRouter: IFluidRouter;
158
+ // @deprecated (undocumented)
159
+ request(request: {
160
+ url: "/";
161
+ headers?: undefined;
162
+ }): Promise<IResponse>;
163
+ // @deprecated
164
+ request(request: IRequest): Promise<IResponse>;
165
+ trySetAlias(alias: string): Promise<AliasResult>;
166
+ }
167
+
168
+ // @public
169
+ export interface IdCreationRange {
170
+ // (undocumented)
171
+ readonly ids?: {
172
+ readonly firstGenCount: number;
173
+ readonly count: number;
174
+ };
175
+ // (undocumented)
176
+ readonly sessionId: SessionId;
177
+ }
178
+
179
+ // @public (undocumented)
180
+ export type IdCreationRangeWithStashedState = IdCreationRange & {
181
+ stashedState: SerializedIdCompressorWithOngoingSession;
182
+ };
183
+
184
+ // @public
185
+ export interface IEnvelope {
186
+ address: string;
187
+ contents: any;
188
+ }
189
+
190
+ // @public
191
+ export interface IExperimentalIncrementalSummaryContext {
192
+ latestSummarySequenceNumber: number;
193
+ summaryPath: string;
194
+ summarySequenceNumber: number;
195
+ }
196
+
197
+ // @public
198
+ export interface IFluidDataStoreChannel extends IDisposable {
199
+ // (undocumented)
200
+ applyStashedOp(content: any): Promise<unknown>;
201
+ // @deprecated
202
+ attachGraph(): void;
203
+ readonly attachState: AttachState;
204
+ readonly entryPoint: IFluidHandle<FluidObject>;
205
+ getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
206
+ getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
207
+ // (undocumented)
208
+ readonly id: string;
209
+ // @deprecated (undocumented)
210
+ readonly IFluidRouter: IFluidRouter;
211
+ makeVisibleAndAttachGraph(): void;
212
+ process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
213
+ processSignal(message: any, local: boolean): void;
214
+ // (undocumented)
215
+ request(request: IRequest): Promise<IResponse>;
216
+ reSubmit(type: string, content: any, localOpMetadata: unknown): any;
217
+ rollback?(type: string, content: any, localOpMetadata: unknown): void;
218
+ setConnectionState(connected: boolean, clientId?: string): any;
219
+ summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
220
+ updateUsedRoutes(usedRoutes: string[]): void;
221
+ // (undocumented)
222
+ readonly visibilityState: VisibilityState;
223
+ }
224
+
225
+ // @public
226
+ export interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreContextEvents>, Partial<IProvideFluidDataStoreRegistry>, IProvideFluidHandleContext {
227
+ addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
228
+ readonly attachState: AttachState;
229
+ // (undocumented)
230
+ readonly baseSnapshot: ISnapshotTree | undefined;
231
+ // (undocumented)
232
+ readonly clientDetails: IClientDetails;
233
+ // (undocumented)
234
+ readonly clientId: string | undefined;
235
+ // (undocumented)
236
+ readonly connected: boolean;
237
+ // (undocumented)
238
+ readonly containerRuntime: IContainerRuntimeBase;
239
+ // @deprecated (undocumented)
240
+ readonly createProps?: any;
241
+ // (undocumented)
242
+ readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
243
+ ensureNoDataModelChanges<T>(callback: () => T): T;
244
+ getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
245
+ getAudience(): IAudience;
246
+ // @deprecated (undocumented)
247
+ getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
248
+ // (undocumented)
249
+ getCreateChildSummarizerNodeFn(
250
+ id: string,
251
+ createParam: CreateChildSummarizerNodeParam): CreateChildSummarizerNodeFn;
252
+ getQuorum(): IQuorumClients;
253
+ // (undocumented)
254
+ readonly id: string;
255
+ // (undocumented)
256
+ readonly idCompressor?: IIdCompressor;
257
+ readonly isLocalDataStore: boolean;
258
+ // (undocumented)
259
+ readonly logger: ITelemetryBaseLogger;
260
+ makeLocallyVisible(): void;
261
+ // (undocumented)
262
+ readonly options: ILoaderOptions;
263
+ readonly packagePath: readonly string[];
264
+ readonly scope: FluidObject;
265
+ setChannelDirty(address: string): void;
266
+ // (undocumented)
267
+ readonly storage: IDocumentStorageService;
268
+ submitMessage(type: string, content: any, localOpMetadata: unknown): void;
269
+ submitSignal(type: string, content: any): void;
270
+ // (undocumented)
271
+ uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
272
+ }
273
+
274
+ // @public (undocumented)
275
+ export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
276
+ attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<void>;
277
+ }
278
+
279
+ // @public (undocumented)
280
+ export interface IFluidDataStoreContextEvents extends IEvent {
281
+ // (undocumented)
282
+ (event: "attaching" | "attached", listener: () => void): any;
283
+ }
284
+
285
+ // @public (undocumented)
286
+ export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
287
+
288
+ // @public
289
+ export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
290
+ instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
291
+ type: string;
292
+ }
293
+
294
+ // @public (undocumented)
295
+ export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
296
+
297
+ // @public
298
+ export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
299
+ // (undocumented)
300
+ get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
301
+ }
302
+
303
+ // @public
304
+ export interface IGarbageCollectionData {
305
+ gcNodes: {
306
+ [id: string]: string[];
307
+ };
308
+ }
309
+
310
+ // @public
311
+ export interface IGarbageCollectionDetailsBase {
312
+ gcData?: IGarbageCollectionData;
313
+ usedRoutes?: string[];
314
+ }
315
+
316
+ // @public
317
+ export interface IIdCompressor {
318
+ decompress(id: SessionSpaceCompressedId): StableId;
319
+ generateCompressedId(): SessionSpaceCompressedId;
320
+ // (undocumented)
321
+ localSessionId: SessionId;
322
+ normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
323
+ normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
324
+ recompress(uncompressed: StableId): SessionSpaceCompressedId;
325
+ tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
326
+ }
327
+
328
+ // @public (undocumented)
329
+ export interface IIdCompressorCore {
330
+ finalizeCreationRange(range: IdCreationRange): void;
331
+ serialize(withSession: true): SerializedIdCompressorWithOngoingSession;
332
+ serialize(withSession: false): SerializedIdCompressorWithNoSession;
333
+ takeNextCreationRange(): IdCreationRange;
334
+ }
335
+
336
+ // @public
337
+ export interface IInboundSignalMessage extends ISignalMessage {
338
+ // (undocumented)
339
+ type: string;
340
+ }
341
+
342
+ // @public
343
+ export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
344
+ snapshot: IAttachMessage["snapshot"] | null;
345
+ };
346
+
347
+ // @public
348
+ export const initialClusterCapacity = 512;
349
+
350
+ // @public (undocumented)
351
+ export interface IProvideFluidDataStoreFactory {
352
+ // (undocumented)
353
+ readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
354
+ }
355
+
356
+ // @public (undocumented)
357
+ export interface IProvideFluidDataStoreRegistry {
358
+ // (undocumented)
359
+ readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
360
+ }
361
+
362
+ // @public (undocumented)
363
+ export interface ISignalEnvelope {
364
+ address?: string;
365
+ clientSignalSequenceNumber: number;
366
+ contents: {
367
+ type: string;
368
+ content: any;
369
+ };
370
+ }
371
+
372
+ // @public
373
+ export interface ISummarizeInternalResult extends ISummarizeResult {
374
+ // (undocumented)
375
+ id: string;
376
+ pathPartsForChildren?: string[];
377
+ }
378
+
379
+ // @public
380
+ export interface ISummarizeResult {
381
+ // (undocumented)
382
+ stats: ISummaryStats;
383
+ // (undocumented)
384
+ summary: SummaryTree;
385
+ }
386
+
387
+ // @public (undocumented)
388
+ export interface ISummarizerNode {
389
+ // (undocumented)
390
+ createChild(
391
+ summarizeInternalFn: SummarizeInternalFn,
392
+ id: string,
393
+ createParam: CreateChildSummarizerNodeParam,
394
+ config?: ISummarizerNodeConfig): ISummarizerNode;
395
+ // (undocumented)
396
+ getChild(id: string): ISummarizerNode | undefined;
397
+ invalidate(sequenceNumber: number): void;
398
+ isSummaryInProgress?(): boolean;
399
+ recordChange(op: ISequencedDocumentMessage): void;
400
+ readonly referenceSequenceNumber: number;
401
+ summarize(fullTree: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;
402
+ updateBaseSummaryState(snapshot: ISnapshotTree): void;
403
+ }
404
+
405
+ // @public (undocumented)
406
+ export interface ISummarizerNodeConfig {
407
+ readonly canReuseHandle?: boolean;
408
+ readonly throwOnFailure?: true;
409
+ }
410
+
411
+ // @public (undocumented)
412
+ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
413
+ readonly gcDisabled?: boolean;
414
+ }
415
+
416
+ // @public
417
+ export interface ISummarizerNodeWithGC extends ISummarizerNode {
418
+ // (undocumented)
419
+ createChild(
420
+ summarizeInternalFn: SummarizeInternalFn,
421
+ id: string,
422
+ createParam: CreateChildSummarizerNodeParam,
423
+ config?: ISummarizerNodeConfigWithGC, getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
424
+ getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>): ISummarizerNodeWithGC;
425
+ deleteChild(id: string): void;
426
+ // (undocumented)
427
+ getChild(id: string): ISummarizerNodeWithGC | undefined;
428
+ getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
429
+ isReferenced(): boolean;
430
+ updateUsedRoutes(usedRoutes: string[]): void;
431
+ }
432
+
433
+ // @public
434
+ export interface ISummaryStats {
435
+ // (undocumented)
436
+ blobNodeCount: number;
437
+ // (undocumented)
438
+ handleNodeCount: number;
439
+ // (undocumented)
440
+ totalBlobSize: number;
441
+ // (undocumented)
442
+ treeNodeCount: number;
443
+ // (undocumented)
444
+ unreferencedBlobSize: number;
445
+ }
446
+
447
+ // @public
448
+ export interface ISummaryTreeWithStats {
449
+ stats: ISummaryStats;
450
+ summary: ISummaryTree;
451
+ }
452
+
453
+ // @public
454
+ export interface ITelemetryContext {
455
+ get(prefix: string, property: string): TelemetryEventPropertyType;
456
+ serialize(): string;
457
+ set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
458
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
459
+ }
460
+
461
+ // @alpha
462
+ export interface LocalAttributionKey {
463
+ // (undocumented)
464
+ type: "local";
465
+ }
466
+
467
+ // @public
468
+ export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
469
+
470
+ // @public
471
+ export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
472
+
473
+ // @alpha
474
+ export interface OpAttributionKey {
475
+ seq: number;
476
+ type: "op";
477
+ }
478
+
479
+ // @public
480
+ export type OpSpaceCompressedId = number & {
481
+ readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
482
+ };
483
+
484
+ // @public
485
+ export type SerializedIdCompressor = string & {
486
+ readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
487
+ };
488
+
489
+ // @public
490
+ export type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
491
+ readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
492
+ };
493
+
494
+ // @public
495
+ export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
496
+ readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
497
+ };
498
+
499
+ // @public
500
+ export type SessionId = StableId & {
501
+ readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
502
+ };
503
+
504
+ // @public
505
+ export type SessionSpaceCompressedId = number & {
506
+ readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
507
+ };
508
+
509
+ // @public
510
+ export type StableId = string & {
511
+ readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
512
+ };
513
+
514
+ // @public (undocumented)
515
+ export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
516
+
517
+ // @public (undocumented)
518
+ export const totalBlobSizePropertyName = "TotalBlobSize";
519
+
520
+ // @public
521
+ export const VisibilityState: {
522
+ NotVisible: string;
523
+ LocallyVisible: string;
524
+ GloballyVisible: string;
525
+ };
526
+
527
+ // @public (undocumented)
528
+ export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
529
+
530
+ // (No @packageDocumentation comment for this package)
531
+
532
+ ```
@@ -56,7 +56,7 @@ export interface LocalAttributionKey {
56
56
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
57
57
  * @alpha
58
58
  */
59
- export declare type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
59
+ export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
60
60
  /**
61
61
  * Attribution information associated with a change.
62
62
  * @alpha
@@ -1 +1 @@
1
- {"version":3,"file":"attribution.d.ts","sourceRoot":"","sources":["../src/attribution.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAElE;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;;;OAOG;IACH,EAAE,EAAE,CAAC,CAAC;CACN;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,OAAO,CAAC;CACd;AAED;;;GAGG;AACH,oBAAY,cAAc,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,mBAAmB,CAAC;AAE7F;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"attribution.d.ts","sourceRoot":"","sources":["../src/attribution.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAElE;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;;;OAOG;IACH,EAAE,EAAE,CAAC,CAAC;CACN;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,OAAO,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,mBAAmB,CAAC;AAE7F;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB"}