@fluidframework/container-definitions 2.32.0 → 2.33.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
|
@@ -22,7 +22,7 @@ export namespace ConnectionState {
|
|
|
22
22
|
// @public
|
|
23
23
|
export type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connected;
|
|
24
24
|
|
|
25
|
-
// @alpha
|
|
25
|
+
// @alpha @legacy
|
|
26
26
|
export const ContainerErrorTypes: {
|
|
27
27
|
readonly clientSessionExpiredError: "clientSessionExpiredError";
|
|
28
28
|
readonly genericError: "genericError";
|
|
@@ -32,10 +32,10 @@ export const ContainerErrorTypes: {
|
|
|
32
32
|
readonly usageError: "usageError";
|
|
33
33
|
};
|
|
34
34
|
|
|
35
|
-
// @alpha
|
|
35
|
+
// @alpha @legacy
|
|
36
36
|
export type ContainerErrorTypes = (typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes];
|
|
37
37
|
|
|
38
|
-
// @alpha
|
|
38
|
+
// @alpha @legacy
|
|
39
39
|
export interface ContainerWarning extends IErrorBase_2 {
|
|
40
40
|
logged?: boolean;
|
|
41
41
|
}
|
|
@@ -56,14 +56,14 @@ export interface IAudienceEvents extends IEvent {
|
|
|
56
56
|
(event: "selfChanged", listener: (oldValue: ISelf | undefined, newValue: ISelf) => void): void;
|
|
57
57
|
}
|
|
58
58
|
|
|
59
|
-
// @alpha
|
|
59
|
+
// @alpha @legacy
|
|
60
60
|
export interface IAudienceOwner extends IAudience {
|
|
61
61
|
addMember(clientId: string, details: IClient): void;
|
|
62
62
|
removeMember(clientId: string): boolean;
|
|
63
63
|
setCurrentClientId(clientId: string): void;
|
|
64
64
|
}
|
|
65
65
|
|
|
66
|
-
// @alpha
|
|
66
|
+
// @alpha @legacy
|
|
67
67
|
export interface IBatchMessage {
|
|
68
68
|
// (undocumented)
|
|
69
69
|
compression?: string;
|
|
@@ -75,12 +75,12 @@ export interface IBatchMessage {
|
|
|
75
75
|
referenceSequenceNumber?: number;
|
|
76
76
|
}
|
|
77
77
|
|
|
78
|
-
// @alpha
|
|
78
|
+
// @alpha @legacy
|
|
79
79
|
export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
|
|
80
80
|
load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
|
|
81
81
|
}
|
|
82
82
|
|
|
83
|
-
// @alpha
|
|
83
|
+
// @alpha @legacy
|
|
84
84
|
export interface IConnectionDetails {
|
|
85
85
|
checkpointSequenceNumber: number | undefined;
|
|
86
86
|
// (undocumented)
|
|
@@ -90,7 +90,7 @@ export interface IConnectionDetails {
|
|
|
90
90
|
serviceConfiguration: IClientConfiguration;
|
|
91
91
|
}
|
|
92
92
|
|
|
93
|
-
// @alpha
|
|
93
|
+
// @alpha @legacy
|
|
94
94
|
export interface IContainer extends IEventProvider<IContainerEvents> {
|
|
95
95
|
attach(request: IRequest, attachProps?: {
|
|
96
96
|
deltaConnection?: "none" | "delayed";
|
|
@@ -122,7 +122,7 @@ export interface IContainer extends IEventProvider<IContainerEvents> {
|
|
|
122
122
|
serialize(): string;
|
|
123
123
|
}
|
|
124
124
|
|
|
125
|
-
// @alpha
|
|
125
|
+
// @alpha @legacy
|
|
126
126
|
export interface IContainerContext {
|
|
127
127
|
readonly attachState: AttachState;
|
|
128
128
|
// (undocumented)
|
|
@@ -173,7 +173,7 @@ export interface IContainerContext {
|
|
|
173
173
|
updateDirtyContainerState(dirty: boolean): void;
|
|
174
174
|
}
|
|
175
175
|
|
|
176
|
-
// @alpha
|
|
176
|
+
// @alpha @legacy
|
|
177
177
|
export interface IContainerEvents extends IEvent {
|
|
178
178
|
(event: "readonly", listener: (readonly: boolean) => void): void;
|
|
179
179
|
(event: "connected", listener: (clientId: string) => void): any;
|
|
@@ -190,7 +190,7 @@ export interface IContainerEvents extends IEvent {
|
|
|
190
190
|
(event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
|
|
191
191
|
}
|
|
192
192
|
|
|
193
|
-
// @alpha (undocumented)
|
|
193
|
+
// @alpha @legacy (undocumented)
|
|
194
194
|
export interface IContainerLoadMode {
|
|
195
195
|
// (undocumented)
|
|
196
196
|
deltaConnection?: "none" | "delayed" | undefined;
|
|
@@ -198,7 +198,7 @@ export interface IContainerLoadMode {
|
|
|
198
198
|
opsBeforeReturn?: undefined | "cached" | "all";
|
|
199
199
|
}
|
|
200
200
|
|
|
201
|
-
// @alpha
|
|
201
|
+
// @alpha @legacy
|
|
202
202
|
export type IContainerPolicies = {
|
|
203
203
|
maxClientLeaveWaitTime?: number;
|
|
204
204
|
};
|
|
@@ -206,7 +206,7 @@ export type IContainerPolicies = {
|
|
|
206
206
|
// @public
|
|
207
207
|
export type ICriticalContainerError = IErrorBase_2;
|
|
208
208
|
|
|
209
|
-
// @alpha @sealed
|
|
209
|
+
// @alpha @sealed @legacy
|
|
210
210
|
export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
|
|
211
211
|
readonly active: boolean;
|
|
212
212
|
readonly clientDetails: IClientDetails;
|
|
@@ -225,7 +225,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
|
|
|
225
225
|
readonly version: string;
|
|
226
226
|
}
|
|
227
227
|
|
|
228
|
-
// @alpha @sealed
|
|
228
|
+
// @alpha @sealed @legacy
|
|
229
229
|
export interface IDeltaManagerEvents extends IEvent {
|
|
230
230
|
// @deprecated (undocumented)
|
|
231
231
|
(event: "prepareSend", listener: (messageBuffer: any[]) => void): any;
|
|
@@ -241,7 +241,7 @@ export interface IDeltaManagerEvents extends IEvent {
|
|
|
241
241
|
}) => void): any;
|
|
242
242
|
}
|
|
243
243
|
|
|
244
|
-
// @alpha @sealed
|
|
244
|
+
// @alpha @sealed @legacy
|
|
245
245
|
export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
|
|
246
246
|
idle: boolean;
|
|
247
247
|
length: number;
|
|
@@ -256,21 +256,21 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, ID
|
|
|
256
256
|
}>;
|
|
257
257
|
}
|
|
258
258
|
|
|
259
|
-
// @alpha @sealed
|
|
259
|
+
// @alpha @sealed @legacy
|
|
260
260
|
export interface IDeltaQueueEvents<T> extends IErrorEvent {
|
|
261
261
|
(event: "push", listener: (task: T) => void): any;
|
|
262
262
|
(event: "op", listener: (task: T) => void): any;
|
|
263
263
|
(event: "idle", listener: (count: number, duration: number) => void): any;
|
|
264
264
|
}
|
|
265
265
|
|
|
266
|
-
// @alpha @sealed
|
|
266
|
+
// @alpha @sealed @legacy
|
|
267
267
|
export interface IDeltaSender {
|
|
268
268
|
flush(): void;
|
|
269
269
|
}
|
|
270
270
|
|
|
271
271
|
export { IErrorBase }
|
|
272
272
|
|
|
273
|
-
// @alpha
|
|
273
|
+
// @alpha @legacy
|
|
274
274
|
export interface IFluidBrowserPackage extends IFluidPackage {
|
|
275
275
|
fluid: {
|
|
276
276
|
browser: IFluidBrowserPackageEnvironment;
|
|
@@ -278,7 +278,7 @@ export interface IFluidBrowserPackage extends IFluidPackage {
|
|
|
278
278
|
};
|
|
279
279
|
}
|
|
280
280
|
|
|
281
|
-
// @alpha
|
|
281
|
+
// @alpha @legacy
|
|
282
282
|
export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
|
|
283
283
|
umd: {
|
|
284
284
|
files: string[];
|
|
@@ -286,40 +286,40 @@ export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironmen
|
|
|
286
286
|
};
|
|
287
287
|
}
|
|
288
288
|
|
|
289
|
-
// @alpha
|
|
289
|
+
// @alpha @legacy
|
|
290
290
|
export interface IFluidCodeDetails {
|
|
291
291
|
readonly config?: IFluidCodeDetailsConfig;
|
|
292
292
|
readonly package: string | Readonly<IFluidPackage>;
|
|
293
293
|
}
|
|
294
294
|
|
|
295
|
-
// @alpha (undocumented)
|
|
295
|
+
// @alpha @legacy (undocumented)
|
|
296
296
|
export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
|
|
297
297
|
|
|
298
|
-
// @alpha
|
|
298
|
+
// @alpha @legacy
|
|
299
299
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
300
300
|
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
301
301
|
satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
|
|
302
302
|
}
|
|
303
303
|
|
|
304
|
-
// @alpha
|
|
304
|
+
// @alpha @legacy
|
|
305
305
|
export interface IFluidCodeDetailsConfig {
|
|
306
306
|
// (undocumented)
|
|
307
307
|
readonly [key: string]: string;
|
|
308
308
|
}
|
|
309
309
|
|
|
310
|
-
// @alpha (undocumented)
|
|
310
|
+
// @alpha @legacy (undocumented)
|
|
311
311
|
export interface IFluidModule {
|
|
312
312
|
// (undocumented)
|
|
313
313
|
fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
|
|
314
314
|
}
|
|
315
315
|
|
|
316
|
-
// @alpha
|
|
316
|
+
// @alpha @legacy
|
|
317
317
|
export interface IFluidModuleWithDetails {
|
|
318
318
|
details: IFluidCodeDetails;
|
|
319
319
|
module: IFluidModule;
|
|
320
320
|
}
|
|
321
321
|
|
|
322
|
-
// @alpha
|
|
322
|
+
// @alpha @legacy
|
|
323
323
|
export interface IFluidPackage {
|
|
324
324
|
[key: string]: unknown;
|
|
325
325
|
fluid: {
|
|
@@ -328,7 +328,7 @@ export interface IFluidPackage {
|
|
|
328
328
|
name: string;
|
|
329
329
|
}
|
|
330
330
|
|
|
331
|
-
// @alpha
|
|
331
|
+
// @alpha @legacy
|
|
332
332
|
export interface IFluidPackageEnvironment {
|
|
333
333
|
[target: string]: undefined | {
|
|
334
334
|
files: string[];
|
|
@@ -336,7 +336,7 @@ export interface IFluidPackageEnvironment {
|
|
|
336
336
|
};
|
|
337
337
|
}
|
|
338
338
|
|
|
339
|
-
// @alpha
|
|
339
|
+
// @alpha @legacy
|
|
340
340
|
export interface IGetPendingLocalStateProps {
|
|
341
341
|
readonly notifyImminentClosure: boolean;
|
|
342
342
|
readonly sessionExpiryTimerStarted?: number;
|
|
@@ -344,7 +344,7 @@ export interface IGetPendingLocalStateProps {
|
|
|
344
344
|
readonly stopBlobAttachingSignal?: AbortSignal;
|
|
345
345
|
}
|
|
346
346
|
|
|
347
|
-
// @alpha
|
|
347
|
+
// @alpha @legacy
|
|
348
348
|
export interface IHostLoader extends ILoader {
|
|
349
349
|
createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
|
|
350
350
|
canReconnect?: boolean;
|
|
@@ -356,12 +356,12 @@ export interface IHostLoader extends ILoader {
|
|
|
356
356
|
}): Promise<IContainer>;
|
|
357
357
|
}
|
|
358
358
|
|
|
359
|
-
// @alpha
|
|
359
|
+
// @alpha @legacy
|
|
360
360
|
export interface ILoader extends Partial<IProvideLoader> {
|
|
361
361
|
resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
|
|
362
362
|
}
|
|
363
363
|
|
|
364
|
-
// @alpha
|
|
364
|
+
// @alpha @legacy
|
|
365
365
|
export type ILoaderOptions = {
|
|
366
366
|
cache?: boolean;
|
|
367
367
|
client?: IClient;
|
|
@@ -370,25 +370,25 @@ export type ILoaderOptions = {
|
|
|
370
370
|
maxClientLeaveWaitTime?: number;
|
|
371
371
|
};
|
|
372
372
|
|
|
373
|
-
// @alpha (undocumented)
|
|
373
|
+
// @alpha @legacy (undocumented)
|
|
374
374
|
export interface IProvideFluidCodeDetailsComparer {
|
|
375
375
|
// (undocumented)
|
|
376
376
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
377
377
|
}
|
|
378
378
|
|
|
379
|
-
// @alpha (undocumented)
|
|
379
|
+
// @alpha @legacy (undocumented)
|
|
380
380
|
export interface IProvideLoader {
|
|
381
381
|
// (undocumented)
|
|
382
382
|
readonly ILoader: ILoader;
|
|
383
383
|
}
|
|
384
384
|
|
|
385
|
-
// @alpha (undocumented)
|
|
385
|
+
// @alpha @legacy (undocumented)
|
|
386
386
|
export interface IProvideRuntimeFactory {
|
|
387
387
|
// (undocumented)
|
|
388
388
|
readonly IRuntimeFactory: IRuntimeFactory;
|
|
389
389
|
}
|
|
390
390
|
|
|
391
|
-
// @alpha
|
|
391
|
+
// @alpha @legacy
|
|
392
392
|
export interface IRuntime extends IDisposable {
|
|
393
393
|
createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
|
|
394
394
|
getEntryPoint(): Promise<FluidObject>;
|
|
@@ -400,10 +400,10 @@ export interface IRuntime extends IDisposable {
|
|
|
400
400
|
setConnectionState(connected: boolean, clientId?: string): any;
|
|
401
401
|
}
|
|
402
402
|
|
|
403
|
-
// @alpha (undocumented)
|
|
403
|
+
// @alpha @legacy (undocumented)
|
|
404
404
|
export const IRuntimeFactory: keyof IProvideRuntimeFactory;
|
|
405
405
|
|
|
406
|
-
// @alpha
|
|
406
|
+
// @alpha @legacy
|
|
407
407
|
export interface IRuntimeFactory extends IProvideRuntimeFactory {
|
|
408
408
|
instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
|
|
409
409
|
}
|
|
@@ -414,13 +414,13 @@ export interface ISelf {
|
|
|
414
414
|
readonly clientId: string;
|
|
415
415
|
}
|
|
416
416
|
|
|
417
|
-
// @alpha
|
|
417
|
+
// @alpha @legacy
|
|
418
418
|
export const isFluidBrowserPackage: (maybePkg: unknown) => maybePkg is Readonly<IFluidBrowserPackage>;
|
|
419
419
|
|
|
420
|
-
// @alpha
|
|
420
|
+
// @alpha @legacy
|
|
421
421
|
export const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
|
|
422
422
|
|
|
423
|
-
// @alpha
|
|
423
|
+
// @alpha @legacy
|
|
424
424
|
export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
|
|
425
425
|
// (undocumented)
|
|
426
426
|
blobsContents?: {
|
|
@@ -434,7 +434,7 @@ export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
|
|
|
434
434
|
|
|
435
435
|
export { IThrottlingWarning }
|
|
436
436
|
|
|
437
|
-
// @alpha
|
|
437
|
+
// @alpha @legacy
|
|
438
438
|
export enum LoaderHeader {
|
|
439
439
|
// @deprecated (undocumented)
|
|
440
440
|
cache = "fluid-cache",
|
|
@@ -447,7 +447,7 @@ export enum LoaderHeader {
|
|
|
447
447
|
version = "version"
|
|
448
448
|
}
|
|
449
449
|
|
|
450
|
-
// @alpha (undocumented)
|
|
450
|
+
// @alpha @legacy (undocumented)
|
|
451
451
|
export type ReadOnlyInfo = {
|
|
452
452
|
readonly readonly: false | undefined;
|
|
453
453
|
} | {
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-definitions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.33.0",
|
|
4
4
|
"description": "Fluid container definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
"main": "lib/index.js",
|
|
48
48
|
"types": "lib/public.d.ts",
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@fluidframework/core-interfaces": "~2.
|
|
51
|
-
"@fluidframework/driver-definitions": "~2.
|
|
50
|
+
"@fluidframework/core-interfaces": "~2.33.0",
|
|
51
|
+
"@fluidframework/driver-definitions": "~2.33.0"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -56,9 +56,9 @@
|
|
|
56
56
|
"@fluid-tools/build-cli": "^0.55.0",
|
|
57
57
|
"@fluidframework/build-common": "^2.0.3",
|
|
58
58
|
"@fluidframework/build-tools": "^0.55.0",
|
|
59
|
-
"@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.
|
|
59
|
+
"@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.32.0",
|
|
60
60
|
"@fluidframework/eslint-config-fluid": "^5.7.3",
|
|
61
|
-
"@microsoft/api-extractor": "7.
|
|
61
|
+
"@microsoft/api-extractor": "7.52.5",
|
|
62
62
|
"concurrently": "^8.2.1",
|
|
63
63
|
"copyfiles": "^2.4.1",
|
|
64
64
|
"eslint": "~8.55.0",
|