@fluidframework/container-definitions 0.49.1000-69955 → 1.1.0-75972
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/.eslintrc.js +1 -1
- package/api-extractor.json +3 -11
- package/dist/deltas.d.ts +1 -20
- package/dist/deltas.d.ts.map +1 -1
- package/dist/deltas.js +0 -5
- package/dist/deltas.js.map +1 -1
- package/dist/fluidPackage.d.ts +3 -0
- package/dist/fluidPackage.d.ts.map +1 -1
- package/dist/fluidPackage.js.map +1 -1
- package/dist/index.d.ts +1 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -2
- package/dist/index.js.map +1 -1
- package/dist/loader.d.ts +1 -19
- package/dist/loader.d.ts.map +1 -1
- package/dist/loader.js.map +1 -1
- package/lib/deltas.d.ts +1 -20
- package/lib/deltas.d.ts.map +1 -1
- package/lib/deltas.js +1 -4
- package/lib/deltas.js.map +1 -1
- package/lib/fluidPackage.d.ts +3 -0
- package/lib/fluidPackage.d.ts.map +1 -1
- package/lib/fluidPackage.js.map +1 -1
- package/lib/index.d.ts +1 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -2
- package/lib/index.js.map +1 -1
- package/lib/loader.d.ts +1 -19
- package/lib/loader.d.ts.map +1 -1
- package/lib/loader.js.map +1 -1
- package/package.json +13 -42
- package/src/deltas.ts +1 -23
- package/src/fluidPackage.ts +3 -0
- package/src/index.ts +1 -2
- package/src/loader.ts +3 -28
- package/api-report/container-definitions.api.md +0 -581
- package/dist/legacy/index.d.ts +0 -32
- package/dist/legacy/index.d.ts.map +0 -1
- package/dist/legacy/index.js +0 -12
- package/dist/legacy/index.js.map +0 -1
- package/dist/proxyLoader.d.ts +0 -23
- package/dist/proxyLoader.d.ts.map +0 -1
- package/dist/proxyLoader.js +0 -7
- package/dist/proxyLoader.js.map +0 -1
- package/lib/legacy/index.d.ts +0 -32
- package/lib/legacy/index.d.ts.map +0 -1
- package/lib/legacy/index.js +0 -9
- package/lib/legacy/index.js.map +0 -1
- package/lib/proxyLoader.d.ts +0 -23
- package/lib/proxyLoader.d.ts.map +0 -1
- package/lib/proxyLoader.js +0 -6
- package/lib/proxyLoader.js.map +0 -1
- package/src/legacy/index.ts +0 -34
- package/src/proxyLoader.ts +0 -29
|
@@ -1,581 +0,0 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/container-definitions"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
/// <reference types="node" />
|
|
8
|
-
|
|
9
|
-
import { ConnectionMode } from '@fluidframework/protocol-definitions';
|
|
10
|
-
import { EventEmitter } from 'events';
|
|
11
|
-
import { FluidObject } from '@fluidframework/core-interfaces';
|
|
12
|
-
import { IClient } from '@fluidframework/protocol-definitions';
|
|
13
|
-
import { IClientConfiguration } from '@fluidframework/protocol-definitions';
|
|
14
|
-
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
15
|
-
import { IDisposable } from '@fluidframework/common-definitions';
|
|
16
|
-
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
17
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
18
|
-
import { IErrorEvent } from '@fluidframework/common-definitions';
|
|
19
|
-
import { IEvent } from '@fluidframework/common-definitions';
|
|
20
|
-
import { IEventProvider } from '@fluidframework/common-definitions';
|
|
21
|
-
import { IFluidResolvedUrl } from '@fluidframework/driver-definitions';
|
|
22
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
23
|
-
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
24
|
-
import { IRequest } from '@fluidframework/core-interfaces';
|
|
25
|
-
import { IResolvedUrl } from '@fluidframework/driver-definitions';
|
|
26
|
-
import { IResponse } from '@fluidframework/core-interfaces';
|
|
27
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
28
|
-
import { ISequencedProposal } from '@fluidframework/protocol-definitions';
|
|
29
|
-
import { ISignalClient } from '@fluidframework/protocol-definitions';
|
|
30
|
-
import { ISignalMessage } from '@fluidframework/protocol-definitions';
|
|
31
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
32
|
-
import { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
33
|
-
import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';
|
|
34
|
-
import { ITelemetryProperties } from '@fluidframework/common-definitions';
|
|
35
|
-
import { ITokenClaims } from '@fluidframework/protocol-definitions';
|
|
36
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
37
|
-
import { MessageType } from '@fluidframework/protocol-definitions';
|
|
38
|
-
|
|
39
|
-
// @public
|
|
40
|
-
export enum AttachState {
|
|
41
|
-
Attached = "Attached",
|
|
42
|
-
Attaching = "Attaching",
|
|
43
|
-
Detached = "Detached"
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
// @public (undocumented)
|
|
47
|
-
export enum BindState {
|
|
48
|
-
// (undocumented)
|
|
49
|
-
Binding = "Binding",
|
|
50
|
-
// (undocumented)
|
|
51
|
-
Bound = "Bound",
|
|
52
|
-
// (undocumented)
|
|
53
|
-
NotBound = "NotBound"
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
// @public
|
|
57
|
-
export namespace ConnectionState {
|
|
58
|
-
export type CatchingUp = 1;
|
|
59
|
-
export type Connected = 2;
|
|
60
|
-
// @deprecated (undocumented)
|
|
61
|
-
export type Connecting = 1;
|
|
62
|
-
export type Disconnected = 0;
|
|
63
|
-
export type EstablishingConnection = 3;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
// @public
|
|
67
|
-
export type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connecting | ConnectionState.Connected;
|
|
68
|
-
|
|
69
|
-
// @public
|
|
70
|
-
export enum ContainerErrorType {
|
|
71
|
-
clientSessionExpiredError = "clientSessionExpiredError",
|
|
72
|
-
dataCorruptionError = "dataCorruptionError",
|
|
73
|
-
dataProcessingError = "dataProcessingError",
|
|
74
|
-
genericError = "genericError",
|
|
75
|
-
throttlingError = "throttlingError",
|
|
76
|
-
usageError = "usageError"
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
// @public
|
|
80
|
-
export interface ContainerWarning extends IErrorBase {
|
|
81
|
-
logged?: boolean;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
// @public
|
|
85
|
-
export interface IAudience extends EventEmitter {
|
|
86
|
-
getMember(clientId: string): IClient | undefined;
|
|
87
|
-
getMembers(): Map<string, IClient>;
|
|
88
|
-
// (undocumented)
|
|
89
|
-
on(event: "addMember" | "removeMember", listener: (clientId: string, client: IClient) => void): this;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
// @public
|
|
93
|
-
export interface ICodeAllowList {
|
|
94
|
-
// (undocumented)
|
|
95
|
-
testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
// @public
|
|
99
|
-
export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
|
|
100
|
-
load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
// @public @deprecated
|
|
104
|
-
export interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {
|
|
105
|
-
load(source: IFluidCodeDetails): Promise<IFluidModule>;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
// @public
|
|
109
|
-
export interface IConnectionDetails {
|
|
110
|
-
checkpointSequenceNumber: number | undefined;
|
|
111
|
-
// (undocumented)
|
|
112
|
-
claims: ITokenClaims;
|
|
113
|
-
// (undocumented)
|
|
114
|
-
clientId: string;
|
|
115
|
-
// (undocumented)
|
|
116
|
-
existing: boolean;
|
|
117
|
-
// (undocumented)
|
|
118
|
-
initialClients: ISignalClient[];
|
|
119
|
-
// (undocumented)
|
|
120
|
-
mode: ConnectionMode;
|
|
121
|
-
// (undocumented)
|
|
122
|
-
serviceConfiguration: IClientConfiguration;
|
|
123
|
-
// (undocumented)
|
|
124
|
-
version: string;
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
// @public
|
|
128
|
-
export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
|
|
129
|
-
attach(request: IRequest): Promise<void>;
|
|
130
|
-
readonly attachState: AttachState;
|
|
131
|
-
readonly audience: IAudience;
|
|
132
|
-
// @alpha
|
|
133
|
-
readonly clientId?: string | undefined;
|
|
134
|
-
close(error?: ICriticalContainerError): void;
|
|
135
|
-
closeAndGetPendingLocalState(): string;
|
|
136
|
-
readonly closed: boolean;
|
|
137
|
-
connect(): void;
|
|
138
|
-
readonly connectionState: ConnectionState;
|
|
139
|
-
deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
140
|
-
disconnect(): void;
|
|
141
|
-
// @alpha
|
|
142
|
-
forceReadonly?(readonly: boolean): any;
|
|
143
|
-
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
|
|
144
|
-
getLoadedCodeDetails(): IFluidCodeDetails | undefined;
|
|
145
|
-
getQuorum(): IQuorumClients;
|
|
146
|
-
getSpecifiedCodeDetails(): IFluidCodeDetails | undefined;
|
|
147
|
-
readonly isDirty: boolean;
|
|
148
|
-
proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
|
|
149
|
-
readonly readOnlyInfo: ReadOnlyInfo;
|
|
150
|
-
request(request: IRequest): Promise<IResponse>;
|
|
151
|
-
resolvedUrl: IResolvedUrl | undefined;
|
|
152
|
-
serialize(): string;
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
// @public
|
|
156
|
-
export interface IContainerContext extends IDisposable {
|
|
157
|
-
readonly attachState: AttachState;
|
|
158
|
-
// (undocumented)
|
|
159
|
-
readonly audience: IAudience | undefined;
|
|
160
|
-
// (undocumented)
|
|
161
|
-
readonly baseSnapshot: ISnapshotTree | undefined;
|
|
162
|
-
// (undocumented)
|
|
163
|
-
readonly clientDetails: IClientDetails;
|
|
164
|
-
// (undocumented)
|
|
165
|
-
readonly clientId: string | undefined;
|
|
166
|
-
// (undocumented)
|
|
167
|
-
readonly closeFn: (error?: ICriticalContainerError) => void;
|
|
168
|
-
// (undocumented)
|
|
169
|
-
readonly connected: boolean;
|
|
170
|
-
// (undocumented)
|
|
171
|
-
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
172
|
-
// (undocumented)
|
|
173
|
-
readonly existing: boolean | undefined;
|
|
174
|
-
getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;
|
|
175
|
-
// (undocumented)
|
|
176
|
-
getLoadedFromVersion(): IVersion | undefined;
|
|
177
|
-
// @deprecated (undocumented)
|
|
178
|
-
getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
|
|
179
|
-
readonly id: string;
|
|
180
|
-
// (undocumented)
|
|
181
|
-
readonly loader: ILoader;
|
|
182
|
-
// (undocumented)
|
|
183
|
-
readonly options: ILoaderOptions;
|
|
184
|
-
// (undocumented)
|
|
185
|
-
pendingLocalState?: unknown;
|
|
186
|
-
// (undocumented)
|
|
187
|
-
readonly quorum: IQuorumClients;
|
|
188
|
-
readonly scope: FluidObject;
|
|
189
|
-
// (undocumented)
|
|
190
|
-
readonly serviceConfiguration: IClientConfiguration | undefined;
|
|
191
|
-
// (undocumented)
|
|
192
|
-
readonly storage: IDocumentStorageService;
|
|
193
|
-
// (undocumented)
|
|
194
|
-
readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;
|
|
195
|
-
// (undocumented)
|
|
196
|
-
readonly submitSignalFn: (contents: any) => void;
|
|
197
|
-
// (undocumented)
|
|
198
|
-
readonly taggedLogger: ITelemetryBaseLogger;
|
|
199
|
-
// (undocumented)
|
|
200
|
-
updateDirtyContainerState(dirty: boolean): void;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
// @public
|
|
204
|
-
export interface IContainerEvents extends IEvent {
|
|
205
|
-
// (undocumented)
|
|
206
|
-
(event: "readonly", listener: (readonly: boolean) => void): void;
|
|
207
|
-
// (undocumented)
|
|
208
|
-
(event: "connected", listener: (clientId: string) => void): any;
|
|
209
|
-
// (undocumented)
|
|
210
|
-
(event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails, proposal: ISequencedProposal) => void): any;
|
|
211
|
-
// (undocumented)
|
|
212
|
-
(event: "contextChanged", listener: (codeDetails: IFluidCodeDetails) => void): any;
|
|
213
|
-
// (undocumented)
|
|
214
|
-
(event: "disconnected" | "attached", listener: () => void): any;
|
|
215
|
-
// (undocumented)
|
|
216
|
-
(event: "closed", listener: (error?: ICriticalContainerError) => void): any;
|
|
217
|
-
// (undocumented)
|
|
218
|
-
(event: "warning", listener: (error: ContainerWarning) => void): any;
|
|
219
|
-
// (undocumented)
|
|
220
|
-
(event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
|
|
221
|
-
// (undocumented)
|
|
222
|
-
(event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
// @public (undocumented)
|
|
226
|
-
export interface IContainerLoadMode {
|
|
227
|
-
// (undocumented)
|
|
228
|
-
deltaConnection?: "none" | "delayed" | undefined;
|
|
229
|
-
// (undocumented)
|
|
230
|
-
opsBeforeReturn?: undefined | "cached" | "all";
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
// @public
|
|
234
|
-
export type ICriticalContainerError = IErrorBase;
|
|
235
|
-
|
|
236
|
-
// @public
|
|
237
|
-
export interface IDeltaHandlerStrategy {
|
|
238
|
-
process: (message: ISequencedDocumentMessage) => void;
|
|
239
|
-
processSignal: (message: ISignalMessage) => void;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
// @public
|
|
243
|
-
export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {
|
|
244
|
-
readonly active: boolean;
|
|
245
|
-
readonly clientDetails: IClientDetails;
|
|
246
|
-
readonly hasCheckpointSequenceNumber: boolean;
|
|
247
|
-
readonly inbound: IDeltaQueue<T>;
|
|
248
|
-
readonly inboundSignal: IDeltaQueue<ISignalMessage>;
|
|
249
|
-
readonly initialSequenceNumber: number;
|
|
250
|
-
readonly lastKnownSeqNumber: number;
|
|
251
|
-
readonly lastMessage: ISequencedDocumentMessage | undefined;
|
|
252
|
-
readonly lastSequenceNumber: number;
|
|
253
|
-
readonly maxMessageSize: number;
|
|
254
|
-
readonly minimumSequenceNumber: number;
|
|
255
|
-
readonly outbound: IDeltaQueue<U[]>;
|
|
256
|
-
// (undocumented)
|
|
257
|
-
readonly readOnlyInfo: ReadOnlyInfo;
|
|
258
|
-
readonly serviceConfiguration: IClientConfiguration | undefined;
|
|
259
|
-
submitSignal(content: any): void;
|
|
260
|
-
readonly version: string;
|
|
261
|
-
}
|
|
262
|
-
|
|
263
|
-
// @public
|
|
264
|
-
export interface IDeltaManagerEvents extends IEvent {
|
|
265
|
-
// (undocumented)
|
|
266
|
-
(event: "prepareSend", listener: (messageBuffer: any[]) => void): any;
|
|
267
|
-
// (undocumented)
|
|
268
|
-
(event: "submitOp", listener: (message: IDocumentMessage) => void): any;
|
|
269
|
-
// (undocumented)
|
|
270
|
-
(event: "op", listener: (message: ISequencedDocumentMessage, processingTime: number) => void): any;
|
|
271
|
-
// (undocumented)
|
|
272
|
-
(event: "allSentOpsAckd", listener: () => void): any;
|
|
273
|
-
// (undocumented)
|
|
274
|
-
(event: "pong" | "processTime", listener: (latency: number) => void): any;
|
|
275
|
-
(event: "connect", listener: (details: IConnectionDetails, opsBehind?: number) => void): any;
|
|
276
|
-
// (undocumented)
|
|
277
|
-
(event: "disconnect", listener: (reason: string) => void): any;
|
|
278
|
-
// (undocumented)
|
|
279
|
-
(event: "readonly", listener: (readonly: boolean) => void): any;
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
// @public
|
|
283
|
-
export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
|
|
284
|
-
idle: boolean;
|
|
285
|
-
length: number;
|
|
286
|
-
pause(): Promise<void>;
|
|
287
|
-
paused: boolean;
|
|
288
|
-
peek(): T | undefined;
|
|
289
|
-
resume(): void;
|
|
290
|
-
toArray(): T[];
|
|
291
|
-
// (undocumented)
|
|
292
|
-
waitTillProcessingDone(): Promise<void>;
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
// @public
|
|
296
|
-
export interface IDeltaQueueEvents<T> extends IErrorEvent {
|
|
297
|
-
// (undocumented)
|
|
298
|
-
(event: "push" | "op", listener: (task: T) => void): any;
|
|
299
|
-
// (undocumented)
|
|
300
|
-
(event: "idle", listener: (count: number, duration: number) => void): any;
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
// @public @deprecated (undocumented)
|
|
304
|
-
export const IDeltaSender: keyof IProvideDeltaSender;
|
|
305
|
-
|
|
306
|
-
// @public
|
|
307
|
-
export interface IDeltaSender extends IProvideDeltaSender {
|
|
308
|
-
flush(): void;
|
|
309
|
-
}
|
|
310
|
-
|
|
311
|
-
// @public
|
|
312
|
-
export interface IErrorBase extends Partial<Error> {
|
|
313
|
-
readonly errorType: string;
|
|
314
|
-
getTelemetryProperties?(): ITelemetryProperties;
|
|
315
|
-
readonly message: string;
|
|
316
|
-
readonly name?: string;
|
|
317
|
-
readonly stack?: string;
|
|
318
|
-
}
|
|
319
|
-
|
|
320
|
-
// @public
|
|
321
|
-
export interface IFluidBrowserPackage extends IFluidPackage {
|
|
322
|
-
// (undocumented)
|
|
323
|
-
fluid: {
|
|
324
|
-
browser: IFluidBrowserPackageEnvironment;
|
|
325
|
-
[environment: string]: IFluidPackageEnvironment;
|
|
326
|
-
};
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
// @public
|
|
330
|
-
export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
|
|
331
|
-
umd: {
|
|
332
|
-
files: string[];
|
|
333
|
-
library: string;
|
|
334
|
-
};
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
// @public
|
|
338
|
-
export interface IFluidCodeDetails {
|
|
339
|
-
readonly config?: IFluidCodeDetailsConfig;
|
|
340
|
-
readonly package: string | Readonly<IFluidPackage>;
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
// @public (undocumented)
|
|
344
|
-
export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
|
|
345
|
-
|
|
346
|
-
// @public
|
|
347
|
-
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
348
|
-
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
349
|
-
satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
// @public
|
|
353
|
-
export interface IFluidCodeDetailsConfig {
|
|
354
|
-
// (undocumented)
|
|
355
|
-
readonly [key: string]: string;
|
|
356
|
-
}
|
|
357
|
-
|
|
358
|
-
// @public
|
|
359
|
-
export interface IFluidCodeResolver {
|
|
360
|
-
resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
// @public (undocumented)
|
|
364
|
-
export interface IFluidModule {
|
|
365
|
-
// (undocumented)
|
|
366
|
-
fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
// @public
|
|
370
|
-
export interface IFluidModuleWithDetails {
|
|
371
|
-
details: IFluidCodeDetails;
|
|
372
|
-
module: IFluidModule;
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
// @public
|
|
376
|
-
export interface IFluidPackage {
|
|
377
|
-
[key: string]: unknown;
|
|
378
|
-
fluid: {
|
|
379
|
-
[environment: string]: undefined | IFluidPackageEnvironment;
|
|
380
|
-
};
|
|
381
|
-
name: string;
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
// @public
|
|
385
|
-
export interface IFluidPackageEnvironment {
|
|
386
|
-
[target: string]: undefined | {
|
|
387
|
-
files: string[];
|
|
388
|
-
[key: string]: unknown;
|
|
389
|
-
};
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
// @public @deprecated (undocumented)
|
|
393
|
-
export const IFluidTokenProvider: keyof IProvideFluidTokenProvider;
|
|
394
|
-
|
|
395
|
-
// @public @deprecated (undocumented)
|
|
396
|
-
export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
|
|
397
|
-
// (undocumented)
|
|
398
|
-
intelligence: {
|
|
399
|
-
[service: string]: any;
|
|
400
|
-
};
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
// @public
|
|
404
|
-
export interface IGenericError extends IErrorBase {
|
|
405
|
-
// (undocumented)
|
|
406
|
-
error?: any;
|
|
407
|
-
// (undocumented)
|
|
408
|
-
readonly errorType: ContainerErrorType.genericError;
|
|
409
|
-
}
|
|
410
|
-
|
|
411
|
-
// @public
|
|
412
|
-
export interface IHostLoader extends ILoader {
|
|
413
|
-
createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;
|
|
414
|
-
rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;
|
|
415
|
-
}
|
|
416
|
-
|
|
417
|
-
// @public
|
|
418
|
-
export interface ILoader extends IFluidRouter, Partial<IProvideLoader> {
|
|
419
|
-
resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
// @public
|
|
423
|
-
export interface ILoaderHeader {
|
|
424
|
-
// (undocumented)
|
|
425
|
-
[LoaderHeader.cache]: boolean;
|
|
426
|
-
// (undocumented)
|
|
427
|
-
[LoaderHeader.clientDetails]: IClientDetails;
|
|
428
|
-
// (undocumented)
|
|
429
|
-
[LoaderHeader.reconnect]: boolean;
|
|
430
|
-
// (undocumented)
|
|
431
|
-
[LoaderHeader.sequenceNumber]: number;
|
|
432
|
-
// (undocumented)
|
|
433
|
-
[LoaderHeader.loadMode]: IContainerLoadMode;
|
|
434
|
-
// (undocumented)
|
|
435
|
-
[LoaderHeader.version]: string | undefined;
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
// @public (undocumented)
|
|
439
|
-
export type ILoaderOptions = {
|
|
440
|
-
[key in string | number]: any;
|
|
441
|
-
} & {
|
|
442
|
-
cache?: boolean;
|
|
443
|
-
provideScopeLoader?: boolean;
|
|
444
|
-
noopTimeFrequency?: number;
|
|
445
|
-
noopCountFrequency?: number;
|
|
446
|
-
maxClientLeaveWaitTime?: number;
|
|
447
|
-
};
|
|
448
|
-
|
|
449
|
-
// @public @deprecated (undocumented)
|
|
450
|
-
export interface IPendingLocalState {
|
|
451
|
-
// (undocumented)
|
|
452
|
-
pendingRuntimeState: unknown;
|
|
453
|
-
// (undocumented)
|
|
454
|
-
url: string;
|
|
455
|
-
}
|
|
456
|
-
|
|
457
|
-
// @public @deprecated (undocumented)
|
|
458
|
-
export interface IProvideDeltaSender {
|
|
459
|
-
// @deprecated (undocumented)
|
|
460
|
-
readonly IDeltaSender: IDeltaSender;
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
// @public (undocumented)
|
|
464
|
-
export interface IProvideFluidCodeDetailsComparer {
|
|
465
|
-
// (undocumented)
|
|
466
|
-
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
467
|
-
}
|
|
468
|
-
|
|
469
|
-
// @public @deprecated (undocumented)
|
|
470
|
-
export interface IProvideFluidTokenProvider {
|
|
471
|
-
// (undocumented)
|
|
472
|
-
readonly IFluidTokenProvider: IFluidTokenProvider;
|
|
473
|
-
}
|
|
474
|
-
|
|
475
|
-
// @public (undocumented)
|
|
476
|
-
export interface IProvideLoader {
|
|
477
|
-
// (undocumented)
|
|
478
|
-
readonly ILoader: ILoader;
|
|
479
|
-
}
|
|
480
|
-
|
|
481
|
-
// @public (undocumented)
|
|
482
|
-
export interface IProvideRuntimeFactory {
|
|
483
|
-
// (undocumented)
|
|
484
|
-
readonly IRuntimeFactory: IRuntimeFactory;
|
|
485
|
-
}
|
|
486
|
-
|
|
487
|
-
// @public @deprecated
|
|
488
|
-
export interface IProxyLoaderFactory {
|
|
489
|
-
// @deprecated
|
|
490
|
-
createProxyLoader(id: string, options: ILoaderOptions, resolved: IFluidResolvedUrl, fromSequenceNumber: number): Promise<ILoader>;
|
|
491
|
-
// @deprecated
|
|
492
|
-
environment: string;
|
|
493
|
-
}
|
|
494
|
-
|
|
495
|
-
// @public
|
|
496
|
-
export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
|
|
497
|
-
readonly resolvedPackage: Readonly<IFluidPackage>;
|
|
498
|
-
readonly resolvedPackageCacheId: string | undefined;
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
// @public
|
|
502
|
-
export interface IRuntime extends IDisposable {
|
|
503
|
-
createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
|
|
504
|
-
getPendingLocalState(): unknown;
|
|
505
|
-
notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
|
|
506
|
-
process(message: ISequencedDocumentMessage, local: boolean, context: any): any;
|
|
507
|
-
processSignal(message: any, local: boolean): any;
|
|
508
|
-
request(request: IRequest): Promise<IResponse>;
|
|
509
|
-
setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
|
|
510
|
-
setConnectionState(connected: boolean, clientId?: string): any;
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
// @public (undocumented)
|
|
514
|
-
export const IRuntimeFactory: keyof IProvideRuntimeFactory;
|
|
515
|
-
|
|
516
|
-
// @public
|
|
517
|
-
export interface IRuntimeFactory extends IProvideRuntimeFactory {
|
|
518
|
-
instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;
|
|
519
|
-
}
|
|
520
|
-
|
|
521
|
-
// @public
|
|
522
|
-
export const isFluidBrowserPackage: (maybePkg: any) => maybePkg is Readonly<IFluidBrowserPackage>;
|
|
523
|
-
|
|
524
|
-
// @public (undocumented)
|
|
525
|
-
export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
526
|
-
|
|
527
|
-
// @public
|
|
528
|
-
export const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
529
|
-
|
|
530
|
-
// @public
|
|
531
|
-
export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
|
|
532
|
-
// (undocumented)
|
|
533
|
-
blobsContents: {
|
|
534
|
-
[path: string]: ArrayBufferLike;
|
|
535
|
-
};
|
|
536
|
-
// (undocumented)
|
|
537
|
-
trees: {
|
|
538
|
-
[path: string]: ISnapshotTreeWithBlobContents;
|
|
539
|
-
};
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
// @public
|
|
543
|
-
export interface IThrottlingWarning extends IErrorBase {
|
|
544
|
-
// (undocumented)
|
|
545
|
-
readonly errorType: ContainerErrorType.throttlingError;
|
|
546
|
-
// (undocumented)
|
|
547
|
-
readonly retryAfterSeconds: number;
|
|
548
|
-
}
|
|
549
|
-
|
|
550
|
-
// @public
|
|
551
|
-
export interface IUsageError extends IErrorBase {
|
|
552
|
-
// (undocumented)
|
|
553
|
-
readonly errorType: ContainerErrorType.usageError;
|
|
554
|
-
}
|
|
555
|
-
|
|
556
|
-
// @public
|
|
557
|
-
export enum LoaderHeader {
|
|
558
|
-
cache = "fluid-cache",
|
|
559
|
-
// (undocumented)
|
|
560
|
-
clientDetails = "fluid-client-details",
|
|
561
|
-
loadMode = "loadMode",
|
|
562
|
-
// (undocumented)
|
|
563
|
-
reconnect = "fluid-reconnect",
|
|
564
|
-
// (undocumented)
|
|
565
|
-
sequenceNumber = "fluid-sequence-number",
|
|
566
|
-
version = "version"
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
// @public (undocumented)
|
|
570
|
-
export type ReadOnlyInfo = {
|
|
571
|
-
readonly readonly: false | undefined;
|
|
572
|
-
} | {
|
|
573
|
-
readonly readonly: true;
|
|
574
|
-
readonly forced: boolean;
|
|
575
|
-
readonly permissions: boolean | undefined;
|
|
576
|
-
readonly storageOnly: boolean;
|
|
577
|
-
};
|
|
578
|
-
|
|
579
|
-
// (No @packageDocumentation comment for this package)
|
|
580
|
-
|
|
581
|
-
```
|
package/dist/legacy/index.d.ts
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { IRuntimeFactory } from "../runtime";
|
|
6
|
-
/**
|
|
7
|
-
* @deprecated - This will be removed in a later release.
|
|
8
|
-
*/
|
|
9
|
-
export declare const IFluidTokenProvider: keyof IProvideFluidTokenProvider;
|
|
10
|
-
/**
|
|
11
|
-
* @deprecated - This will be removed in a later release.
|
|
12
|
-
*/
|
|
13
|
-
export interface IProvideFluidTokenProvider {
|
|
14
|
-
readonly IFluidTokenProvider: IFluidTokenProvider;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @deprecated - This will be removed in a later release.
|
|
18
|
-
*/
|
|
19
|
-
export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
|
|
20
|
-
intelligence: {
|
|
21
|
-
[service: string]: any;
|
|
22
|
-
};
|
|
23
|
-
}
|
|
24
|
-
declare module "@fluidframework/core-interfaces" {
|
|
25
|
-
interface IFluidObject {
|
|
26
|
-
/** @deprecated - use `FluidObject<IRuntimeFactory>` instead */
|
|
27
|
-
readonly IRuntimeFactory?: IRuntimeFactory;
|
|
28
|
-
/** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */
|
|
29
|
-
readonly IFluidTokenProvider?: IFluidTokenProvider;
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/legacy/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAC7C;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAC7C,UAAiB,YAAY;QACzB,+DAA+D;QAC/D,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;QAC3C,mEAAmE;QACnE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;KACtD;CACJ"}
|
package/dist/legacy/index.js
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*!
|
|
3
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
4
|
-
* Licensed under the MIT License.
|
|
5
|
-
*/
|
|
6
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.IFluidTokenProvider = void 0;
|
|
8
|
-
/**
|
|
9
|
-
* @deprecated - This will be removed in a later release.
|
|
10
|
-
*/
|
|
11
|
-
exports.IFluidTokenProvider = "IFluidTokenProvider";
|
|
12
|
-
//# sourceMappingURL=index.js.map
|
package/dist/legacy/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/legacy/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRuntimeFactory } from \"../runtime\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const IFluidTokenProvider: keyof IProvideFluidTokenProvider = \"IFluidTokenProvider\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideFluidTokenProvider {\n readonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n intelligence: { [service: string]: any; };\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n export interface IFluidObject {\n /** @deprecated - use `FluidObject<IRuntimeFactory>` instead */\n readonly IRuntimeFactory?: IRuntimeFactory;\n /** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */\n readonly IFluidTokenProvider?: IFluidTokenProvider;\n }\n}\n"]}
|
package/dist/proxyLoader.d.ts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
|
|
6
|
-
import { ILoader, ILoaderOptions } from "./loader";
|
|
7
|
-
/**
|
|
8
|
-
* Abstraction layer to support different Loaders in different Node execution contexts
|
|
9
|
-
* @deprecated Not recommended for general use and will be removed in an upcoming release.
|
|
10
|
-
*/
|
|
11
|
-
export interface IProxyLoaderFactory {
|
|
12
|
-
/**
|
|
13
|
-
* Loader environment
|
|
14
|
-
* @deprecated Not recommended for general use and will be removed in an upcoming release.
|
|
15
|
-
*/
|
|
16
|
-
environment: string;
|
|
17
|
-
/**
|
|
18
|
-
* Returns an instance of ILoader loaded inside an execution context.
|
|
19
|
-
* @deprecated Not recommended for general use and will be removed in an upcoming release.
|
|
20
|
-
*/
|
|
21
|
-
createProxyLoader(id: string, options: ILoaderOptions, resolved: IFluidResolvedUrl, fromSequenceNumber: number): Promise<ILoader>;
|
|
22
|
-
}
|
|
23
|
-
//# sourceMappingURL=proxyLoader.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"proxyLoader.d.ts","sourceRoot":"","sources":["../src/proxyLoader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CACb,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,EACvB,QAAQ,EAAE,iBAAiB,EAC3B,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACrD"}
|
package/dist/proxyLoader.js
DELETED
package/dist/proxyLoader.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"proxyLoader.js","sourceRoot":"","sources":["../src/proxyLoader.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { ILoader, ILoaderOptions } from \"./loader\";\n\n/**\n * Abstraction layer to support different Loaders in different Node execution contexts\n * @deprecated Not recommended for general use and will be removed in an upcoming release.\n */\nexport interface IProxyLoaderFactory {\n /**\n * Loader environment\n * @deprecated Not recommended for general use and will be removed in an upcoming release.\n */\n environment: string;\n\n /**\n * Returns an instance of ILoader loaded inside an execution context.\n * @deprecated Not recommended for general use and will be removed in an upcoming release.\n */\n createProxyLoader(\n id: string,\n options: ILoaderOptions,\n resolved: IFluidResolvedUrl,\n fromSequenceNumber: number): Promise<ILoader>;\n}\n"]}
|