@fluidframework/routerlicious-driver 2.74.0 → 2.81.0-374083

package/src/restWrapper.ts

@@ -25,7 +25,6 @@ import {
 import fetch from "cross-fetch";
 import safeStringify from "json-stringify-safe";
 
-import type { AxiosRequestConfig, RawAxiosRequestHeaders } from "./axios.cjs";
 import {
 	getUrlForTelemetry,
 	RouterliciousErrorTypes,
@@ -33,21 +32,22 @@ import {
 } from "./errorUtils.js";
 import { pkgVersion as driverVersion } from "./packageVersion.js";
 import { addOrUpdateQueryParams, type QueryStringType } from "./queryStringUtils.js";
+import type { RequestConfig, RawRequestHeaders } from "./request.cjs";
 import { RestWrapper } from "./restWrapperBase.js";
 import { ITokenProvider, ITokenResponse } from "./tokens.js";
 
 type AuthorizationHeaderGetter = (token: ITokenResponse) => string;
 export type TokenFetcher = (refresh?: boolean) => Promise<ITokenResponse>;
 
-const buildRequestUrl = (requestConfig: AxiosRequestConfig): string =>
+const buildRequestUrl = (requestConfig: RequestConfig): string =>
 	requestConfig.baseURL !== undefined
 		? `${requestConfig.baseURL ?? ""}${requestConfig.url ?? ""}`
 		: (requestConfig.url ?? "");
 
-const axiosBuildRequestInitConfig = (requestConfig: AxiosRequestConfig): RequestInit => {
+const buildRequestInitConfig = (requestConfig: RequestConfig): RequestInit => {
 	const requestInit: RequestInit = {
 		method: requestConfig.method,
-		// NOTE: I believe that although the Axios type permits non-string values in the header, here we are
+		// NOTE: Although the RequestHeaders type permits non-string values in the header, here we are
 		// guaranteed the requestConfig only has string values in its header.
 		headers: requestConfig.headers as Record<string, string>,
 		body: requestConfig.data,
@@ -139,7 +139,7 @@ class RouterliciousRestWrapper extends RestWrapper {
 	}
 
 	protected async request<T>(
-		requestConfig: AxiosRequestConfig,
+		requestConfig: RequestConfig,
 		statusCode: number,
 		canRetry = true,
 	): Promise<IR11sResponse<T>> {
@@ -151,7 +151,7 @@ class RouterliciousRestWrapper extends RestWrapper {
 		// Build the complete request url including baseUrl, url and query params. (all except 'retry' query param)
 		let completeRequestUrl = addOrUpdateQueryParams(
 			buildRequestUrl(requestConfig),
-			requestConfig.params,
+			requestConfig.params ?? {},
 		);
 
 		// Check whether this request has been made before or if it is a retry.
@@ -164,13 +164,17 @@ class RouterliciousRestWrapper extends RestWrapper {
 			});
 		}
 
-		const config = {
+		const config: RequestConfig = {
 			...requestConfig,
 			headers: await this.generateHeaders(requestConfig.headers),
 		};
 
-		const translatedConfig = this.useRestLess ? this.restLess.translate(config) : config;
-		const fetchRequestConfig = axiosBuildRequestInitConfig(translatedConfig);
+		// RestLessClient.translate() returns AxiosRequestConfig (from server-services-client),
+		// which is structurally compatible with our RequestConfig type.
+		const translatedConfig: RequestConfig = this.useRestLess
+			? (this.restLess.translate(config) as RequestConfig)
+			: config;
+		const fetchRequestConfig = buildRequestInitConfig(translatedConfig);
 
 		const res = await this.rateLimiter.schedule(async () => {
 			const perfStart = performanceNow();
@@ -292,11 +296,11 @@ class RouterliciousRestWrapper extends RestWrapper {
 	}
 
 	private async generateHeaders(
-		requestHeaders?: RawAxiosRequestHeaders | undefined,
-	): Promise<RawAxiosRequestHeaders> {
+		requestHeaders?: RawRequestHeaders | undefined,
+	): Promise<RawRequestHeaders> {
 		const token = await this.getToken();
 		assert(token !== undefined, 0x679 /* token should be present */);
-		const headers: RawAxiosRequestHeaders = {
+		const headers: RawRequestHeaders = {
 			...requestHeaders,
 			[DriverVersionHeaderName]: driverVersion,
 			// NOTE: If this.authorizationHeader is undefined, should "Authorization" be removed entirely?

package/src/restWrapperBase.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import type { AxiosRequestConfig, AxiosRequestHeaders } from "./axios.cjs";
-import { type QueryStringType } from "./queryStringUtils.js";
+import type { QueryStringType } from "./queryStringUtils.js";
+import type { RequestConfig, RequestHeaders } from "./request.cjs";
 import { IR11sResponse } from "./restWrapper.js";
 
 export abstract class RestWrapper {
@@ -24,15 +24,15 @@ export abstract class RestWrapper {
 	public async get<T>(
 		url: string,
 		queryString?: QueryStringType,
-		headers?: AxiosRequestHeaders,
+		headers?: RequestHeaders,
 		additionalOptions?: Partial<
 			Omit<
-				AxiosRequestConfig,
+				RequestConfig,
 				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
 			>
 		>,
 	): Promise<IR11sResponse<T>> {
-		const options: AxiosRequestConfig = {
+		const options: RequestConfig = {
 			...additionalOptions,
 			baseURL: this.baseurl,
 			headers,
@@ -56,15 +56,15 @@ export abstract class RestWrapper {
 		url: string,
 		requestBody: any,
 		queryString?: QueryStringType,
-		headers?: AxiosRequestHeaders,
+		headers?: RequestHeaders,
 		additionalOptions?: Partial<
 			Omit<
-				AxiosRequestConfig,
+				RequestConfig,
 				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
 			>
 		>,
 	): Promise<IR11sResponse<T>> {
-		const options: AxiosRequestConfig = {
+		const options: RequestConfig = {
 			...additionalOptions,
 			baseURL: this.baseurl,
 			data: requestBody,
@@ -87,15 +87,15 @@ export abstract class RestWrapper {
 	public async delete<T>(
 		url: string,
 		queryString?: QueryStringType,
-		headers?: AxiosRequestHeaders,
+		headers?: RequestHeaders,
 		additionalOptions?: Partial<
 			Omit<
-				AxiosRequestConfig,
+				RequestConfig,
 				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
 			>
 		>,
 	): Promise<IR11sResponse<T>> {
-		const options: AxiosRequestConfig = {
+		const options: RequestConfig = {
 			...additionalOptions,
 			baseURL: this.baseurl,
 			headers,
@@ -119,15 +119,15 @@ export abstract class RestWrapper {
 		url: string,
 		requestBody: any,
 		queryString?: QueryStringType,
-		headers?: AxiosRequestHeaders,
+		headers?: RequestHeaders,
 		additionalOptions?: Partial<
 			Omit<
-				AxiosRequestConfig,
+				RequestConfig,
 				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
 			>
 		>,
 	): Promise<IR11sResponse<T>> {
-		const options: AxiosRequestConfig = {
+		const options: RequestConfig = {
 			...additionalOptions,
 			baseURL: this.baseurl,
 			data: requestBody,
@@ -142,7 +142,7 @@ export abstract class RestWrapper {
 	}
 
 	protected abstract request<T>(
-		options: AxiosRequestConfig,
+		options: RequestConfig,
 		statusCode: number,
 		addNetworkCallProps?: boolean,
 	): Promise<IR11sResponse<T>>;

package/src/shreddedSummaryDocumentStorageService.ts

@@ -76,6 +76,7 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 	}
 
 	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+		// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- using ?? could change behavior for falsy values
 		const id = versionId ? versionId : this.id;
 		const commits = await PerformanceEvent.timedExecAsync(
 			this.logger,

package/src/wholeSummaryDocumentStorageService.ts

@@ -142,6 +142,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 		}
 
 		// Otherwise, get the latest version of the document as normal.
+		// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- using ?? could change behavior for falsy values
 		const id = versionId ? versionId : this.id;
 		const commits = await PerformanceEvent.timedExecAsync(
 			this.logger,

package/.eslintrc.cjs

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: [
-		require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
-		"prettier",
-	],
-	parserOptions: {
-		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
-	},
-	rules: {
-		"@typescript-eslint/no-non-null-assertion": "off",
-		"@typescript-eslint/strict-boolean-expressions": "off",
-		"no-case-declarations": "off",
-		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
-
-		// Disabled because the rule is crashing on this package - AB#51780
-		"@typescript-eslint/unbound-method": "off",
-	},
-};

package/dist/axios.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios.cjs","sourceRoot":"","sources":["../src/axios.cts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders } from \"axios\";\n\nexport { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders };\n"]}

package/dist/axios.d.cts

@@ -1,7 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders } from "axios";
-export { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders };
-//# sourceMappingURL=axios.d.cts.map

package/dist/axios.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios.d.cts","sourceRoot":"","sources":["../src/axios.cts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAC;AAE7F,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,CAAC"}

package/lib/axios.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios.cjs","sourceRoot":"","sources":["../src/axios.cts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders } from \"axios\";\n\nexport { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders };\n"]}

package/lib/axios.d.cts

@@ -1,7 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders } from "axios";
-export { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders };
-//# sourceMappingURL=axios.d.cts.map

package/lib/axios.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"axios.d.cts","sourceRoot":"","sources":["../src/axios.cts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAC;AAE7F,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,CAAC"}

package/src/axios.cts

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import type { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders } from "axios";
-
-export { AxiosRequestConfig, AxiosRequestHeaders, RawAxiosRequestHeaders };