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

package/dist/driver-utils-beta.d.ts

@@ -38,11 +38,13 @@ import { LoaderCachingPolicy } from '@fluidframework/driver-definitions';
  * @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
  */
 export declare function applyStorageCompression(documentServiceFactory: IDocumentServiceFactory, config?: ICompressionStorageConfig | boolean): IDocumentServiceFactory;
 
 /**
  * Basic implementation of an attachment ITreeEntry
+ * @public
  */
 export declare class AttachmentTreeEntry {
     readonly path: string;
@@ -58,6 +60,9 @@ export declare class AttachmentTreeEntry {
     constructor(path: string, id: string);
 }
 
+/**
+ * @public
+ */
 export declare class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {
     readonly claims: string | undefined;
     readonly tenantId: string | undefined;
@@ -66,10 +71,14 @@ export declare class AuthorizationError extends LoggingError implements IAuthori
     constructor(message: string, claims: string | undefined, tenantId: string | undefined, props: DriverErrorTelemetryProps);
 }
 
+/**
+ * @public
+ */
 export declare const blobHeadersBlobName = ".metadata.blobHeaders";
 
 /**
  * Basic implementation of a blob ITreeEntry
+ * @public
  */
 export declare class BlobTreeEntry {
     readonly path: string;
@@ -92,6 +101,7 @@ export declare class BlobTreeEntry {
  * @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
  */
 export declare function buildSnapshotTree(entries: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): ISnapshotTree;
 
@@ -101,15 +111,21 @@ export declare function buildSnapshotTree(entries: ITreeEntry[], blobMap: Map<st
  * 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 declare function calculateMaxWaitTime(error: unknown): number;
 
+/**
+ * @privateRemarks ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+ * @public
+ */
 export declare function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
 
 /**
  * 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
  */
 export declare const canRetryOnError: (error: any) => boolean;
 
@@ -118,16 +134,26 @@ export declare const canRetryOnError: (error: any) => boolean;
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @public
  */
 export declare function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree;
 
+/**
+ * @public
+ */
 export declare function createGenericNetworkError(message: string, retryInfo: {
     canRetry: boolean;
     retryAfterMs?: number;
 }, props: DriverErrorTelemetryProps): ThrottlingError | GenericNetworkError;
 
+/**
+ * @public
+ */
 export declare const createWriteError: (message: string, props: DriverErrorTelemetryProps) => NonRetryableError<"writeError">;
 
+/**
+ * @public
+ */
 export declare class DeltaStreamConnectionForbiddenError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
     static readonly errorType = DriverErrorType.deltaStreamConnectionForbidden;
     readonly errorType = DriverErrorType.deltaStreamConnectionForbidden;
@@ -136,6 +162,9 @@ export declare class DeltaStreamConnectionForbiddenError extends LoggingError im
     constructor(message: string, props: DriverErrorTelemetryProps, storageOnlyReason?: string);
 }
 
+/**
+ * @public
+ */
 export declare class DocumentStorageServiceProxy implements IDocumentStorageService {
     protected readonly internalStorageService: IDocumentStorageService;
     private _policies;
@@ -151,15 +180,22 @@ export declare class DocumentStorageServiceProxy implements IDocumentStorageServ
     readBlob(blobId: string): Promise<ArrayBufferLike>;
 }
 
-/** Telemetry props with driver-specific required properties */
+/**
+ * Telemetry props with driver-specific required properties
+ * @public
+ */
 export declare type DriverErrorTelemetryProps = ITelemetryProperties & {
     driverVersion: string | undefined;
 };
 
+/**
+ * @public
+ */
 export declare const emptyMessageStream: IStream<ISequencedDocumentMessage[]>;
 
 /**
  * FluidInvalidSchema error class.
+ * @public
  */
 export declare class FluidInvalidSchemaError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
     readonly errorType = DriverErrorType.fluidInvalidSchema;
@@ -169,6 +205,7 @@ export declare class FluidInvalidSchemaError extends LoggingError implements IDr
 
 /**
  * Generic network error class.
+ * @public
  */
 export declare class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
     readonly canRetry: boolean;
@@ -179,21 +216,32 @@ export declare class GenericNetworkError extends LoggingError implements IDriver
 /**
  * Extract the attributes from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export declare function getDocAttributesFromProtocolSummary(protocolSummary: ISummaryTree): IDocumentAttributes;
 
 /**
  * Extract quorum values from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export declare function getQuorumValuesFromProtocolSummary(protocolSummary: ISummaryTree): [string, ICommittedProposal][];
 
-/** Check retryAfterSeconds property on error and convert to ms */
+/**
+ * Check retryAfterSeconds property on error and convert to ms
+ * @public
+ * */
 export declare const getRetryDelayFromError: (error: any) => number | undefined;
 
-/** Check retryAfterSeconds property on error */
+/**
+ * Check retryAfterSeconds property on error
+ * @public
+ * */
 export declare const getRetryDelaySecondsFromError: (error: any) => number | undefined;
 
+/**
+ * @public
+ */
 export declare interface ICompressionStorageConfig {
     algorithm: SummaryCompressionAlgorithm;
     minSizeToCompress: number;
@@ -212,6 +260,7 @@ export declare interface ICompressionStorageConfig {
  * 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
  */
 export declare class InsecureUrlResolver implements IUrlResolver {
     private readonly hostUrl;
@@ -231,6 +280,7 @@ export declare class InsecureUrlResolver implements IUrlResolver {
 /**
  * Interface describing an object passed to various network APIs.
  * It allows caller to control cancellation, as well as learn about any delays.
+ * @public
  */
 export declare interface IProgress {
     /**
@@ -261,17 +311,27 @@ export declare interface IProgress {
 
 /* Excluded from this release type: isCombinedAppAndProtocolSummary */
 
+/**
+ * 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
+ */
 export declare function isOnline(): OnlineStatus;
 
 /**
  * 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
  */
 export declare function isRuntimeMessage(message: {
     type: string;
 }): boolean;
 
+/**
+ * @public
+ */
 export declare class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {
     readonly redirectUrl: IResolvedUrl;
     readonly errorType = DriverErrorType.locationRedirection;
@@ -281,23 +341,40 @@ export declare class LocationRedirectionError extends LoggingError implements IL
 
 /* Excluded from this release type: LoggingError */
 
+/**
+ * @public
+ */
 export declare function logNetworkFailure(logger: ITelemetryLoggerExt, event: ITelemetryErrorEvent, error?: any): void;
 
+/**
+ * @privateRemarks ADO #1385: staging code changes across layers.
+ * Eventually to be replaced by MessageType.accept
+ * @public
+ */
 export declare enum MessageType2 {
     Accept = "accept"
 }
 
+/**
+ * @public
+ */
 export declare class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
     readonly errorType: T;
     readonly canRetry: boolean;
     constructor(message: string, errorType: T, canRetry: boolean, props: DriverErrorTelemetryProps);
 }
 
+/**
+ * @public
+ */
 export declare class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
     readonly errorType: T;
     constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
 }
 
+/**
+ * @public
+ */
 export declare enum OnlineStatus {
     Offline = 0,
     Online = 1,
@@ -315,6 +392,7 @@ export declare enum OnlineStatus {
  * @param logger - logger to use
  * @param requestCallback - callback to request batches
  * @returns Queue that can be used to retrieve data
+ * @public
  */
 export declare class ParallelRequests<T> {
     private to;
@@ -347,6 +425,9 @@ export declare class ParallelRequests<T> {
     private addRequestCore;
 }
 
+/**
+ * @public
+ */
 export declare class PrefetchDocumentStorageService extends DocumentStorageServiceProxy {
     private readonly prefetchCache;
     private prefetchEnabled;
@@ -365,6 +446,7 @@ export declare class PrefetchDocumentStorageService extends DocumentStorageServi
 /**
  * Helper queue class to allow async push / pull
  * It's essentially a pipe allowing multiple writers, and single reader
+ * @public
  */
 export declare class Queue<T> implements IStream<T> {
     private readonly queue;
@@ -377,6 +459,9 @@ export declare class Queue<T> implements IStream<T> {
     read(): Promise<IStreamResult<T>>;
 }
 
+/**
+ * @public
+ */
 export declare class RateLimiter {
     private maxRequests;
     private readonly tasks;
@@ -398,6 +483,7 @@ export declare class RateLimiter {
  * @typeParam T - Output type matching JSON format of inpyt blob data.
  *
  * @returns The object that we decoded and parsed via `JSON.parse`.
+ * @public
  */
 export declare function readAndParse<T>(storage: Pick<IDocumentStorageService, "readBlob">, id: string): Promise<T>;
 
@@ -412,27 +498,44 @@ export declare function readAndParse<T>(storage: Pick<IDocumentStorageService, "
  * @param signal - Cancelation signal
  * @param scenarioName - Reason for fetching ops
  * @returns Messages fetched
+ * @public
  */
 export declare function requestOps(get: (from: number, to: number, telemetryProps: ITelemetryProperties) => Promise<IDeltasFetchResult>, concurrency: number, fromTotal: number, toTotal: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, signal?: AbortSignal, scenarioName?: string): IStream<ISequencedDocumentMessage[]>;
 
+/**
+ * @public
+ */
 export declare class RetryableError<T extends string> extends NetworkErrorBasic<T> {
     readonly errorType: T;
     constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
 }
 
+/**
+ * @public
+ */
 export declare function runWithRetry<T>(api: (cancel?: AbortSignal) => Promise<T>, fetchCallName: string, logger: ITelemetryLoggerExt, progress: IProgress): Promise<T>;
 
+/**
+ * @public
+ */
 export declare function streamFromMessages(messagesArg: Promise<ISequencedDocumentMessage[]>): IStream<ISequencedDocumentMessage[]>;
 
+/**
+ * @public
+ */
 export declare function streamObserver<T>(stream: IStream<T>, handler: (value: IStreamResult<T>) => void): IStream<T>;
 
-declare enum SummaryCompressionAlgorithm {
+/**
+ * @public
+ */
+export declare enum SummaryCompressionAlgorithm {
     None = 0,
     LZ4 = 1
 }
 
 /**
  * Throttling error class - used to communicate all throttling errors
+ * @public
  */
 export declare class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
     readonly retryAfterSeconds: number;
@@ -443,6 +546,7 @@ export declare class ThrottlingError extends LoggingError implements IThrottling
 
 /**
  * Basic implementation of a tree ITreeEntry
+ * @public
  */
 export declare class TreeTreeEntry {
     readonly path: string;
@@ -457,7 +561,10 @@ export declare class TreeTreeEntry {
     constructor(path: string, value: ITree);
 }
 
-/** Error indicating an API is being used improperly resulting in an invalid operation. */
+/**
+ * Error indicating an API is being used improperly resulting in an invalid operation.
+ * @public
+ */
 export declare class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
     readonly errorType = DriverErrorType.usageError;
     readonly canRetry = false;