@fluidframework/driver-definitions 2.0.0-dev.7.4.0.216897 → 2.0.0-dev.7.4.0.217212

package/api-report/driver-definitions.api.md

@@ -27,7 +27,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
 // @internal (undocumented)
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-// @internal @deprecated
+// @alpha @deprecated
 export enum DriverErrorType {
     authorizationError = "authorizationError",
     deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
@@ -89,7 +89,7 @@ export interface DriverPreCheckInfo {
     criticalBootDomains?: string[];
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export enum FetchSource {
     // (undocumented)
     default = "default",
@@ -97,10 +97,10 @@ export enum FetchSource {
     noCache = "noCache"
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type FiveDaysMs = 432000000;
 
-// @internal
+// @alpha
 export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
     // (undocumented)
     readonly errorType: string;
@@ -116,7 +116,7 @@ export interface IAuthorizationError extends IDriverErrorBase {
     readonly tenantId?: string;
 }
 
-// @internal
+// @alpha
 export interface IContainerPackageInfo {
     name: string;
 }
@@ -134,7 +134,7 @@ export interface IDeltaStorageService {
     fetchReason?: string): Promise<IDeltasFetchResult>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
     checkpointSequenceNumber?: number;
     claims: ITokenClaims;
@@ -151,7 +151,7 @@ export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<ID
     version: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
     // (undocumented)
     (event: "nack", listener: (documentId: string, message: INack[]) => void): any;
@@ -167,12 +167,12 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
     (event: "error", listener: (error: any) => void): any;
 }
 
-// @internal
+// @alpha
 export interface IDocumentDeltaStorageService {
     fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentService {
     connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
     connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
@@ -183,19 +183,19 @@ export interface IDocumentService {
     resolvedUrl: IResolvedUrl;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentServiceFactory {
     createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentServicePolicies {
     readonly storageOnly?: boolean;
     readonly summarizeProtocolTree?: boolean;
 }
 
-// @internal
+// @alpha
 export interface IDocumentStorageService extends Partial<IDisposable> {
     createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
     downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
@@ -208,7 +208,7 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
     uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
 }
 
-// @internal
+// @alpha
 export interface IDocumentStorageServicePolicies {
     readonly caching?: LoaderCachingPolicy;
     readonly maximumCacheDurationMs?: FiveDaysMs;
@@ -222,7 +222,7 @@ export interface IDriverBasicError extends IDriverErrorBase {
     readonly statusCode?: number;
 }
 
-// @internal
+// @alpha
 export interface IDriverErrorBase {
     canRetry: boolean;
     endpointReached?: boolean;
@@ -255,7 +255,7 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
     readonly redirectUrl: IResolvedUrl;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IResolvedUrl {
     // (undocumented)
     endpoints: {
@@ -272,13 +272,13 @@ export interface IResolvedUrl {
     url: string;
 }
 
-// @internal
+// @alpha
 export interface IStream<T> {
     // (undocumented)
     read(): Promise<IStreamResult<T>>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type IStreamResult<T> = {
     done: true;
 } | {
@@ -286,7 +286,7 @@ export type IStreamResult<T> = {
     value: T;
 };
 
-// @internal
+// @alpha
 export interface ISummaryContext {
     readonly ackHandle: string | undefined;
     readonly proposalHandle: string | undefined;
@@ -302,14 +302,14 @@ export interface IThrottlingWarning extends IDriverErrorBase {
     readonly retryAfterSeconds: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IUrlResolver {
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
     // (undocumented)
     resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export enum LoaderCachingPolicy {
     NoCaching = 0,
     Prefetch = 1