@fluidframework/driver-utils 2.0.0-internal.7.0.1 → 2.0.0-internal.7.1.1
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 +4 -0
- package/api-extractor.json +12 -1
- package/api-report/driver-utils.api.md +393 -0
- package/dist/adapters/compression/documentServiceCompressionAdapter.d.ts.map +1 -1
- package/dist/adapters/compression/documentServiceCompressionAdapter.js.map +1 -1
- package/dist/blob.d.ts.map +1 -1
- package/dist/blob.js.map +1 -1
- package/dist/driver-utils-alpha.d.ts +467 -0
- package/dist/driver-utils-beta.d.ts +467 -0
- package/dist/driver-utils-public.d.ts +467 -0
- package/dist/driver-utils.d.ts +481 -0
- package/dist/network.d.ts.map +1 -1
- package/dist/network.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/adapters/compression/documentServiceCompressionAdapter.d.ts.map +1 -1
- package/lib/adapters/compression/documentServiceCompressionAdapter.js.map +1 -1
- package/lib/blob.d.ts.map +1 -1
- package/lib/blob.js.map +1 -1
- package/lib/network.d.ts.map +1 -1
- package/lib/network.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/package.json +16 -16
- package/src/adapters/compression/documentServiceCompressionAdapter.ts +4 -1
- package/src/blob.ts +8 -2
- package/src/network.ts +15 -3
- package/src/packageVersion.ts +1 -1
package/CHANGELOG.md
CHANGED
package/api-extractor.json
CHANGED
|
@@ -1,4 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "@fluidframework/build-common/api-extractor-
|
|
3
|
+
"extends": "@fluidframework/build-common/api-extractor-base.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
// TODO: Fix violations and remove this rule override
|
|
6
|
+
"extractorMessageReporting": {
|
|
7
|
+
"ae-missing-release-tag": {
|
|
8
|
+
"logLevel": "none"
|
|
9
|
+
},
|
|
10
|
+
"ae-forgotten-export": {
|
|
11
|
+
"logLevel": "none"
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
}
|
|
4
15
|
}
|
|
@@ -0,0 +1,393 @@
|
|
|
1
|
+
## API Report File for "@fluidframework/driver-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { FetchSource } from '@fluidframework/driver-definitions';
|
|
8
|
+
import { IAttachment } from '@fluidframework/protocol-definitions';
|
|
9
|
+
import { IAuthorizationError } from '@fluidframework/driver-definitions';
|
|
10
|
+
import { IBlob } from '@fluidframework/protocol-definitions';
|
|
11
|
+
import { ICommittedProposal } from '@fluidframework/protocol-definitions';
|
|
12
|
+
import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
|
|
13
|
+
import { IDeltasFetchResult } from '@fluidframework/driver-definitions';
|
|
14
|
+
import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
|
|
15
|
+
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
16
|
+
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
17
|
+
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
18
|
+
import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
|
|
19
|
+
import { IDriverErrorBase } from '@fluidframework/driver-definitions';
|
|
20
|
+
import { IFluidErrorBase } from '@fluidframework/telemetry-utils';
|
|
21
|
+
import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
|
|
22
|
+
import { IRequest } from '@fluidframework/core-interfaces';
|
|
23
|
+
import { IResolvedUrl } from '@fluidframework/driver-definitions';
|
|
24
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
25
|
+
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
26
|
+
import { IStream } from '@fluidframework/driver-definitions';
|
|
27
|
+
import { IStreamResult } from '@fluidframework/driver-definitions';
|
|
28
|
+
import { ISummaryContext } from '@fluidframework/driver-definitions';
|
|
29
|
+
import { ISummaryHandle } from '@fluidframework/protocol-definitions';
|
|
30
|
+
import { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
31
|
+
import { ITelemetryErrorEvent } from '@fluidframework/core-interfaces';
|
|
32
|
+
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
|
|
33
|
+
import { ITelemetryProperties } from '@fluidframework/core-interfaces';
|
|
34
|
+
import { IThrottlingWarning } from '@fluidframework/driver-definitions';
|
|
35
|
+
import { ITree } from '@fluidframework/protocol-definitions';
|
|
36
|
+
import { ITreeEntry } from '@fluidframework/protocol-definitions';
|
|
37
|
+
import { IUrlResolver } from '@fluidframework/driver-definitions';
|
|
38
|
+
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
39
|
+
import { LoaderCachingPolicy } from '@fluidframework/driver-definitions';
|
|
40
|
+
import { LoggingError } from '@fluidframework/telemetry-utils';
|
|
41
|
+
|
|
42
|
+
// @public
|
|
43
|
+
export function applyStorageCompression(documentServiceFactory: IDocumentServiceFactory, config?: ICompressionStorageConfig | boolean): IDocumentServiceFactory;
|
|
44
|
+
|
|
45
|
+
// @public
|
|
46
|
+
export class AttachmentTreeEntry {
|
|
47
|
+
constructor(path: string, id: string);
|
|
48
|
+
// (undocumented)
|
|
49
|
+
readonly id: string;
|
|
50
|
+
// (undocumented)
|
|
51
|
+
readonly mode = FileMode.File;
|
|
52
|
+
// (undocumented)
|
|
53
|
+
readonly path: string;
|
|
54
|
+
// (undocumented)
|
|
55
|
+
readonly type = TreeEntry.Attachment;
|
|
56
|
+
// (undocumented)
|
|
57
|
+
readonly value: IAttachment;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// @public (undocumented)
|
|
61
|
+
export class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {
|
|
62
|
+
constructor(message: string, claims: string | undefined, tenantId: string | undefined, props: DriverErrorTelemetryProps);
|
|
63
|
+
// (undocumented)
|
|
64
|
+
readonly canRetry = false;
|
|
65
|
+
// (undocumented)
|
|
66
|
+
readonly claims: string | undefined;
|
|
67
|
+
// (undocumented)
|
|
68
|
+
readonly errorType = DriverErrorType.authorizationError;
|
|
69
|
+
// (undocumented)
|
|
70
|
+
readonly tenantId: string | undefined;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// @public (undocumented)
|
|
74
|
+
export const blobHeadersBlobName = ".metadata.blobHeaders";
|
|
75
|
+
|
|
76
|
+
// @public
|
|
77
|
+
export class BlobTreeEntry {
|
|
78
|
+
constructor(path: string, contents: string, encoding?: "utf-8" | "base64");
|
|
79
|
+
// (undocumented)
|
|
80
|
+
readonly mode = FileMode.File;
|
|
81
|
+
// (undocumented)
|
|
82
|
+
readonly path: string;
|
|
83
|
+
// (undocumented)
|
|
84
|
+
readonly type = TreeEntry.Blob;
|
|
85
|
+
// (undocumented)
|
|
86
|
+
readonly value: IBlob;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// @public
|
|
90
|
+
export function buildSnapshotTree(entries: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): ISnapshotTree;
|
|
91
|
+
|
|
92
|
+
// @public
|
|
93
|
+
export function calculateMaxWaitTime(error: unknown): number;
|
|
94
|
+
|
|
95
|
+
// @public (undocumented)
|
|
96
|
+
export function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
|
|
97
|
+
|
|
98
|
+
// @public
|
|
99
|
+
export const canRetryOnError: (error: any) => boolean;
|
|
100
|
+
|
|
101
|
+
// @internal
|
|
102
|
+
export interface CombinedAppAndProtocolSummary extends ISummaryTree {
|
|
103
|
+
// (undocumented)
|
|
104
|
+
tree: {
|
|
105
|
+
[".app"]: ISummaryTree;
|
|
106
|
+
[".protocol"]: ISummaryTree;
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// @public
|
|
111
|
+
export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree;
|
|
112
|
+
|
|
113
|
+
// @public (undocumented)
|
|
114
|
+
export function createGenericNetworkError(message: string, retryInfo: {
|
|
115
|
+
canRetry: boolean;
|
|
116
|
+
retryAfterMs?: number;
|
|
117
|
+
}, props: DriverErrorTelemetryProps): ThrottlingError | GenericNetworkError;
|
|
118
|
+
|
|
119
|
+
// @public (undocumented)
|
|
120
|
+
export const createWriteError: (message: string, props: DriverErrorTelemetryProps) => NonRetryableError<"writeError">;
|
|
121
|
+
|
|
122
|
+
// @public (undocumented)
|
|
123
|
+
export class DeltaStreamConnectionForbiddenError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
|
|
124
|
+
constructor(message: string, props: DriverErrorTelemetryProps, storageOnlyReason?: string);
|
|
125
|
+
// (undocumented)
|
|
126
|
+
readonly canRetry = false;
|
|
127
|
+
// (undocumented)
|
|
128
|
+
static readonly errorType = DriverErrorType.deltaStreamConnectionForbidden;
|
|
129
|
+
// (undocumented)
|
|
130
|
+
readonly errorType = DriverErrorType.deltaStreamConnectionForbidden;
|
|
131
|
+
// (undocumented)
|
|
132
|
+
readonly storageOnlyReason: string | undefined;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
// @public (undocumented)
|
|
136
|
+
export class DocumentStorageServiceProxy implements IDocumentStorageService {
|
|
137
|
+
constructor(internalStorageService: IDocumentStorageService);
|
|
138
|
+
// (undocumented)
|
|
139
|
+
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
140
|
+
// (undocumented)
|
|
141
|
+
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
142
|
+
// (undocumented)
|
|
143
|
+
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
144
|
+
// (undocumented)
|
|
145
|
+
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
146
|
+
// (undocumented)
|
|
147
|
+
protected readonly internalStorageService: IDocumentStorageService;
|
|
148
|
+
set policies(policies: IDocumentStorageServicePolicies | undefined);
|
|
149
|
+
// (undocumented)
|
|
150
|
+
get policies(): IDocumentStorageServicePolicies | undefined;
|
|
151
|
+
// (undocumented)
|
|
152
|
+
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
153
|
+
// (undocumented)
|
|
154
|
+
get repositoryUrl(): string;
|
|
155
|
+
// (undocumented)
|
|
156
|
+
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// @public
|
|
160
|
+
export type DriverErrorTelemetryProps = ITelemetryProperties & {
|
|
161
|
+
driverVersion: string | undefined;
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
// @public (undocumented)
|
|
165
|
+
export const emptyMessageStream: IStream<ISequencedDocumentMessage[]>;
|
|
166
|
+
|
|
167
|
+
// @public
|
|
168
|
+
export class FluidInvalidSchemaError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
|
|
169
|
+
constructor(message: string, props: DriverErrorTelemetryProps);
|
|
170
|
+
// (undocumented)
|
|
171
|
+
readonly canRetry = false;
|
|
172
|
+
// (undocumented)
|
|
173
|
+
readonly errorType = DriverErrorType.fluidInvalidSchema;
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
// @public
|
|
177
|
+
export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
|
|
178
|
+
constructor(message: string, canRetry: boolean, props: DriverErrorTelemetryProps);
|
|
179
|
+
// (undocumented)
|
|
180
|
+
readonly canRetry: boolean;
|
|
181
|
+
// (undocumented)
|
|
182
|
+
readonly errorType = DriverErrorType.genericNetworkError;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
// @public
|
|
186
|
+
export function getDocAttributesFromProtocolSummary(protocolSummary: ISummaryTree): IDocumentAttributes;
|
|
187
|
+
|
|
188
|
+
// @public
|
|
189
|
+
export function getQuorumValuesFromProtocolSummary(protocolSummary: ISummaryTree): [string, ICommittedProposal][];
|
|
190
|
+
|
|
191
|
+
// @public
|
|
192
|
+
export const getRetryDelayFromError: (error: any) => number | undefined;
|
|
193
|
+
|
|
194
|
+
// @public
|
|
195
|
+
export const getRetryDelaySecondsFromError: (error: any) => number | undefined;
|
|
196
|
+
|
|
197
|
+
// @public (undocumented)
|
|
198
|
+
export interface ICompressionStorageConfig {
|
|
199
|
+
// (undocumented)
|
|
200
|
+
algorithm: SummaryCompressionAlgorithm;
|
|
201
|
+
// (undocumented)
|
|
202
|
+
minSizeToCompress: number;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// @public
|
|
206
|
+
export class InsecureUrlResolver implements IUrlResolver {
|
|
207
|
+
constructor(hostUrl: string, ordererUrl: string, storageUrl: string, tenantId: string, bearer: string, isForNodeTest?: boolean);
|
|
208
|
+
// (undocumented)
|
|
209
|
+
createCreateNewRequest(fileName?: string): IRequest;
|
|
210
|
+
// (undocumented)
|
|
211
|
+
getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
|
|
212
|
+
// (undocumented)
|
|
213
|
+
resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// @public
|
|
217
|
+
export interface IProgress {
|
|
218
|
+
cancel?: AbortSignal;
|
|
219
|
+
onRetry?(delayInMs: number, error: any): void;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
// @internal
|
|
223
|
+
export function isCombinedAppAndProtocolSummary(summary: ISummaryTree | undefined): summary is CombinedAppAndProtocolSummary;
|
|
224
|
+
|
|
225
|
+
// @public (undocumented)
|
|
226
|
+
export function isOnline(): OnlineStatus;
|
|
227
|
+
|
|
228
|
+
// @public
|
|
229
|
+
export function isRuntimeMessage(message: {
|
|
230
|
+
type: string;
|
|
231
|
+
}): boolean;
|
|
232
|
+
|
|
233
|
+
// @public (undocumented)
|
|
234
|
+
export class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {
|
|
235
|
+
constructor(message: string, redirectUrl: IResolvedUrl, props: DriverErrorTelemetryProps);
|
|
236
|
+
// (undocumented)
|
|
237
|
+
readonly canRetry = false;
|
|
238
|
+
// (undocumented)
|
|
239
|
+
readonly errorType = DriverErrorType.locationRedirection;
|
|
240
|
+
// (undocumented)
|
|
241
|
+
readonly redirectUrl: IResolvedUrl;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
// @public (undocumented)
|
|
245
|
+
export function logNetworkFailure(logger: ITelemetryLoggerExt, event: ITelemetryErrorEvent, error?: any): void;
|
|
246
|
+
|
|
247
|
+
// @public (undocumented)
|
|
248
|
+
export enum MessageType2 {
|
|
249
|
+
// (undocumented)
|
|
250
|
+
Accept = "accept"
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
// @public (undocumented)
|
|
254
|
+
export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
|
|
255
|
+
constructor(message: string, errorType: T, canRetry: boolean, props: DriverErrorTelemetryProps);
|
|
256
|
+
// (undocumented)
|
|
257
|
+
readonly canRetry: boolean;
|
|
258
|
+
// (undocumented)
|
|
259
|
+
readonly errorType: T;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
// @public (undocumented)
|
|
263
|
+
export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
|
|
264
|
+
constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
|
|
265
|
+
// (undocumented)
|
|
266
|
+
readonly errorType: T;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
// @public (undocumented)
|
|
270
|
+
export enum OnlineStatus {
|
|
271
|
+
// (undocumented)
|
|
272
|
+
Offline = 0,
|
|
273
|
+
// (undocumented)
|
|
274
|
+
Online = 1,
|
|
275
|
+
// (undocumented)
|
|
276
|
+
Unknown = 2
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
// @public
|
|
280
|
+
export class ParallelRequests<T> {
|
|
281
|
+
constructor(from: number, to: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, requestCallback: (request: number, from: number, to: number, strongTo: boolean, props: ITelemetryProperties) => Promise<{
|
|
282
|
+
partial: boolean;
|
|
283
|
+
cancel: boolean;
|
|
284
|
+
payload: T[];
|
|
285
|
+
}>, responseCallback: (payload: T[]) => void);
|
|
286
|
+
// (undocumented)
|
|
287
|
+
cancel(): void;
|
|
288
|
+
// (undocumented)
|
|
289
|
+
get canceled(): boolean;
|
|
290
|
+
// (undocumented)
|
|
291
|
+
run(concurrency: number): Promise<void>;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
// @public (undocumented)
|
|
295
|
+
export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy {
|
|
296
|
+
// (undocumented)
|
|
297
|
+
getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
|
|
298
|
+
// (undocumented)
|
|
299
|
+
get policies(): {
|
|
300
|
+
caching: LoaderCachingPolicy;
|
|
301
|
+
maximumCacheDurationMs?: 432000000 | undefined;
|
|
302
|
+
} | undefined;
|
|
303
|
+
// (undocumented)
|
|
304
|
+
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
305
|
+
// (undocumented)
|
|
306
|
+
stopPrefetch(): void;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
// @public
|
|
310
|
+
export class Queue<T> implements IStream<T> {
|
|
311
|
+
// (undocumented)
|
|
312
|
+
protected pushCore(value: Promise<IStreamResult<T>>): void;
|
|
313
|
+
// (undocumented)
|
|
314
|
+
pushDone(): void;
|
|
315
|
+
// (undocumented)
|
|
316
|
+
pushError(error: any): void;
|
|
317
|
+
// (undocumented)
|
|
318
|
+
pushValue(value: T): void;
|
|
319
|
+
// (undocumented)
|
|
320
|
+
read(): Promise<IStreamResult<T>>;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
// @public (undocumented)
|
|
324
|
+
export class RateLimiter {
|
|
325
|
+
constructor(maxRequests: number);
|
|
326
|
+
// (undocumented)
|
|
327
|
+
protected acquire(): Promise<void>;
|
|
328
|
+
// (undocumented)
|
|
329
|
+
protected readonly release: () => void;
|
|
330
|
+
// (undocumented)
|
|
331
|
+
schedule<T>(work: () => Promise<T>): Promise<T>;
|
|
332
|
+
// (undocumented)
|
|
333
|
+
get waitQueueLength(): number;
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
// @public
|
|
337
|
+
export function readAndParse<T>(storage: Pick<IDocumentStorageService, "readBlob">, id: string): Promise<T>;
|
|
338
|
+
|
|
339
|
+
// @public
|
|
340
|
+
export function requestOps(get: (from: number, to: number, telemetryProps: ITelemetryProperties) => Promise<IDeltasFetchResult>, concurrency: number, fromTotal: number, toTotal: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, signal?: AbortSignal, scenarioName?: string): IStream<ISequencedDocumentMessage[]>;
|
|
341
|
+
|
|
342
|
+
// @public (undocumented)
|
|
343
|
+
export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
|
|
344
|
+
constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
|
|
345
|
+
// (undocumented)
|
|
346
|
+
readonly errorType: T;
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
// @public (undocumented)
|
|
350
|
+
export function runWithRetry<T>(api: (cancel?: AbortSignal) => Promise<T>, fetchCallName: string, logger: ITelemetryLoggerExt, progress: IProgress): Promise<T>;
|
|
351
|
+
|
|
352
|
+
// @public (undocumented)
|
|
353
|
+
export function streamFromMessages(messagesArg: Promise<ISequencedDocumentMessage[]>): IStream<ISequencedDocumentMessage[]>;
|
|
354
|
+
|
|
355
|
+
// @public (undocumented)
|
|
356
|
+
export function streamObserver<T>(stream: IStream<T>, handler: (value: IStreamResult<T>) => void): IStream<T>;
|
|
357
|
+
|
|
358
|
+
// @public
|
|
359
|
+
export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
|
|
360
|
+
constructor(message: string, retryAfterSeconds: number, props: DriverErrorTelemetryProps);
|
|
361
|
+
// (undocumented)
|
|
362
|
+
readonly canRetry = true;
|
|
363
|
+
// (undocumented)
|
|
364
|
+
readonly errorType = DriverErrorType.throttlingError;
|
|
365
|
+
// (undocumented)
|
|
366
|
+
readonly retryAfterSeconds: number;
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// @public
|
|
370
|
+
export class TreeTreeEntry {
|
|
371
|
+
constructor(path: string, value: ITree);
|
|
372
|
+
// (undocumented)
|
|
373
|
+
readonly mode = FileMode.Directory;
|
|
374
|
+
// (undocumented)
|
|
375
|
+
readonly path: string;
|
|
376
|
+
// (undocumented)
|
|
377
|
+
readonly type = TreeEntry.Tree;
|
|
378
|
+
// (undocumented)
|
|
379
|
+
readonly value: ITree;
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
// @public
|
|
383
|
+
export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
|
|
384
|
+
constructor(message: string);
|
|
385
|
+
// (undocumented)
|
|
386
|
+
readonly canRetry = false;
|
|
387
|
+
// (undocumented)
|
|
388
|
+
readonly errorType = DriverErrorType.usageError;
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
// (No @packageDocumentation comment for this package)
|
|
392
|
+
|
|
393
|
+
```
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC/F,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,qBAAa,iCAAkC,SAAQ,oBAAoB;
|
|
1
|
+
{"version":3,"file":"documentServiceCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC/F,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,qBAAa,iCAAkC,SAAQ,oBAAoB;IAGzE,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADxB,OAAO,EAAE,gBAAgB,EACR,OAAO,EAAE,yBAAyB;IAKvC,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;CASjE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qEAAkE;AAClE,+CAAgI;AAGhI,MAAa,iCAAkC,SAAQ,2CAAoB;IAC1E,
|
|
1
|
+
{"version":3,"file":"documentServiceCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qEAAkE;AAClE,+CAAgI;AAGhI,MAAa,iCAAkC,SAAQ,2CAAoB;IAC1E,YACC,OAAyB,EACR,OAAkC;QAEnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,YAAO,GAAP,OAAO,CAA2B;IAGpD,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC5B,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,sDAAmD,CACtE,OAAO,EACP,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AAjBD,8EAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentService, IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { DocumentServiceProxy } from \"../../documentServiceProxy\";\nimport { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from \"./summaryblob\";\nimport { ICompressionStorageConfig } from \"./compressionTypes\";\n\nexport class DocumentServiceCompressionAdapter extends DocumentServiceProxy {\n\tconstructor(\n\t\tservice: IDocumentService,\n\t\tprivate readonly _config: ICompressionStorageConfig,\n\t) {\n\t\tsuper(service);\n\t}\n\n\tpublic async connectToStorage(): Promise<IDocumentStorageService> {\n\t\tconst storage = await super.connectToStorage();\n\t\tconst wrapped = new DocumentStorageServiceSummaryBlobCompressionAdapter(\n\t\t\tstorage,\n\t\t\tthis._config,\n\t\t);\n\t\tawait wrapped.getSnapshotTree();\n\t\treturn wrapped;\n\t}\n}\n"]}
|
package/dist/blob.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,QAAQ,EACR,KAAK,EACL,WAAW,EACX,KAAK,EACL,SAAS,EACT,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,qBAAa,aAAa;aAYR,IAAI,EAAE,MAAM;IAX7B,SAAgB,IAAI,iBAAiB;IACrC,SAAgB,IAAI,kBAAkB;IACtC,SAAgB,KAAK,EAAE,KAAK,CAAC;IAE7B;;;;;OAKG;gBAEc,IAAI,EAAE,MAAM,EAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,OAAO,GAAG,QAAkB;CAIvC;AAED;;GAEG;AACH,qBAAa,aAAa;
|
|
1
|
+
{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,QAAQ,EACR,KAAK,EACL,WAAW,EACX,KAAK,EACL,SAAS,EACT,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,qBAAa,aAAa;aAYR,IAAI,EAAE,MAAM;IAX7B,SAAgB,IAAI,iBAAiB;IACrC,SAAgB,IAAI,kBAAkB;IACtC,SAAgB,KAAK,EAAE,KAAK,CAAC;IAE7B;;;;;OAKG;gBAEc,IAAI,EAAE,MAAM,EAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,OAAO,GAAG,QAAkB;CAIvC;AAED;;GAEG;AACH,qBAAa,aAAa;aAUR,IAAI,EAAE,MAAM;aACZ,KAAK,EAAE,KAAK;IAV7B,SAAgB,IAAI,sBAAsB;IAC1C,SAAgB,IAAI,kBAAkB;IAEtC;;;;OAIG;gBAEc,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,KAAK;CAE7B;AAED;;GAEG;AACH,qBAAa,mBAAmB;aAWd,IAAI,EAAE,MAAM;aACZ,EAAE,EAAE,MAAM;IAX3B,SAAgB,IAAI,iBAAiB;IACrC,SAAgB,IAAI,wBAAwB;IAC5C,SAAgB,KAAK,EAAE,WAAW,CAAC;IAEnC;;;;OAIG;gBAEc,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM;CAI3B"}
|
package/dist/blob.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blob.js","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+EAM8C;AAE9C;;GAEG;AACH,MAAa,aAAa;IAKzB;;;;;OAKG;IACH,YACiB,IAAY,EAC5B,QAAgB,EAChB,WAA+B,OAAO;QAFtB,SAAI,GAAJ,IAAI,CAAQ;QAXb,SAAI,GAAG,+BAAQ,CAAC,IAAI,CAAC;QACrB,SAAI,GAAG,gCAAS,CAAC,IAAI,CAAC;QAcrC,IAAI,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrC,CAAC;CACD;AAlBD,sCAkBC;AAED;;GAEG;AACH,MAAa,aAAa;IAIzB;;;;OAIG;IACH,
|
|
1
|
+
{"version":3,"file":"blob.js","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+EAM8C;AAE9C;;GAEG;AACH,MAAa,aAAa;IAKzB;;;;;OAKG;IACH,YACiB,IAAY,EAC5B,QAAgB,EAChB,WAA+B,OAAO;QAFtB,SAAI,GAAJ,IAAI,CAAQ;QAXb,SAAI,GAAG,+BAAQ,CAAC,IAAI,CAAC;QACrB,SAAI,GAAG,gCAAS,CAAC,IAAI,CAAC;QAcrC,IAAI,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrC,CAAC;CACD;AAlBD,sCAkBC;AAED;;GAEG;AACH,MAAa,aAAa;IAIzB;;;;OAIG;IACH,YACiB,IAAY,EACZ,KAAY;QADZ,SAAI,GAAJ,IAAI,CAAQ;QACZ,UAAK,GAAL,KAAK,CAAO;QAVb,SAAI,GAAG,+BAAQ,CAAC,SAAS,CAAC;QAC1B,SAAI,GAAG,gCAAS,CAAC,IAAI,CAAC;IAUnC,CAAC;CACJ;AAbD,sCAaC;AAED;;GAEG;AACH,MAAa,mBAAmB;IAK/B;;;;OAIG;IACH,YACiB,IAAY,EACZ,EAAU;QADV,SAAI,GAAJ,IAAI,CAAQ;QACZ,OAAE,GAAF,EAAE,CAAQ;QAXX,SAAI,GAAG,+BAAQ,CAAC,IAAI,CAAC;QACrB,SAAI,GAAG,gCAAS,CAAC,UAAU,CAAC;QAY3C,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC;IACrB,CAAC;CACD;AAhBD,kDAgBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tFileMode,\n\tIBlob,\n\tIAttachment,\n\tITree,\n\tTreeEntry,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Basic implementation of a blob ITreeEntry\n */\nexport class BlobTreeEntry {\n\tpublic readonly mode = FileMode.File;\n\tpublic readonly type = TreeEntry.Blob;\n\tpublic readonly value: IBlob;\n\n\t/**\n\t * Creates a blob ITreeEntry\n\t * @param path - path of entry\n\t * @param contents - blob contents\n\t * @param encoding - encoding of contents; defaults to utf-8\n\t */\n\tconstructor(\n\t\tpublic readonly path: string,\n\t\tcontents: string,\n\t\tencoding: \"utf-8\" | \"base64\" = \"utf-8\",\n\t) {\n\t\tthis.value = { contents, encoding };\n\t}\n}\n\n/**\n * Basic implementation of a tree ITreeEntry\n */\nexport class TreeTreeEntry {\n\tpublic readonly mode = FileMode.Directory;\n\tpublic readonly type = TreeEntry.Tree;\n\n\t/**\n\t * Creates a tree ITreeEntry\n\t * @param path - path of entry\n\t * @param value - subtree\n\t */\n\tconstructor(\n\t\tpublic readonly path: string,\n\t\tpublic readonly value: ITree,\n\t) {}\n}\n\n/**\n * Basic implementation of an attachment ITreeEntry\n */\nexport class AttachmentTreeEntry {\n\tpublic readonly mode = FileMode.File;\n\tpublic readonly type = TreeEntry.Attachment;\n\tpublic readonly value: IAttachment;\n\n\t/**\n\t * Creates an attachment ITreeEntry\n\t * @param path - path of entry\n\t * @param id - id of external blob attachment\n\t */\n\tconstructor(\n\t\tpublic readonly path: string,\n\t\tpublic readonly id: string,\n\t) {\n\t\tthis.value = { id };\n\t}\n}\n"]}
|