@fluidframework/driver-utils 2.0.0-dev.6.4.0.192049 → 2.0.0-dev.7.2.0.204906

package/src/rateLimiter.ts

@@ -5,6 +5,9 @@
 
 import { assert } from "@fluidframework/core-utils";
 
+/**
+ * @public
+ */
 export class RateLimiter {
 	private readonly tasks: (() => void)[] = [];
 	constructor(private maxRequests: number) {

package/src/readAndParse.ts

@@ -17,6 +17,7 @@ import { IDocumentStorageService } from "@fluidframework/driver-definitions";
  * @typeParam T - Output type matching JSON format of inpyt blob data.
  *
  * @returns The object that we decoded and parsed via `JSON.parse`.
+ * @public
  */
 export async function readAndParse<T>(
 	storage: Pick<IDocumentStorageService, "readBlob">,

package/src/runWithRetry.ts

@@ -14,6 +14,7 @@ import { NonRetryableError } from ".";
 /**
  * Interface describing an object passed to various network APIs.
  * It allows caller to control cancellation, as well as learn about any delays.
+ * @public
  */
 export interface IProgress {
 	/**
@@ -43,6 +44,9 @@ export interface IProgress {
 	onRetry?(delayInMs: number, error: any): void;
 }
 
+/**
+ * @public
+ */
 export async function runWithRetry<T>(
 	api: (cancel?: AbortSignal) => Promise<T>,
 	fetchCallName: string,
@@ -81,8 +85,7 @@ export async function runWithRetry<T>(
 						retry: numRetries,
 						duration: performance.now() - startTime,
 						fetchCallName,
-						// TODO: Remove when typescript version of the repo contains the AbortSignal.reason property (AB#5045)
-						reason: (progress.cancel as AbortSignal & { reason: any }).reason,
+						reason: progress.cancel.reason,
 					},
 					err,
 				);
@@ -92,8 +95,7 @@ export async function runWithRetry<T>(
 					{
 						driverVersion: pkgVersion,
 						fetchCallName,
-						// TODO: Remove when typescript version of the repo contains the AbortSignal.reason property (AB#5045)
-						reason: (progress.cancel as AbortSignal & { reason: any }).reason,
+						reason: progress.cancel.reason,
 					},
 				);
 			}
@@ -148,6 +150,7 @@ const MaxReconnectDelayInMsWhenEndpointIsNotReachable = 8000;
  * to when endpoint is reachable in which case it is 30s.
  * @param error - error based on which we decide max wait time.
  * @returns Max wait time.
+ * @public
  */
 export function calculateMaxWaitTime(error: unknown): number {
 	return isFluidError(error) && error.getTelemetryProperties().endpointReached === true

package/src/summaryForCreateNew.ts

@@ -30,6 +30,7 @@ export interface CombinedAppAndProtocolSummary extends ISummaryTree {
  */
 export function isCombinedAppAndProtocolSummary(
 	summary: ISummaryTree | undefined,
+	...optionalRootTrees: string[]
 ): summary is CombinedAppAndProtocolSummary {
 	if (
 		summary?.tree === undefined ||
@@ -38,7 +39,7 @@ export function isCombinedAppAndProtocolSummary(
 	) {
 		return false;
 	}
-	const treeKeys = Object.keys(summary.tree);
+	const treeKeys = Object.keys(summary.tree).filter((t) => !optionalRootTrees.includes(t));
 	if (treeKeys.length !== 2) {
 		return false;
 	}
@@ -48,6 +49,7 @@ export function isCombinedAppAndProtocolSummary(
 /**
  * Extract the attributes from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export function getDocAttributesFromProtocolSummary(
 	protocolSummary: ISummaryTree,
@@ -59,6 +61,7 @@ export function getDocAttributesFromProtocolSummary(
 /**
  * Extract quorum values from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export function getQuorumValuesFromProtocolSummary(
 	protocolSummary: ISummaryTree,

package/src/treeConversions.ts

@@ -12,6 +12,7 @@ import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew";
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @public
  */
 export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {
 	const entries: ITreeEntry[] = [];