@fluidframework/driver-utils 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/src/adapters/compression/compressionTypes.ts

@@ -4,7 +4,7 @@
  */
 
 /**
- * @public
+ * @alpha
  */
 export enum SummaryCompressionAlgorithm {
 	None = 0,
@@ -12,7 +12,7 @@ export enum SummaryCompressionAlgorithm {
 }
 
 /**
- * @public
+ * @alpha
  */
 export interface ICompressionStorageConfig {
 	algorithm: SummaryCompressionAlgorithm;

package/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts

@@ -20,7 +20,7 @@ import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProx
 import { ICompressionStorageConfig, SummaryCompressionAlgorithm } from "../";
 
 /**
- * @public
+ * @internal
  */
 export const blobHeadersBlobName = ".metadata.blobHeaders";
 const metadataBlobName = ".metadata";

package/src/adapters/predefinedAdapters.ts

@@ -17,7 +17,7 @@ import {
  * @param documentServiceFactory - The document service factory to apply compression to.
  * @param config - The compression configuration.
  * @returns The document service factory possibly with compression applied.
- * @public
+ * @internal
  */
 export function applyStorageCompression(
 	documentServiceFactory: IDocumentServiceFactory,

package/src/blob.ts

@@ -13,7 +13,7 @@ import {
 
 /**
  * Basic implementation of a blob ITreeEntry
- * @public
+ * @internal
  */
 export class BlobTreeEntry {
 	public readonly mode = FileMode.File;
@@ -37,7 +37,7 @@ export class BlobTreeEntry {
 
 /**
  * Basic implementation of a tree ITreeEntry
- * @public
+ * @internal
  */
 export class TreeTreeEntry {
 	public readonly mode = FileMode.Directory;
@@ -56,7 +56,7 @@ export class TreeTreeEntry {
 
 /**
  * Basic implementation of an attachment ITreeEntry
- * @public
+ * @internal
  */
 export class AttachmentTreeEntry {
 	public readonly mode = FileMode.File;

package/src/buildSnapshotTree.ts

@@ -86,7 +86,7 @@ function flatten(tree: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): git
  * @param blobMap - a map of blob's sha1 to content that gets filled with content from entries
  * NOTE: blobMap's validity is contingent on the returned promise's resolution
  * @returns the hierarchical tree
- * @public
+ * @internal
  */
 export function buildSnapshotTree(
 	entries: ITreeEntry[],

package/src/documentStorageServiceProxy.ts

@@ -18,7 +18,7 @@ import {
 } from "@fluidframework/protocol-definitions";
 
 /**
- * @public
+ * @internal
  */
 export class DocumentStorageServiceProxy implements IDocumentStorageService {
 	private _policies: IDocumentStorageServicePolicies | undefined;

package/src/error.ts

@@ -9,7 +9,7 @@ import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
 /**
  * Error indicating an API is being used improperly resulting in an invalid operation.
- * @public
+ * @internal
  */
 export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated

package/src/insecureUrlResolver.ts

@@ -22,7 +22,7 @@ import Axios from "axios";
  * The tenantId/documentId pair defines the 'full' document ID the service makes use of. The path is then an optional
  * part of the URL that the document interprets and maps to a data store. It's exactly similar to how a web service
  * works or a router inside of a single page app framework.
- * @public
+ * @internal
  */
 export class InsecureUrlResolver implements IUrlResolver {
 	private readonly cache = new Map<string, Promise<IResolvedUrl>>();

package/src/messageRecognition.ts

@@ -12,7 +12,7 @@ import {
  * Tells if message was sent by container runtime
  * @privateRemarks ADO #1385: To be moved to container-definitions
  * @returns whether the message is a runtime message
- * @public
+ * @internal
  */
 export function isRuntimeMessage(message: { type: string }): boolean {
 	return message.type === MessageType.Operation;
@@ -21,7 +21,7 @@ export function isRuntimeMessage(message: { type: string }): boolean {
 /**
  * @privateRemarks ADO #1385: staging code changes across layers.
  * Eventually to be replaced by MessageType.accept
- * @public
+ * @internal
  */
 export enum MessageType2 {
 	Accept = "accept",
@@ -29,7 +29,7 @@ export enum MessageType2 {
 
 /**
  * @privateRemarks ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
- * @public
+ * @internal
  */
 export function canBeCoalescedByService(
 	message: ISequencedDocumentMessage | IDocumentMessage,

package/src/network.ts

@@ -17,7 +17,7 @@ import { ITelemetryProperties } from "@fluidframework/core-interfaces";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
 /**
- * @public
+ * @internal
  */
 export enum OnlineStatus {
 	Offline,
@@ -29,7 +29,7 @@ export enum OnlineStatus {
  * It tells if we have local connection only - we might not have connection to web.
  * No solution for node.js (other than resolve dns names / ping specific sites)
  * Can also use window.addEventListener("online" / "offline")
- * @public
+ * @internal
  */
 export function isOnline(): OnlineStatus {
 	if (
@@ -44,7 +44,7 @@ export function isOnline(): OnlineStatus {
 
 /**
  * Telemetry props with driver-specific required properties
- * @public
+ * @internal
  */
 export type DriverErrorTelemetryProps = ITelemetryProperties & {
 	driverVersion: string | undefined;
@@ -52,7 +52,7 @@ export type DriverErrorTelemetryProps = ITelemetryProperties & {
 
 /**
  * Generic network error class.
- * @public
+ * @internal
  */
 export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated
@@ -69,7 +69,7 @@ export class GenericNetworkError extends LoggingError implements IDriverErrorBas
 
 /**
  * FluidInvalidSchema error class.
- * @public
+ * @internal
  */
 export class FluidInvalidSchemaError
 	extends LoggingError
@@ -85,7 +85,7 @@ export class FluidInvalidSchemaError
 }
 
 /**
- * @public
+ * @internal
  */
 export class DeltaStreamConnectionForbiddenError
 	extends LoggingError
@@ -104,7 +104,7 @@ export class DeltaStreamConnectionForbiddenError
 }
 
 /**
- * @public
+ * @internal
  */
 export class AuthorizationError
 	extends LoggingError
@@ -126,7 +126,7 @@ export class AuthorizationError
 }
 
 /**
- * @public
+ * @internal
  */
 export class LocationRedirectionError
 	extends LoggingError
@@ -147,7 +147,7 @@ export class LocationRedirectionError
 }
 
 /**
- * @public
+ * @internal
  */
 export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
 	constructor(
@@ -161,7 +161,7 @@ export class NetworkErrorBasic<T extends string> extends LoggingError implements
 }
 
 /**
- * @public
+ * @internal
  */
 export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
 	constructor(
@@ -174,7 +174,7 @@ export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
 }
 
 /**
- * @public
+ * @internal
  */
 export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
 	constructor(
@@ -188,7 +188,7 @@ export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
 
 /**
  * Throttling error class - used to communicate all throttling errors
- * @public
+ * @internal
  */
 export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated
@@ -205,13 +205,13 @@ export class ThrottlingError extends LoggingError implements IThrottlingWarning,
 }
 
 /**
- * @public
+ * @internal
  */
 export const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>
 	new NonRetryableError(message, DriverErrorTypes.writeError, props);
 
 /**
- * @public
+ * @internal
  */
 export function createGenericNetworkError(
 	message: string,
@@ -228,20 +228,20 @@ export function createGenericNetworkError(
  * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.
  * I.e. asserts or unexpected exceptions in our code result in container failure.
  * @param error - The error to inspect for ability to retry
- * @public
+ * @internal
  */
 export const canRetryOnError = (error: any): boolean => error?.canRetry === true;
 
 /**
  * Check retryAfterSeconds property on error
- * @public
- * */
+ * @internal
+ */
 export const getRetryDelaySecondsFromError = (error: any): number | undefined =>
 	error?.retryAfterSeconds as number | undefined;
 
 /**
  * Check retryAfterSeconds property on error and convert to ms
- * @public
- * */
+ * @internal
+ */
 export const getRetryDelayFromError = (error: any): number | undefined =>
 	error?.retryAfterSeconds !== undefined ? error.retryAfterSeconds * 1000 : undefined;

package/src/networkUtils.ts

@@ -8,7 +8,7 @@ import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { isOnline, OnlineStatus, canRetryOnError } from "./network";
 
 /**
- * @public
+ * @internal
  */
 export function logNetworkFailure(
 	logger: ITelemetryLoggerExt,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-internal.7.3.0";
+export const pkgVersion = "2.0.0-internal.8.0.0";

package/src/parallelRequests.ts

@@ -30,7 +30,7 @@ type WorkingState = "working" | "done" | "canceled";
  * @param logger - logger to use
  * @param requestCallback - callback to request batches
  * @returns Queue that can be used to retrieve data
- * @public
+ * @internal
  */
 export class ParallelRequests<T> {
 	private latestRequested: number;
@@ -340,7 +340,7 @@ export class ParallelRequests<T> {
 /**
  * Helper queue class to allow async push / pull
  * It's essentially a pipe allowing multiple writers, and single reader
- * @public
+ * @internal
  */
 export class Queue<T> implements IStream<T> {
 	private readonly queue: Promise<IStreamResult<T>>[] = [];
@@ -533,7 +533,7 @@ async function getSingleOpBatch(
  * @param signal - Cancelation signal
  * @param scenarioName - Reason for fetching ops
  * @returns Messages fetched
- * @public
+ * @internal
  */
 export function requestOps(
 	get: (
@@ -655,7 +655,7 @@ export function requestOps(
 }
 
 /**
- * @public
+ * @internal
  */
 export const emptyMessageStream: IStream<ISequencedDocumentMessage[]> = {
 	read: async () => {
@@ -664,7 +664,7 @@ export const emptyMessageStream: IStream<ISequencedDocumentMessage[]> = {
 };
 
 /**
- * @public
+ * @internal
  */
 export function streamFromMessages(
 	messagesArg: Promise<ISequencedDocumentMessage[]>,
@@ -683,7 +683,7 @@ export function streamFromMessages(
 }
 
 /**
- * @public
+ * @internal
  */
 export function streamObserver<T>(
 	stream: IStream<T>,

package/src/prefetchDocumentStorageService.ts

@@ -8,7 +8,7 @@ import { DocumentStorageServiceProxy } from "./documentStorageServiceProxy";
 import { canRetryOnError } from "./network";
 
 /**
- * @public
+ * @internal
  */
 export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy {
 	// BlobId -> blob prefetchCache cache

package/src/rateLimiter.ts

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

package/src/readAndParse.ts

@@ -17,7 +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
+ * @internal
  */
 export async function readAndParse<T>(
 	storage: Pick<IDocumentStorageService, "readBlob">,

package/src/runWithRetry.ts

@@ -14,7 +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
+ * @internal
  */
 export interface IProgress {
 	/**
@@ -45,7 +45,7 @@ export interface IProgress {
 }
 
 /**
- * @public
+ * @internal
  */
 export async function runWithRetry<T>(
 	api: (cancel?: AbortSignal) => Promise<T>,
@@ -151,7 +151,7 @@ const MaxReconnectDelayInMsWhenEndpointIsNotReachable = 8000;
  * @param delayMs - wait time for previous iteration
  * @param error - error based on which we decide wait time.
  * @returns Wait time to wait for.
- * @public
+ * @internal
  */
 export function calculateMaxWaitTime(delayMs: number, error: unknown): number {
 	const retryDelayFromError = getRetryDelayFromError(error);

package/src/summaryForCreateNew.ts

@@ -49,7 +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
+ * @internal
  */
 export function getDocAttributesFromProtocolSummary(
 	protocolSummary: ISummaryTree,
@@ -61,7 +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
+ * @internal
  */
 export function getQuorumValuesFromProtocolSummary(
 	protocolSummary: ISummaryTree,

package/src/treeConversions.ts

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