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

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-extractor.json

@@ -3,10 +3,6 @@
 	"extends": "../../../common/build/build-common/api-extractor-base.json",
 	"messages": {
 		"extractorMessageReporting": {
-			"ae-missing-release-tag": {
-				// TODO: Fix violations and remove this rule override
-				"logLevel": "none"
-			},
 			// TODO: Add missing documentation and remove this rule override
 			"ae-undocumented": {
 				"logLevel": "none"

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

@@ -24,10 +24,10 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-// @public (undocumented)
+// @internal (undocumented)
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-// @public @deprecated
+// @internal @deprecated
 export enum DriverErrorType {
     authorizationError = "authorizationError",
     deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden",
@@ -50,7 +50,7 @@ export enum DriverErrorType {
     writeError = "writeError"
 }
 
-// @public
+// @internal
 export const DriverErrorTypes: {
     readonly genericNetworkError: "genericNetworkError";
     readonly authorizationError: "authorizationError";
@@ -72,10 +72,10 @@ export const DriverErrorTypes: {
     readonly usageError: "usageError";
 };
 
-// @public (undocumented)
+// @internal (undocumented)
 export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
 
-// @public
+// @internal
 export enum DriverHeader {
     // (undocumented)
     createNew = "createNew",
@@ -83,13 +83,13 @@ export enum DriverHeader {
     summarizingClient = "fluid-client-summarizer"
 }
 
-// @public
+// @internal
 export interface DriverPreCheckInfo {
     codeDetailsHint?: string;
     criticalBootDomains?: string[];
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export enum FetchSource {
     // (undocumented)
     default = "default",
@@ -97,16 +97,16 @@ export enum FetchSource {
     noCache = "noCache"
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export type FiveDaysMs = 432000000;
 
-// @public
+// @internal
 export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
     // (undocumented)
     readonly errorType: string;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IAuthorizationError extends IDriverErrorBase {
     // (undocumented)
     readonly claims?: string;
@@ -116,25 +116,25 @@ export interface IAuthorizationError extends IDriverErrorBase {
     readonly tenantId?: string;
 }
 
-// @public
+// @internal
 export interface IContainerPackageInfo {
     name: string;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDeltasFetchResult {
     messages: ISequencedDocumentMessage[];
     partialResult: boolean;
 }
 
-// @public
+// @internal
 export interface IDeltaStorageService {
     get(tenantId: string, id: string, from: number, // inclusive
     to: number, // exclusive
     fetchReason?: string): Promise<IDeltasFetchResult>;
 }
 
-// @public (undocumented)
+// @internal (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;
 }
 
-// @public (undocumented)
+// @internal (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;
 }
 
-// @public
+// @internal
 export interface IDocumentDeltaStorageService {
     fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDocumentService {
     connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
     connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
@@ -183,19 +183,19 @@ export interface IDocumentService {
     resolvedUrl: IResolvedUrl;
 }
 
-// @public (undocumented)
+// @internal (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>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDocumentServicePolicies {
     readonly storageOnly?: boolean;
     readonly summarizeProtocolTree?: boolean;
 }
 
-// @public
+// @internal
 export interface IDocumentStorageService extends Partial<IDisposable> {
     createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
     downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
@@ -208,13 +208,13 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
     uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
 }
 
-// @public
+// @internal
 export interface IDocumentStorageServicePolicies {
     readonly caching?: LoaderCachingPolicy;
     readonly maximumCacheDurationMs?: FiveDaysMs;
 }
 
-// @public
+// @internal
 export interface IDriverBasicError extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError;
@@ -222,7 +222,7 @@ export interface IDriverBasicError extends IDriverErrorBase {
     readonly statusCode?: number;
 }
 
-// @public
+// @internal
 export interface IDriverErrorBase {
     canRetry: boolean;
     endpointReached?: boolean;
@@ -231,7 +231,7 @@ export interface IDriverErrorBase {
     online?: string;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IDriverHeader {
     // (undocumented)
     [DriverHeader.summarizingClient]: boolean;
@@ -239,7 +239,7 @@ export interface IDriverHeader {
     [DriverHeader.createNew]: any;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IGenericNetworkError extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.genericNetworkError;
@@ -247,7 +247,7 @@ export interface IGenericNetworkError extends IDriverErrorBase {
     readonly statusCode?: number;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface ILocationRedirectionError extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.locationRedirection;
@@ -255,7 +255,7 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
     readonly redirectUrl: IResolvedUrl;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IResolvedUrl {
     // (undocumented)
     endpoints: {
@@ -272,13 +272,13 @@ export interface IResolvedUrl {
     url: string;
 }
 
-// @public
+// @internal
 export interface IStream<T> {
     // (undocumented)
     read(): Promise<IStreamResult<T>>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export type IStreamResult<T> = {
     done: true;
 } | {
@@ -286,7 +286,7 @@ export type IStreamResult<T> = {
     value: T;
 };
 
-// @public
+// @internal
 export interface ISummaryContext {
     readonly ackHandle: string | undefined;
     readonly proposalHandle: string | undefined;
@@ -294,7 +294,7 @@ export interface ISummaryContext {
     readonly referenceSequenceNumber: number;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IThrottlingWarning extends IDriverErrorBase {
     // (undocumented)
     readonly errorType: DriverErrorType.throttlingError;
@@ -302,14 +302,14 @@ export interface IThrottlingWarning extends IDriverErrorBase {
     readonly retryAfterSeconds: number;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IUrlResolver {
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
     // (undocumented)
     resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export enum LoaderCachingPolicy {
     NoCaching = 0,
     Prefetch = 1