@fluidframework/runtime-definitions 2.53.1 → 2.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/{runtime-definitions.legacy.alpha.api.md → runtime-definitions.legacy.beta.api.md} +57 -57
  3. package/dist/attribution.d.ts +5 -10
  4. package/dist/attribution.d.ts.map +1 -1
  5. package/dist/attribution.js.map +1 -1
  6. package/dist/compatibilityDefinitions.d.ts +1 -2
  7. package/dist/compatibilityDefinitions.d.ts.map +1 -1
  8. package/dist/compatibilityDefinitions.js.map +1 -1
  9. package/dist/dataStoreContext.d.ts +17 -34
  10. package/dist/dataStoreContext.d.ts.map +1 -1
  11. package/dist/dataStoreContext.js +2 -4
  12. package/dist/dataStoreContext.js.map +1 -1
  13. package/dist/dataStoreFactory.d.ts +3 -6
  14. package/dist/dataStoreFactory.d.ts.map +1 -1
  15. package/dist/dataStoreFactory.js +1 -2
  16. package/dist/dataStoreFactory.js.map +1 -1
  17. package/dist/dataStoreRegistry.d.ts +7 -14
  18. package/dist/dataStoreRegistry.d.ts.map +1 -1
  19. package/dist/dataStoreRegistry.js +1 -2
  20. package/dist/dataStoreRegistry.js.map +1 -1
  21. package/dist/garbageCollectionDefinitions.d.ts +2 -4
  22. package/dist/garbageCollectionDefinitions.d.ts.map +1 -1
  23. package/dist/garbageCollectionDefinitions.js.map +1 -1
  24. package/dist/protocol.d.ts +8 -16
  25. package/dist/protocol.d.ts.map +1 -1
  26. package/dist/protocol.js.map +1 -1
  27. package/dist/summary.d.ts +13 -26
  28. package/dist/summary.d.ts.map +1 -1
  29. package/dist/summary.js +1 -2
  30. package/dist/summary.js.map +1 -1
  31. package/lib/attribution.d.ts +5 -10
  32. package/lib/attribution.d.ts.map +1 -1
  33. package/lib/attribution.js.map +1 -1
  34. package/lib/compatibilityDefinitions.d.ts +1 -2
  35. package/lib/compatibilityDefinitions.d.ts.map +1 -1
  36. package/lib/compatibilityDefinitions.js.map +1 -1
  37. package/lib/dataStoreContext.d.ts +17 -34
  38. package/lib/dataStoreContext.d.ts.map +1 -1
  39. package/lib/dataStoreContext.js +2 -4
  40. package/lib/dataStoreContext.js.map +1 -1
  41. package/lib/dataStoreFactory.d.ts +3 -6
  42. package/lib/dataStoreFactory.d.ts.map +1 -1
  43. package/lib/dataStoreFactory.js +1 -2
  44. package/lib/dataStoreFactory.js.map +1 -1
  45. package/lib/dataStoreRegistry.d.ts +7 -14
  46. package/lib/dataStoreRegistry.d.ts.map +1 -1
  47. package/lib/dataStoreRegistry.js +1 -2
  48. package/lib/dataStoreRegistry.js.map +1 -1
  49. package/lib/garbageCollectionDefinitions.d.ts +2 -4
  50. package/lib/garbageCollectionDefinitions.d.ts.map +1 -1
  51. package/lib/garbageCollectionDefinitions.js.map +1 -1
  52. package/lib/protocol.d.ts +8 -16
  53. package/lib/protocol.d.ts.map +1 -1
  54. package/lib/protocol.js.map +1 -1
  55. package/lib/summary.d.ts +13 -26
  56. package/lib/summary.d.ts.map +1 -1
  57. package/lib/summary.js +1 -2
  58. package/lib/summary.js.map +1 -1
  59. package/package.json +7 -7
  60. package/src/attribution.ts +5 -10
  61. package/src/compatibilityDefinitions.ts +1 -2
  62. package/src/dataStoreContext.ts +17 -34
  63. package/src/dataStoreFactory.ts +3 -6
  64. package/src/dataStoreRegistry.ts +7 -14
  65. package/src/garbageCollectionDefinitions.ts +2 -4
  66. package/src/protocol.ts +8 -16
  67. package/src/summary.ts +13 -26
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/runtime-definitions
2
2
 
3
+ ## 2.60.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.53.0
4
8
 
5
9
  Dependency updates only.
@@ -1,31 +1,31 @@
1
- ## Alpha API Report File for "@fluidframework/runtime-definitions"
1
+ ## Beta API Report File for "@fluidframework/runtime-definitions"
2
2
 
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
5
5
  ```ts
6
6
 
7
- // @alpha @legacy
7
+ // @beta @legacy
8
8
  export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
9
9
 
10
- // @alpha @legacy
10
+ // @beta @legacy
11
11
  export interface AttributionInfo {
12
12
  timestamp: number;
13
13
  user: IUser;
14
14
  }
15
15
 
16
- // @alpha @legacy
16
+ // @beta @legacy
17
17
  export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
18
18
 
19
- // @alpha @sealed @deprecated @legacy (undocumented)
19
+ // @beta @sealed @deprecated @legacy (undocumented)
20
20
  export interface CommitStagedChangesOptionsExperimental {
21
21
  squash?: boolean;
22
22
  }
23
23
 
24
- // @alpha @legacy (undocumented)
24
+ // @beta @legacy (undocumented)
25
25
  export type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
26
26
  getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
27
27
 
28
- // @alpha @legacy (undocumented)
28
+ // @beta @legacy (undocumented)
29
29
  export type CreateChildSummarizerNodeParam = {
30
30
  type: CreateSummarizerNodeSource.FromSummary;
31
31
  } | {
@@ -36,7 +36,7 @@ export type CreateChildSummarizerNodeParam = {
36
36
  type: CreateSummarizerNodeSource.Local;
37
37
  };
38
38
 
39
- // @alpha @legacy (undocumented)
39
+ // @beta @legacy (undocumented)
40
40
  export enum CreateSummarizerNodeSource {
41
41
  // (undocumented)
42
42
  FromAttach = 1,
@@ -46,31 +46,31 @@ export enum CreateSummarizerNodeSource {
46
46
  Local = 2
47
47
  }
48
48
 
49
- // @alpha @legacy
49
+ // @beta @legacy
50
50
  export interface DetachedAttributionKey {
51
51
  id: 0;
52
52
  // (undocumented)
53
53
  type: "detached";
54
54
  }
55
55
 
56
- // @alpha @legacy
56
+ // @beta @legacy
57
57
  export type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
58
58
 
59
- // @alpha @legacy
59
+ // @beta @legacy
60
60
  export enum FlushMode {
61
61
  // @deprecated
62
62
  Immediate = 0,
63
63
  TurnBased = 1
64
64
  }
65
65
 
66
- // @alpha @legacy
66
+ // @beta @legacy
67
67
  export interface IAttachMessage {
68
68
  id: string;
69
69
  snapshot: ITree;
70
70
  type: string;
71
71
  }
72
72
 
73
- // @alpha @sealed @legacy
73
+ // @beta @sealed @legacy
74
74
  export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
75
75
  // (undocumented)
76
76
  readonly baseLogger: ITelemetryBaseLogger;
@@ -95,7 +95,7 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
95
95
  uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
96
96
  }
97
97
 
98
- // @alpha @sealed @legacy (undocumented)
98
+ // @beta @sealed @legacy (undocumented)
99
99
  export interface IContainerRuntimeBaseEvents extends IEvent {
100
100
  (event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
101
101
  (event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;
@@ -106,7 +106,7 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
106
106
  (event: "dispose", listener: () => void): any;
107
107
  }
108
108
 
109
- // @alpha @sealed @deprecated @legacy (undocumented)
109
+ // @beta @sealed @deprecated @legacy (undocumented)
110
110
  export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase {
111
111
  // (undocumented)
112
112
  enterStagingMode?(): StageControlsExperimental;
@@ -114,26 +114,26 @@ export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase
114
114
  readonly inStagingMode?: boolean;
115
115
  }
116
116
 
117
- // @alpha @legacy
117
+ // @beta @legacy
118
118
  export interface IDataStore {
119
119
  readonly entryPoint: IFluidHandleInternal<FluidObject>;
120
120
  trySetAlias(alias: string): Promise<AliasResult>;
121
121
  }
122
122
 
123
- // @alpha @legacy
123
+ // @beta @legacy
124
124
  export interface IEnvelope {
125
125
  address: string;
126
126
  contents: any;
127
127
  }
128
128
 
129
- // @alpha @legacy
129
+ // @beta @legacy
130
130
  export interface IExperimentalIncrementalSummaryContext {
131
131
  readonly latestSummarySequenceNumber: number;
132
132
  readonly summaryPath: string;
133
133
  readonly summarySequenceNumber: number;
134
134
  }
135
135
 
136
- // @alpha @legacy
136
+ // @beta @legacy
137
137
  export interface IFluidDataStoreChannel extends IDisposable {
138
138
  // (undocumented)
139
139
  applyStashedOp(content: any): Promise<unknown>;
@@ -157,7 +157,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
157
157
  updateUsedRoutes(usedRoutes: string[]): void;
158
158
  }
159
159
 
160
- // @alpha @legacy
160
+ // @beta @legacy
161
161
  export interface IFluidDataStoreContext extends IFluidParentContext {
162
162
  // (undocumented)
163
163
  readonly baseSnapshot: ISnapshotTree | undefined;
@@ -172,15 +172,15 @@ export interface IFluidDataStoreContext extends IFluidParentContext {
172
172
  readonly packagePath: PackagePath;
173
173
  }
174
174
 
175
- // @alpha @legacy (undocumented)
175
+ // @beta @legacy (undocumented)
176
176
  export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
177
177
  attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<IDataStore>;
178
178
  }
179
179
 
180
- // @alpha @legacy (undocumented)
180
+ // @beta @legacy (undocumented)
181
181
  export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
182
182
 
183
- // @alpha @legacy
183
+ // @beta @legacy
184
184
  export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
185
185
  createDataStore?(context: IFluidDataStoreContext): {
186
186
  readonly runtime: IFluidDataStoreChannel;
@@ -189,21 +189,21 @@ export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
189
189
  type: string;
190
190
  }
191
191
 
192
- // @alpha @legacy
192
+ // @beta @legacy
193
193
  export interface IFluidDataStorePolicies {
194
194
  readonly readonlyInStagingMode: boolean;
195
195
  }
196
196
 
197
- // @alpha @legacy (undocumented)
197
+ // @beta @legacy (undocumented)
198
198
  export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
199
199
 
200
- // @alpha @legacy
200
+ // @beta @legacy
201
201
  export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
202
202
  get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
203
203
  getSync?(name: string): FluidDataStoreRegistryEntry | undefined;
204
204
  }
205
205
 
206
- // @alpha @legacy
206
+ // @beta @legacy
207
207
  export interface IFluidParentContext extends IProvideFluidHandleContext, Partial<IProvideFluidDataStoreRegistry> {
208
208
  addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
209
209
  readonly attachState: AttachState;
@@ -249,57 +249,57 @@ export interface IFluidParentContext extends IProvideFluidHandleContext, Partial
249
249
  uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternal<ArrayBufferLike>>;
250
250
  }
251
251
 
252
- // @alpha @legacy
252
+ // @beta @legacy
253
253
  export interface IGarbageCollectionData {
254
254
  gcNodes: {
255
255
  [id: string]: string[];
256
256
  };
257
257
  }
258
258
 
259
- // @alpha @legacy
259
+ // @beta @legacy
260
260
  export interface IGarbageCollectionDetailsBase {
261
261
  gcData?: IGarbageCollectionData;
262
262
  usedRoutes?: string[];
263
263
  }
264
264
 
265
- // @alpha @legacy
265
+ // @beta @legacy
266
266
  export interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessage<TMessage> {
267
267
  // (undocumented)
268
268
  readonly type: TMessage["type"];
269
269
  }
270
270
 
271
- // @alpha @legacy
271
+ // @beta @legacy
272
272
  export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
273
273
  snapshot: IAttachMessage["snapshot"] | null;
274
274
  };
275
275
 
276
- // @alpha @legacy (undocumented)
276
+ // @beta @legacy (undocumented)
277
277
  export interface IProvideFluidDataStoreFactory {
278
278
  // (undocumented)
279
279
  readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
280
280
  }
281
281
 
282
- // @alpha @legacy (undocumented)
282
+ // @beta @legacy (undocumented)
283
283
  export interface IProvideFluidDataStoreRegistry {
284
284
  // (undocumented)
285
285
  readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
286
286
  }
287
287
 
288
- // @alpha @sealed @legacy
288
+ // @beta @sealed @legacy
289
289
  export interface IRuntimeMessageCollection {
290
290
  readonly envelope: ISequencedMessageEnvelope;
291
291
  readonly local: boolean;
292
292
  readonly messagesContent: readonly IRuntimeMessagesContent[];
293
293
  }
294
294
 
295
- // @alpha @sealed @legacy
295
+ // @beta @sealed @legacy
296
296
  export interface IRuntimeMessagesContent {
297
297
  readonly clientSequenceNumber: number;
298
298
  readonly contents: unknown;
299
299
  readonly localOpMetadata: unknown;
300
300
  }
301
301
 
302
- // @alpha @legacy
302
+ // @beta @legacy
303
303
  export interface IRuntimeStorageService {
304
304
  // @deprecated (undocumented)
305
305
  createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
@@ -322,17 +322,17 @@ export interface IRuntimeStorageService {
322
322
  uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
323
323
  }
324
324
 
325
- // @alpha @legacy
325
+ // @beta @legacy
326
326
  export type ISequencedMessageEnvelope = Omit<ISequencedDocumentMessage, "contents" | "clientSequenceNumber">;
327
327
 
328
- // @alpha @legacy
328
+ // @beta @legacy
329
329
  export interface ISummarizeInternalResult extends ISummarizeResult {
330
330
  // (undocumented)
331
331
  id: string;
332
332
  pathPartsForChildren?: string[];
333
333
  }
334
334
 
335
- // @alpha @legacy
335
+ // @beta @legacy
336
336
  export interface ISummarizeResult {
337
337
  // (undocumented)
338
338
  stats: ISummaryStats;
@@ -340,7 +340,7 @@ export interface ISummarizeResult {
340
340
  summary: SummaryTree;
341
341
  }
342
342
 
343
- // @alpha @legacy (undocumented)
343
+ // @beta @legacy (undocumented)
344
344
  export interface ISummarizerNode {
345
345
  // (undocumented)
346
346
  createChild(
@@ -359,17 +359,17 @@ export interface ISummarizerNode {
359
359
  updateBaseSummaryState(snapshot: ISnapshotTree): void;
360
360
  }
361
361
 
362
- // @alpha @legacy (undocumented)
362
+ // @beta @legacy (undocumented)
363
363
  export interface ISummarizerNodeConfig {
364
364
  readonly canReuseHandle?: boolean;
365
365
  }
366
366
 
367
- // @alpha @legacy (undocumented)
367
+ // @beta @legacy (undocumented)
368
368
  export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
369
369
  readonly gcDisabled?: boolean;
370
370
  }
371
371
 
372
- // @alpha @legacy
372
+ // @beta @legacy
373
373
  export interface ISummarizerNodeWithGC extends ISummarizerNode {
374
374
  // (undocumented)
375
375
  createChild(
@@ -386,7 +386,7 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
386
386
  updateUsedRoutes(usedRoutes: string[]): void;
387
387
  }
388
388
 
389
- // @alpha @legacy
389
+ // @beta @legacy
390
390
  export interface ISummaryStats {
391
391
  // (undocumented)
392
392
  blobNodeCount: number;
@@ -400,65 +400,65 @@ export interface ISummaryStats {
400
400
  unreferencedBlobSize: number;
401
401
  }
402
402
 
403
- // @alpha @legacy
403
+ // @beta @legacy
404
404
  export interface ISummaryTreeWithStats {
405
405
  stats: ISummaryStats;
406
406
  summary: ISummaryTree;
407
407
  }
408
408
 
409
- // @alpha @legacy
409
+ // @beta @legacy
410
410
  export interface ITelemetryContext {
411
411
  set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
412
412
  setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
413
413
  }
414
414
 
415
- // @alpha @legacy
415
+ // @beta @legacy
416
416
  export interface LocalAttributionKey {
417
417
  // (undocumented)
418
418
  type: "local";
419
419
  }
420
420
 
421
- // @alpha @legacy
421
+ // @beta @legacy
422
422
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
423
423
 
424
- // @alpha @legacy
424
+ // @beta @legacy
425
425
  export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry2>;
426
426
 
427
- // @alpha @legacy
427
+ // @beta @legacy
428
428
  export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
429
429
 
430
- // @alpha @legacy
430
+ // @beta @legacy
431
431
  export type NamedFluidDataStoreRegistryEntry2 = [
432
432
  string,
433
433
  Promise<FluidDataStoreRegistryEntry> | FluidDataStoreRegistryEntry
434
434
  ];
435
435
 
436
- // @alpha @legacy
436
+ // @beta @legacy
437
437
  export interface OpAttributionKey {
438
438
  seq: number;
439
439
  type: "op";
440
440
  }
441
441
 
442
- // @alpha @legacy
442
+ // @beta @legacy
443
443
  export type PackagePath = readonly string[];
444
444
 
445
- // @alpha @sealed @deprecated @legacy (undocumented)
445
+ // @beta @sealed @deprecated @legacy (undocumented)
446
446
  export interface StageControlsExperimental {
447
447
  readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;
448
448
  readonly discardChanges: () => void;
449
449
  }
450
450
 
451
- // @alpha @legacy (undocumented)
451
+ // @beta @legacy (undocumented)
452
452
  export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
453
453
 
454
- // @alpha @legacy
454
+ // @beta @legacy
455
455
  export const VisibilityState: {
456
456
  NotVisible: string;
457
457
  LocallyVisible: string;
458
458
  GloballyVisible: string;
459
459
  };
460
460
 
461
- // @alpha @legacy (undocumented)
461
+ // @beta @legacy (undocumented)
462
462
  export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
463
463
 
464
464
  // (No @packageDocumentation comment for this package)
@@ -6,8 +6,7 @@ import type { IUser } from "@fluidframework/driver-definitions";
6
6
  /**
7
7
  * AttributionKey representing a reference to some op in the op stream.
8
8
  * Content associated with this key aligns with content modified by that op.
9
- * @legacy
10
- * @alpha
9
+ * @legacy @beta
11
10
  */
12
11
  export interface OpAttributionKey {
13
12
  /**
@@ -29,8 +28,7 @@ export interface OpAttributionKey {
29
28
  * is currently unsupported, as applications can effectively modify content anonymously while detached.
30
29
  * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting
31
30
  * this functionality if the host provided additional context to their attributor or attach calls.
32
- * @legacy
33
- * @alpha
31
+ * @legacy @beta
34
32
  */
35
33
  export interface DetachedAttributionKey {
36
34
  type: "detached";
@@ -46,22 +44,19 @@ export interface DetachedAttributionKey {
46
44
  }
47
45
  /**
48
46
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
49
- * @legacy
50
- * @alpha
47
+ * @legacy @beta
51
48
  */
52
49
  export interface LocalAttributionKey {
53
50
  type: "local";
54
51
  }
55
52
  /**
56
53
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
57
- * @legacy
58
- * @alpha
54
+ * @legacy @beta
59
55
  */
60
56
  export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
61
57
  /**
62
58
  * Attribution information associated with a change.
63
- * @legacy
64
- * @alpha
59
+ * @legacy @beta
65
60
  */
66
61
  export interface AttributionInfo {
67
62
  /**
@@ -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,oCAAoC,CAAC;AAEhE;;;;;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;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,mBAAmB,CAAC;AAE7F;;;;GAIG;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,oCAAoC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;;;;OAOG;IACH,EAAE,EAAE,CAAC,CAAC;CACN;AAED;;;GAGG;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"}
@@ -1 +1 @@
1
- {"version":3,"file":"attribution.js","sourceRoot":"","sources":["../src/attribution.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"@fluidframework/driver-definitions\";\n\n/**\n * AttributionKey representing a reference to some op in the op stream.\n * Content associated with this key aligns with content modified by that op.\n * @legacy\n * @alpha\n */\nexport interface OpAttributionKey {\n\t/**\n\t * The type of attribution this key corresponds to.\n\t *\n\t * Keys currently all represent op-based attribution, so have the form `{ type: \"op\", key: sequenceNumber }`.\n\t * Thus, they can be used with an `OpStreamAttributor` to recover timestamp/user information.\n\t */\n\ttype: \"op\";\n\n\t/**\n\t * The sequenceNumber of the op this attribution key is for.\n\t */\n\tseq: number;\n}\n\n/**\n * AttributionKey associated with content that was inserted while the container was in a detached state.\n *\n * @remarks Retrieving an {@link AttributionInfo} from content associated with detached attribution keys\n * is currently unsupported, as applications can effectively modify content anonymously while detached.\n * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting\n * this functionality if the host provided additional context to their attributor or attach calls.\n * @legacy\n * @alpha\n */\nexport interface DetachedAttributionKey {\n\ttype: \"detached\";\n\n\t/**\n\t * Arbitrary discriminator associated with content inserted while detached.\n\t *\n\t * @remarks For now, the runtime assumes all content created while detached is associated\n\t * with the same user/timestamp.\n\t * We could weaken this assumption in the future with further API support and\n\t * allow arbitrary strings or numbers as part of this key.\n\t */\n\tid: 0;\n}\n\n/**\n * AttributionKey associated with content that has been made locally but not yet acked by the server.\n * @legacy\n * @alpha\n */\nexport interface LocalAttributionKey {\n\ttype: \"local\";\n}\n\n/**\n * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.\n * @legacy\n * @alpha\n */\nexport type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;\n\n/**\n * Attribution information associated with a change.\n * @legacy\n * @alpha\n */\nexport interface AttributionInfo {\n\t/**\n\t * The user that performed the change.\n\t */\n\tuser: IUser;\n\t/**\n\t * When the change happened.\n\t */\n\ttimestamp: number;\n}\n"]}
1
+ {"version":3,"file":"attribution.js","sourceRoot":"","sources":["../src/attribution.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"@fluidframework/driver-definitions\";\n\n/**\n * AttributionKey representing a reference to some op in the op stream.\n * Content associated with this key aligns with content modified by that op.\n * @legacy @beta\n */\nexport interface OpAttributionKey {\n\t/**\n\t * The type of attribution this key corresponds to.\n\t *\n\t * Keys currently all represent op-based attribution, so have the form `{ type: \"op\", key: sequenceNumber }`.\n\t * Thus, they can be used with an `OpStreamAttributor` to recover timestamp/user information.\n\t */\n\ttype: \"op\";\n\n\t/**\n\t * The sequenceNumber of the op this attribution key is for.\n\t */\n\tseq: number;\n}\n\n/**\n * AttributionKey associated with content that was inserted while the container was in a detached state.\n *\n * @remarks Retrieving an {@link AttributionInfo} from content associated with detached attribution keys\n * is currently unsupported, as applications can effectively modify content anonymously while detached.\n * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting\n * this functionality if the host provided additional context to their attributor or attach calls.\n * @legacy @beta\n */\nexport interface DetachedAttributionKey {\n\ttype: \"detached\";\n\n\t/**\n\t * Arbitrary discriminator associated with content inserted while detached.\n\t *\n\t * @remarks For now, the runtime assumes all content created while detached is associated\n\t * with the same user/timestamp.\n\t * We could weaken this assumption in the future with further API support and\n\t * allow arbitrary strings or numbers as part of this key.\n\t */\n\tid: 0;\n}\n\n/**\n * AttributionKey associated with content that has been made locally but not yet acked by the server.\n * @legacy @beta\n */\nexport interface LocalAttributionKey {\n\ttype: \"local\";\n}\n\n/**\n * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.\n * @legacy @beta\n */\nexport type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;\n\n/**\n * Attribution information associated with a change.\n * @legacy @beta\n */\nexport interface AttributionInfo {\n\t/**\n\t * The user that performed the change.\n\t */\n\tuser: IUser;\n\t/**\n\t * When the change happened.\n\t */\n\ttimestamp: number;\n}\n"]}
@@ -5,8 +5,7 @@
5
5
  /**
6
6
  * String in a valid semver format of a specific version at least specifying minor.
7
7
  *
8
- * @legacy
9
- * @alpha
8
+ * @legacy @beta
10
9
  */
11
10
  export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
12
11
  //# sourceMappingURL=compatibilityDefinitions.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
1
+ {"version":3,"file":"compatibilityDefinitions.d.ts","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAChC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,GAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n *\n * @legacy\n * @alpha\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
1
+ {"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * String in a valid semver format of a specific version at least specifying minor.\n *\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
@@ -16,8 +16,7 @@ import type { IInboundSignalMessage, IRuntimeMessageCollection, IRuntimeStorageS
16
16
  import type { CreateChildSummarizerNodeParam, ISummarizerNodeWithGC, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn } from "./summary.js";
17
17
  /**
18
18
  * Runtime flush mode handling
19
- * @legacy
20
- * @alpha
19
+ * @legacy @beta
21
20
  */
22
21
  export declare enum FlushMode {
23
22
  /**
@@ -51,8 +50,7 @@ export declare enum FlushModeExperimental {
51
50
  /**
52
51
  * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible
53
52
  * locally within the container only or visible globally to all clients.
54
- * @legacy
55
- * @alpha
53
+ * @legacy @beta
56
54
  */
57
55
  export declare const VisibilityState: {
58
56
  /**
@@ -77,13 +75,11 @@ export declare const VisibilityState: {
77
75
  GloballyVisible: string;
78
76
  };
79
77
  /**
80
- * @legacy
81
- * @alpha
78
+ * @legacy @beta
82
79
  */
83
80
  export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
84
81
  /**
85
- * @legacy
86
- * @alpha
82
+ * @legacy @beta
87
83
  * @sealed
88
84
  */
89
85
  export interface IContainerRuntimeBaseEvents extends IEvent {
@@ -117,8 +113,7 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
117
113
  * and will be garbage collected. The current datastore cannot be aliased to a different value.
118
114
  *
119
115
  * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.
120
- * @legacy
121
- * @alpha
116
+ * @legacy @beta
122
117
  */
123
118
  export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
124
119
  /**
@@ -133,8 +128,7 @@ export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
133
128
  * @privateRemarks
134
129
  * TODO: These docs should define what a "data store" is, and not do so by just referencing "data store".
135
130
  *
136
- * @legacy
137
- * @alpha
131
+ * @legacy @beta
138
132
  */
139
133
  export interface IDataStore {
140
134
  /**
@@ -156,8 +150,7 @@ export interface IDataStore {
156
150
  * A reduced set of functionality of {@link @fluidframework/container-runtime-definitions#IContainerRuntime} that a data store context/data store runtime will need.
157
151
  * @privateRemarks
158
152
  * TODO: this should be merged into IFluidDataStoreContext
159
- * @legacy
160
- * @alpha
153
+ * @legacy @beta
161
154
  * @sealed
162
155
  */
163
156
  export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
@@ -250,8 +243,7 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
250
243
  /**
251
244
  * @experimental
252
245
  * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
253
- * @legacy
254
- * @alpha
246
+ * @legacy @beta
255
247
  * @sealed
256
248
  */
257
249
  export interface CommitStagedChangesOptionsExperimental {
@@ -274,8 +266,7 @@ export interface CommitStagedChangesOptionsExperimental {
274
266
  /**
275
267
  * @experimental
276
268
  * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
277
- * @legacy
278
- * @alpha
269
+ * @legacy @beta
279
270
  * @sealed
280
271
  */
281
272
  export interface StageControlsExperimental {
@@ -294,8 +285,7 @@ export interface StageControlsExperimental {
294
285
  /**
295
286
  * @experimental
296
287
  * @deprecated - These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
297
- * @legacy
298
- * @alpha
288
+ * @legacy @beta
299
289
  * @sealed
300
290
  */
301
291
  export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase {
@@ -309,8 +299,7 @@ export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase
309
299
  * Policies allow data store authors to define specific behaviors or constraints for their data stores.
310
300
  * These settings can impact how the data store interacts with the runtime and other components.
311
301
  *
312
- * @legacy
313
- * @alpha
302
+ * @legacy @beta
314
303
  */
315
304
  export interface IFluidDataStorePolicies {
316
305
  /**
@@ -327,8 +316,7 @@ export interface IFluidDataStorePolicies {
327
316
  *
328
317
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
329
318
  * and connection state notifications
330
- * @legacy
331
- * @alpha
319
+ * @legacy @beta
332
320
  */
333
321
  export interface IFluidDataStoreChannel extends IDisposable {
334
322
  /**
@@ -424,8 +412,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
424
412
  setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
425
413
  }
426
414
  /**
427
- * @legacy
428
- * @alpha
415
+ * @legacy @beta
429
416
  */
430
417
  export type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
431
418
  /**
@@ -452,8 +439,7 @@ export interface IPendingMessagesState {
452
439
  * @privateRemarks
453
440
  * In addition to the use for datastores via IFluidDataStoreContext, this is implemented by ContainerRuntime to provide context to the ChannelCollection.
454
441
  *
455
- * @legacy
456
- * @alpha
442
+ * @legacy @beta
457
443
  */
458
444
  export interface IFluidParentContext extends IProvideFluidHandleContext, Partial<IProvideFluidDataStoreRegistry> {
459
445
  readonly options: Record<string | number, any>;
@@ -562,8 +548,7 @@ export interface IFluidParentContext extends IProvideFluidHandleContext, Partial
562
548
  * Each string in the array is the "identifier" to pick a specific {@link NamedFluidDataStoreRegistryEntry2} within a {@link NamedFluidDataStoreRegistryEntries}.
563
549
  *
564
550
  * Due to some usages joining this array with "/", it is recommended to avoid using "/" in the strings.
565
- * @legacy
566
- * @alpha
551
+ * @legacy @beta
567
552
  */
568
553
  export type PackagePath = readonly string[];
569
554
  /**
@@ -572,8 +557,7 @@ export type PackagePath = readonly string[];
572
557
  * @remarks
573
558
  * This context is provided to the implementation of {@link IFluidDataStoreChannel} which powers the datastore.
574
559
  *
575
- * @legacy
576
- * @alpha
560
+ * @legacy @beta
577
561
  */
578
562
  export interface IFluidDataStoreContext extends IFluidParentContext {
579
563
  readonly id: string;
@@ -625,8 +609,7 @@ export interface IFluidDataStoreContext extends IFluidParentContext {
625
609
  createChildDataStore?<T extends IFluidDataStoreFactory>(childFactory: T): ReturnType<Exclude<T["createDataStore"], undefined>>;
626
610
  }
627
611
  /**
628
- * @legacy
629
- * @alpha
612
+ * @legacy @beta
630
613
  */
631
614
  export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
632
615
  /**