@fluidframework/routerlicious-driver 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.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.
Files changed (99) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-extractor-lint.json +13 -0
  3. package/api-extractor.json +3 -3
  4. package/api-report/routerlicious-driver.api.md +10 -10
  5. package/dist/defaultTokenProvider.cjs +1 -0
  6. package/dist/defaultTokenProvider.cjs.map +1 -1
  7. package/dist/defaultTokenProvider.d.ts +1 -0
  8. package/dist/defaultTokenProvider.d.ts.map +1 -1
  9. package/dist/documentServiceFactory.cjs +2 -0
  10. package/dist/documentServiceFactory.cjs.map +1 -1
  11. package/dist/documentServiceFactory.d.ts +2 -0
  12. package/dist/documentServiceFactory.d.ts.map +1 -1
  13. package/dist/errorUtils.cjs +2 -0
  14. package/dist/errorUtils.cjs.map +1 -1
  15. package/dist/errorUtils.d.ts +12 -0
  16. package/dist/errorUtils.d.ts.map +1 -1
  17. package/dist/packageVersion.cjs +1 -1
  18. package/dist/packageVersion.cjs.map +1 -1
  19. package/dist/packageVersion.d.ts +1 -1
  20. package/dist/policies.cjs.map +1 -1
  21. package/dist/policies.d.ts +3 -0
  22. package/dist/policies.d.ts.map +1 -1
  23. package/dist/routerlicious-driver-alpha.d.ts +92 -0
  24. package/dist/routerlicious-driver-beta.d.ts +35 -0
  25. package/dist/routerlicious-driver-public.d.ts +35 -0
  26. package/dist/routerlicious-driver-untrimmed.d.ts +268 -0
  27. package/dist/tokens.cjs.map +1 -1
  28. package/dist/tokens.d.ts +5 -0
  29. package/dist/tokens.d.ts.map +1 -1
  30. package/lib/contracts.d.ts.map +1 -1
  31. package/lib/createNewUtils.d.ts.map +1 -1
  32. package/lib/defaultTokenProvider.d.ts +2 -1
  33. package/lib/defaultTokenProvider.d.ts.map +1 -1
  34. package/lib/defaultTokenProvider.mjs +1 -0
  35. package/lib/defaultTokenProvider.mjs.map +1 -1
  36. package/lib/definitions.d.ts.map +1 -1
  37. package/lib/deltaStorageService.d.ts +2 -2
  38. package/lib/deltaStorageService.d.ts.map +1 -1
  39. package/lib/documentDeltaConnection.d.ts.map +1 -1
  40. package/lib/documentService.d.ts +6 -6
  41. package/lib/documentService.d.ts.map +1 -1
  42. package/lib/documentServiceFactory.d.ts +4 -2
  43. package/lib/documentServiceFactory.d.ts.map +1 -1
  44. package/lib/documentServiceFactory.mjs +2 -0
  45. package/lib/documentServiceFactory.mjs.map +1 -1
  46. package/lib/documentStorageService.d.ts +5 -5
  47. package/lib/documentStorageService.d.ts.map +1 -1
  48. package/lib/errorUtils.d.ts +12 -0
  49. package/lib/errorUtils.d.ts.map +1 -1
  50. package/lib/errorUtils.mjs +2 -0
  51. package/lib/errorUtils.mjs.map +1 -1
  52. package/lib/gitManager.d.ts +3 -3
  53. package/lib/gitManager.d.ts.map +1 -1
  54. package/lib/historian.d.ts +4 -4
  55. package/lib/historian.d.ts.map +1 -1
  56. package/lib/index.d.ts +5 -5
  57. package/lib/index.d.ts.map +1 -1
  58. package/lib/nullBlobStorageService.d.ts.map +1 -1
  59. package/lib/packageVersion.d.ts +1 -1
  60. package/lib/packageVersion.mjs +1 -1
  61. package/lib/packageVersion.mjs.map +1 -1
  62. package/lib/policies.d.ts +3 -0
  63. package/lib/policies.d.ts.map +1 -1
  64. package/lib/policies.mjs.map +1 -1
  65. package/lib/r11sSnapshotParser.d.ts +1 -1
  66. package/lib/r11sSnapshotParser.d.ts.map +1 -1
  67. package/lib/restWrapper.d.ts +2 -2
  68. package/lib/restWrapper.d.ts.map +1 -1
  69. package/lib/restWrapperBase.d.ts +1 -1
  70. package/lib/restWrapperBase.d.ts.map +1 -1
  71. package/lib/retriableGitManager.d.ts +3 -3
  72. package/lib/retriableGitManager.d.ts.map +1 -1
  73. package/lib/routerlicious-driver-alpha.d.ts +92 -0
  74. package/lib/routerlicious-driver-beta.d.ts +35 -0
  75. package/lib/routerlicious-driver-public.d.ts +35 -0
  76. package/lib/routerlicious-driver-untrimmed.d.ts +268 -0
  77. package/lib/shreddedSummaryDocumentStorageService.d.ts +4 -4
  78. package/lib/shreddedSummaryDocumentStorageService.d.ts.map +1 -1
  79. package/lib/storageContracts.d.ts +2 -2
  80. package/lib/storageContracts.d.ts.map +1 -1
  81. package/lib/summaryTreeUploadManager.d.ts +1 -1
  82. package/lib/summaryTreeUploadManager.d.ts.map +1 -1
  83. package/lib/tokens.d.ts +5 -0
  84. package/lib/tokens.d.ts.map +1 -1
  85. package/lib/tokens.mjs.map +1 -1
  86. package/lib/treeUtils.d.ts +1 -1
  87. package/lib/treeUtils.d.ts.map +1 -1
  88. package/lib/urlUtils.d.ts.map +1 -1
  89. package/lib/wholeSummaryDocumentStorageService.d.ts +4 -4
  90. package/lib/wholeSummaryDocumentStorageService.d.ts.map +1 -1
  91. package/lib/wholeSummaryUploadManager.d.ts +1 -1
  92. package/lib/wholeSummaryUploadManager.d.ts.map +1 -1
  93. package/package.json +33 -26
  94. package/src/defaultTokenProvider.ts +1 -0
  95. package/src/documentServiceFactory.ts +2 -0
  96. package/src/errorUtils.ts +5 -0
  97. package/src/packageVersion.ts +1 -1
  98. package/src/policies.ts +3 -0
  99. package/src/tokens.ts +5 -0
@@ -0,0 +1,268 @@
1
+ import { IDocumentService } from '@fluidframework/driver-definitions';
2
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
3
+ import { IResolvedUrl } from '@fluidframework/driver-definitions';
4
+ import { ISession } from '@fluidframework/server-services-client';
5
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
6
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
7
+ import { ITokenClaims } from '@fluidframework/protocol-definitions';
8
+
9
+ /**
10
+ * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
11
+ * @internal
12
+ */
13
+ export declare class DefaultTokenProvider implements ITokenProvider {
14
+ private readonly jwt;
15
+ constructor(jwt: string);
16
+ fetchOrdererToken(): Promise<ITokenResponse>;
17
+ fetchStorageToken(): Promise<ITokenResponse>;
18
+ }
19
+
20
+ /**
21
+ * Error returned by {@link RouterliciousDocumentServiceFactory.createContainer} when an error is thrown
22
+ * in {@link ITokenProvider.documentPostCreateCallback}.
23
+ * It is the consumer's responsibility to ensure that any state related to container creation is appropriately
24
+ * cleaned up in the event of failure.
25
+ * This includes the document itself, which will have been created by the time this error was thrown.
26
+ *
27
+ * @remarks TODO: examples of suggested actions for recovery.
28
+ * - How would a user delete the created document?
29
+ * - What would a retry pattern look like here?
30
+ * @internal
31
+ */
32
+ export declare class DocumentPostCreateError extends Error {
33
+ /**
34
+ * Inner error being wrapped.
35
+ */
36
+ private readonly innerError;
37
+ constructor(
38
+ /**
39
+ * Inner error being wrapped.
40
+ */
41
+ innerError: Error);
42
+ readonly name = "DocumentPostCreateError";
43
+ get stack(): string | undefined;
44
+ }
45
+
46
+ /**
47
+ * @internal
48
+ */
49
+ export declare interface IRouterliciousDriverPolicies {
50
+ /**
51
+ * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.
52
+ * Default: true
53
+ */
54
+ enablePrefetch: boolean;
55
+ /**
56
+ * Rate limit concurrent storage requests.
57
+ * Default: 100
58
+ */
59
+ maxConcurrentStorageRequests: number;
60
+ /**
61
+ * Rate limit concurrent orderer requests.
62
+ * Default: 100
63
+ */
64
+ maxConcurrentOrdererRequests: number;
65
+ /**
66
+ * Enable uploading entire summary tree as a IWholeSummaryPayload to storage.
67
+ * Default: false
68
+ */
69
+ enableWholeSummaryUpload: boolean;
70
+ /**
71
+ * Enable service endpoint discovery when creating or joining a session.
72
+ * Default: false
73
+ */
74
+ enableDiscovery: boolean;
75
+ /**
76
+ * Enable using RestLess which avoids CORS preflight requests.
77
+ * Default: true
78
+ */
79
+ enableRestLess: boolean;
80
+ /**
81
+ * Enable internal cache of summaries/snapshots.
82
+ * Reduces Summarizer boot time and reduces server load in E2E tests.
83
+ * Default: true
84
+ */
85
+ enableInternalSummaryCaching: boolean;
86
+ /**
87
+ * Enable downgrading socket connection to long-polling
88
+ * when websocket connection cannot be established.
89
+ * Default: true
90
+ */
91
+ enableLongPollingDowngrade: boolean;
92
+ /**
93
+ * Indicates that the container is ephemeral.
94
+ * Artifacts relates to the container are limited to container lifetime.
95
+ * Default: false
96
+ */
97
+ isEphemeralContainer: boolean;
98
+ }
99
+
100
+ /**
101
+ * Abstracts the token fetching mechanism for a hosting application.
102
+ * The hosting application is responsible for providing an implementation.
103
+ * @alpha
104
+ */
105
+ export declare interface ITokenProvider {
106
+ /**
107
+ * Fetches the orderer token from host.
108
+ *
109
+ * @param tenantId - Tenant ID.
110
+ * @param documentId - Optional. Document ID is only required for document-scoped requests.
111
+ * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
112
+ * This likely indicates that some previous request failed authorization due to an expired token,
113
+ * and so a fresh token is required.
114
+ *
115
+ * Default: `false`.
116
+ *
117
+ * NOTE: This parameter will be made required in the future.
118
+ */
119
+ fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
120
+ /**
121
+ * Fetches the storage token from host.
122
+ *
123
+ * @param tenantId - Tenant ID.
124
+ * @param documentId - Document ID.
125
+ * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
126
+ * This likely indicates that some previous request failed authorization due to an expired token,
127
+ * and so a fresh token is required.
128
+ *
129
+ * Default: `false`.
130
+ *
131
+ * NOTE: This parameter will be made required in the future.
132
+ */
133
+ fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
134
+ /**
135
+ * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
136
+ * verify against an authorization service, if the user who claims to create the document is the same user who
137
+ * created it.
138
+ *
139
+ * @remarks Notes:
140
+ *
141
+ * * Using the callback may have performance impact on the document creation process.
142
+ *
143
+ * * Any exceptions thrown in the callback would fail the creation workflow
144
+ * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
145
+ *
146
+ * @param documentId - Document ID.
147
+ * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
148
+ * and document id. It can be used to validate the identity of the document creator.
149
+ */
150
+ documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
151
+ }
152
+
153
+ /**
154
+ * @alpha
155
+ */
156
+ export declare interface ITokenResponse {
157
+ /**
158
+ * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
159
+ */
160
+ jwt: string;
161
+ /**
162
+ * A flag indicating whether token was obtained from local cache.
163
+ *
164
+ * @remarks `undefined` indicates that the source of the token could not be determined.
165
+ */
166
+ fromCache?: boolean;
167
+ }
168
+
169
+ /**
170
+ * Abstracts the discovery of claims contained within a token.
171
+ * @internal
172
+ */
173
+ export declare interface ITokenService {
174
+ /**
175
+ * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided
176
+ * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.
177
+ */
178
+ extractClaims(token: string): ITokenClaims;
179
+ }
180
+
181
+ /**
182
+ * Factory for creating the routerlicious document service. Use this if you want to
183
+ * use the routerlicious implementation.
184
+ * @internal
185
+ */
186
+ export declare class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
187
+ private readonly tokenProvider;
188
+ private readonly driverPolicies;
189
+ private readonly blobCache;
190
+ private readonly wholeSnapshotTreeCache;
191
+ private readonly shreddedSummaryTreeCache;
192
+ constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
193
+ /**
194
+ * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
195
+ *
196
+ * @throws {@link DocumentPostCreateError}
197
+ * If an exception is thrown while invoking the provided {@link ITokenProvider.documentPostCreateCallback}.
198
+ */
199
+ createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
200
+ /**
201
+ * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createDocumentService}
202
+ *
203
+ * @returns Routerlicious document service.
204
+ */
205
+ createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean, session?: ISession): Promise<IDocumentService>;
206
+ }
207
+
208
+ /**
209
+ * Routerlicious Error types
210
+ * Different error types that may be thrown by the routerlicious driver
211
+ *
212
+ * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
213
+ * @internal
214
+ */
215
+ export declare enum RouterliciousErrorType {
216
+ /**
217
+ * File not found, or file deleted during session
218
+ */
219
+ fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
220
+ /**
221
+ * SSL Certificate Error.
222
+ */
223
+ sslCertError = "sslCertError"
224
+ }
225
+
226
+ /**
227
+ * Routerlicious Error types
228
+ * Different error types that may be thrown by the routerlicious driver
229
+ * @internal
230
+ */
231
+ export declare const RouterliciousErrorTypes: {
232
+ /**
233
+ * SSL Certificate Error.
234
+ */
235
+ readonly sslCertError: "sslCertError";
236
+ readonly genericNetworkError: "genericNetworkError";
237
+ readonly authorizationError: "authorizationError";
238
+ readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
239
+ readonly offlineError: "offlineError";
240
+ /**
241
+ * Routerlicious Error types
242
+ * Different error types that may be thrown by the routerlicious driver
243
+ *
244
+ * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
245
+ * @internal
246
+ */
247
+ readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
248
+ readonly writeError: "writeError";
249
+ readonly fetchFailure: "fetchFailure";
250
+ readonly fetchTokenError: "fetchTokenError";
251
+ readonly incorrectServerResponse: "incorrectServerResponse";
252
+ readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
253
+ readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
254
+ readonly locationRedirection: "locationRedirection";
255
+ readonly fluidInvalidSchema: "fluidInvalidSchema";
256
+ readonly fileIsLocked: "fileIsLocked";
257
+ readonly outOfStorageError: "outOfStorageError";
258
+ readonly genericError: "genericError";
259
+ readonly throttlingError: "throttlingError";
260
+ readonly usageError: "usageError";
261
+ };
262
+
263
+ /**
264
+ * @internal
265
+ */
266
+ export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
267
+
268
+ export { }
@@ -5,10 +5,10 @@
5
5
  import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
6
6
  import { IDocumentStorageService, ISummaryContext, IDocumentStorageServicePolicies } from "@fluidframework/driver-definitions";
7
7
  import { ICreateBlobResponse, ISnapshotTreeEx, ISummaryHandle, ISummaryTree, IVersion } from "@fluidframework/protocol-definitions";
8
- import { IRouterliciousDriverPolicies } from "./policies";
9
- import { ICache } from "./cache";
10
- import { ISnapshotTreeVersion } from "./definitions";
11
- import { GitManager } from "./gitManager";
8
+ import { IRouterliciousDriverPolicies } from "./policies.mjs";
9
+ import { ICache } from "./cache.mjs";
10
+ import { ISnapshotTreeVersion } from "./definitions.mjs";
11
+ import { GitManager } from "./gitManager.mjs";
12
12
  /**
13
13
  * Document access to underlying storage for routerlicious driver.
14
14
  * Uploads summaries piece-by-piece traversing the tree recursively.
@@ -1 +1 @@
1
- {"version":3,"file":"shreddedSummaryDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/shreddedSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,mBAAmB,EAInB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACN,uBAAuB,EACvB,eAAe,EACf,+BAA+B,EAC/B,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACN,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAEhD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAM1C;;;;GAIG;AACH,qBAAa,qCAAsC,YAAW,uBAAuB;IAoBnF,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IACtC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;aAC9B,QAAQ,EAAE,+BAA+B;IAIzD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IA1BnC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAGvC,SAAS,CAAC,QAAQ,CAAC,aAAa,sBAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsC;IAChE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2C;IAE7E,SAAgB,aAAa,MAAM;YAErB,uBAAuB;gBAUjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,+BAA+B,EACzD,cAAc,CAAC,EAAE,4BAA4B,EAC7C,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAC/B,iBAAiB,GAAE,CACnC,YAAY,CAAC,EAAE,OAAO,KAClB,OAAO,CAAC,UAAU,CAA4B;IAYvC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAqBzE,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAyCpE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IA8BlD,wBAAwB,CACpC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAqBL,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB9D,uBAAuB;IAYrC,OAAO,CAAC,WAAW;CAGnB"}
1
+ {"version":3,"file":"shreddedSummaryDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/shreddedSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,mBAAmB,EAInB,MAAM,iCAAiC;OAEjC,EACN,uBAAuB,EACvB,eAAe,EACf,+BAA+B,EAC/B,MAAM,oCAAoC;OAEpC,EACN,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,MAAM,sCAAsC;OACtC,EAAE,4BAA4B,EAAE;OAChC,EAAE,MAAM,EAAiB;OAEzB,EAAE,oBAAoB,EAAE;OACxB,EAAE,UAAU,EAAE;AAMrB;;;;GAIG;AACH,qBAAa,qCAAsC,YAAW,uBAAuB;IAoBnF,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IACtC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;aAC9B,QAAQ,EAAE,+BAA+B;IAIzD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IA1BnC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAGvC,SAAS,CAAC,QAAQ,CAAC,aAAa,sBAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsC;IAChE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2C;IAE7E,SAAgB,aAAa,MAAM;YAErB,uBAAuB;gBAUjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,+BAA+B,EACzD,cAAc,CAAC,EAAE,4BAA4B,EAC7C,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAC/B,iBAAiB,GAAE,CACnC,YAAY,CAAC,EAAE,OAAO,KAClB,OAAO,CAAC,UAAU,CAA4B;IAYvC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAqBzE,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAyCpE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IA8BlD,wBAAwB,CACpC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAqBL,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB9D,uBAAuB;IAYrC,OAAO,CAAC,WAAW;CAGnB"}
@@ -5,8 +5,8 @@
5
5
  import * as git from "@fluidframework/gitresources";
6
6
  import * as api from "@fluidframework/protocol-definitions";
7
7
  import { IWholeSummaryPayload, IWholeSummaryPayloadType, IWriteSummaryResponse } from "@fluidframework/server-services-client";
8
- import { IR11sResponse } from "./restWrapper";
9
- import { IWholeFlatSnapshot } from "./contracts";
8
+ import { IR11sResponse } from "./restWrapper.mjs";
9
+ import { IWholeFlatSnapshot } from "./contracts.mjs";
10
10
  /**
11
11
  * Interface to a generic Git provider
12
12
  */
@@ -1 +1 @@
1
- {"version":3,"file":"storageContracts.d.ts","sourceRoot":"","sources":["../src/storageContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,GAAG,MAAM,8BAA8B,CAAC;AACpD,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EACN,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACzF,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,WAAW;IAC3B,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/F,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;;;;;OAOG;IACH,gBAAgB,CACf,WAAW,EAAE,GAAG,CAAC,YAAY,EAC7B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB"}
1
+ {"version":3,"file":"storageContracts.d.ts","sourceRoot":"","sources":["../src/storageContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,KAAK,GAAG,MAAM,8BAA8B;OAC5C,KAAK,GAAG,MAAM,sCAAsC;OACpD,EACN,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,wCAAwC;OACxC,EAAE,aAAa,EAAE;OACjB,EAAE,kBAAkB,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACzF,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,WAAW;IAC3B,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/F,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;;;;;OAOG;IACH,gBAAgB,CACf,WAAW,EAAE,GAAG,CAAC,YAAY,EAC7B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB"}
@@ -4,7 +4,7 @@
4
4
  */
5
5
  import { ISnapshotTreeEx, ISummaryTree } from "@fluidframework/protocol-definitions";
6
6
  import { IWholeSummaryPayloadType } from "@fluidframework/server-services-client";
7
- import { IGitManager, ISummaryUploadManager } from "./storageContracts";
7
+ import { IGitManager, ISummaryUploadManager } from "./storageContracts.mjs";
8
8
  /**
9
9
  * Recursively writes summary tree as individual summary blobs.
10
10
  */
@@ -1 +1 @@
1
- {"version":3,"file":"summaryTreeUploadManager.d.ts","sourceRoot":"","sources":["../src/summaryTreeUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EACN,eAAe,EACf,YAAY,EAGZ,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAExE;;GAEG;AACH,qBAAa,wBAAyB,YAAW,qBAAqB;IAEpE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB;gBAFvB,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,uBAAuB,EAAE,CACzC,YAAY,EAAE,MAAM,KAChB,OAAO,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC;IAGpC,gBAAgB,CAC5B,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,MAAM,CAAC;YAKJ,oBAAoB;YAsBpB,sBAAsB;YA0BtB,gBAAgB;IAgB9B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,iBAAiB;CAgCzB"}
1
+ {"version":3,"file":"summaryTreeUploadManager.d.ts","sourceRoot":"","sources":["../src/summaryTreeUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAMI,EACN,eAAe,EACf,YAAY,EAGZ,MAAM,sCAAsC;OACtC,EAAE,wBAAwB,EAAE,MAAM,wCAAwC;OAC1E,EAAE,WAAW,EAAE,qBAAqB,EAAE;AAE7C;;GAEG;AACH,qBAAa,wBAAyB,YAAW,qBAAqB;IAEpE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB;gBAFvB,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,uBAAuB,EAAE,CACzC,YAAY,EAAE,MAAM,KAChB,OAAO,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC;IAGpC,gBAAgB,CAC5B,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,MAAM,CAAC;YAKJ,oBAAoB;YAsBpB,sBAAsB;YA0BtB,gBAAgB;IAgB9B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,iBAAiB;CAgCzB"}
package/lib/tokens.d.ts CHANGED
@@ -5,6 +5,7 @@
5
5
  import { ITokenClaims } from "@fluidframework/protocol-definitions";
6
6
  /**
7
7
  * Abstracts the discovery of claims contained within a token.
8
+ * @internal
8
9
  */
9
10
  export interface ITokenService {
10
11
  /**
@@ -13,6 +14,9 @@ export interface ITokenService {
13
14
  */
14
15
  extractClaims(token: string): ITokenClaims;
15
16
  }
17
+ /**
18
+ * @alpha
19
+ */
16
20
  export interface ITokenResponse {
17
21
  /**
18
22
  * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
@@ -28,6 +32,7 @@ export interface ITokenResponse {
28
32
  /**
29
33
  * Abstracts the token fetching mechanism for a hosting application.
30
34
  * The hosting application is responsible for providing an implementation.
35
+ * @alpha
31
36
  */
32
37
  export interface ITokenProvider {
33
38
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF"}
1
+ {"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,YAAY,EAAE,MAAM,sCAAsC;AAEnE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF"}
@@ -1 +1 @@
1
- {"version":3,"file":"tokens.mjs","sourceRoot":"","sources":["../src/tokens.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 { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Abstracts the discovery of claims contained within a token.\n */\nexport interface ITokenService {\n\t/**\n\t * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.\n\t */\n\textractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n\t/**\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.\n\t */\n\tjwt: string;\n\n\t/**\n\t * A flag indicating whether token was obtained from local cache.\n\t *\n\t * @remarks `undefined` indicates that the source of the token could not be determined.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Abstracts the token fetching mechanism for a hosting application.\n * The hosting application is responsible for providing an implementation.\n */\nexport interface ITokenProvider {\n\t/**\n\t * Fetches the orderer token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Optional. Document ID is only required for document-scoped requests.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchOrdererToken(\n\t\ttenantId: string,\n\t\tdocumentId?: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * Fetches the storage token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Document ID.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchStorageToken(\n\t\ttenantId: string,\n\t\tdocumentId: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n\t * verify against an authorization service, if the user who claims to create the document is the same user who\n\t * created it.\n\t *\n\t * @remarks Notes:\n\t *\n\t * * Using the callback may have performance impact on the document creation process.\n\t *\n\t * * Any exceptions thrown in the callback would fail the creation workflow\n\t * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).\n\t *\n\t * @param documentId - Document ID.\n\t * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n\t * and document id. It can be used to validate the identity of the document creator.\n\t */\n\tdocumentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"tokens.mjs","sourceRoot":"","sources":["../src/tokens.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 { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Abstracts the discovery of claims contained within a token.\n * @internal\n */\nexport interface ITokenService {\n\t/**\n\t * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.\n\t */\n\textractClaims(token: string): ITokenClaims;\n}\n\n/**\n * @alpha\n */\nexport interface ITokenResponse {\n\t/**\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.\n\t */\n\tjwt: string;\n\n\t/**\n\t * A flag indicating whether token was obtained from local cache.\n\t *\n\t * @remarks `undefined` indicates that the source of the token could not be determined.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Abstracts the token fetching mechanism for a hosting application.\n * The hosting application is responsible for providing an implementation.\n * @alpha\n */\nexport interface ITokenProvider {\n\t/**\n\t * Fetches the orderer token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Optional. Document ID is only required for document-scoped requests.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchOrdererToken(\n\t\ttenantId: string,\n\t\tdocumentId?: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * Fetches the storage token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Document ID.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchStorageToken(\n\t\ttenantId: string,\n\t\tdocumentId: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n\t * verify against an authorization service, if the user who claims to create the document is the same user who\n\t * created it.\n\t *\n\t * @remarks Notes:\n\t *\n\t * * Using the callback may have performance impact on the document creation process.\n\t *\n\t * * Any exceptions thrown in the callback would fail the creation workflow\n\t * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).\n\t *\n\t * @param documentId - Document ID.\n\t * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n\t * and document id. It can be used to validate the identity of the document creator.\n\t */\n\tdocumentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { SummaryType, ISnapshotTree, ISummaryTree } from "@fluidframework/protocol-definitions";
6
- import { INormalizedWholeSnapshot } from "./contracts";
6
+ import { INormalizedWholeSnapshot } from "./contracts.mjs";
7
7
  /**
8
8
  * Summary tree assembler props
9
9
  */
@@ -1 +1 @@
1
- {"version":3,"file":"treeUtils.d.ts","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,WAAW,EACX,aAAa,EACb,YAAY,EAEZ,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAIpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAHnC,OAAO,CAAC,iBAAiB,CAAa;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;gBAExC,KAAK,CAAC,wCAA4B;IAE/D;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAMjC;IAED;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAO/D;;OAEG;IACI,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IAQP;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIxD;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CACnD,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,GAC7B,YAAY,CAcd;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,wBAAwB;;;;EAQnE;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,aAAa,QAS5D"}
1
+ {"version":3,"file":"treeUtils.d.ts","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAII,EACN,WAAW,EACX,aAAa,EACb,YAAY,EAEZ,MAAM,sCAAsC;OACtC,EAAE,wBAAwB,EAAE;AAEnC;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAIpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAHnC,OAAO,CAAC,iBAAiB,CAAa;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;gBAExC,KAAK,CAAC,wCAA4B;IAE/D;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAMjC;IAED;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAO/D;;OAEG;IACI,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IAQP;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIxD;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CACnD,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,GAC7B,YAAY,CAcd;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,wBAAwB;;;;EAQnE;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,aAAa,QAS5D"}
@@ -1 +1 @@
1
- {"version":3,"file":"urlUtils.d.ts","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAElE,eAAO,MAAM,aAAa,aAAc,MAAM,KAAG,QAEhD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,YAAa,MAAM,cAAc,MAAM,KAAG,MACf,CAAC;AAEhE,eAAO,MAAM,6BAA6B,gBAC5B,YAAY,WAChB,QAAQ,KACf,YAuBF,CAAC"}
1
+ {"version":3,"file":"urlUtils.d.ts","sourceRoot":"","sources":["../src/urlUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,YAAY,EAAE,MAAM,oCAAoC;OAC1D,QAAQ,MAAM,WAAW;OACzB,EAAE,QAAQ,EAAE,MAAM,wCAAwC;AAEjE,eAAO,MAAM,aAAa,aAAc,MAAM,KAAG,QAEhD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,YAAa,MAAM,cAAc,MAAM,KAAG,MACf,CAAC;AAEhE,eAAO,MAAM,6BAA6B,gBAC5B,YAAY,WAChB,QAAQ,KACf,YAuBF,CAAC"}
@@ -5,10 +5,10 @@
5
5
  import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
6
6
  import { IDocumentStorageService, ISummaryContext, IDocumentStorageServicePolicies } from "@fluidframework/driver-definitions";
7
7
  import { ICreateBlobResponse, ISnapshotTree, ISummaryHandle, ISummaryTree, IVersion } from "@fluidframework/protocol-definitions";
8
- import { ICache } from "./cache";
9
- import { IRouterliciousDriverPolicies } from "./policies";
10
- import { GitManager } from "./gitManager";
11
- import { INormalizedWholeSnapshot } from "./contracts";
8
+ import { ICache } from "./cache.mjs";
9
+ import { IRouterliciousDriverPolicies } from "./policies.mjs";
10
+ import { GitManager } from "./gitManager.mjs";
11
+ import { INormalizedWholeSnapshot } from "./contracts.mjs";
12
12
  export declare class WholeSummaryDocumentStorageService implements IDocumentStorageService {
13
13
  protected readonly id: string;
14
14
  protected readonly manager: GitManager;
@@ -1 +1 @@
1
- {"version":3,"file":"wholeSummaryDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/wholeSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,mBAAmB,EAInB,MAAM,iCAAiC,CAAC;AAIzC,OAAO,EACN,uBAAuB,EACvB,eAAe,EACf,+BAA+B,EAC/B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAM1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C,OAAO,EAAE,wBAAwB,EAAsB,MAAM,aAAa,CAAC;AAK3E,qBAAa,kCAAmC,YAAW,uBAAuB;IAYhF,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IACtC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;aAC9B,QAAQ,EAAE,+BAA+B;IACzD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAnBnC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IACvC,OAAO,CAAC,iBAAiB,CAAiB;IAE1C,SAAgB,aAAa,MAAM;YAErB,uBAAuB;gBAMjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,+BAA+B,EACxC,cAAc,CAAC,0CAA8B,EAC7C,SAAS,GAAE,MAAM,CAAC,eAAe,CAAuB,EACxD,iBAAiB,GAAE,MAAM,CAAC,wBAAwB,CAAuB,EACzE,iBAAiB,CAAC,wBAAY,EAC9B,iBAAiB,GAAE,CACnC,YAAY,CAAC,EAAE,OAAO,KAClB,OAAO,CAAC,UAAU,CAGP;IAQJ,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA0FzE,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IA+BlE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAgClD,wBAAwB,CACpC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAqBL,eAAe,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAwBrE,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB9D,iBAAiB;YA4CjB,sBAAsB;YAetB,gBAAgB;IAS9B,OAAO,CAAC,WAAW;CAGnB"}
1
+ {"version":3,"file":"wholeSummaryDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/wholeSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,mBAAmB,EAInB,MAAM,iCAAiC;OAIjC,EACN,uBAAuB,EACvB,eAAe,EACf,+BAA+B,EAC/B,MAAM,oCAAoC;OACpC,EACN,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,MAAM,sCAAsC;OACtC,EAAE,MAAM,EAAiB;OACzB,EAAE,4BAA4B,EAAE;OAMhC,EAAE,UAAU,EAAE;OAId,EAAE,wBAAwB,EAAsB;AAKvD,qBAAa,kCAAmC,YAAW,uBAAuB;IAYhF,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IACtC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;aAC9B,QAAQ,EAAE,+BAA+B;IACzD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAnBnC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IACvC,OAAO,CAAC,iBAAiB,CAAiB;IAE1C,SAAgB,aAAa,MAAM;YAErB,uBAAuB;gBAMjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,+BAA+B,EACxC,cAAc,CAAC,0CAA8B,EAC7C,SAAS,GAAE,MAAM,CAAC,eAAe,CAAuB,EACxD,iBAAiB,GAAE,MAAM,CAAC,wBAAwB,CAAuB,EACzE,iBAAiB,CAAC,wBAAY,EAC9B,iBAAiB,GAAE,CACnC,YAAY,CAAC,EAAE,OAAO,KAClB,OAAO,CAAC,UAAU,CAGP;IAQJ,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA0FzE,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IA+BlE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAgClD,wBAAwB,CACpC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAqBL,eAAe,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAwBrE,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB9D,iBAAiB;YA4CjB,sBAAsB;YAetB,gBAAgB;IAS9B,OAAO,CAAC,WAAW;CAGnB"}
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { ISummaryTree, IWholeSummaryPayloadType } from "@fluidframework/server-services-client";
6
- import { IGitManager, ISummaryUploadManager } from "./storageContracts";
6
+ import { IGitManager, ISummaryUploadManager } from "./storageContracts.mjs";
7
7
  /**
8
8
  * Converts summary to snapshot tree and uploads with single snaphot tree payload.
9
9
  */
@@ -1 +1 @@
1
- {"version":3,"file":"wholeSummaryUploadManager.d.ts","sourceRoot":"","sources":["../src/wholeSummaryUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,YAAY,EAEZ,wBAAwB,EAExB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAExE;;GAEG;AACH,qBAAa,yBAA0B,YAAW,qBAAqB;IAC1D,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,WAAW;IAEpC,gBAAgB,CAC5B,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,WAAW,EAAE,wBAAwB,EACrC,cAAc,GAAE,MAAU,EAC1B,OAAO,GAAE,OAAe,GACtB,OAAO,CAAC,MAAM,CAAC;YAcJ,oBAAoB;CAwBlC"}
1
+ {"version":3,"file":"wholeSummaryUploadManager.d.ts","sourceRoot":"","sources":["../src/wholeSummaryUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,YAAY,EAEZ,wBAAwB,EAExB,MAAM,wCAAwC;OACxC,EAAE,WAAW,EAAE,qBAAqB,EAAE;AAE7C;;GAEG;AACH,qBAAa,yBAA0B,YAAW,qBAAqB;IAC1D,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,WAAW;IAEpC,gBAAgB,CAC5B,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,WAAW,EAAE,wBAAwB,EACrC,cAAc,GAAE,MAAU,EAC1B,OAAO,GAAE,OAAe,GACtB,OAAO,CAAC,MAAM,CAAC;YAcJ,oBAAoB;CAwBlC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/routerlicious-driver",
3
- "version": "2.0.0-internal.7.3.0",
3
+ "version": "2.0.0-internal.7.4.1",
4
4
  "description": "Socket.IO + Git implementation of Fluid service API",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -11,18 +11,6 @@
11
11
  "license": "MIT",
12
12
  "author": "Microsoft and contributors",
13
13
  "sideEffects": false,
14
- "exports": {
15
- ".": {
16
- "import": {
17
- "types": "./lib/index.d.ts",
18
- "default": "./lib/index.mjs"
19
- },
20
- "require": {
21
- "types": "./dist/index.d.ts",
22
- "default": "./dist/index.cjs"
23
- }
24
- }
25
- },
26
14
  "main": "dist/index.cjs",
27
15
  "module": "lib/index.mjs",
28
16
  "types": "dist/index.d.ts",
@@ -47,17 +35,17 @@
47
35
  "temp-directory": "nyc/.nyc_output"
48
36
  },
49
37
  "dependencies": {
50
- "@fluid-internal/client-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
51
- "@fluidframework/core-interfaces": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
52
- "@fluidframework/core-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
53
- "@fluidframework/driver-base": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
54
- "@fluidframework/driver-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
55
- "@fluidframework/driver-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
38
+ "@fluid-internal/client-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
39
+ "@fluidframework/core-interfaces": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
40
+ "@fluidframework/core-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
41
+ "@fluidframework/driver-base": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
42
+ "@fluidframework/driver-definitions": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
43
+ "@fluidframework/driver-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
56
44
  "@fluidframework/gitresources": "^2.0.1",
57
45
  "@fluidframework/protocol-base": "^2.0.1",
58
46
  "@fluidframework/protocol-definitions": "^3.0.0",
59
47
  "@fluidframework/server-services-client": "^2.0.1",
60
- "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
48
+ "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
61
49
  "cross-fetch": "^3.1.5",
62
50
  "json-stringify-safe": "5.0.1",
63
51
  "socket.io-client": "^4.6.1",
@@ -65,21 +53,23 @@
65
53
  "uuid": "^9.0.0"
66
54
  },
67
55
  "devDependencies": {
56
+ "@arethetypeswrong/cli": "^0.13.3",
68
57
  "@fluid-tools/build-cli": "^0.28.0",
69
58
  "@fluidframework/build-common": "^2.0.3",
70
59
  "@fluidframework/build-tools": "^0.28.0",
71
60
  "@fluidframework/eslint-config-fluid": "^3.1.0",
72
- "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
61
+ "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
73
62
  "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@2.0.0-internal.7.2.0",
74
63
  "@microsoft/api-extractor": "^7.38.3",
75
64
  "@types/mocha": "^9.1.1",
76
65
  "@types/nock": "^9.3.0",
77
- "@types/node": "^16.18.38",
66
+ "@types/node": "^18.19.0",
78
67
  "@types/sinon": "^7.0.13",
79
68
  "@types/url-parse": "1.4.4",
80
69
  "@types/uuid": "^9.0.2",
81
70
  "axios": "^0.26.0",
82
71
  "c8": "^7.7.1",
72
+ "copyfiles": "^2.4.1",
83
73
  "cross-env": "^7.0.3",
84
74
  "eslint": "~8.50.0",
85
75
  "mocha": "^10.2.0",
@@ -93,26 +83,43 @@
93
83
  "tsc-multi": "^1.1.0",
94
84
  "typescript": "~5.1.6"
95
85
  },
86
+ "fluidBuild": {
87
+ "tasks": {
88
+ "build:docs": {
89
+ "dependsOn": [
90
+ "...",
91
+ "api-extractor:commonjs",
92
+ "api-extractor:esnext"
93
+ ],
94
+ "script": false
95
+ }
96
+ }
97
+ },
96
98
  "typeValidation": {
97
99
  "broken": {}
98
100
  },
99
101
  "scripts": {
102
+ "api": "fluid-build . --task api",
103
+ "api-extractor:commonjs": "api-extractor run --local",
104
+ "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
100
105
  "build": "fluid-build . --task build",
101
106
  "build:commonjs": "fluid-build . --task commonjs",
102
107
  "build:compile": "fluid-build . --task compile",
103
- "build:docs": "api-extractor run --local",
108
+ "build:docs": "fluid-build . --task api",
104
109
  "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
105
110
  "build:genver": "gen-version",
106
111
  "build:test": "tsc-multi --config ./tsc-multi.test.json",
112
+ "check:are-the-types-wrong": "attw --pack",
113
+ "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
107
114
  "ci:build:docs": "api-extractor run",
108
115
  "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
109
116
  "eslint": "eslint --format stylish src",
110
117
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
111
118
  "format": "npm run prettier:fix",
112
- "lint": "npm run prettier && npm run eslint",
119
+ "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
113
120
  "lint:fix": "npm run prettier:fix && npm run eslint:fix",
114
- "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
115
- "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
121
+ "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
122
+ "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
116
123
  "test": "npm run test:mocha",
117
124
  "test:coverage": "c8 npm test",
118
125
  "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
@@ -7,6 +7,7 @@ import { ITokenProvider, ITokenResponse } from "./tokens";
7
7
 
8
8
  /**
9
9
  * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
10
+ * @internal
10
11
  */
11
12
 
12
13
  export class DefaultTokenProvider implements ITokenProvider {
@@ -58,6 +58,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
58
58
  /**
59
59
  * Factory for creating the routerlicious document service. Use this if you want to
60
60
  * use the routerlicious implementation.
61
+ * @internal
61
62
  */
62
63
  export class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
63
64
  private readonly driverPolicies: IRouterliciousDriverPolicies;
@@ -376,6 +377,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
376
377
  * @remarks TODO: examples of suggested actions for recovery.
377
378
  * - How would a user delete the created document?
378
379
  * - What would a retry pattern look like here?
380
+ * @internal
379
381
  */
380
382
  export class DocumentPostCreateError extends Error {
381
383
  public constructor(
package/src/errorUtils.ts CHANGED
@@ -20,6 +20,7 @@ import { pkgVersion as driverVersion } from "./packageVersion";
20
20
  /**
21
21
  * Routerlicious Error types
22
22
  * Different error types that may be thrown by the routerlicious driver
23
+ * @internal
23
24
  */
24
25
  export const RouterliciousErrorTypes = {
25
26
  // Inherit base driver error types
@@ -30,6 +31,9 @@ export const RouterliciousErrorTypes = {
30
31
  */
31
32
  sslCertError: "sslCertError",
32
33
  } as const;
34
+ /**
35
+ * @internal
36
+ */
33
37
  export type RouterliciousErrorTypes =
34
38
  (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
35
39
 
@@ -38,6 +42,7 @@ export type RouterliciousErrorTypes =
38
42
  * Different error types that may be thrown by the routerlicious driver
39
43
  *
40
44
  * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
45
+ * @internal
41
46
  */
42
47
  export enum RouterliciousErrorType {
43
48
  /**
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/routerlicious-driver";
9
- export const pkgVersion = "2.0.0-internal.7.3.0";
9
+ export const pkgVersion = "2.0.0-internal.7.4.1";