@fluidframework/container-definitions 2.0.0-dev.7.4.0.216897 → 2.0.0-dev.7.4.0.217884

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 (45) hide show
  1. package/api-report/container-definitions.api.md +36 -36
  2. package/dist/audience.d.ts +2 -2
  3. package/dist/audience.js.map +1 -1
  4. package/dist/container-definitions-alpha.d.ts +1147 -57
  5. package/dist/container-definitions-untrimmed.d.ts +40 -40
  6. package/dist/deltas.d.ts +7 -7
  7. package/dist/deltas.js.map +1 -1
  8. package/dist/error.d.ts +2 -2
  9. package/dist/error.js.map +1 -1
  10. package/dist/fluidModule.d.ts +1 -1
  11. package/dist/fluidModule.js.map +1 -1
  12. package/dist/fluidPackage.d.ts +7 -7
  13. package/dist/fluidPackage.js +1 -1
  14. package/dist/fluidPackage.js.map +1 -1
  15. package/dist/loader.d.ts +13 -13
  16. package/dist/loader.js.map +1 -1
  17. package/dist/runtime.d.ts +8 -8
  18. package/dist/runtime.js +2 -2
  19. package/dist/runtime.js.map +1 -1
  20. package/lib/audience.d.ts +2 -2
  21. package/lib/audience.js.map +1 -1
  22. package/lib/container-definitions-alpha.d.ts +1147 -57
  23. package/lib/container-definitions-untrimmed.d.ts +40 -40
  24. package/lib/deltas.d.ts +7 -7
  25. package/lib/deltas.js.map +1 -1
  26. package/lib/error.d.ts +2 -2
  27. package/lib/error.js.map +1 -1
  28. package/lib/fluidModule.d.ts +1 -1
  29. package/lib/fluidModule.js.map +1 -1
  30. package/lib/fluidPackage.d.ts +7 -7
  31. package/lib/fluidPackage.js +1 -1
  32. package/lib/fluidPackage.js.map +1 -1
  33. package/lib/loader.d.ts +13 -13
  34. package/lib/loader.js.map +1 -1
  35. package/lib/runtime.d.ts +8 -8
  36. package/lib/runtime.js +2 -2
  37. package/lib/runtime.js.map +1 -1
  38. package/package.json +3 -3
  39. package/src/audience.ts +2 -2
  40. package/src/deltas.ts +7 -7
  41. package/src/error.ts +2 -2
  42. package/src/fluidModule.ts +1 -1
  43. package/src/fluidPackage.ts +7 -7
  44. package/src/loader.ts +13 -13
  45. package/src/runtime.ts +8 -8
package/src/loader.ts CHANGED
@@ -98,7 +98,7 @@ export interface IFluidCodeResolver {
98
98
 
99
99
  /**
100
100
  * Events emitted by the {@link IContainer} "upwards" to the Loader and Host.
101
- * @internal
101
+ * @alpha
102
102
  */
103
103
  export interface IContainerEvents extends IEvent {
104
104
  /**
@@ -258,7 +258,7 @@ export interface IContainerEvents extends IEvent {
258
258
  /**
259
259
  * Namespace for the different connection states a container can be in.
260
260
  * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.
261
- * @internal
261
+ * @alpha
262
262
  */
263
263
  // eslint-disable-next-line @typescript-eslint/no-namespace
264
264
  export namespace ConnectionState {
@@ -266,33 +266,33 @@ export namespace ConnectionState {
266
266
  * The container is not connected to the delta server.
267
267
  * Note - When in this state the container may be about to reconnect,
268
268
  * or may remain disconnected until explicitly told to connect.
269
- * @internal
269
+ * @alpha
270
270
  */
271
271
  export type Disconnected = 0;
272
272
 
273
273
  /**
274
274
  * The container is disconnected but actively trying to establish a new connection.
275
275
  * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.
276
- * @internal
276
+ * @alpha
277
277
  */
278
278
  export type EstablishingConnection = 3;
279
279
 
280
280
  /**
281
281
  * The container has an inbound connection only, and is catching up to the latest known state from the service.
282
- * @internal
282
+ * @alpha
283
283
  */
284
284
  export type CatchingUp = 1;
285
285
 
286
286
  /**
287
287
  * The container is fully connected and syncing.
288
- * @internal
288
+ * @alpha
289
289
  */
290
290
  export type Connected = 2;
291
291
  }
292
292
 
293
293
  /**
294
294
  * Type defining the different states of connectivity a Container can be in.
295
- * @internal
295
+ * @alpha
296
296
  */
297
297
  export type ConnectionState =
298
298
  | ConnectionState.Disconnected
@@ -302,7 +302,7 @@ export type ConnectionState =
302
302
 
303
303
  /**
304
304
  * The Host's view of a Container and its connection to storage
305
- * @internal
305
+ * @alpha
306
306
  */
307
307
  // eslint-disable-next-line import/no-deprecated
308
308
  export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
@@ -513,7 +513,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
513
513
 
514
514
  /**
515
515
  * The Runtime's view of the Loader, used for loading Containers
516
- * @internal
516
+ * @alpha
517
517
  */
518
518
  export interface ILoader extends Partial<IProvideLoader> {
519
519
  /**
@@ -541,7 +541,7 @@ export interface ILoader extends Partial<IProvideLoader> {
541
541
 
542
542
  /**
543
543
  * The Host's view of the Loader, used for loading Containers
544
- * @internal
544
+ * @alpha
545
545
  */
546
546
  export interface IHostLoader extends ILoader {
547
547
  /**
@@ -570,7 +570,7 @@ export interface IHostLoader extends ILoader {
570
570
  }
571
571
 
572
572
  /**
573
- * @internal
573
+ * @alpha
574
574
  */
575
575
  export type ILoaderOptions = {
576
576
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -710,7 +710,7 @@ export interface ILoaderHeader {
710
710
  }
711
711
 
712
712
  /**
713
- * @internal
713
+ * @alpha
714
714
  */
715
715
  export interface IProvideLoader {
716
716
  readonly ILoader: ILoader;
@@ -732,7 +732,7 @@ export interface IPendingLocalState {
732
732
  * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.
733
733
  *
734
734
  * @remarks This is used as the `ContainerContext`'s base snapshot when attaching.
735
- * @internal
735
+ * @alpha
736
736
  */
737
737
  export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
738
738
  blobsContents: { [path: string]: ArrayBufferLike };
package/src/runtime.ts CHANGED
@@ -32,7 +32,7 @@ import { IFluidCodeDetails } from "./fluidPackage";
32
32
  /**
33
33
  * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the
34
34
  * service. The transition from detached to attached state is a one-way transition.
35
- * @internal
35
+ * @alpha
36
36
  */
37
37
  export enum AttachState {
38
38
  /**
@@ -56,7 +56,7 @@ export enum AttachState {
56
56
  /**
57
57
  * The IRuntime represents an instantiation of a code package within a Container.
58
58
  * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.
59
- * @internal
59
+ * @alpha
60
60
  */
61
61
  export interface IRuntime extends IDisposable {
62
62
  /**
@@ -126,7 +126,7 @@ export interface IRuntime extends IDisposable {
126
126
 
127
127
  /**
128
128
  * Payload type for IContainerContext.submitBatchFn()
129
- * @internal
129
+ * @alpha
130
130
  */
131
131
  export interface IBatchMessage {
132
132
  contents?: string;
@@ -139,7 +139,7 @@ export interface IBatchMessage {
139
139
  * IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the
140
140
  * loader layer. It gets passed into the IRuntimeFactory.instantiateRuntime call. Only include members on this interface
141
141
  * if you intend them to be consumed/called from the runtime layer.
142
- * @internal
142
+ * @alpha
143
143
  */
144
144
  export interface IContainerContext {
145
145
  readonly options: ILoaderOptions;
@@ -220,12 +220,12 @@ export interface IContainerContext {
220
220
  }
221
221
 
222
222
  /**
223
- * @internal
223
+ * @alpha
224
224
  */
225
225
  export const IRuntimeFactory: keyof IProvideRuntimeFactory = "IRuntimeFactory";
226
226
 
227
227
  /**
228
- * @internal
228
+ * @alpha
229
229
  */
230
230
  export interface IProvideRuntimeFactory {
231
231
  readonly IRuntimeFactory: IRuntimeFactory;
@@ -236,7 +236,7 @@ export interface IProvideRuntimeFactory {
236
236
  *
237
237
  * Provides the entry point for the ContainerContext to load the proper IRuntime
238
238
  * to start up the running instance of the Container.
239
- * @internal
239
+ * @alpha
240
240
  */
241
241
  export interface IRuntimeFactory extends IProvideRuntimeFactory {
242
242
  /**
@@ -251,7 +251,7 @@ export interface IRuntimeFactory extends IProvideRuntimeFactory {
251
251
 
252
252
  /**
253
253
  * Defines list of properties expected for getPendingLocalState
254
- * @internal
254
+ * @alpha
255
255
  */
256
256
  export interface IGetPendingLocalStateProps {
257
257
  /**