@fluidframework/routerlicious-driver 2.1.0-276985 → 2.1.0-281041

package/src/restWrapperBase.ts

@@ -4,6 +4,7 @@
  */
 
 import type { AxiosRequestConfig, AxiosRequestHeaders } from "./axios.cjs";
+import { type QueryStringType } from "./queryStringUtils.js";
 import { IR11sResponse } from "./restWrapper.js";
 
 export abstract class RestWrapper {
@@ -14,6 +15,12 @@ export abstract class RestWrapper {
 		protected readonly maxContentLength = 1000 * 1024 * 1024,
 	) {}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async get<T>(
 		url: string,
 		queryString?: QueryStringType,
@@ -32,11 +39,19 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "GET",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 200);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param requestBody - requestBody
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async post<T>(
 		url: string,
 		requestBody: any,
@@ -57,11 +72,18 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "POST",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 201);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async delete<T>(
 		url: string,
 		queryString?: QueryStringType,
@@ -80,11 +102,19 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "DELETE",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 204);
 	}
 
+	/**
+	 * @param url - Relative or absolute request url.(should not contain any query params)
+	 * @param requestBody - requestBody
+	 * @param queryString - query params to be appended to the request url
+	 * @param headers - headers
+	 * @param additionalOptions - additionalOptions
+	 */
 	public async patch<T>(
 		url: string,
 		requestBody: any,
@@ -105,7 +135,8 @@ export abstract class RestWrapper {
 			maxBodyLength: this.maxBodyLength,
 			maxContentLength: this.maxContentLength,
 			method: "PATCH",
-			url: `${url}${this.generateQueryString(queryString)}`,
+			url,
+			params: { ...this.defaultQueryString, ...queryString },
 		};
 		return this.request<T>(options, 200);
 	}
@@ -115,32 +146,4 @@ export abstract class RestWrapper {
 		statusCode: number,
 		addNetworkCallProps?: boolean,
 	): Promise<IR11sResponse<T>>;
-
-	protected generateQueryString(queryStringValues?: QueryStringType) {
-		if (this.defaultQueryString || queryStringValues) {
-			const queryStringMap = { ...this.defaultQueryString, ...queryStringValues };
-
-			return getQueryString(queryStringMap);
-		}
-
-		return "";
-	}
-}
-
-/**
- * Generates query string from the given query parameters.
- * @param queryParams - Query parameters from which to create a query.
- */
-export function getQueryString(queryParams: QueryStringType): string {
-	let queryString = "";
-	for (const key of Object.keys(queryParams)) {
-		if (queryParams[key] !== undefined) {
-			const startChar = queryString === "" ? "?" : "&";
-			queryString += `${startChar}${key}=${encodeURIComponent(queryParams[key])}`;
-		}
-	}
-
-	return queryString;
 }
-
-export type QueryStringType = Record<string, string | number | boolean>;

package/src/shreddedSummaryDocumentStorageService.ts

@@ -98,13 +98,14 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 
 	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null> {
 		let requestVersion = version;
-		if (!requestVersion) {
+		if (requestVersion === undefined) {
 			const versions = await this.getVersions(this.id, 1);
-			if (versions.length === 0) {
+			const firstVersion = versions[0];
+			if (firstVersion === undefined) {
 				return null;
 			}
 
-			requestVersion = versions[0];
+			requestVersion = firstVersion;
 		}
 
 		const cachedSnapshotTree = await this.snapshotTreeCache?.get(

package/src/summaryTreeUploadManager.ts

@@ -41,8 +41,7 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 		previousFullSnapshot: ISnapshotTreeEx | undefined,
 	): Promise<string> {
 		const entries = await Promise.all(
-			Object.keys(summaryTree.tree).map(async (key) => {
-				const entry = summaryTree.tree[key];
+			Object.entries(summaryTree.tree).map(async ([key, entry]) => {
 				const pathHandle = await this.writeSummaryTreeObject(entry, previousFullSnapshot);
 				const treeEntry: IGitCreateTreeEntry = {
 					mode: getGitMode(entry),
@@ -123,8 +122,8 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 		/** Previous snapshot, subtree relative to this path part */
 		previousSnapshot: ISnapshotTreeEx,
 	): string {
-		assert(path.length > 0, 0x0b3 /* "Expected at least 1 path part" */);
 		const key = path[0];
+		assert(path.length > 0 && key !== undefined, 0x0b3 /* "Expected at least 1 path part" */);
 		if (path.length === 1) {
 			switch (handleType) {
 				case SummaryType.Blob: {
@@ -147,6 +146,7 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 					throw Error(`Unexpected handle summary object type: "${handleType}".`);
 			}
 		}
-		return this.getIdFromPathCore(handleType, path.slice(1), previousSnapshot.trees[key]);
+		// TODO why are we non null asserting here?
+		return this.getIdFromPathCore(handleType, path.slice(1), previousSnapshot.trees[key]!);
 	}
 }

package/src/urlUtils.ts

@@ -20,11 +20,13 @@ export const getDiscoveredFluidResolvedUrl = (
 	session: ISession,
 ): IResolvedUrl => {
 	const discoveredOrdererUrl = new URL(session.ordererUrl);
-	const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl);
+	// TODO why are we non null asserting here?
+	const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl!);
 	deltaStorageUrl.host = discoveredOrdererUrl.host;
 
 	const discoveredStorageUrl = new URL(session.historianUrl);
-	const storageUrl = new URL(resolvedUrl.endpoints.storageUrl);
+	// TODO why are we non null asserting here?
+	const storageUrl = new URL(resolvedUrl.endpoints.storageUrl!);
 	storageUrl.host = discoveredStorageUrl.host;
 
 	const parsedUrl = new URL(resolvedUrl.url);

package/src/wholeSummaryDocumentStorageService.ts

@@ -161,13 +161,14 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	// eslint-disable-next-line @rushstack/no-new-null
 	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 		let requestVersion = version;
-		if (!requestVersion) {
+		if (requestVersion === undefined) {
 			const versions = await this.getVersions(this.id, 1);
-			if (versions.length === 0) {
+			const firstVersion = versions[0];
+			if (firstVersion === undefined) {
 				return null;
 			}
 
-			requestVersion = versions[0];
+			requestVersion = firstVersion;
 		}
 
 		let normalizedWholeSnapshot = await this.snapshotTreeCache.get(

package/tsconfig.json

@@ -6,6 +6,5 @@
 		"rootDir": "./src",
 		"outDir": "./lib",
 		"exactOptionalPropertyTypes": false,
-		"noUncheckedIndexedAccess": false,
 	},
 }

package/api-extractor/api-extractor-lint-beta.esm.json

@@ -1,5 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
-	"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
-}

package/beta.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export * from "./lib/beta.js";

package/dist/beta.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export {
-	// @public APIs
-	ITokenProvider, 
-	ITokenResponse
-} from "./index.js";

package/lib/beta.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
- */
-
-export {
-	// @public APIs
-	ITokenProvider, 
-	ITokenResponse
-} from "./index.js";