@fluidframework/driver-definitions 2.53.1 → 2.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/{driver-definitions.legacy.alpha.api.md → driver-definitions.legacy.beta.api.md} +73 -73
  3. package/dist/driverError.d.ts +10 -20
  4. package/dist/driverError.d.ts.map +1 -1
  5. package/dist/driverError.js +1 -2
  6. package/dist/driverError.js.map +1 -1
  7. package/dist/git/resources.d.ts +2 -4
  8. package/dist/git/resources.d.ts.map +1 -1
  9. package/dist/git/resources.js.map +1 -1
  10. package/dist/protocol/clients.d.ts +1 -2
  11. package/dist/protocol/clients.d.ts.map +1 -1
  12. package/dist/protocol/clients.js.map +1 -1
  13. package/dist/protocol/config.d.ts +1 -2
  14. package/dist/protocol/config.d.ts.map +1 -1
  15. package/dist/protocol/config.js.map +1 -1
  16. package/dist/protocol/consensus.d.ts +7 -14
  17. package/dist/protocol/consensus.d.ts.map +1 -1
  18. package/dist/protocol/consensus.js.map +1 -1
  19. package/dist/protocol/date.d.ts +1 -2
  20. package/dist/protocol/date.d.ts.map +1 -1
  21. package/dist/protocol/date.js.map +1 -1
  22. package/dist/protocol/protocol.d.ts +15 -30
  23. package/dist/protocol/protocol.d.ts.map +1 -1
  24. package/dist/protocol/protocol.js +2 -4
  25. package/dist/protocol/protocol.js.map +1 -1
  26. package/dist/protocol/scopes.d.ts +1 -2
  27. package/dist/protocol/scopes.d.ts.map +1 -1
  28. package/dist/protocol/scopes.js +1 -2
  29. package/dist/protocol/scopes.js.map +1 -1
  30. package/dist/protocol/sockets.d.ts +2 -4
  31. package/dist/protocol/sockets.d.ts.map +1 -1
  32. package/dist/protocol/sockets.js.map +1 -1
  33. package/dist/protocol/storage.d.ts +10 -20
  34. package/dist/protocol/storage.d.ts.map +1 -1
  35. package/dist/protocol/storage.js +2 -4
  36. package/dist/protocol/storage.js.map +1 -1
  37. package/dist/protocol/summary.d.ts +1 -2
  38. package/dist/protocol/summary.d.ts.map +1 -1
  39. package/dist/protocol/summary.js.map +1 -1
  40. package/dist/protocol/tokens.d.ts +1 -2
  41. package/dist/protocol/tokens.d.ts.map +1 -1
  42. package/dist/protocol/tokens.js.map +1 -1
  43. package/dist/storage.d.ts +17 -34
  44. package/dist/storage.d.ts.map +1 -1
  45. package/dist/storage.js +2 -4
  46. package/dist/storage.js.map +1 -1
  47. package/dist/urlResolver.d.ts +5 -10
  48. package/dist/urlResolver.d.ts.map +1 -1
  49. package/dist/urlResolver.js +1 -2
  50. package/dist/urlResolver.js.map +1 -1
  51. package/lib/driverError.d.ts +10 -20
  52. package/lib/driverError.d.ts.map +1 -1
  53. package/lib/driverError.js +1 -2
  54. package/lib/driverError.js.map +1 -1
  55. package/lib/git/resources.d.ts +2 -4
  56. package/lib/git/resources.d.ts.map +1 -1
  57. package/lib/git/resources.js.map +1 -1
  58. package/lib/protocol/clients.d.ts +1 -2
  59. package/lib/protocol/clients.d.ts.map +1 -1
  60. package/lib/protocol/clients.js.map +1 -1
  61. package/lib/protocol/config.d.ts +1 -2
  62. package/lib/protocol/config.d.ts.map +1 -1
  63. package/lib/protocol/config.js.map +1 -1
  64. package/lib/protocol/consensus.d.ts +7 -14
  65. package/lib/protocol/consensus.d.ts.map +1 -1
  66. package/lib/protocol/consensus.js.map +1 -1
  67. package/lib/protocol/date.d.ts +1 -2
  68. package/lib/protocol/date.d.ts.map +1 -1
  69. package/lib/protocol/date.js.map +1 -1
  70. package/lib/protocol/protocol.d.ts +15 -30
  71. package/lib/protocol/protocol.d.ts.map +1 -1
  72. package/lib/protocol/protocol.js +2 -4
  73. package/lib/protocol/protocol.js.map +1 -1
  74. package/lib/protocol/scopes.d.ts +1 -2
  75. package/lib/protocol/scopes.d.ts.map +1 -1
  76. package/lib/protocol/scopes.js +1 -2
  77. package/lib/protocol/scopes.js.map +1 -1
  78. package/lib/protocol/sockets.d.ts +2 -4
  79. package/lib/protocol/sockets.d.ts.map +1 -1
  80. package/lib/protocol/sockets.js.map +1 -1
  81. package/lib/protocol/storage.d.ts +10 -20
  82. package/lib/protocol/storage.d.ts.map +1 -1
  83. package/lib/protocol/storage.js +2 -4
  84. package/lib/protocol/storage.js.map +1 -1
  85. package/lib/protocol/summary.d.ts +1 -2
  86. package/lib/protocol/summary.d.ts.map +1 -1
  87. package/lib/protocol/summary.js.map +1 -1
  88. package/lib/protocol/tokens.d.ts +1 -2
  89. package/lib/protocol/tokens.d.ts.map +1 -1
  90. package/lib/protocol/tokens.js.map +1 -1
  91. package/lib/storage.d.ts +17 -34
  92. package/lib/storage.d.ts.map +1 -1
  93. package/lib/storage.js +2 -4
  94. package/lib/storage.js.map +1 -1
  95. package/lib/urlResolver.d.ts +5 -10
  96. package/lib/urlResolver.d.ts.map +1 -1
  97. package/lib/urlResolver.js +1 -2
  98. package/lib/urlResolver.js.map +1 -1
  99. package/package.json +3 -3
  100. package/src/driverError.ts +10 -20
  101. package/src/git/resources.ts +2 -4
  102. package/src/protocol/clients.ts +1 -2
  103. package/src/protocol/config.ts +1 -2
  104. package/src/protocol/consensus.ts +7 -14
  105. package/src/protocol/date.ts +1 -2
  106. package/src/protocol/protocol.ts +15 -30
  107. package/src/protocol/scopes.ts +1 -2
  108. package/src/protocol/sockets.ts +2 -4
  109. package/src/protocol/storage.ts +11 -21
  110. package/src/protocol/summary.ts +1 -2
  111. package/src/protocol/tokens.ts +1 -2
  112. package/src/storage.ts +17 -34
  113. package/src/urlResolver.ts +5 -10
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/driver-definitions
2
2
 
3
+ ## 2.60.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.53.0
4
8
 
5
9
  Dependency updates only.
@@ -1,4 +1,4 @@
1
- ## Alpha API Report File for "@fluidframework/driver-definitions"
1
+ ## Beta API Report File for "@fluidframework/driver-definitions"
2
2
 
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
@@ -7,10 +7,10 @@
7
7
  // @public
8
8
  export type ConnectionMode = "write" | "read";
9
9
 
10
- // @alpha @legacy (undocumented)
10
+ // @beta @legacy (undocumented)
11
11
  export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
12
12
 
13
- // @alpha @legacy
13
+ // @beta @legacy
14
14
  export const DriverErrorTypes: {
15
15
  readonly genericNetworkError: "genericNetworkError";
16
16
  readonly authorizationError: "authorizationError";
@@ -32,10 +32,10 @@ export const DriverErrorTypes: {
32
32
  readonly usageError: "usageError";
33
33
  };
34
34
 
35
- // @alpha @legacy
35
+ // @beta @legacy
36
36
  export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
37
37
 
38
- // @alpha @legacy
38
+ // @beta @legacy
39
39
  export enum DriverHeader {
40
40
  // (undocumented)
41
41
  createNew = "createNew",
@@ -43,13 +43,13 @@ export enum DriverHeader {
43
43
  summarizingClient = "fluid-client-summarizer"
44
44
  }
45
45
 
46
- // @alpha @legacy
46
+ // @beta @legacy
47
47
  export interface DriverPreCheckInfo {
48
48
  codeDetailsHint?: string;
49
49
  criticalBootDomains?: string[];
50
50
  }
51
51
 
52
- // @alpha @legacy (undocumented)
52
+ // @beta @legacy (undocumented)
53
53
  export enum FetchSource {
54
54
  // (undocumented)
55
55
  default = "default",
@@ -57,7 +57,7 @@ export enum FetchSource {
57
57
  noCache = "noCache"
58
58
  }
59
59
 
60
- // @alpha @legacy (undocumented)
60
+ // @beta @legacy (undocumented)
61
61
  export enum FileMode {
62
62
  // (undocumented)
63
63
  Directory = "040000",
@@ -69,28 +69,28 @@ export enum FileMode {
69
69
  Symlink = "120000"
70
70
  }
71
71
 
72
- // @alpha @legacy (undocumented)
72
+ // @beta @legacy (undocumented)
73
73
  export type FiveDaysMs = 432_000_000;
74
74
 
75
- // @alpha @legacy
75
+ // @beta @legacy
76
76
  export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
77
77
  // (undocumented)
78
78
  readonly errorType: string;
79
79
  scenarioName?: string;
80
80
  }
81
81
 
82
- // @alpha @legacy
82
+ // @beta @legacy
83
83
  export type IApprovedProposal = {
84
84
  approvalSequenceNumber: number;
85
85
  } & ISequencedProposal;
86
86
 
87
- // @alpha @legacy (undocumented)
87
+ // @beta @legacy (undocumented)
88
88
  export interface IAttachment {
89
89
  // (undocumented)
90
90
  id: string;
91
91
  }
92
92
 
93
- // @alpha @legacy (undocumented)
93
+ // @beta @legacy (undocumented)
94
94
  export interface IAuthorizationError extends IDriverErrorBase {
95
95
  // (undocumented)
96
96
  readonly claims?: string;
@@ -100,13 +100,13 @@ export interface IAuthorizationError extends IDriverErrorBase {
100
100
  readonly tenantId?: string;
101
101
  }
102
102
 
103
- // @alpha @legacy
103
+ // @beta @legacy
104
104
  export interface IBlob {
105
105
  contents: string;
106
106
  encoding: "utf-8" | "base64";
107
107
  }
108
108
 
109
- // @alpha @legacy
109
+ // @beta @legacy
110
110
  export interface IBranchOrigin {
111
111
  id: string;
112
112
  minimumSequenceNumber: number;
@@ -129,7 +129,7 @@ export interface IClient {
129
129
  user: IUser;
130
130
  }
131
131
 
132
- // @alpha @legacy
132
+ // @beta @legacy
133
133
  export interface IClientConfiguration {
134
134
  blockSize: number;
135
135
  maxMessageSize: number;
@@ -147,12 +147,12 @@ export interface IClientDetails {
147
147
  type?: string;
148
148
  }
149
149
 
150
- // @alpha @legacy
150
+ // @beta @legacy
151
151
  export type ICommittedProposal = {
152
152
  commitSequenceNumber: number;
153
153
  } & IApprovedProposal;
154
154
 
155
- // @alpha @legacy
155
+ // @beta @legacy
156
156
  export interface IConnect {
157
157
  client: IClient;
158
158
  driverVersion?: string;
@@ -167,7 +167,7 @@ export interface IConnect {
167
167
  versions: string[];
168
168
  }
169
169
 
170
- // @alpha @legacy
170
+ // @beta @legacy
171
171
  export interface IConnected {
172
172
  checkpointSequenceNumber?: number;
173
173
  claims: ITokenClaims;
@@ -188,24 +188,24 @@ export interface IConnected {
188
188
  version: string;
189
189
  }
190
190
 
191
- // @alpha @legacy
191
+ // @beta @legacy
192
192
  export interface IContainerPackageInfo {
193
193
  name: string;
194
194
  }
195
195
 
196
- // @alpha @legacy (undocumented)
196
+ // @beta @legacy (undocumented)
197
197
  export interface ICreateBlobResponse {
198
198
  // (undocumented)
199
199
  id: string;
200
200
  }
201
201
 
202
- // @alpha @legacy (undocumented)
202
+ // @beta @legacy (undocumented)
203
203
  export interface IDocumentAttributes {
204
204
  minimumSequenceNumber: number;
205
205
  sequenceNumber: number;
206
206
  }
207
207
 
208
- // @alpha @legacy (undocumented)
208
+ // @beta @legacy (undocumented)
209
209
  export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
210
210
  checkpointSequenceNumber?: number;
211
211
  claims: ITokenClaims;
@@ -222,7 +222,7 @@ export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<ID
222
222
  version: string;
223
223
  }
224
224
 
225
- // @alpha @legacy (undocumented)
225
+ // @beta @legacy (undocumented)
226
226
  export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
227
227
  // (undocumented)
228
228
  (event: "nack", listener: (documentId: string, message: INack[]) => void): any;
@@ -238,12 +238,12 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
238
238
  (event: "error", listener: (error: any) => void): any;
239
239
  }
240
240
 
241
- // @alpha @legacy
241
+ // @beta @legacy
242
242
  export interface IDocumentDeltaStorageService {
243
243
  fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
244
244
  }
245
245
 
246
- // @alpha @legacy
246
+ // @beta @legacy
247
247
  export interface IDocumentMessage {
248
248
  clientSequenceNumber: number;
249
249
  compression?: string;
@@ -255,7 +255,7 @@ export interface IDocumentMessage {
255
255
  type: string;
256
256
  }
257
257
 
258
- // @alpha @legacy (undocumented)
258
+ // @beta @legacy (undocumented)
259
259
  export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
260
260
  connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
261
261
  connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
@@ -266,25 +266,25 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents>
266
266
  resolvedUrl: IResolvedUrl;
267
267
  }
268
268
 
269
- // @alpha @legacy
269
+ // @beta @legacy
270
270
  export interface IDocumentServiceEvents extends IEvent {
271
271
  (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
272
272
  }
273
273
 
274
- // @alpha @legacy (undocumented)
274
+ // @beta @legacy (undocumented)
275
275
  export interface IDocumentServiceFactory {
276
276
  createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
277
277
  createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
278
278
  }
279
279
 
280
- // @alpha @legacy (undocumented)
280
+ // @beta @legacy (undocumented)
281
281
  export interface IDocumentServicePolicies {
282
282
  readonly storageOnly?: boolean;
283
283
  readonly summarizeProtocolTree?: boolean;
284
284
  readonly supportGetSnapshotApi?: boolean;
285
285
  }
286
286
 
287
- // @alpha @legacy
287
+ // @beta @legacy
288
288
  export interface IDocumentStorageService extends Partial<IDisposable> {
289
289
  createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
290
290
  downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
@@ -296,13 +296,13 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
296
296
  uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
297
297
  }
298
298
 
299
- // @alpha @legacy
299
+ // @beta @legacy
300
300
  export interface IDocumentStorageServicePolicies {
301
301
  readonly caching?: LoaderCachingPolicy;
302
302
  readonly maximumCacheDurationMs?: FiveDaysMs;
303
303
  }
304
304
 
305
- // @alpha @legacy
305
+ // @beta @legacy
306
306
  export interface IDriverBasicError extends IDriverErrorBase {
307
307
  // (undocumented)
308
308
  readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
@@ -310,7 +310,7 @@ export interface IDriverBasicError extends IDriverErrorBase {
310
310
  readonly statusCode?: number;
311
311
  }
312
312
 
313
- // @alpha @legacy
313
+ // @beta @legacy
314
314
  export interface IDriverErrorBase {
315
315
  canRetry: boolean;
316
316
  endpointReached?: boolean;
@@ -319,7 +319,7 @@ export interface IDriverErrorBase {
319
319
  online?: string;
320
320
  }
321
321
 
322
- // @alpha @legacy (undocumented)
322
+ // @beta @legacy (undocumented)
323
323
  export interface IGenericNetworkError extends IDriverErrorBase {
324
324
  // (undocumented)
325
325
  readonly errorType: typeof DriverErrorTypes.genericNetworkError;
@@ -327,7 +327,7 @@ export interface IGenericNetworkError extends IDriverErrorBase {
327
327
  readonly statusCode?: number;
328
328
  }
329
329
 
330
- // @alpha @legacy (undocumented)
330
+ // @beta @legacy (undocumented)
331
331
  export interface ILocationRedirectionError extends IDriverErrorBase {
332
332
  // (undocumented)
333
333
  readonly errorType: typeof DriverErrorTypes.locationRedirection;
@@ -335,14 +335,14 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
335
335
  readonly redirectUrl: IResolvedUrl;
336
336
  }
337
337
 
338
- // @alpha @legacy (undocumented)
338
+ // @beta @legacy (undocumented)
339
339
  export interface INack {
340
340
  content: INackContent;
341
341
  operation: IDocumentMessage | undefined;
342
342
  sequenceNumber: number;
343
343
  }
344
344
 
345
- // @alpha @legacy
345
+ // @beta @legacy
346
346
  export interface INackContent {
347
347
  code: number;
348
348
  message: string;
@@ -350,19 +350,19 @@ export interface INackContent {
350
350
  type: NackErrorType;
351
351
  }
352
352
 
353
- // @alpha @legacy (undocumented)
353
+ // @beta @legacy (undocumented)
354
354
  export interface IProcessMessageResult {
355
355
  // (undocumented)
356
356
  immediateNoOp?: boolean;
357
357
  }
358
358
 
359
- // @alpha @legacy
359
+ // @beta @legacy
360
360
  export interface IProposal {
361
361
  key: string;
362
362
  value: unknown;
363
363
  }
364
364
 
365
- // @alpha @legacy
365
+ // @beta @legacy
366
366
  export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
367
367
  // (undocumented)
368
368
  off: IQuorum["on"];
@@ -390,7 +390,7 @@ export interface IQuorumClients {
390
390
  once: IQuorumClients["on"];
391
391
  }
392
392
 
393
- // @alpha @legacy
393
+ // @beta @legacy
394
394
  export interface IQuorumProposals {
395
395
  // (undocumented)
396
396
  get(key: string): unknown;
@@ -410,7 +410,7 @@ export interface IQuorumProposals {
410
410
  propose(key: string, value: unknown): Promise<void>;
411
411
  }
412
412
 
413
- // @alpha @legacy (undocumented)
413
+ // @beta @legacy (undocumented)
414
414
  export interface IResolvedUrl {
415
415
  // (undocumented)
416
416
  endpoints: {
@@ -433,7 +433,7 @@ export interface ISequencedClient {
433
433
  sequenceNumber: number;
434
434
  }
435
435
 
436
- // @alpha @legacy
436
+ // @beta @legacy
437
437
  export interface ISequencedDocumentMessage {
438
438
  clientId: string | null;
439
439
  clientSequenceNumber: number;
@@ -454,12 +454,12 @@ export interface ISequencedDocumentMessage {
454
454
  type: string;
455
455
  }
456
456
 
457
- // @alpha @legacy
457
+ // @beta @legacy
458
458
  export type ISequencedProposal = {
459
459
  sequenceNumber: number;
460
460
  } & IProposal;
461
461
 
462
- // @alpha @legacy (undocumented)
462
+ // @beta @legacy (undocumented)
463
463
  export interface ISignalClient {
464
464
  client: IClient;
465
465
  clientConnectionNumber?: number;
@@ -467,12 +467,12 @@ export interface ISignalClient {
467
467
  referenceSequenceNumber?: number;
468
468
  }
469
469
 
470
- // @alpha @legacy
470
+ // @beta @legacy
471
471
  export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
472
472
  clientId: string | null;
473
473
  }
474
474
 
475
- // @alpha @legacy
475
+ // @beta @legacy
476
476
  export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
477
477
  clientConnectionNumber?: number;
478
478
  content: TMessage["content"];
@@ -481,7 +481,7 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage
481
481
  type?: TMessage["type"];
482
482
  }
483
483
 
484
- // @alpha @legacy
484
+ // @beta @legacy
485
485
  export interface ISnapshot {
486
486
  // (undocumented)
487
487
  blobContents: Map<string, ArrayBuffer>;
@@ -495,7 +495,7 @@ export interface ISnapshot {
495
495
  snapshotTree: ISnapshotTree;
496
496
  }
497
497
 
498
- // @alpha @legacy
498
+ // @beta @legacy
499
499
  export interface ISnapshotFetchOptions {
500
500
  cacheSnapshot?: boolean;
501
501
  fetchSource?: FetchSource;
@@ -504,7 +504,7 @@ export interface ISnapshotFetchOptions {
504
504
  versionId?: string;
505
505
  }
506
506
 
507
- // @alpha @legacy (undocumented)
507
+ // @beta @legacy (undocumented)
508
508
  export interface ISnapshotTree {
509
509
  // (undocumented)
510
510
  blobs: {
@@ -520,16 +520,16 @@ export interface ISnapshotTree {
520
520
  unreferenced?: true;
521
521
  }
522
522
 
523
- // @alpha @legacy
523
+ // @beta @legacy
524
524
  export type IsoDate = string;
525
525
 
526
- // @alpha @legacy
526
+ // @beta @legacy
527
527
  export interface IStream<T> {
528
528
  // (undocumented)
529
529
  read(): Promise<IStreamResult<T>>;
530
530
  }
531
531
 
532
- // @alpha @legacy (undocumented)
532
+ // @beta @legacy (undocumented)
533
533
  export type IStreamResult<T> = {
534
534
  done: true;
535
535
  } | {
@@ -537,7 +537,7 @@ export type IStreamResult<T> = {
537
537
  value: T;
538
538
  };
539
539
 
540
- // @alpha @legacy
540
+ // @beta @legacy
541
541
  export interface ISummaryAck {
542
542
  handle: string;
543
543
  summaryProposal: ISummaryProposal;
@@ -559,7 +559,7 @@ export interface ISummaryBlob {
559
559
  type: SummaryType.Blob;
560
560
  }
561
561
 
562
- // @alpha @legacy (undocumented)
562
+ // @beta @legacy (undocumented)
563
563
  export interface ISummaryContent {
564
564
  details?: IUploadedSummaryDetails;
565
565
  handle: string;
@@ -568,7 +568,7 @@ export interface ISummaryContent {
568
568
  parents: string[];
569
569
  }
570
570
 
571
- // @alpha @legacy
571
+ // @beta @legacy
572
572
  export interface ISummaryContext {
573
573
  readonly ackHandle: string | undefined;
574
574
  readonly proposalHandle: string | undefined;
@@ -584,7 +584,7 @@ export interface ISummaryHandle {
584
584
  type: SummaryType.Handle;
585
585
  }
586
586
 
587
- // @alpha @legacy
587
+ // @beta @legacy
588
588
  export interface ISummaryNack {
589
589
  code?: number;
590
590
  message?: string;
@@ -592,7 +592,7 @@ export interface ISummaryNack {
592
592
  summaryProposal: ISummaryProposal;
593
593
  }
594
594
 
595
- // @alpha @legacy
595
+ // @beta @legacy
596
596
  export interface ISummaryProposal {
597
597
  summarySequenceNumber: number;
598
598
  }
@@ -608,7 +608,7 @@ export interface ISummaryTree {
608
608
  unreferenced?: true;
609
609
  }
610
610
 
611
- // @alpha @legacy (undocumented)
611
+ // @beta @legacy (undocumented)
612
612
  export interface IThrottlingWarning extends IDriverErrorBase {
613
613
  // (undocumented)
614
614
  readonly errorType: typeof DriverErrorTypes.throttlingError;
@@ -616,7 +616,7 @@ export interface IThrottlingWarning extends IDriverErrorBase {
616
616
  readonly retryAfterSeconds: number;
617
617
  }
618
618
 
619
- // @alpha @legacy
619
+ // @beta @legacy
620
620
  export interface ITokenClaims {
621
621
  documentId: string;
622
622
  exp: number;
@@ -628,14 +628,14 @@ export interface ITokenClaims {
628
628
  ver: string;
629
629
  }
630
630
 
631
- // @alpha @legacy
631
+ // @beta @legacy
632
632
  export interface ITrace {
633
633
  action: string;
634
634
  service: string;
635
635
  timestamp: number;
636
636
  }
637
637
 
638
- // @alpha @legacy (undocumented)
638
+ // @beta @legacy (undocumented)
639
639
  export interface ITree {
640
640
  // (undocumented)
641
641
  entries: ITreeEntry[];
@@ -644,7 +644,7 @@ export interface ITree {
644
644
  unreferenced?: true;
645
645
  }
646
646
 
647
- // @alpha @legacy
647
+ // @beta @legacy
648
648
  export type ITreeEntry = {
649
649
  path: string;
650
650
  mode: FileMode;
@@ -659,12 +659,12 @@ export type ITreeEntry = {
659
659
  value: IAttachment;
660
660
  });
661
661
 
662
- // @alpha @legacy (undocumented)
662
+ // @beta @legacy (undocumented)
663
663
  export interface IUploadedSummaryDetails {
664
664
  includesProtocolTree?: boolean;
665
665
  }
666
666
 
667
- // @alpha @legacy (undocumented)
667
+ // @beta @legacy (undocumented)
668
668
  export interface IUrlResolver {
669
669
  getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
670
670
  // (undocumented)
@@ -676,20 +676,20 @@ export interface IUser {
676
676
  id: string;
677
677
  }
678
678
 
679
- // @alpha @legacy
679
+ // @beta @legacy
680
680
  export interface IVersion {
681
681
  date?: IsoDate;
682
682
  id: string;
683
683
  treeId: string;
684
684
  }
685
685
 
686
- // @alpha @legacy (undocumented)
686
+ // @beta @legacy (undocumented)
687
687
  export enum LoaderCachingPolicy {
688
688
  NoCaching = 0,
689
689
  Prefetch = 1
690
690
  }
691
691
 
692
- // @alpha @legacy (undocumented)
692
+ // @beta @legacy (undocumented)
693
693
  export enum MessageType {
694
694
  Accept = "accept",
695
695
  ClientJoin = "join",
@@ -706,7 +706,7 @@ export enum MessageType {
706
706
  SummaryNack = "summaryNack"
707
707
  }
708
708
 
709
- // @alpha @legacy
709
+ // @beta @legacy
710
710
  export enum NackErrorType {
711
711
  BadRequestError = "BadRequestError",
712
712
  InvalidScopeError = "InvalidScopeError",
@@ -714,7 +714,7 @@ export enum NackErrorType {
714
714
  ThrottlingError = "ThrottlingError"
715
715
  }
716
716
 
717
- // @alpha @legacy
717
+ // @beta @legacy
718
718
  export enum ScopeType {
719
719
  DocRead = "doc:read",
720
720
  DocWrite = "doc:write",
@@ -724,7 +724,7 @@ export enum ScopeType {
724
724
  // @public
725
725
  export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
726
726
 
727
- // @alpha @legacy
727
+ // @beta @legacy
728
728
  export type SummaryTree = ISummaryTree | ISummaryHandle;
729
729
 
730
730
  // @public
@@ -741,7 +741,7 @@ export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryTyp
741
741
  // @public
742
742
  export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
743
743
 
744
- // @alpha @legacy
744
+ // @beta @legacy
745
745
  export enum TreeEntry {
746
746
  // (undocumented)
747
747
  Attachment = "Attachment",
@@ -5,8 +5,7 @@
5
5
  import type { IResolvedUrl } from "./urlResolver.js";
6
6
  /**
7
7
  * Different error types the Driver may report out to the Host.
8
- * @legacy
9
- * @alpha
8
+ * @legacy @beta
10
9
  */
11
10
  export declare const DriverErrorTypes: {
12
11
  /**
@@ -83,8 +82,7 @@ export declare const DriverErrorTypes: {
83
82
  };
84
83
  /**
85
84
  * {@inheritDoc (DriverErrorTypes:variable)}
86
- * @legacy
87
- * @alpha
85
+ * @legacy @beta
88
86
  */
89
87
  export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
90
88
  /**
@@ -97,8 +95,7 @@ export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErro
97
95
  * "Any" in the interface name is a nod to the fact that errorType has lost its type constraint.
98
96
  * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,
99
97
  * but we can't reference a specific driver's error type enum in this code.
100
- * @legacy
101
- * @alpha
98
+ * @legacy @beta
102
99
  */
103
100
  export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
104
101
  readonly errorType: string;
@@ -110,8 +107,7 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
110
107
  }
111
108
  /**
112
109
  * Base interface for all errors and warnings
113
- * @legacy
114
- * @alpha
110
+ * @legacy @beta
115
111
  */
116
112
  export interface IDriverErrorBase {
117
113
  /**
@@ -139,24 +135,21 @@ export interface IDriverErrorBase {
139
135
  endpointReached?: boolean;
140
136
  }
141
137
  /**
142
- * @legacy
143
- * @alpha
138
+ * @legacy @beta
144
139
  */
145
140
  export interface IThrottlingWarning extends IDriverErrorBase {
146
141
  readonly errorType: typeof DriverErrorTypes.throttlingError;
147
142
  readonly retryAfterSeconds: number;
148
143
  }
149
144
  /**
150
- * @legacy
151
- * @alpha
145
+ * @legacy @beta
152
146
  */
153
147
  export interface IGenericNetworkError extends IDriverErrorBase {
154
148
  readonly errorType: typeof DriverErrorTypes.genericNetworkError;
155
149
  readonly statusCode?: number;
156
150
  }
157
151
  /**
158
- * @legacy
159
- * @alpha
152
+ * @legacy @beta
160
153
  */
161
154
  export interface IAuthorizationError extends IDriverErrorBase {
162
155
  readonly errorType: typeof DriverErrorTypes.authorizationError;
@@ -164,8 +157,7 @@ export interface IAuthorizationError extends IDriverErrorBase {
164
157
  readonly tenantId?: string;
165
158
  }
166
159
  /**
167
- * @legacy
168
- * @alpha
160
+ * @legacy @beta
169
161
  */
170
162
  export interface ILocationRedirectionError extends IDriverErrorBase {
171
163
  readonly errorType: typeof DriverErrorTypes.locationRedirection;
@@ -174,16 +166,14 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
174
166
  /**
175
167
  * Having this uber interface without types that have their own interfaces
176
168
  * allows compiler to differentiate interfaces based on error type
177
- * @legacy
178
- * @alpha
169
+ * @legacy @beta
179
170
  */
180
171
  export interface IDriverBasicError extends IDriverErrorBase {
181
172
  readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
182
173
  readonly statusCode?: number;
183
174
  }
184
175
  /**
185
- * @legacy
186
- * @alpha
176
+ * @legacy @beta
187
177
  */
188
178
  export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
189
179
  //# sourceMappingURL=driverError.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
1
+ {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}