@fluidframework/container-definitions 2.0.0-internal.7.4.0 → 2.0.0-internal.8.0.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,48 @@
1
1
  # @fluidframework/container-definitions
2
2
 
3
+ ## 2.0.0-internal.8.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - container-definitions: Removed request(...) and IFluidRouter from IContainer [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
8
+
9
+ The `request(...)` method and `IFluidRouter` property have been removed from `IContainer`. Please use the
10
+ `IContainer.getEntryPoint()` method to get the container's entry point.
11
+
12
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
13
+
14
+ - container-loader: Removed request(...) and IFluidRouter from ILoader and Loader [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
15
+
16
+ The `request(...)` method and `IFluidRouter` property have been removed from `ILoader` and `Loader`. Instead, after
17
+ calling `ILoader.resolve(...)`, call the `getEntryPoint()` method on the returned `IContainer`.
18
+
19
+ See
20
+ [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
21
+ for more details.
22
+
23
+ - container-runtime: Removed IPendingLocalState and IRuntime.notifyAttaching [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
24
+
25
+ The deprecated `IPendingLocalState` and `IRuntime.notifyAttaching` APIs are removed. There is no replacement as they are
26
+ not longer used.
27
+
28
+ - container-runtime: Removed request pattern from ContainerRuntime, IRuntime, and IContainerRuntimeBase [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
29
+
30
+ The `request(...)` method and `IFluidRouter` property have been removed from the following places:
31
+
32
+ - `ContainerRuntime`
33
+ - `IRuntime`
34
+ - `IContainerRuntimeBase`
35
+
36
+ Please use the `IRuntime.getEntryPoint()` method to get the runtime's entry point.
37
+
38
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
39
+
40
+ - container-definitions: Fix ISnapshotTreeWithBlobContents and mark internal [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
41
+
42
+ `ISnapshotTreeWithBlobContents` is an internal type that should not be used externally. Additionally, the type didn't
43
+ match the usage, specifically in runtime-utils where an `any` cast was used to work around undefined blobContents. The
44
+ type has been updated to reflect that blobContents can be undefined.
45
+
3
46
  ## 2.0.0-internal.7.4.0
4
47
 
5
48
  Dependency updates only.
@@ -17,12 +17,10 @@ import { IErrorBase } from '@fluidframework/core-interfaces';
17
17
  import { IErrorEvent } from '@fluidframework/core-interfaces';
18
18
  import { IEvent } from '@fluidframework/core-interfaces';
19
19
  import { IEventProvider } from '@fluidframework/core-interfaces';
20
- import { IFluidRouter } from '@fluidframework/core-interfaces';
21
20
  import { IGenericError } from '@fluidframework/core-interfaces';
22
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
22
  import { IRequest } from '@fluidframework/core-interfaces';
24
23
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
25
- import { IResponse } from '@fluidframework/core-interfaces';
26
24
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
27
25
  import { ISequencedProposal } from '@fluidframework/protocol-definitions';
28
26
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
@@ -124,7 +122,7 @@ export interface IConnectionDetails {
124
122
  }
125
123
 
126
124
  // @alpha
127
- export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
125
+ export interface IContainer extends IEventProvider<IContainerEvents> {
128
126
  attach(request: IRequest, attachProps?: {
129
127
  deltaConnection?: "none" | "delayed";
130
128
  }): Promise<void>;
@@ -141,22 +139,13 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
141
139
  readonly disposed?: boolean;
142
140
  forceReadonly?(readonly: boolean): any;
143
141
  getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
144
- getEntryPoint(): Promise<FluidObject | undefined>;
142
+ getEntryPoint(): Promise<FluidObject>;
145
143
  getLoadedCodeDetails(): IFluidCodeDetails | undefined;
146
144
  getQuorum(): IQuorumClients;
147
145
  getSpecifiedCodeDetails(): IFluidCodeDetails | undefined;
148
- // @deprecated (undocumented)
149
- readonly IFluidRouter: IFluidRouter;
150
146
  readonly isDirty: boolean;
151
147
  proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
152
148
  readonly readOnlyInfo: ReadOnlyInfo;
153
- // @deprecated (undocumented)
154
- request(request: {
155
- url: "/";
156
- headers?: undefined;
157
- }): Promise<IResponse>;
158
- // @deprecated
159
- request(request: IRequest): Promise<IResponse>;
160
149
  resolvedUrl: IResolvedUrl | undefined;
161
150
  serialize(): string;
162
151
  }
@@ -402,10 +391,6 @@ export interface IHostLoader extends ILoader {
402
391
 
403
392
  // @alpha
404
393
  export interface ILoader extends Partial<IProvideLoader> {
405
- // @deprecated (undocumented)
406
- readonly IFluidRouter: IFluidRouter;
407
- // @deprecated (undocumented)
408
- request(request: IRequest): Promise<IResponse>;
409
394
  resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
410
395
  }
411
396
 
@@ -433,14 +418,6 @@ export type ILoaderOptions = {
433
418
  maxClientLeaveWaitTime?: number;
434
419
  };
435
420
 
436
- // @internal @deprecated (undocumented)
437
- export interface IPendingLocalState {
438
- // (undocumented)
439
- pendingRuntimeState: unknown;
440
- // (undocumented)
441
- url: string;
442
- }
443
-
444
421
  // @alpha (undocumented)
445
422
  export interface IProvideFluidCodeDetailsComparer {
446
423
  // (undocumented)
@@ -468,15 +445,11 @@ export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
468
445
  // @alpha
469
446
  export interface IRuntime extends IDisposable {
470
447
  createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
471
- getEntryPoint(): Promise<FluidObject | undefined>;
448
+ getEntryPoint(): Promise<FluidObject>;
472
449
  getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
473
- // @deprecated
474
- notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
475
450
  notifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;
476
451
  process(message: ISequencedDocumentMessage, local: boolean): any;
477
452
  processSignal(message: any, local: boolean): any;
478
- // @deprecated
479
- request(request: IRequest): Promise<IResponse>;
480
453
  setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
481
454
  setConnectionState(connected: boolean, clientId?: string): any;
482
455
  }
@@ -501,7 +474,7 @@ export const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
501
474
  // @alpha
502
475
  export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
503
476
  // (undocumented)
504
- blobsContents: {
477
+ blobsContents?: {
505
478
  [path: string]: ArrayBufferLike;
506
479
  };
507
480
  // (undocumented)
@@ -17,12 +17,10 @@ import { IErrorBase } from '@fluidframework/core-interfaces';
17
17
  import { IErrorEvent } from '@fluidframework/core-interfaces';
18
18
  import { IEvent } from '@fluidframework/core-interfaces';
19
19
  import { IEventProvider } from '@fluidframework/core-interfaces';
20
- import { IFluidRouter } from '@fluidframework/core-interfaces';
21
20
  import { IGenericError } from '@fluidframework/core-interfaces';
22
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
22
  import { IRequest } from '@fluidframework/core-interfaces';
24
23
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
25
- import { IResponse } from '@fluidframework/core-interfaces';
26
24
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
27
25
  import { ISequencedProposal } from '@fluidframework/protocol-definitions';
28
26
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
@@ -189,7 +187,7 @@ export declare interface IConnectionDetails {
189
187
  * The Host's view of a Container and its connection to storage
190
188
  * @alpha
191
189
  */
192
- export declare interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
190
+ export declare interface IContainer extends IEventProvider<IContainerEvents> {
193
191
  /**
194
192
  * The Delta Manager supporting the op stream for this Container
195
193
  */
@@ -275,39 +273,6 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
275
273
  * @param relativeUrl - A container-relative request URL.
276
274
  */
277
275
  getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
278
- /**
279
- * @deprecated Requesting will not be supported in a future major release.
280
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
281
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
282
- * could implement a request paradigm itself)
283
- *
284
- * IMPORTANT: This overload is provided for back-compat where IContainer.request(\{ url: "/" \}) is already implemented and used.
285
- * The functionality it can provide (if the Container implementation is built for it) is redundant with @see {@link IContainer.getEntryPoint}.
286
- *
287
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
288
- *
289
- * @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
290
- */
291
- request(request: {
292
- url: "/";
293
- headers?: undefined;
294
- }): Promise<IResponse>;
295
- /**
296
- * Issue a request against the container for a resource.
297
- * @param request - The request to be issued against the container
298
- *
299
- * @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
300
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
301
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
302
- * could implement a request paradigm itself)
303
- *
304
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
305
- */
306
- request(request: IRequest): Promise<IResponse>;
307
- /**
308
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
309
- */
310
- readonly IFluidRouter: IFluidRouter;
311
276
  /**
312
277
  * Provides the current state of the container's connection to the ordering service.
313
278
  *
@@ -368,7 +333,7 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
368
333
  * Exposes the entryPoint for the container.
369
334
  * Use this as the primary way of getting access to the user-defined logic within the container.
370
335
  */
371
- getEntryPoint(): Promise<FluidObject | undefined>;
336
+ getEntryPoint(): Promise<FluidObject>;
372
337
  }
373
338
 
374
339
  /**
@@ -1036,14 +1001,6 @@ export declare interface ILoader extends Partial<IProvideLoader> {
1036
1001
  * a request against the server found from the resolve step.
1037
1002
  */
1038
1003
  resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
1039
- /**
1040
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
1041
- */
1042
- request(request: IRequest): Promise<IResponse>;
1043
- /**
1044
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
1045
- */
1046
- readonly IFluidRouter: IFluidRouter;
1047
1004
  }
1048
1005
 
1049
1006
  /* Excluded from this release type: ILoaderHeader */
@@ -1078,8 +1035,6 @@ export declare type ILoaderOptions = {
1078
1035
  maxClientLeaveWaitTime?: number;
1079
1036
  };
1080
1037
 
1081
- /* Excluded from this release type: IPendingLocalState */
1082
-
1083
1038
  /**
1084
1039
  * @alpha
1085
1040
  */
@@ -1109,11 +1064,6 @@ export declare interface IProvideRuntimeFactory {
1109
1064
  * @alpha
1110
1065
  */
1111
1066
  export declare interface IRuntime extends IDisposable {
1112
- /**
1113
- * Executes a request against the runtime
1114
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
1115
- */
1116
- request(request: IRequest): Promise<IResponse>;
1117
1067
  /**
1118
1068
  * Notifies the runtime of a change in the connection state
1119
1069
  */
@@ -1143,12 +1093,6 @@ export declare interface IRuntime extends IDisposable {
1143
1093
  * Get pending local state in a serializable format to be given back to a newly loaded container
1144
1094
  */
1145
1095
  getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
1146
- /**
1147
- * Notify runtime that container is moving to "Attaching" state
1148
- * @param snapshot - snapshot created at attach time
1149
- * @deprecated not necessary after op replay moved to Container
1150
- */
1151
- notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
1152
1096
  /**
1153
1097
  * Notify runtime that we have processed a saved message, so that it can do async work (applying
1154
1098
  * stashed ops) after having processed it.
@@ -1160,7 +1104,7 @@ export declare interface IRuntime extends IDisposable {
1160
1104
  *
1161
1105
  * @see {@link IContainer.getEntryPoint}
1162
1106
  */
1163
- getEntryPoint(): Promise<FluidObject | undefined>;
1107
+ getEntryPoint(): Promise<FluidObject>;
1164
1108
  }
1165
1109
 
1166
1110
  /**
@@ -1200,7 +1144,7 @@ export declare interface IRuntimeFactory extends IProvideRuntimeFactory {
1200
1144
  * @alpha
1201
1145
  */
1202
1146
  export declare interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
1203
- blobsContents: {
1147
+ blobsContents?: {
1204
1148
  [path: string]: ArrayBufferLike;
1205
1149
  };
1206
1150
  trees: {
@@ -17,12 +17,10 @@ import { IErrorBase } from '@fluidframework/core-interfaces';
17
17
  import { IErrorEvent } from '@fluidframework/core-interfaces';
18
18
  import { IEvent } from '@fluidframework/core-interfaces';
19
19
  import { IEventProvider } from '@fluidframework/core-interfaces';
20
- import { IFluidRouter } from '@fluidframework/core-interfaces';
21
20
  import { IGenericError } from '@fluidframework/core-interfaces';
22
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
22
  import { IRequest } from '@fluidframework/core-interfaces';
24
23
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
25
- import { IResponse } from '@fluidframework/core-interfaces';
26
24
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
27
25
  import { ISequencedProposal } from '@fluidframework/protocol-definitions';
28
26
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
@@ -112,8 +110,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
112
110
 
113
111
  /* Excluded from this release type: IFluidPackageEnvironment */
114
112
 
115
- /* Excluded from this release type: IFluidRouter */
116
-
117
113
  /* Excluded from this release type: IGenericError */
118
114
 
119
115
  /* Excluded from this release type: IGetPendingLocalStateProps */
@@ -126,8 +122,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
126
122
 
127
123
  /* Excluded from this release type: ILoaderOptions */
128
124
 
129
- /* Excluded from this release type: IPendingLocalState */
130
-
131
125
  /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
132
126
 
133
127
  /* Excluded from this release type: IProvideLoader */
@@ -140,8 +134,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
140
134
 
141
135
  /* Excluded from this release type: IResolvedUrl */
142
136
 
143
- /* Excluded from this release type: IResponse */
144
-
145
137
  /* Excluded from this release type: IRuntime */
146
138
 
147
139
  /* Excluded from this release type: IRuntimeFactory */
@@ -17,12 +17,10 @@ import { IErrorBase } from '@fluidframework/core-interfaces';
17
17
  import { IErrorEvent } from '@fluidframework/core-interfaces';
18
18
  import { IEvent } from '@fluidframework/core-interfaces';
19
19
  import { IEventProvider } from '@fluidframework/core-interfaces';
20
- import { IFluidRouter } from '@fluidframework/core-interfaces';
21
20
  import { IGenericError } from '@fluidframework/core-interfaces';
22
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
22
  import { IRequest } from '@fluidframework/core-interfaces';
24
23
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
25
- import { IResponse } from '@fluidframework/core-interfaces';
26
24
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
27
25
  import { ISequencedProposal } from '@fluidframework/protocol-definitions';
28
26
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
@@ -112,8 +110,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
112
110
 
113
111
  /* Excluded from this release type: IFluidPackageEnvironment */
114
112
 
115
- /* Excluded from this release type: IFluidRouter */
116
-
117
113
  /* Excluded from this release type: IGenericError */
118
114
 
119
115
  /* Excluded from this release type: IGetPendingLocalStateProps */
@@ -126,8 +122,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
126
122
 
127
123
  /* Excluded from this release type: ILoaderOptions */
128
124
 
129
- /* Excluded from this release type: IPendingLocalState */
130
-
131
125
  /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
132
126
 
133
127
  /* Excluded from this release type: IProvideLoader */
@@ -140,8 +134,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
140
134
 
141
135
  /* Excluded from this release type: IResolvedUrl */
142
136
 
143
- /* Excluded from this release type: IResponse */
144
-
145
137
  /* Excluded from this release type: IRuntime */
146
138
 
147
139
  /* Excluded from this release type: IRuntimeFactory */
@@ -17,12 +17,10 @@ import { IErrorBase } from '@fluidframework/core-interfaces';
17
17
  import { IErrorEvent } from '@fluidframework/core-interfaces';
18
18
  import { IEvent } from '@fluidframework/core-interfaces';
19
19
  import { IEventProvider } from '@fluidframework/core-interfaces';
20
- import { IFluidRouter } from '@fluidframework/core-interfaces';
21
20
  import { IGenericError } from '@fluidframework/core-interfaces';
22
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
23
22
  import { IRequest } from '@fluidframework/core-interfaces';
24
23
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
25
- import { IResponse } from '@fluidframework/core-interfaces';
26
24
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
27
25
  import { ISequencedProposal } from '@fluidframework/protocol-definitions';
28
26
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
@@ -254,7 +252,7 @@ export declare interface IConnectionDetails {
254
252
  * The Host's view of a Container and its connection to storage
255
253
  * @alpha
256
254
  */
257
- export declare interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
255
+ export declare interface IContainer extends IEventProvider<IContainerEvents> {
258
256
  /**
259
257
  * The Delta Manager supporting the op stream for this Container
260
258
  */
@@ -340,39 +338,6 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
340
338
  * @param relativeUrl - A container-relative request URL.
341
339
  */
342
340
  getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
343
- /**
344
- * @deprecated Requesting will not be supported in a future major release.
345
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
346
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
347
- * could implement a request paradigm itself)
348
- *
349
- * IMPORTANT: This overload is provided for back-compat where IContainer.request(\{ url: "/" \}) is already implemented and used.
350
- * The functionality it can provide (if the Container implementation is built for it) is redundant with @see {@link IContainer.getEntryPoint}.
351
- *
352
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
353
- *
354
- * @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
355
- */
356
- request(request: {
357
- url: "/";
358
- headers?: undefined;
359
- }): Promise<IResponse>;
360
- /**
361
- * Issue a request against the container for a resource.
362
- * @param request - The request to be issued against the container
363
- *
364
- * @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
365
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
366
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
367
- * could implement a request paradigm itself)
368
- *
369
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
370
- */
371
- request(request: IRequest): Promise<IResponse>;
372
- /**
373
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
374
- */
375
- readonly IFluidRouter: IFluidRouter;
376
341
  /**
377
342
  * Provides the current state of the container's connection to the ordering service.
378
343
  *
@@ -433,7 +398,7 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
433
398
  * Exposes the entryPoint for the container.
434
399
  * Use this as the primary way of getting access to the user-defined logic within the container.
435
400
  */
436
- getEntryPoint(): Promise<FluidObject | undefined>;
401
+ getEntryPoint(): Promise<FluidObject>;
437
402
  }
438
403
 
439
404
  /**
@@ -1182,14 +1147,6 @@ export declare interface ILoader extends Partial<IProvideLoader> {
1182
1147
  * a request against the server found from the resolve step.
1183
1148
  */
1184
1149
  resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
1185
- /**
1186
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
1187
- */
1188
- request(request: IRequest): Promise<IResponse>;
1189
- /**
1190
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
1191
- */
1192
- readonly IFluidRouter: IFluidRouter;
1193
1150
  }
1194
1151
 
1195
1152
  /**
@@ -1242,17 +1199,6 @@ export declare type ILoaderOptions = {
1242
1199
  maxClientLeaveWaitTime?: number;
1243
1200
  };
1244
1201
 
1245
- /**
1246
- * @deprecated 0.48, This API will be removed in 0.50
1247
- * No replacement since it is not expected anyone will depend on this outside container-loader
1248
- * See {@link https://github.com/microsoft/FluidFramework/issues/9711} for context.
1249
- * @internal
1250
- */
1251
- export declare interface IPendingLocalState {
1252
- url: string;
1253
- pendingRuntimeState: unknown;
1254
- }
1255
-
1256
1202
  /**
1257
1203
  * @alpha
1258
1204
  */
@@ -1296,11 +1242,6 @@ export declare interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
1296
1242
  * @alpha
1297
1243
  */
1298
1244
  export declare interface IRuntime extends IDisposable {
1299
- /**
1300
- * Executes a request against the runtime
1301
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
1302
- */
1303
- request(request: IRequest): Promise<IResponse>;
1304
1245
  /**
1305
1246
  * Notifies the runtime of a change in the connection state
1306
1247
  */
@@ -1330,12 +1271,6 @@ export declare interface IRuntime extends IDisposable {
1330
1271
  * Get pending local state in a serializable format to be given back to a newly loaded container
1331
1272
  */
1332
1273
  getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
1333
- /**
1334
- * Notify runtime that container is moving to "Attaching" state
1335
- * @param snapshot - snapshot created at attach time
1336
- * @deprecated not necessary after op replay moved to Container
1337
- */
1338
- notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
1339
1274
  /**
1340
1275
  * Notify runtime that we have processed a saved message, so that it can do async work (applying
1341
1276
  * stashed ops) after having processed it.
@@ -1347,7 +1282,7 @@ export declare interface IRuntime extends IDisposable {
1347
1282
  *
1348
1283
  * @see {@link IContainer.getEntryPoint}
1349
1284
  */
1350
- getEntryPoint(): Promise<FluidObject | undefined>;
1285
+ getEntryPoint(): Promise<FluidObject>;
1351
1286
  }
1352
1287
 
1353
1288
  /**
@@ -1401,7 +1336,7 @@ export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPac
1401
1336
  * @alpha
1402
1337
  */
1403
1338
  export declare interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
1404
- blobsContents: {
1339
+ blobsContents?: {
1405
1340
  [path: string]: ArrayBufferLike;
1406
1341
  };
1407
1342
  trees: {
package/dist/index.d.ts CHANGED
@@ -11,7 +11,7 @@ export { IAudience, IAudienceOwner } from "./audience";
11
11
  export { IFluidBrowserPackage, IFluidBrowserPackageEnvironment, isFluidBrowserPackage, } from "./browserPackage";
12
12
  export { IConnectionDetails, IDeltaManager, IDeltaManagerEvents, IDeltaQueue, IDeltaQueueEvents, IDeltaSender, ReadOnlyInfo, } from "./deltas";
13
13
  export { ContainerErrorTypes, ContainerErrorType, ContainerWarning, ICriticalContainerError, } from "./error";
14
- export { ConnectionState, ICodeDetailsLoader, IContainer, IContainerEvents, IContainerLoadMode, IFluidCodeResolver, IFluidModuleWithDetails, IHostLoader, ILoader, ILoaderHeader, ILoaderOptions, IPendingLocalState, IProvideLoader, IResolvedFluidCodeDetails, ISnapshotTreeWithBlobContents, LoaderHeader, } from "./loader";
14
+ export { ConnectionState, ICodeDetailsLoader, IContainer, IContainerEvents, IContainerLoadMode, IFluidCodeResolver, IFluidModuleWithDetails, IHostLoader, ILoader, ILoaderHeader, ILoaderOptions, IProvideLoader, IResolvedFluidCodeDetails, ISnapshotTreeWithBlobContents, LoaderHeader, } from "./loader";
15
15
  export { IFluidModule } from "./fluidModule";
16
16
  export { IFluidPackage, IFluidPackageEnvironment, IFluidCodeDetails, IFluidCodeDetailsComparer, IFluidCodeDetailsConfig, IProvideFluidCodeDetailsComparer, isFluidPackage, isFluidCodeDetails, } from "./fluidPackage";
17
17
  export { AttachState, IBatchMessage, IContainerContext, IProvideRuntimeFactory, IRuntime, IRuntimeFactory, IGetPendingLocalStateProps, } from "./runtime";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EACN,oBAAoB,EACpB,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,YAAY,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,WAAW,EACX,OAAO,EACP,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,YAAY,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACN,aAAa,EACb,wBAAwB,EACxB,iBAAiB,EACjB,yBAAyB,EACzB,uBAAuB,EACvB,gCAAgC,EAChC,cAAc,EACd,kBAAkB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,QAAQ,EACR,eAAe,EACf,0BAA0B,GAC1B,MAAM,WAAW,CAAC;AAEnB,OAAO;AACN;;GAEG;AACH,UAAU;AACV;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,kBAAkB;AAClB;;GAEG;AACH,WAAW,GACX,MAAM,iCAAiC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EACN,oBAAoB,EACpB,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,YAAY,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,WAAW,EACX,OAAO,EACP,aAAa,EACb,cAAc,EACd,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,YAAY,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACN,aAAa,EACb,wBAAwB,EACxB,iBAAiB,EACjB,yBAAyB,EACzB,uBAAuB,EACvB,gCAAgC,EAChC,cAAc,EACd,kBAAkB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,QAAQ,EACR,eAAe,EACf,0BAA0B,GAC1B,MAAM,WAAW,CAAC;AAEnB,OAAO;AACN;;GAEG;AACH,UAAU;AACV;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,kBAAkB;AAClB;;GAEG;AACH,WAAW,GACX,MAAM,iCAAiC,CAAC"}
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,mDAI0B;AADzB,uHAAA,qBAAqB,OAAA;AAWtB,iCAKiB;AAJhB,4GAAA,mBAAmB,OAAA;AACnB,2GAAA,kBAAkB,OAAA;AAInB,mCAiBkB;AADjB,sGAAA,YAAY,OAAA;AAGb,+CASwB;AALvB,yHAAA,yBAAyB,OAAA;AAGzB,8GAAA,cAAc,OAAA;AACd,kHAAA,kBAAkB,OAAA;AAEnB,qCAQmB;AAPlB,sGAAA,WAAW,OAAA;AAKX,0GAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This library contains the interfaces and types concerning the `Loader` and loading the `Container`.\n *\n * @packageDocumentation\n */\n\nexport { IAudience, IAudienceOwner } from \"./audience\";\nexport {\n\tIFluidBrowserPackage,\n\tIFluidBrowserPackageEnvironment,\n\tisFluidBrowserPackage,\n} from \"./browserPackage\";\nexport {\n\tIConnectionDetails,\n\tIDeltaManager,\n\tIDeltaManagerEvents,\n\tIDeltaQueue,\n\tIDeltaQueueEvents,\n\tIDeltaSender,\n\tReadOnlyInfo,\n} from \"./deltas\";\nexport {\n\tContainerErrorTypes,\n\tContainerErrorType,\n\tContainerWarning,\n\tICriticalContainerError,\n} from \"./error\";\nexport {\n\tConnectionState,\n\tICodeDetailsLoader,\n\tIContainer,\n\tIContainerEvents,\n\tIContainerLoadMode,\n\tIFluidCodeResolver,\n\tIFluidModuleWithDetails,\n\tIHostLoader,\n\tILoader,\n\tILoaderHeader,\n\tILoaderOptions,\n\tIPendingLocalState,\n\tIProvideLoader,\n\tIResolvedFluidCodeDetails,\n\tISnapshotTreeWithBlobContents,\n\tLoaderHeader,\n} from \"./loader\";\nexport { IFluidModule } from \"./fluidModule\";\nexport {\n\tIFluidPackage,\n\tIFluidPackageEnvironment,\n\tIFluidCodeDetails,\n\tIFluidCodeDetailsComparer,\n\tIFluidCodeDetailsConfig,\n\tIProvideFluidCodeDetailsComparer,\n\tisFluidPackage,\n\tisFluidCodeDetails,\n} from \"./fluidPackage\";\nexport {\n\tAttachState,\n\tIBatchMessage,\n\tIContainerContext,\n\tIProvideRuntimeFactory,\n\tIRuntime,\n\tIRuntimeFactory,\n\tIGetPendingLocalStateProps,\n} from \"./runtime\";\n\nexport {\n\t/**\n\t * @deprecated IErrorBase is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIErrorBase,\n\t/**\n\t * @deprecated IGenericError is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIGenericError,\n\t/**\n\t * @deprecated IThrottlingWarning is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIThrottlingWarning,\n\t/**\n\t * @deprecated IUsageError is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIUsageError,\n} from \"@fluidframework/core-interfaces\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,mDAI0B;AADzB,uHAAA,qBAAqB,OAAA;AAWtB,iCAKiB;AAJhB,4GAAA,mBAAmB,OAAA;AACnB,2GAAA,kBAAkB,OAAA;AAInB,mCAgBkB;AADjB,sGAAA,YAAY,OAAA;AAGb,+CASwB;AALvB,yHAAA,yBAAyB,OAAA;AAGzB,8GAAA,cAAc,OAAA;AACd,kHAAA,kBAAkB,OAAA;AAEnB,qCAQmB;AAPlB,sGAAA,WAAW,OAAA;AAKX,0GAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This library contains the interfaces and types concerning the `Loader` and loading the `Container`.\n *\n * @packageDocumentation\n */\n\nexport { IAudience, IAudienceOwner } from \"./audience\";\nexport {\n\tIFluidBrowserPackage,\n\tIFluidBrowserPackageEnvironment,\n\tisFluidBrowserPackage,\n} from \"./browserPackage\";\nexport {\n\tIConnectionDetails,\n\tIDeltaManager,\n\tIDeltaManagerEvents,\n\tIDeltaQueue,\n\tIDeltaQueueEvents,\n\tIDeltaSender,\n\tReadOnlyInfo,\n} from \"./deltas\";\nexport {\n\tContainerErrorTypes,\n\tContainerErrorType,\n\tContainerWarning,\n\tICriticalContainerError,\n} from \"./error\";\nexport {\n\tConnectionState,\n\tICodeDetailsLoader,\n\tIContainer,\n\tIContainerEvents,\n\tIContainerLoadMode,\n\tIFluidCodeResolver,\n\tIFluidModuleWithDetails,\n\tIHostLoader,\n\tILoader,\n\tILoaderHeader,\n\tILoaderOptions,\n\tIProvideLoader,\n\tIResolvedFluidCodeDetails,\n\tISnapshotTreeWithBlobContents,\n\tLoaderHeader,\n} from \"./loader\";\nexport { IFluidModule } from \"./fluidModule\";\nexport {\n\tIFluidPackage,\n\tIFluidPackageEnvironment,\n\tIFluidCodeDetails,\n\tIFluidCodeDetailsComparer,\n\tIFluidCodeDetailsConfig,\n\tIProvideFluidCodeDetailsComparer,\n\tisFluidPackage,\n\tisFluidCodeDetails,\n} from \"./fluidPackage\";\nexport {\n\tAttachState,\n\tIBatchMessage,\n\tIContainerContext,\n\tIProvideRuntimeFactory,\n\tIRuntime,\n\tIRuntimeFactory,\n\tIGetPendingLocalStateProps,\n} from \"./runtime\";\n\nexport {\n\t/**\n\t * @deprecated IErrorBase is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIErrorBase,\n\t/**\n\t * @deprecated IGenericError is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIGenericError,\n\t/**\n\t * @deprecated IThrottlingWarning is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIThrottlingWarning,\n\t/**\n\t * @deprecated IUsageError is being deprecated as a public export is moving to \"core-interfaces\".\n\t */\n\tIUsageError,\n} from \"@fluidframework/core-interfaces\";\n"]}
package/dist/loader.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { IRequest, IResponse, IFluidRouter, FluidObject, IEvent, IEventProvider } from "@fluidframework/core-interfaces";
5
+ import { IRequest, FluidObject, IEvent, IEventProvider } from "@fluidframework/core-interfaces";
6
6
  import { IClientDetails, IDocumentMessage, IQuorumClients, ISequencedDocumentMessage, ISequencedProposal, ISnapshotTree } from "@fluidframework/protocol-definitions";
7
7
  import { IResolvedUrl } from "@fluidframework/driver-definitions";
8
8
  import { IAudience } from "./audience";
@@ -257,7 +257,7 @@ export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Est
257
257
  * The Host's view of a Container and its connection to storage
258
258
  * @alpha
259
259
  */
260
- export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
260
+ export interface IContainer extends IEventProvider<IContainerEvents> {
261
261
  /**
262
262
  * The Delta Manager supporting the op stream for this Container
263
263
  */
@@ -343,39 +343,6 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
343
343
  * @param relativeUrl - A container-relative request URL.
344
344
  */
345
345
  getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
346
- /**
347
- * @deprecated Requesting will not be supported in a future major release.
348
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
349
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
350
- * could implement a request paradigm itself)
351
- *
352
- * IMPORTANT: This overload is provided for back-compat where IContainer.request(\{ url: "/" \}) is already implemented and used.
353
- * The functionality it can provide (if the Container implementation is built for it) is redundant with @see {@link IContainer.getEntryPoint}.
354
- *
355
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
356
- *
357
- * @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
358
- */
359
- request(request: {
360
- url: "/";
361
- headers?: undefined;
362
- }): Promise<IResponse>;
363
- /**
364
- * Issue a request against the container for a resource.
365
- * @param request - The request to be issued against the container
366
- *
367
- * @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
368
- * Instead, access the objects in a Fluid Container using entryPoint, and then navigate from there using
369
- * app-specific logic (e.g. retrieving handles from the entryPoint's DDSes, or a container's entryPoint object
370
- * could implement a request paradigm itself)
371
- *
372
- * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
373
- */
374
- request(request: IRequest): Promise<IResponse>;
375
- /**
376
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
377
- */
378
- readonly IFluidRouter: IFluidRouter;
379
346
  /**
380
347
  * Provides the current state of the container's connection to the ordering service.
381
348
  *
@@ -436,7 +403,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
436
403
  * Exposes the entryPoint for the container.
437
404
  * Use this as the primary way of getting access to the user-defined logic within the container.
438
405
  */
439
- getEntryPoint(): Promise<FluidObject | undefined>;
406
+ getEntryPoint(): Promise<FluidObject>;
440
407
  }
441
408
  /**
442
409
  * The Runtime's view of the Loader, used for loading Containers
@@ -453,14 +420,6 @@ export interface ILoader extends Partial<IProvideLoader> {
453
420
  * a request against the server found from the resolve step.
454
421
  */
455
422
  resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
456
- /**
457
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
458
- */
459
- request(request: IRequest): Promise<IResponse>;
460
- /**
461
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
462
- */
463
- readonly IFluidRouter: IFluidRouter;
464
423
  }
465
424
  /**
466
425
  * The Host's view of the Loader, used for loading Containers
@@ -578,16 +537,6 @@ export interface ILoaderHeader {
578
537
  export interface IProvideLoader {
579
538
  readonly ILoader: ILoader;
580
539
  }
581
- /**
582
- * @deprecated 0.48, This API will be removed in 0.50
583
- * No replacement since it is not expected anyone will depend on this outside container-loader
584
- * See {@link https://github.com/microsoft/FluidFramework/issues/9711} for context.
585
- * @internal
586
- */
587
- export interface IPendingLocalState {
588
- url: string;
589
- pendingRuntimeState: unknown;
590
- }
591
540
  /**
592
541
  * This is used when we rehydrate a container from the snapshot. Here we put the blob contents
593
542
  * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.
@@ -596,7 +545,7 @@ export interface IPendingLocalState {
596
545
  * @alpha
597
546
  */
598
547
  export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
599
- blobsContents: {
548
+ blobsContents?: {
600
549
  [path: string]: ArrayBufferLike;
601
550
  };
602
551
  trees: {