@fluidframework/container-loader 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

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 (78) hide show
  1. package/api-extractor-lint.json +13 -0
  2. package/api-extractor.json +0 -4
  3. package/api-report/container-loader.api.md +17 -17
  4. package/dist/connectionState.cjs +3 -0
  5. package/dist/connectionState.cjs.map +1 -1
  6. package/dist/connectionState.d.ts +3 -0
  7. package/dist/connectionState.d.ts.map +1 -1
  8. package/dist/container-loader-alpha.d.ts +70 -325
  9. package/dist/container-loader-beta.d.ts +67 -301
  10. package/dist/container-loader-public.d.ts +67 -301
  11. package/dist/container-loader-untrimmed.d.ts +23 -5
  12. package/dist/container.cjs +11 -8
  13. package/dist/container.cjs.map +1 -1
  14. package/dist/container.d.ts +4 -6
  15. package/dist/container.d.ts.map +1 -1
  16. package/dist/deltaManager.cjs +18 -1
  17. package/dist/deltaManager.cjs.map +1 -1
  18. package/dist/deltaManager.d.ts.map +1 -1
  19. package/dist/loader.cjs +2 -0
  20. package/dist/loader.cjs.map +1 -1
  21. package/dist/loader.d.ts +10 -0
  22. package/dist/loader.d.ts.map +1 -1
  23. package/dist/location-redirection-utilities/resolveWithLocationRedirection.cjs +2 -0
  24. package/dist/location-redirection-utilities/resolveWithLocationRedirection.cjs.map +1 -1
  25. package/dist/location-redirection-utilities/resolveWithLocationRedirection.d.ts +2 -0
  26. package/dist/location-redirection-utilities/resolveWithLocationRedirection.d.ts.map +1 -1
  27. package/dist/packageVersion.cjs +1 -1
  28. package/dist/packageVersion.cjs.map +1 -1
  29. package/dist/packageVersion.d.ts +1 -1
  30. package/dist/protocol.cjs.map +1 -1
  31. package/dist/protocol.d.ts +4 -0
  32. package/dist/protocol.d.ts.map +1 -1
  33. package/dist/utils.cjs +1 -0
  34. package/dist/utils.cjs.map +1 -1
  35. package/dist/utils.d.ts +2 -0
  36. package/dist/utils.d.ts.map +1 -1
  37. package/lib/connectionState.d.ts +3 -0
  38. package/lib/connectionState.d.ts.map +1 -1
  39. package/lib/connectionState.mjs +3 -0
  40. package/lib/connectionState.mjs.map +1 -1
  41. package/lib/container-loader-alpha.d.ts +70 -325
  42. package/lib/container-loader-beta.d.ts +67 -301
  43. package/lib/container-loader-public.d.ts +67 -301
  44. package/lib/container-loader-untrimmed.d.ts +23 -5
  45. package/lib/container.d.ts +4 -6
  46. package/lib/container.d.ts.map +1 -1
  47. package/lib/container.mjs +11 -8
  48. package/lib/container.mjs.map +1 -1
  49. package/lib/deltaManager.d.ts.map +1 -1
  50. package/lib/deltaManager.mjs +18 -1
  51. package/lib/deltaManager.mjs.map +1 -1
  52. package/lib/loader.d.ts +10 -0
  53. package/lib/loader.d.ts.map +1 -1
  54. package/lib/loader.mjs +2 -0
  55. package/lib/loader.mjs.map +1 -1
  56. package/lib/location-redirection-utilities/resolveWithLocationRedirection.d.ts +2 -0
  57. package/lib/location-redirection-utilities/resolveWithLocationRedirection.d.ts.map +1 -1
  58. package/lib/location-redirection-utilities/resolveWithLocationRedirection.mjs +2 -0
  59. package/lib/location-redirection-utilities/resolveWithLocationRedirection.mjs.map +1 -1
  60. package/lib/packageVersion.d.ts +1 -1
  61. package/lib/packageVersion.mjs +1 -1
  62. package/lib/packageVersion.mjs.map +1 -1
  63. package/lib/protocol.d.ts +4 -0
  64. package/lib/protocol.d.ts.map +1 -1
  65. package/lib/protocol.mjs.map +1 -1
  66. package/lib/utils.d.ts +2 -0
  67. package/lib/utils.d.ts.map +1 -1
  68. package/lib/utils.mjs +1 -0
  69. package/lib/utils.mjs.map +1 -1
  70. package/package.json +12 -11
  71. package/src/connectionState.ts +3 -0
  72. package/src/container.ts +24 -13
  73. package/src/deltaManager.ts +25 -1
  74. package/src/loader.ts +10 -0
  75. package/src/location-redirection-utilities/resolveWithLocationRedirection.ts +2 -0
  76. package/src/packageVersion.ts +1 -1
  77. package/src/protocol.ts +4 -0
  78. package/src/utils.ts +2 -0
package/src/loader.ts CHANGED
@@ -113,6 +113,9 @@ export class RelativeLoader implements ILoader {
113
113
  }
114
114
  }
115
115
 
116
+ /**
117
+ * @internal
118
+ */
116
119
  export interface ILoaderOptions extends ILoaderOptions1 {
117
120
  summarizeProtocolTree?: boolean;
118
121
  }
@@ -122,6 +125,7 @@ export interface ILoaderOptions extends ILoaderOptions1 {
122
125
  * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
123
126
  * to have all the code loading modules in one package. #8193
124
127
  * Encapsulates a module entry point with corresponding code details.
128
+ * @internal
125
129
  */
126
130
  export interface IFluidModuleWithDetails {
127
131
  /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
@@ -139,6 +143,7 @@ export interface IFluidModuleWithDetails {
139
143
  * to have code loading modules in one package. #8193
140
144
  * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
141
145
  * a package name and package version range.
146
+ * @internal
142
147
  */
143
148
  export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
144
149
  /**
@@ -152,6 +157,7 @@ export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComp
152
157
 
153
158
  /**
154
159
  * Services and properties necessary for creating a loader
160
+ * @internal
155
161
  */
156
162
  export interface ILoaderProps {
157
163
  /**
@@ -208,6 +214,7 @@ export interface ILoaderProps {
208
214
 
209
215
  /**
210
216
  * Services and properties used by and exposed by the loader
217
+ * @internal
211
218
  */
212
219
  export interface ILoaderServices {
213
220
  /**
@@ -260,6 +267,7 @@ export interface ILoaderServices {
260
267
  /**
261
268
  * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
262
269
  * blobs in detached containers.
270
+ * @internal
263
271
  */
264
272
  export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
265
273
  size: number;
@@ -274,6 +282,7 @@ export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" |
274
282
  * @param container - a resolved container
275
283
  * @returns component on the container
276
284
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
285
+ * @internal
277
286
  */
278
287
  export async function requestResolvedObjectFromContainer(
279
288
  container: IContainer,
@@ -298,6 +307,7 @@ export async function requestResolvedObjectFromContainer(
298
307
 
299
308
  /**
300
309
  * Manages Fluid resource loading
310
+ * @internal
301
311
  */
302
312
  export class Loader implements IHostLoader {
303
313
  public readonly services: ILoaderServices;
@@ -15,6 +15,7 @@ import { createChildLogger } from "@fluidframework/telemetry-utils";
15
15
  * Checks if the error is location redirection error.
16
16
  * @param error - error whose type is to be determined.
17
17
  * @returns `true` is the error is location redirection error, otherwise `false`.
18
+ * @internal
18
19
  */
19
20
  export function isLocationRedirectionError(error: any): error is ILocationRedirectionError {
20
21
  return (
@@ -31,6 +32,7 @@ export function isLocationRedirectionError(error: any): error is ILocationRedire
31
32
  * @param urlResolver - resolver used to resolve the url.
32
33
  * @param logger - logger to send events.
33
34
  * @returns Response from the API call.
35
+ * @internal
34
36
  */
35
37
  export async function resolveWithLocationRedirectionHandling<T>(
36
38
  api: (request: IRequest) => Promise<T>,
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/container-loader";
9
- export const pkgVersion = "2.0.0-dev.7.4.0.215930";
9
+ export const pkgVersion = "2.0.0-dev.7.4.0.216897";
package/src/protocol.ts CHANGED
@@ -28,6 +28,7 @@ export enum SignalType {
28
28
 
29
29
  /**
30
30
  * Function to be used for creating a protocol handler.
31
+ * @internal
31
32
  */
32
33
  export type ProtocolHandlerBuilder = (
33
34
  attributes: IDocumentAttributes,
@@ -35,6 +36,9 @@ export type ProtocolHandlerBuilder = (
35
36
  sendProposal: (key: string, value: any) => number,
36
37
  ) => IProtocolHandler;
37
38
 
39
+ /**
40
+ * @internal
41
+ */
38
42
  export interface IProtocolHandler extends IBaseProtocolHandler {
39
43
  readonly audience: IAudienceOwner;
40
44
  processSignal(message: ISignalMessage);
package/src/utils.ts CHANGED
@@ -27,6 +27,7 @@ export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
27
27
  * Interface to represent the parsed parts of IResolvedUrl.url to help
28
28
  * in getting info about different parts of the url.
29
29
  * May not be compatible or relevant for any Url Resolver
30
+ * @internal
30
31
  */
31
32
  export interface IParsedUrl {
32
33
  /**
@@ -56,6 +57,7 @@ export interface IParsedUrl {
56
57
  * with urls of type: protocol://<string>/.../..?<querystring>
57
58
  * @param url - This is the IResolvedUrl.url part of the resolved url.
58
59
  * @returns The IParsedUrl representing the input URL, or undefined if the format was not supported
60
+ * @internal
59
61
  */
60
62
  export function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined {
61
63
  const parsed = parse(url, true);