@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.
- package/api-extractor-lint.json +13 -0
- package/api-extractor.json +0 -4
- package/api-report/container-loader.api.md +17 -17
- package/dist/connectionState.cjs +3 -0
- package/dist/connectionState.cjs.map +1 -1
- package/dist/connectionState.d.ts +3 -0
- package/dist/connectionState.d.ts.map +1 -1
- package/dist/container-loader-alpha.d.ts +70 -325
- package/dist/container-loader-beta.d.ts +67 -301
- package/dist/container-loader-public.d.ts +67 -301
- package/dist/container-loader-untrimmed.d.ts +23 -5
- package/dist/container.cjs +11 -8
- package/dist/container.cjs.map +1 -1
- package/dist/container.d.ts +4 -6
- package/dist/container.d.ts.map +1 -1
- package/dist/deltaManager.cjs +18 -1
- package/dist/deltaManager.cjs.map +1 -1
- package/dist/deltaManager.d.ts.map +1 -1
- package/dist/loader.cjs +2 -0
- package/dist/loader.cjs.map +1 -1
- package/dist/loader.d.ts +10 -0
- package/dist/loader.d.ts.map +1 -1
- package/dist/location-redirection-utilities/resolveWithLocationRedirection.cjs +2 -0
- package/dist/location-redirection-utilities/resolveWithLocationRedirection.cjs.map +1 -1
- package/dist/location-redirection-utilities/resolveWithLocationRedirection.d.ts +2 -0
- package/dist/location-redirection-utilities/resolveWithLocationRedirection.d.ts.map +1 -1
- package/dist/packageVersion.cjs +1 -1
- package/dist/packageVersion.cjs.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/protocol.cjs.map +1 -1
- package/dist/protocol.d.ts +4 -0
- package/dist/protocol.d.ts.map +1 -1
- package/dist/utils.cjs +1 -0
- package/dist/utils.cjs.map +1 -1
- package/dist/utils.d.ts +2 -0
- package/dist/utils.d.ts.map +1 -1
- package/lib/connectionState.d.ts +3 -0
- package/lib/connectionState.d.ts.map +1 -1
- package/lib/connectionState.mjs +3 -0
- package/lib/connectionState.mjs.map +1 -1
- package/lib/container-loader-alpha.d.ts +70 -325
- package/lib/container-loader-beta.d.ts +67 -301
- package/lib/container-loader-public.d.ts +67 -301
- package/lib/container-loader-untrimmed.d.ts +23 -5
- package/lib/container.d.ts +4 -6
- package/lib/container.d.ts.map +1 -1
- package/lib/container.mjs +11 -8
- package/lib/container.mjs.map +1 -1
- package/lib/deltaManager.d.ts.map +1 -1
- package/lib/deltaManager.mjs +18 -1
- package/lib/deltaManager.mjs.map +1 -1
- package/lib/loader.d.ts +10 -0
- package/lib/loader.d.ts.map +1 -1
- package/lib/loader.mjs +2 -0
- package/lib/loader.mjs.map +1 -1
- package/lib/location-redirection-utilities/resolveWithLocationRedirection.d.ts +2 -0
- package/lib/location-redirection-utilities/resolveWithLocationRedirection.d.ts.map +1 -1
- package/lib/location-redirection-utilities/resolveWithLocationRedirection.mjs +2 -0
- package/lib/location-redirection-utilities/resolveWithLocationRedirection.mjs.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.mjs +1 -1
- package/lib/packageVersion.mjs.map +1 -1
- package/lib/protocol.d.ts +4 -0
- package/lib/protocol.d.ts.map +1 -1
- package/lib/protocol.mjs.map +1 -1
- package/lib/utils.d.ts +2 -0
- package/lib/utils.d.ts.map +1 -1
- package/lib/utils.mjs +1 -0
- package/lib/utils.mjs.map +1 -1
- package/package.json +12 -11
- package/src/connectionState.ts +3 -0
- package/src/container.ts +24 -13
- package/src/deltaManager.ts +25 -1
- package/src/loader.ts +10 -0
- package/src/location-redirection-utilities/resolveWithLocationRedirection.ts +2 -0
- package/src/packageVersion.ts +1 -1
- package/src/protocol.ts +4 -0
- package/src/utils.ts +2 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-lint.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: remove once base config has this enabled as an error
|
|
7
|
+
"ae-incompatible-release-tags": {
|
|
8
|
+
"logLevel": "error",
|
|
9
|
+
"addToApiReportFile": false
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
package/api-extractor.json
CHANGED
|
@@ -6,10 +6,6 @@
|
|
|
6
6
|
},
|
|
7
7
|
"messages": {
|
|
8
8
|
"extractorMessageReporting": {
|
|
9
|
-
// TODO: Fix violations and remove this rule override
|
|
10
|
-
"ae-missing-release-tag": {
|
|
11
|
-
"logLevel": "none"
|
|
12
|
-
},
|
|
13
9
|
// TODO: Add missing documentation and remove this rule override
|
|
14
10
|
"ae-undocumented": {
|
|
15
11
|
"logLevel": "none"
|
|
@@ -29,7 +29,7 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
|
29
29
|
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
|
|
30
30
|
import { IUrlResolver } from '@fluidframework/driver-definitions';
|
|
31
31
|
|
|
32
|
-
// @
|
|
32
|
+
// @internal (undocumented)
|
|
33
33
|
export enum ConnectionState {
|
|
34
34
|
CatchingUp = 1,
|
|
35
35
|
Connected = 2,
|
|
@@ -37,36 +37,36 @@ export enum ConnectionState {
|
|
|
37
37
|
EstablishingConnection = 3
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
-
// @
|
|
40
|
+
// @internal @deprecated (undocumented)
|
|
41
41
|
export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
|
|
42
42
|
load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
|
|
43
43
|
}
|
|
44
44
|
|
|
45
|
-
// @
|
|
45
|
+
// @internal
|
|
46
46
|
export interface IContainerExperimental extends IContainer {
|
|
47
47
|
closeAndGetPendingLocalState?(stopBlobAttachingSignal?: AbortSignal): Promise<string>;
|
|
48
48
|
getPendingLocalState?(): Promise<string>;
|
|
49
49
|
}
|
|
50
50
|
|
|
51
|
-
// @
|
|
51
|
+
// @internal
|
|
52
52
|
export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
|
|
53
53
|
size: number;
|
|
54
54
|
getBlobIds(): string[];
|
|
55
55
|
};
|
|
56
56
|
|
|
57
|
-
// @
|
|
57
|
+
// @internal @deprecated (undocumented)
|
|
58
58
|
export interface IFluidModuleWithDetails {
|
|
59
59
|
details: IFluidCodeDetails;
|
|
60
60
|
module: IFluidModule;
|
|
61
61
|
}
|
|
62
62
|
|
|
63
|
-
// @
|
|
63
|
+
// @internal (undocumented)
|
|
64
64
|
export interface ILoaderOptions extends ILoaderOptions_2 {
|
|
65
65
|
// (undocumented)
|
|
66
66
|
summarizeProtocolTree?: boolean;
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
-
// @
|
|
69
|
+
// @internal
|
|
70
70
|
export interface ILoaderProps {
|
|
71
71
|
readonly codeLoader: ICodeDetailsLoader;
|
|
72
72
|
readonly configProvider?: IConfigProviderBase;
|
|
@@ -79,7 +79,7 @@ export interface ILoaderProps {
|
|
|
79
79
|
readonly urlResolver: IUrlResolver;
|
|
80
80
|
}
|
|
81
81
|
|
|
82
|
-
// @
|
|
82
|
+
// @internal
|
|
83
83
|
export interface ILoaderServices {
|
|
84
84
|
readonly codeLoader: ICodeDetailsLoader;
|
|
85
85
|
readonly detachedBlobStorage?: IDetachedBlobStorage;
|
|
@@ -91,7 +91,7 @@ export interface ILoaderServices {
|
|
|
91
91
|
readonly urlResolver: IUrlResolver;
|
|
92
92
|
}
|
|
93
93
|
|
|
94
|
-
// @
|
|
94
|
+
// @internal
|
|
95
95
|
export interface IParsedUrl {
|
|
96
96
|
id: string;
|
|
97
97
|
path: string;
|
|
@@ -99,7 +99,7 @@ export interface IParsedUrl {
|
|
|
99
99
|
version: string | null | undefined;
|
|
100
100
|
}
|
|
101
101
|
|
|
102
|
-
// @
|
|
102
|
+
// @internal (undocumented)
|
|
103
103
|
export interface IProtocolHandler extends IProtocolHandler_2 {
|
|
104
104
|
// (undocumented)
|
|
105
105
|
readonly audience: IAudienceOwner;
|
|
@@ -107,10 +107,10 @@ export interface IProtocolHandler extends IProtocolHandler_2 {
|
|
|
107
107
|
processSignal(message: ISignalMessage): any;
|
|
108
108
|
}
|
|
109
109
|
|
|
110
|
-
// @
|
|
110
|
+
// @internal
|
|
111
111
|
export function isLocationRedirectionError(error: any): error is ILocationRedirectionError;
|
|
112
112
|
|
|
113
|
-
// @
|
|
113
|
+
// @internal
|
|
114
114
|
export class Loader implements IHostLoader {
|
|
115
115
|
constructor(loaderProps: ILoaderProps);
|
|
116
116
|
// (undocumented)
|
|
@@ -133,19 +133,19 @@ export class Loader implements IHostLoader {
|
|
|
133
133
|
readonly services: ILoaderServices;
|
|
134
134
|
}
|
|
135
135
|
|
|
136
|
-
// @
|
|
136
|
+
// @internal
|
|
137
137
|
export type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
|
|
138
138
|
|
|
139
|
-
// @
|
|
139
|
+
// @internal @deprecated
|
|
140
140
|
export function requestResolvedObjectFromContainer(container: IContainer, headers?: IRequestHeader): Promise<IResponse>;
|
|
141
141
|
|
|
142
|
-
// @
|
|
142
|
+
// @internal
|
|
143
143
|
export function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
|
|
144
144
|
|
|
145
|
-
// @
|
|
145
|
+
// @internal
|
|
146
146
|
export function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined;
|
|
147
147
|
|
|
148
|
-
// @
|
|
148
|
+
// @internal
|
|
149
149
|
export function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
|
|
150
150
|
|
|
151
151
|
// (No @packageDocumentation comment for this package)
|
package/dist/connectionState.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connectionState.cjs","sourceRoot":"","sources":["../src/connectionState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,IAAY,eAuBX;AAvBD,WAAY,eAAe;IAC1B;;;;OAIG;IACH,qEAAgB,CAAA;IAEhB;;;OAGG;IACH,yFAA0B,CAAA;IAE1B;;OAEG;IACH,iEAAc,CAAA;IAEd;;OAEG;IACH,+DAAa,CAAA;AACd,CAAC,EAvBW,eAAe,+BAAf,eAAe,QAuB1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport enum ConnectionState {\n\t/**\n\t * The container is not connected to the ordering service\n\t * Note - When in this state the container may be about to reconnect,\n\t * or may remain disconnected until explicitly told to connect.\n\t */\n\tDisconnected = 0,\n\n\t/**\n\t * The container is disconnected but actively trying to establish a new connection\n\t * PLEASE NOTE that this numerical value falls out of the order you may expect for this state\n\t */\n\tEstablishingConnection = 3,\n\n\t/**\n\t * The container has an inbound connection only, and is catching up to the latest known state from the service.\n\t */\n\tCatchingUp = 1,\n\n\t/**\n\t * The container is fully connected and syncing\n\t */\n\tConnected = 2,\n}\n"]}
|
|
1
|
+
{"version":3,"file":"connectionState.cjs","sourceRoot":"","sources":["../src/connectionState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,IAAY,eAuBX;AAvBD,WAAY,eAAe;IAC1B;;;;OAIG;IACH,qEAAgB,CAAA;IAEhB;;;OAGG;IACH,yFAA0B,CAAA;IAE1B;;OAEG;IACH,iEAAc,CAAA;IAEd;;OAEG;IACH,+DAAa,CAAA;AACd,CAAC,EAvBW,eAAe,+BAAf,eAAe,QAuB1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @internal\n */\nexport enum ConnectionState {\n\t/**\n\t * The container is not connected to the ordering service\n\t * Note - When in this state the container may be about to reconnect,\n\t * or may remain disconnected until explicitly told to connect.\n\t */\n\tDisconnected = 0,\n\n\t/**\n\t * The container is disconnected but actively trying to establish a new connection\n\t * PLEASE NOTE that this numerical value falls out of the order you may expect for this state\n\t */\n\tEstablishingConnection = 3,\n\n\t/**\n\t * The container has an inbound connection only, and is catching up to the latest known state from the service.\n\t */\n\tCatchingUp = 1,\n\n\t/**\n\t * The container is fully connected and syncing\n\t */\n\tConnected = 2,\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connectionState.d.ts","sourceRoot":"","sources":["../src/connectionState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,oBAAY,eAAe;IAC1B;;;;OAIG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,sBAAsB,IAAI;IAE1B;;OAEG;IACH,UAAU,IAAI;IAEd;;OAEG;IACH,SAAS,IAAI;CACb"}
|
|
1
|
+
{"version":3,"file":"connectionState.d.ts","sourceRoot":"","sources":["../src/connectionState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,oBAAY,eAAe;IAC1B;;;;OAIG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,sBAAsB,IAAI;IAE1B;;OAEG;IACH,UAAU,IAAI;IAEd;;OAEG;IACH,SAAS,IAAI;CACb"}
|
|
@@ -1,333 +1,78 @@
|
|
|
1
|
-
import { FluidObject } from '@fluidframework/core-interfaces';
|
|
2
|
-
import { IAudienceOwner } from '@fluidframework/container-definitions';
|
|
3
1
|
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
4
|
-
import { IConfigProviderBase } from '@fluidframework/telemetry-utils';
|
|
5
|
-
import { IContainer } from '@fluidframework/container-definitions';
|
|
6
2
|
import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
8
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
9
|
-
import { IFluidCodeDetails } from '@fluidframework/container-definitions';
|
|
10
|
-
import { IFluidModule } from '@fluidframework/container-definitions';
|
|
11
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
12
|
-
import { IHostLoader } from '@fluidframework/container-definitions';
|
|
13
|
-
import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
|
|
14
|
-
import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
|
|
15
3
|
import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
|
|
16
|
-
import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
|
|
17
4
|
import { IQuorumSnapshot } from '@fluidframework/protocol-base';
|
|
18
|
-
import { IRequest } from '@fluidframework/core-interfaces';
|
|
19
5
|
import { IRequestHeader } from '@fluidframework/core-interfaces';
|
|
20
|
-
import { IResponse } from '@fluidframework/core-interfaces';
|
|
21
6
|
import { ISignalMessage } from '@fluidframework/protocol-definitions';
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
*/
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
size: number;
|
|
93
|
-
/**
|
|
94
|
-
* Return an array of all blob IDs present in storage
|
|
95
|
-
*/
|
|
96
|
-
getBlobIds(): string[];
|
|
97
|
-
};
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* @deprecated IFluidModuleWithDetails interface is moved to
|
|
101
|
-
* {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
|
|
102
|
-
* to have all the code loading modules in one package. #8193
|
|
103
|
-
* Encapsulates a module entry point with corresponding code details.
|
|
104
|
-
*/
|
|
105
|
-
export declare interface IFluidModuleWithDetails {
|
|
106
|
-
/** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
|
|
107
|
-
module: IFluidModule;
|
|
108
|
-
/**
|
|
109
|
-
* Code details associated with the module. Represents a document schema this module supports.
|
|
110
|
-
* If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
|
|
111
|
-
* it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
|
|
112
|
-
*/
|
|
113
|
-
details: IFluidCodeDetails;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
export declare interface ILoaderOptions extends ILoaderOptions_2 {
|
|
117
|
-
summarizeProtocolTree?: boolean;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* Services and properties necessary for creating a loader
|
|
122
|
-
*/
|
|
123
|
-
export declare interface ILoaderProps {
|
|
124
|
-
/**
|
|
125
|
-
* The url resolver used by the loader for resolving external urls
|
|
126
|
-
* into Fluid urls such that the container specified by the
|
|
127
|
-
* external url can be loaded.
|
|
128
|
-
*/
|
|
129
|
-
readonly urlResolver: IUrlResolver;
|
|
130
|
-
/**
|
|
131
|
-
* The document service factory take the Fluid url provided
|
|
132
|
-
* by the resolved url and constructs all the necessary services
|
|
133
|
-
* for communication with the container's server.
|
|
134
|
-
*/
|
|
135
|
-
readonly documentServiceFactory: IDocumentServiceFactory;
|
|
136
|
-
/**
|
|
137
|
-
* The code loader handles loading the necessary code
|
|
138
|
-
* for running a container once it is loaded.
|
|
139
|
-
*/
|
|
140
|
-
readonly codeLoader: ICodeDetailsLoader;
|
|
141
|
-
/**
|
|
142
|
-
* A property bag of options used by various layers
|
|
143
|
-
* to control features
|
|
144
|
-
*/
|
|
145
|
-
readonly options?: ILoaderOptions;
|
|
146
|
-
/**
|
|
147
|
-
* Scope is provided to all container and is a set of shared
|
|
148
|
-
* services for container's to integrate with their host environment.
|
|
149
|
-
*/
|
|
150
|
-
readonly scope?: FluidObject;
|
|
151
|
-
/**
|
|
152
|
-
* The logger that all telemetry should be pushed to.
|
|
153
|
-
*/
|
|
154
|
-
readonly logger?: ITelemetryBaseLogger;
|
|
155
|
-
/**
|
|
156
|
-
* Blobs storage for detached containers.
|
|
157
|
-
*/
|
|
158
|
-
readonly detachedBlobStorage?: IDetachedBlobStorage;
|
|
159
|
-
/**
|
|
160
|
-
* The configuration provider which may be used to control features.
|
|
161
|
-
*/
|
|
162
|
-
readonly configProvider?: IConfigProviderBase;
|
|
163
|
-
/**
|
|
164
|
-
* Optional property for allowing the container to use a custom
|
|
165
|
-
* protocol implementation for handling the quorum and/or the audience.
|
|
166
|
-
*/
|
|
167
|
-
readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* Services and properties used by and exposed by the loader
|
|
172
|
-
*/
|
|
173
|
-
export declare interface ILoaderServices {
|
|
174
|
-
/**
|
|
175
|
-
* The url resolver used by the loader for resolving external urls
|
|
176
|
-
* into Fluid urls such that the container specified by the
|
|
177
|
-
* external url can be loaded.
|
|
178
|
-
*/
|
|
179
|
-
readonly urlResolver: IUrlResolver;
|
|
180
|
-
/**
|
|
181
|
-
* The document service factory take the Fluid url provided
|
|
182
|
-
* by the resolved url and constructs all the necessary services
|
|
183
|
-
* for communication with the container's server.
|
|
184
|
-
*/
|
|
185
|
-
readonly documentServiceFactory: IDocumentServiceFactory;
|
|
186
|
-
/**
|
|
187
|
-
* The code loader handles loading the necessary code
|
|
188
|
-
* for running a container once it is loaded.
|
|
189
|
-
*/
|
|
190
|
-
readonly codeLoader: ICodeDetailsLoader;
|
|
191
|
-
/**
|
|
192
|
-
* A property bag of options used by various layers
|
|
193
|
-
* to control features
|
|
194
|
-
*/
|
|
195
|
-
readonly options: ILoaderOptions;
|
|
196
|
-
/**
|
|
197
|
-
* Scope is provided to all container and is a set of shared
|
|
198
|
-
* services for container's to integrate with their host environment.
|
|
199
|
-
*/
|
|
200
|
-
readonly scope: FluidObject;
|
|
201
|
-
/**
|
|
202
|
-
* The logger downstream consumers should construct their loggers from
|
|
203
|
-
*/
|
|
204
|
-
readonly subLogger: ITelemetryLoggerExt;
|
|
205
|
-
/**
|
|
206
|
-
* Blobs storage for detached containers.
|
|
207
|
-
*/
|
|
208
|
-
readonly detachedBlobStorage?: IDetachedBlobStorage;
|
|
209
|
-
/**
|
|
210
|
-
* Optional property for allowing the container to use a custom
|
|
211
|
-
* protocol implementation for handling the quorum and/or the audience.
|
|
212
|
-
*/
|
|
213
|
-
readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
/**
|
|
217
|
-
* Interface to represent the parsed parts of IResolvedUrl.url to help
|
|
218
|
-
* in getting info about different parts of the url.
|
|
219
|
-
* May not be compatible or relevant for any Url Resolver
|
|
220
|
-
*/
|
|
221
|
-
export declare interface IParsedUrl {
|
|
222
|
-
/**
|
|
223
|
-
* It is combination of tenantid/docId part of the url.
|
|
224
|
-
*/
|
|
225
|
-
id: string;
|
|
226
|
-
/**
|
|
227
|
-
* It is the deep link path in the url.
|
|
228
|
-
*/
|
|
229
|
-
path: string;
|
|
230
|
-
/**
|
|
231
|
-
* Query string part of the url.
|
|
232
|
-
*/
|
|
233
|
-
query: string;
|
|
234
|
-
/**
|
|
235
|
-
* Null means do not use snapshots, undefined means load latest snapshot
|
|
236
|
-
* otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.
|
|
237
|
-
* If needed, can add undefined which is treated by Container.load() as load latest snapshot.
|
|
238
|
-
*/
|
|
239
|
-
version: string | null | undefined;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
export declare interface IProtocolHandler extends IProtocolHandler_2 {
|
|
243
|
-
readonly audience: IAudienceOwner;
|
|
244
|
-
processSignal(message: ISignalMessage): any;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
/**
|
|
248
|
-
* Checks if the error is location redirection error.
|
|
249
|
-
* @param error - error whose type is to be determined.
|
|
250
|
-
* @returns `true` is the error is location redirection error, otherwise `false`.
|
|
251
|
-
*/
|
|
252
|
-
export declare function isLocationRedirectionError(error: any): error is ILocationRedirectionError;
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
* Manages Fluid resource loading
|
|
256
|
-
*/
|
|
257
|
-
export declare class Loader implements IHostLoader {
|
|
258
|
-
readonly services: ILoaderServices;
|
|
259
|
-
private readonly mc;
|
|
260
|
-
constructor(loaderProps: ILoaderProps);
|
|
261
|
-
/**
|
|
262
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
|
|
263
|
-
*/
|
|
264
|
-
get IFluidRouter(): IFluidRouter;
|
|
265
|
-
createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
|
|
266
|
-
canReconnect?: boolean;
|
|
267
|
-
clientDetailsOverride?: IClientDetails;
|
|
268
|
-
}): Promise<IContainer>;
|
|
269
|
-
rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
|
|
270
|
-
canReconnect?: boolean;
|
|
271
|
-
clientDetailsOverride?: IClientDetails;
|
|
272
|
-
}): Promise<IContainer>;
|
|
273
|
-
resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
|
|
274
|
-
/**
|
|
275
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
|
|
276
|
-
*/
|
|
277
|
-
request(request: IRequest): Promise<IResponse>;
|
|
278
|
-
private resolveCore;
|
|
279
|
-
private loadContainer;
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* Function to be used for creating a protocol handler.
|
|
284
|
-
*/
|
|
285
|
-
export declare type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
|
|
286
|
-
|
|
287
|
-
/**
|
|
288
|
-
* With an already-resolved container, we can request a component directly, without loading the container again
|
|
289
|
-
* @param container - a resolved container
|
|
290
|
-
* @returns component on the container
|
|
291
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
292
|
-
*/
|
|
293
|
-
export declare function requestResolvedObjectFromContainer(container: IContainer, headers?: IRequestHeader): Promise<IResponse>;
|
|
294
|
-
|
|
295
|
-
/**
|
|
296
|
-
* Handles location redirection while fulfilling the loader request.
|
|
297
|
-
* @param api - Callback in which user can wrap the loader.resolve or loader.request call.
|
|
298
|
-
* @param request - request to be resolved.
|
|
299
|
-
* @param urlResolver - resolver used to resolve the url.
|
|
300
|
-
* @param logger - logger to send events.
|
|
301
|
-
* @returns Response from the API call.
|
|
302
|
-
*/
|
|
303
|
-
export declare function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
|
|
304
|
-
|
|
305
|
-
/**
|
|
306
|
-
* Utility api to parse the IResolvedUrl.url into specific parts like querystring, path to get
|
|
307
|
-
* deep link info etc.
|
|
308
|
-
* Warning - This function may not be compatible with any Url Resolver's resolved url. It works
|
|
309
|
-
* with urls of type: protocol://<string>/.../..?<querystring>
|
|
310
|
-
* @param url - This is the IResolvedUrl.url part of the resolved url.
|
|
311
|
-
* @returns The IParsedUrl representing the input URL, or undefined if the format was not supported
|
|
312
|
-
*/
|
|
313
|
-
export declare function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined;
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
* Waits until container connects to delta storage and gets up-to-date.
|
|
317
|
-
*
|
|
318
|
-
* Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being
|
|
319
|
-
* up to date. Host may chose to wait in such case and retry resolving URI.
|
|
320
|
-
*
|
|
321
|
-
* Warning: Will wait infinitely for connection to establish if there is no connection.
|
|
322
|
-
* May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
|
|
323
|
-
*
|
|
324
|
-
* @returns `true`: container is up to date, it processed all the ops that were know at the time of first connection.
|
|
325
|
-
*
|
|
326
|
-
* `false`: storage does not provide indication of how far the client is. Container processed all the ops known to it,
|
|
327
|
-
* but it maybe still behind.
|
|
328
|
-
*
|
|
329
|
-
* @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
|
|
330
|
-
*/
|
|
331
|
-
export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
|
|
7
|
+
|
|
8
|
+
/* Excluded from this release type: ConnectionState */
|
|
9
|
+
|
|
10
|
+
/* Excluded from this release type: FluidObject */
|
|
11
|
+
|
|
12
|
+
/* Excluded from this release type: IAudienceOwner */
|
|
13
|
+
|
|
14
|
+
/* Excluded from this release type: ICodeDetailsLoader */
|
|
15
|
+
|
|
16
|
+
/* Excluded from this release type: IConfigProviderBase */
|
|
17
|
+
|
|
18
|
+
/* Excluded from this release type: IContainer */
|
|
19
|
+
|
|
20
|
+
/* Excluded from this release type: IContainerExperimental */
|
|
21
|
+
|
|
22
|
+
/* Excluded from this release type: IDetachedBlobStorage */
|
|
23
|
+
|
|
24
|
+
/* Excluded from this release type: IDocumentServiceFactory */
|
|
25
|
+
|
|
26
|
+
/* Excluded from this release type: IDocumentStorageService */
|
|
27
|
+
|
|
28
|
+
/* Excluded from this release type: IFluidCodeDetails */
|
|
29
|
+
|
|
30
|
+
/* Excluded from this release type: IFluidModule */
|
|
31
|
+
|
|
32
|
+
/* Excluded from this release type: IFluidModuleWithDetails */
|
|
33
|
+
|
|
34
|
+
/* Excluded from this release type: IFluidRouter */
|
|
35
|
+
|
|
36
|
+
/* Excluded from this release type: IHostLoader */
|
|
37
|
+
|
|
38
|
+
/* Excluded from this release type: ILoaderOptions */
|
|
39
|
+
|
|
40
|
+
/* Excluded from this release type: ILoaderOptions_2 */
|
|
41
|
+
|
|
42
|
+
/* Excluded from this release type: ILoaderProps */
|
|
43
|
+
|
|
44
|
+
/* Excluded from this release type: ILoaderServices */
|
|
45
|
+
|
|
46
|
+
/* Excluded from this release type: ILocationRedirectionError */
|
|
47
|
+
|
|
48
|
+
/* Excluded from this release type: IParsedUrl */
|
|
49
|
+
|
|
50
|
+
/* Excluded from this release type: IProtocolHandler */
|
|
51
|
+
|
|
52
|
+
/* Excluded from this release type: IProvideFluidCodeDetailsComparer */
|
|
53
|
+
|
|
54
|
+
/* Excluded from this release type: IRequest */
|
|
55
|
+
|
|
56
|
+
/* Excluded from this release type: IResponse */
|
|
57
|
+
|
|
58
|
+
/* Excluded from this release type: isLocationRedirectionError */
|
|
59
|
+
|
|
60
|
+
/* Excluded from this release type: ITelemetryBaseLogger */
|
|
61
|
+
|
|
62
|
+
/* Excluded from this release type: ITelemetryLoggerExt */
|
|
63
|
+
|
|
64
|
+
/* Excluded from this release type: IUrlResolver */
|
|
65
|
+
|
|
66
|
+
/* Excluded from this release type: Loader */
|
|
67
|
+
|
|
68
|
+
/* Excluded from this release type: ProtocolHandlerBuilder */
|
|
69
|
+
|
|
70
|
+
/* Excluded from this release type: requestResolvedObjectFromContainer */
|
|
71
|
+
|
|
72
|
+
/* Excluded from this release type: resolveWithLocationRedirectionHandling */
|
|
73
|
+
|
|
74
|
+
/* Excluded from this release type: tryParseCompatibleResolvedUrl */
|
|
75
|
+
|
|
76
|
+
/* Excluded from this release type: waitContainerToCatchUp */
|
|
332
77
|
|
|
333
78
|
export { }
|