@fluidframework/container-definitions 0.48.1000-58906 → 0.48.1000

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/container-definitions",
3
- "version": "0.48.1000-58906",
3
+ "version": "0.48.1000",
4
4
  "description": "Fluid container definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -22,8 +22,7 @@
22
22
  "build:esnext": "tsc --project ./tsconfig.esnext.json",
23
23
  "build:full": "npm run build",
24
24
  "build:full:compile": "npm run build:compile",
25
- "build:gen": "npm run build:gen:typetests",
26
- "build:gen:typetests": "fluid-type-validator -d .",
25
+ "build:gen": "npm run typetests:gen",
27
26
  "build:test": "tsc --project ./src/test/types/tsconfig.json",
28
27
  "ci:build": "npm run build:gen && npm run build:compile",
29
28
  "ci:build:docs": "api-extractor run --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
@@ -37,27 +36,21 @@
37
36
  "tsc": "tsc",
38
37
  "tsc:watch": "tsc --watch",
39
38
  "tsfmt": "tsfmt --verify",
40
- "tsfmt:fix": "tsfmt --replace"
39
+ "tsfmt:fix": "tsfmt --replace",
40
+ "typetests:gen": "fluid-type-validator -d .",
41
+ "typetests:prepare": "fluid-type-validator -d . -p"
41
42
  },
42
43
  "dependencies": {
43
- "@fluidframework/common-definitions": "^0.20.0",
44
- "@fluidframework/core-interfaces": "^0.42.0",
45
- "@fluidframework/driver-definitions": "^0.46.1000-0",
46
- "@fluidframework/protocol-definitions": "^0.1028.1000-0"
44
+ "@fluidframework/common-definitions": "^0.20.1",
45
+ "@fluidframework/core-interfaces": "^0.43.1000",
46
+ "@fluidframework/driver-definitions": "^0.46.1000",
47
+ "@fluidframework/protocol-definitions": "^0.1028.1000"
47
48
  },
48
49
  "devDependencies": {
49
50
  "@fluidframework/build-common": "^0.23.0",
50
- "@fluidframework/build-tools": "^0.2.58041",
51
- "@fluidframework/container-definitions-0.39.8": "npm:@fluidframework/container-definitions@0.39.8",
52
- "@fluidframework/container-definitions-0.40.0": "npm:@fluidframework/container-definitions@0.40.0",
53
- "@fluidframework/container-definitions-0.41.0": "npm:@fluidframework/container-definitions@0.41.0",
54
- "@fluidframework/container-definitions-0.42.0": "npm:@fluidframework/container-definitions@0.42.0",
55
- "@fluidframework/container-definitions-0.43.0": "npm:@fluidframework/container-definitions@0.43.0",
56
- "@fluidframework/container-definitions-0.44.0": "npm:@fluidframework/container-definitions@0.44.0",
57
- "@fluidframework/container-definitions-0.45.0": "npm:@fluidframework/container-definitions@0.45.0",
58
- "@fluidframework/container-definitions-0.46.0": "npm:@fluidframework/container-definitions@0.46.0",
59
- "@fluidframework/container-definitions-0.47.1000": "npm:@fluidframework/container-definitions@0.47.1000",
60
- "@fluidframework/eslint-config-fluid": "^0.27.0",
51
+ "@fluidframework/build-tools": "^0.2.61288",
52
+ "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@0.47.1000",
53
+ "@fluidframework/eslint-config-fluid": "^0.28.1000",
61
54
  "@microsoft/api-extractor": "^7.16.1",
62
55
  "@rushstack/eslint-config": "^2.5.1",
63
56
  "@types/mocha": "^8.2.2",
@@ -80,446 +73,6 @@
80
73
  "typeValidation": {
81
74
  "version": "0.48.1000",
82
75
  "broken": {
83
- "0.39.8": {
84
- "EnumDeclaration_ContainerErrorType": {
85
- "backCompat": false
86
- },
87
- "InterfaceDeclaration_ICodeLoader": {
88
- "forwardCompat": false,
89
- "backCompat": false
90
- },
91
- "InterfaceDeclaration_IContainer": {
92
- "forwardCompat": false,
93
- "backCompat": false
94
- },
95
- "InterfaceDeclaration_IContainerContext": {
96
- "forwardCompat": false,
97
- "backCompat": false
98
- },
99
- "InterfaceDeclaration_IFluidModule": {
100
- "forwardCompat": false,
101
- "backCompat": false
102
- },
103
- "InterfaceDeclaration_IGenericError": {
104
- "backCompat": false
105
- },
106
- "InterfaceDeclaration_IHostLoader": {
107
- "forwardCompat": false,
108
- "backCompat": false
109
- },
110
- "InterfaceDeclaration_ILoader": {
111
- "forwardCompat": false,
112
- "backCompat": false
113
- },
114
- "InterfaceDeclaration_ILoaderHeader": {
115
- "forwardCompat": false
116
- },
117
- "InterfaceDeclaration_IProvideRuntimeFactory": {
118
- "forwardCompat": false,
119
- "backCompat": false
120
- },
121
- "InterfaceDeclaration_IProxyLoaderFactory": {
122
- "forwardCompat": false,
123
- "backCompat": false
124
- },
125
- "InterfaceDeclaration_IRuntime": {
126
- "backCompat": false
127
- },
128
- "InterfaceDeclaration_IRuntimeFactory": {
129
- "forwardCompat": false,
130
- "backCompat": false
131
- },
132
- "InterfaceDeclaration_IThrottlingWarning": {
133
- "backCompat": false
134
- },
135
- "InterfaceDeclaration_IDeltaManager": {
136
- "backCompat": false
137
- },
138
- "InterfaceDeclaration_IConnectionDetails": {
139
- "backCompat": false
140
- }
141
- },
142
- "0.40.0": {
143
- "InterfaceDeclaration_IUsageError": {
144
- "backCompat": false
145
- },
146
- "InterfaceDeclaration_IThrottlingWarning": {
147
- "backCompat": false
148
- },
149
- "InterfaceDeclaration_IGenericError": {
150
- "backCompat": false
151
- },
152
- "EnumDeclaration_ContainerErrorType": {
153
- "backCompat": false
154
- },
155
- "InterfaceDeclaration_ICodeLoader": {
156
- "forwardCompat": false,
157
- "backCompat": false
158
- },
159
- "InterfaceDeclaration_IContainerContext": {
160
- "forwardCompat": false,
161
- "backCompat": false
162
- },
163
- "InterfaceDeclaration_IFluidModule": {
164
- "forwardCompat": false,
165
- "backCompat": false
166
- },
167
- "InterfaceDeclaration_IProvideRuntimeFactory": {
168
- "forwardCompat": false,
169
- "backCompat": false
170
- },
171
- "InterfaceDeclaration_IRuntime": {
172
- "backCompat": false
173
- },
174
- "InterfaceDeclaration_IRuntimeFactory": {
175
- "forwardCompat": false,
176
- "backCompat": false
177
- },
178
- "InterfaceDeclaration_ILoader": {
179
- "backCompat": false,
180
- "forwardCompat": false
181
- },
182
- "InterfaceDeclaration_IProxyLoaderFactory": {
183
- "backCompat": false,
184
- "forwardCompat": false
185
- },
186
- "InterfaceDeclaration_IHostLoader": {
187
- "backCompat": false,
188
- "forwardCompat": false
189
- },
190
- "InterfaceDeclaration_IContainer": {
191
- "backCompat": false,
192
- "forwardCompat": false
193
- },
194
- "InterfaceDeclaration_IDeltaManager": {
195
- "backCompat": false
196
- },
197
- "InterfaceDeclaration_IConnectionDetails": {
198
- "backCompat": false
199
- }
200
- },
201
- "0.41.0": {
202
- "InterfaceDeclaration_IUsageError": {
203
- "backCompat": false
204
- },
205
- "InterfaceDeclaration_IThrottlingWarning": {
206
- "backCompat": false
207
- },
208
- "InterfaceDeclaration_IGenericError": {
209
- "backCompat": false
210
- },
211
- "EnumDeclaration_ContainerErrorType": {
212
- "backCompat": false
213
- },
214
- "InterfaceDeclaration_ILoader": {
215
- "backCompat": false,
216
- "forwardCompat": false
217
- },
218
- "InterfaceDeclaration_IProxyLoaderFactory": {
219
- "backCompat": false,
220
- "forwardCompat": false
221
- },
222
- "InterfaceDeclaration_IHostLoader": {
223
- "backCompat": false,
224
- "forwardCompat": false
225
- },
226
- "InterfaceDeclaration_IFluidModule": {
227
- "backCompat": false,
228
- "forwardCompat": false
229
- },
230
- "InterfaceDeclaration_IContainerContext": {
231
- "backCompat": false,
232
- "forwardCompat": false
233
- },
234
- "InterfaceDeclaration_IContainer": {
235
- "backCompat": false,
236
- "forwardCompat": false
237
- },
238
- "InterfaceDeclaration_ICodeLoader": {
239
- "backCompat": false,
240
- "forwardCompat": false
241
- },
242
- "InterfaceDeclaration_IDeltaManager": {
243
- "backCompat": false
244
- },
245
- "InterfaceDeclaration_IConnectionDetails": {
246
- "backCompat": false
247
- },
248
- "InterfaceDeclaration_IProvideRuntimeFactory": {
249
- "backCompat": false,
250
- "forwardCompat": false
251
- },
252
- "InterfaceDeclaration_IRuntime": {
253
- "backCompat": false
254
- },
255
- "InterfaceDeclaration_IRuntimeFactory": {
256
- "backCompat": false,
257
- "forwardCompat": false
258
- }
259
- },
260
- "0.42.0": {
261
- "InterfaceDeclaration_IUsageError": {
262
- "backCompat": false
263
- },
264
- "InterfaceDeclaration_IThrottlingWarning": {
265
- "backCompat": false
266
- },
267
- "InterfaceDeclaration_IGenericError": {
268
- "backCompat": false
269
- },
270
- "EnumDeclaration_ContainerErrorType": {
271
- "backCompat": false
272
- },
273
- "InterfaceDeclaration_ILoader": {
274
- "backCompat": false,
275
- "forwardCompat": false
276
- },
277
- "InterfaceDeclaration_IProxyLoaderFactory": {
278
- "backCompat": false,
279
- "forwardCompat": false
280
- },
281
- "InterfaceDeclaration_IHostLoader": {
282
- "backCompat": false,
283
- "forwardCompat": false
284
- },
285
- "InterfaceDeclaration_IContainerContext": {
286
- "backCompat": false,
287
- "forwardCompat": false
288
- },
289
- "InterfaceDeclaration_IContainer": {
290
- "backCompat": false,
291
- "forwardCompat": false
292
- },
293
- "InterfaceDeclaration_IProvideLoader": {
294
- "backCompat": false,
295
- "forwardCompat": false
296
- },
297
- "InterfaceDeclaration_IProvideRuntimeFactory": {
298
- "backCompat": false,
299
- "forwardCompat": false
300
- },
301
- "InterfaceDeclaration_IRuntime": {
302
- "backCompat": false
303
- },
304
- "InterfaceDeclaration_IRuntimeFactory": {
305
- "backCompat": false,
306
- "forwardCompat": false
307
- },
308
- "InterfaceDeclaration_IDeltaManager": {
309
- "backCompat": false
310
- },
311
- "InterfaceDeclaration_IConnectionDetails": {
312
- "backCompat": false
313
- },
314
- "InterfaceDeclaration_ICodeLoader": {
315
- "backCompat": false,
316
- "forwardCompat": false
317
- },
318
- "InterfaceDeclaration_IFluidModule": {
319
- "backCompat": false,
320
- "forwardCompat": false
321
- }
322
- },
323
- "0.43.0": {
324
- "InterfaceDeclaration_IUsageError": {
325
- "backCompat": false
326
- },
327
- "InterfaceDeclaration_IThrottlingWarning": {
328
- "backCompat": false
329
- },
330
- "InterfaceDeclaration_IGenericError": {
331
- "backCompat": false
332
- },
333
- "EnumDeclaration_ContainerErrorType": {
334
- "backCompat": false
335
- },
336
- "InterfaceDeclaration_ILoader": {
337
- "backCompat": false,
338
- "forwardCompat": false
339
- },
340
- "InterfaceDeclaration_IHostLoader": {
341
- "backCompat": false,
342
- "forwardCompat": false
343
- },
344
- "InterfaceDeclaration_IContainerContext": {
345
- "backCompat": false,
346
- "forwardCompat": false
347
- },
348
- "InterfaceDeclaration_IContainer": {
349
- "backCompat": false,
350
- "forwardCompat": false
351
- },
352
- "InterfaceDeclaration_IProvideLoader": {
353
- "backCompat": false,
354
- "forwardCompat": false
355
- },
356
- "InterfaceDeclaration_IProxyLoaderFactory": {
357
- "backCompat": false,
358
- "forwardCompat": false
359
- },
360
- "InterfaceDeclaration_ICodeDetailsLoader": {
361
- "backCompat": false,
362
- "forwardCompat": false
363
- },
364
- "InterfaceDeclaration_ICodeLoader": {
365
- "backCompat": false,
366
- "forwardCompat": false
367
- },
368
- "InterfaceDeclaration_IFluidModule": {
369
- "backCompat": false,
370
- "forwardCompat": false
371
- },
372
- "InterfaceDeclaration_IFluidModuleWithDetails": {
373
- "backCompat": false,
374
- "forwardCompat": false
375
- },
376
- "InterfaceDeclaration_IProvideRuntimeFactory": {
377
- "backCompat": false,
378
- "forwardCompat": false
379
- },
380
- "InterfaceDeclaration_IRuntime": {
381
- "backCompat": false
382
- },
383
- "InterfaceDeclaration_IRuntimeFactory": {
384
- "backCompat": false,
385
- "forwardCompat": false
386
- }
387
- },
388
- "0.44.0": {
389
- "EnumDeclaration_ContainerErrorType": {
390
- "backCompat": false
391
- },
392
- "InterfaceDeclaration_ICodeDetailsLoader": {
393
- "backCompat": false,
394
- "forwardCompat": false
395
- },
396
- "InterfaceDeclaration_ICodeLoader": {
397
- "backCompat": false,
398
- "forwardCompat": false
399
- },
400
- "InterfaceDeclaration_IContainer": {
401
- "backCompat": false,
402
- "forwardCompat": false
403
- },
404
- "InterfaceDeclaration_IContainerContext": {
405
- "backCompat": false,
406
- "forwardCompat": false
407
- },
408
- "InterfaceDeclaration_IFluidModule": {
409
- "backCompat": false,
410
- "forwardCompat": false
411
- },
412
- "InterfaceDeclaration_IFluidModuleWithDetails": {
413
- "backCompat": false,
414
- "forwardCompat": false
415
- },
416
- "InterfaceDeclaration_IGenericError": {
417
- "backCompat": false
418
- },
419
- "InterfaceDeclaration_IHostLoader": {
420
- "backCompat": false,
421
- "forwardCompat": false
422
- },
423
- "InterfaceDeclaration_ILoader": {
424
- "backCompat": false,
425
- "forwardCompat": false
426
- },
427
- "InterfaceDeclaration_IProvideLoader": {
428
- "backCompat": false,
429
- "forwardCompat": false
430
- },
431
- "InterfaceDeclaration_IProvideRuntimeFactory": {
432
- "backCompat": false,
433
- "forwardCompat": false
434
- },
435
- "InterfaceDeclaration_IProxyLoaderFactory": {
436
- "backCompat": false,
437
- "forwardCompat": false
438
- },
439
- "InterfaceDeclaration_IRuntime": {
440
- "backCompat": false
441
- },
442
- "InterfaceDeclaration_IRuntimeFactory": {
443
- "backCompat": false,
444
- "forwardCompat": false
445
- },
446
- "InterfaceDeclaration_IThrottlingWarning": {
447
- "backCompat": false
448
- },
449
- "InterfaceDeclaration_IUsageError": {
450
- "backCompat": false
451
- }
452
- },
453
- "0.45.0": {
454
- "InterfaceDeclaration_ICodeDetailsLoader": {
455
- "backCompat": false
456
- },
457
- "InterfaceDeclaration_ICodeLoader": {
458
- "backCompat": false
459
- },
460
- "InterfaceDeclaration_IFluidModule": {
461
- "backCompat": false
462
- },
463
- "InterfaceDeclaration_IFluidModuleWithDetails": {
464
- "backCompat": false
465
- },
466
- "InterfaceDeclaration_IProvideRuntimeFactory": {
467
- "backCompat": false,
468
- "forwardCompat": false
469
- },
470
- "InterfaceDeclaration_IRuntime": {
471
- "backCompat": false
472
- },
473
- "InterfaceDeclaration_IRuntimeFactory": {
474
- "backCompat": false,
475
- "forwardCompat": false
476
- },
477
- "InterfaceDeclaration_IContainer": {
478
- "backCompat": false
479
- },
480
- "InterfaceDeclaration_IContainerContext": {
481
- "backCompat": false,
482
- "forwardCompat": false
483
- },
484
- "InterfaceDeclaration_IHostLoader": {
485
- "backCompat": false
486
- },
487
- "InterfaceDeclaration_ILoader": {
488
- "backCompat": false
489
- },
490
- "InterfaceDeclaration_IProvideLoader": {
491
- "backCompat": false
492
- },
493
- "InterfaceDeclaration_IProxyLoaderFactory": {
494
- "backCompat": false
495
- }
496
- },
497
- "0.46.0": {
498
- "InterfaceDeclaration_IContainerContext": {
499
- "forwardCompat": false,
500
- "backCompat": false
501
- },
502
- "InterfaceDeclaration_ICodeDetailsLoader": {
503
- "backCompat": false
504
- },
505
- "InterfaceDeclaration_ICodeLoader": {
506
- "backCompat": false
507
- },
508
- "InterfaceDeclaration_IFluidModule": {
509
- "backCompat": false
510
- },
511
- "InterfaceDeclaration_IFluidModuleWithDetails": {
512
- "backCompat": false
513
- },
514
- "InterfaceDeclaration_IProvideRuntimeFactory": {
515
- "forwardCompat": false,
516
- "backCompat": false
517
- },
518
- "InterfaceDeclaration_IRuntimeFactory": {
519
- "backCompat": false,
520
- "forwardCompat": false
521
- }
522
- },
523
76
  "0.47.1000": {
524
77
  "InterfaceDeclaration_IContainerContext": {
525
78
  "backCompat": false
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
- import { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from "@fluidframework/core-interfaces";
6
+ import { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from "./fluidPackage";
7
7
 
8
8
  /**
9
9
  * A specific Fluid package environment for browsers
@@ -3,9 +3,10 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
- import { FluidObject, IFluidObject, IProvideFluidCodeDetailsComparer } from "@fluidframework/core-interfaces";
6
+ import { FluidObject } from "@fluidframework/core-interfaces";
7
+ import { IProvideFluidCodeDetailsComparer } from "./fluidPackage";
7
8
  import { IRuntimeFactory } from "./runtime";
8
9
 
9
10
  export interface IFluidModule {
10
- fluidExport: IFluidObject & FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
11
+ fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
11
12
  }
package/src/loader.ts CHANGED
@@ -7,9 +7,6 @@ import {
7
7
  IRequest,
8
8
  IResponse,
9
9
  IFluidRouter,
10
- IFluidCodeDetails,
11
- IFluidPackage,
12
- IProvideFluidCodeDetailsComparer,
13
10
  } from "@fluidframework/core-interfaces";
14
11
  import {
15
12
  IClientDetails,
@@ -25,6 +22,11 @@ import { IDeltaManager, ReadOnlyInfo } from "./deltas";
25
22
  import { ICriticalContainerError, ContainerWarning } from "./error";
26
23
  import { IFluidModule } from "./fluidModule";
27
24
  import { AttachState } from "./runtime";
25
+ import {
26
+ IFluidCodeDetails,
27
+ IFluidPackage,
28
+ IProvideFluidCodeDetailsComparer,
29
+ } from "./fluidPackage";
28
30
 
29
31
  /**
30
32
  * Code loading interface
@@ -252,20 +254,37 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
252
254
 
253
255
  /**
254
256
  * Boolean indicating whether the container is currently connected or not
257
+ * @deprecated - 0.58, This API will be removed in 1.0
258
+ * Check `connectionState === ConnectionState.Connected` instead
259
+ * See https://github.com/microsoft/FluidFramework/issues/9167 for context
255
260
  */
256
261
  readonly connected: boolean;
257
262
 
263
+ /**
264
+ * Attempts to connect the container to the delta stream and process ops
265
+ */
266
+ connect?(): void;
267
+
268
+ /**
269
+ * Disconnects the container from the delta stream and stops processing ops
270
+ */
271
+ disconnect?(): void;
272
+
258
273
  /**
259
274
  * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
260
275
  * after receiving a disconnect event
261
276
  * @param reconnect - Boolean indicating if reconnect should automatically occur
262
- * @alpha
277
+ * @deprecated - 0.58, This API will be removed in 1.0
278
+ * Use `connect()` and `disconnect()` instead of `setAutoReconnect(true)` and `setAutoReconnect(false)` respectively
279
+ * See https://github.com/microsoft/FluidFramework/issues/9167 for context
263
280
  */
264
281
  setAutoReconnect?(reconnect: boolean): void;
265
282
 
266
283
  /**
267
284
  * Have the container attempt to resume processing ops
268
- * @alpha
285
+ * @deprecated - 0.58, This API will be removed in 1.0
286
+ * Use `connect()` instead
287
+ * See https://github.com/microsoft/FluidFramework/issues/9167 for context
269
288
  */
270
289
  resume?(): void;
271
290
 
package/src/runtime.ts CHANGED
@@ -6,8 +6,6 @@
6
6
  import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
7
7
  import {
8
8
  FluidObject,
9
- IFluidCodeDetails,
10
- IFluidObject,
11
9
  IRequest,
12
10
  IResponse,
13
11
  } from "@fluidframework/core-interfaces";
@@ -25,8 +23,9 @@ import {
25
23
  } from "@fluidframework/protocol-definitions";
26
24
  import { IAudience } from "./audience";
27
25
  import { IDeltaManager } from "./deltas";
28
- import { ICriticalContainerError, ContainerWarning } from "./error";
26
+ import { ICriticalContainerError } from "./error";
29
27
  import { ILoader, ILoaderOptions } from "./loader";
28
+ import { IFluidCodeDetails } from "./fluidPackage";
30
29
 
31
30
  /**
32
31
  * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the
@@ -144,12 +143,7 @@ export interface IContainerContext extends IDisposable {
144
143
  /**
145
144
  * Ambient services provided with the context
146
145
  */
147
- readonly scope: IFluidObject & FluidObject;
148
-
149
- /**
150
- * @deprecated 0.56, will be removed in the next release
151
- */
152
- raiseContainerWarning?(warning: ContainerWarning): void;
146
+ readonly scope: FluidObject;
153
147
 
154
148
  /**
155
149
  * Get an absolute url for a provided container-relative request.