@fluidframework/container-definitions 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212

package/dist/container-definitions-alpha.d.ts

@@ -18,7 +18,6 @@ import { IErrorEvent } from '@fluidframework/core-interfaces';
 import { IEvent } from '@fluidframework/core-interfaces';
 import { IEventProvider } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
-import { IGenericError } from '@fluidframework/core-interfaces';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
 import { IRequest } from '@fluidframework/core-interfaces';
 import { IResolvedUrl } from '@fluidframework/driver-definitions';
@@ -30,16 +29,14 @@ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
 import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { IThrottlingWarning } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { IUsageError } from '@fluidframework/core-interfaces';
 import { IVersion } from '@fluidframework/protocol-definitions';
 import { MessageType } from '@fluidframework/protocol-definitions';
 
 /**
  * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the
  * service.  The transition from detached to attached state is a one-way transition.
- * @public
+ * @alpha
  */
 export declare enum AttachState {
     /**
@@ -61,95 +58,47 @@ export declare enum AttachState {
 /**
  * Namespace for the different connection states a container can be in.
  * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.
- * @public
+ * @alpha
  */
 export declare namespace ConnectionState {
     /**
      * The container is not connected to the delta server.
      * Note - When in this state the container may be about to reconnect,
      * or may remain disconnected until explicitly told to connect.
+     * @alpha
      */
     export type Disconnected = 0;
     /**
      * The container is disconnected but actively trying to establish a new connection.
      * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.
+     * @alpha
      */
     export type EstablishingConnection = 3;
     /**
      * The container has an inbound connection only, and is catching up to the latest known state from the service.
+     * @alpha
      */
     export type CatchingUp = 1;
     /**
      * The container is fully connected and syncing.
+     * @alpha
      */
     export type Connected = 2;
 }
 
 /**
  * Type defining the different states of connectivity a Container can be in.
- * @public
+ * @alpha
  */
 export declare type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connected;
 
-/**
- * Different error types the Container may report out to the Host.
- *
- * @deprecated ContainerErrorType is being deprecated as a public export. Please use {@link ContainerErrorTypes#clientSessionExpiredError} instead.
- * @public
- */
-export declare enum ContainerErrorType {
-    /**
-     * Some error, most likely an exception caught by runtime and propagated to container as critical error
-     */
-    genericError = "genericError",
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    throttlingError = "throttlingError",
-    /**
-     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.
-     */
-    dataCorruptionError = "dataCorruptionError",
-    /**
-     * Error encountered when processing an operation. May correlate with data corruption.
-     */
-    dataProcessingError = "dataProcessingError",
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     */
-    usageError = "usageError",
-    /**
-     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and
-     * aids in safely deleting unused objects.
-     */
-    clientSessionExpiredError = "clientSessionExpiredError"
-}
-
-/**
- * Different error types the ClientSession may report out to the Host.
- * @public
- */
-export declare const ContainerErrorTypes: {
-    /**
-     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and
-     * aids in safely deleting unused objects.
-     */
-    readonly clientSessionExpiredError: "clientSessionExpiredError";
-    readonly genericError: "genericError";
-    readonly throttlingError: "throttlingError";
-    readonly dataCorruptionError: "dataCorruptionError";
-    readonly dataProcessingError: "dataProcessingError";
-    readonly usageError: "usageError";
-};
+/* Excluded from this release type: ContainerErrorType */
 
-/**
- * @public
- */
-export declare type ContainerErrorTypes = (typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes];
+/* Excluded from this release type: ContainerErrorTypes */
 
 /**
  * Represents warnings raised on container.
- * @public
+ * @alpha
  */
 export declare interface ContainerWarning extends IErrorBase {
     /**
@@ -165,7 +114,7 @@ export declare interface ContainerWarning extends IErrorBase {
  *
  * See {@link https://nodejs.org/api/events.html#class-eventemitter | here} for an overview of the `EventEmitter`
  * class.
- * @public
+ * @alpha
  */
 export declare interface IAudience extends EventEmitter {
     /**
@@ -185,7 +134,7 @@ export declare interface IAudience extends EventEmitter {
 
 /**
  * Manages the state and the members for {@link IAudience}
- * @public
+ * @alpha
  */
 export declare interface IAudienceOwner extends IAudience {
     /**
@@ -201,7 +150,7 @@ export declare interface IAudienceOwner extends IAudience {
 
 /**
  * Payload type for IContainerContext.submitBatchFn()
- * @public
+ * @alpha
  */
 export declare interface IBatchMessage {
     contents?: string;
@@ -210,24 +159,11 @@ export declare interface IBatchMessage {
     referenceSequenceNumber?: number;
 }
 
-/**
- * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
- * a package name and package version range.
- * @public
- */
-export declare interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    /**
-     * Load the code module (package) that can interact with the document.
-     *
-     * @param source - Code proposal that articulates the current schema the document is written in.
-     * @returns Code module entry point along with the code details associated with it.
-     */
-    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
-}
+/* Excluded from this release type: ICodeDetailsLoader */
 
 /**
  * Contract representing the result of a newly established connection to the server for syncing deltas.
- * @public
+ * @alpha
  */
 export declare interface IConnectionDetails {
     clientId: string;
@@ -248,7 +184,7 @@ export declare interface IConnectionDetails {
 
 /**
  * The Host's view of a Container and its connection to storage
- * @public
+ * @alpha
  */
 export declare interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
     /**
@@ -423,7 +359,6 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
     /**
      * Allows the host to have the container force to be in read-only mode
      * @param readonly - Boolean that toggles if read-only policies will be enforced
-     * @alpha
      */
     forceReadonly?(readonly: boolean): any;
     /**
@@ -437,7 +372,7 @@ export declare interface IContainer extends IEventProvider<IContainerEvents>, IF
  * IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the
  * loader layer.  It gets passed into the IRuntimeFactory.instantiateRuntime call.  Only include members on this interface
  * if you intend them to be consumed/called from the runtime layer.
- * @public
+ * @alpha
  */
 export declare interface IContainerContext {
     readonly options: ILoaderOptions;
@@ -505,7 +440,7 @@ export declare interface IContainerContext {
 
 /**
  * Events emitted by the {@link IContainer} "upwards" to the Loader and Host.
- * @public
+ * @alpha
  */
 export declare interface IContainerEvents extends IEvent {
     /**
@@ -648,17 +583,7 @@ export declare interface IContainerEvents extends IEvent {
     (event: "saved", listener: (dirty: boolean) => void): any;
 }
 
-/**
- * @public
- */
-export declare interface IContainerLoadMode {
-    opsBeforeReturn?: undefined | "sequenceNumber" | "cached" | "all";
-    deltaConnection?: "none" | "delayed" | undefined;
-    /**
-     * If set to true, will indefinitely pause all incoming and outgoing after the container is loaded.
-     */
-    pauseAfterLoad?: boolean;
-}
+/* Excluded from this release type: IContainerLoadMode */
 
 /**
  * Represents errors raised on container.
@@ -674,14 +599,13 @@ export declare interface IContainerLoadMode {
  * - {@link @fluidframework/odsp-driver-definitions#OdspErrorType}
  *
  * - {@link @fluidframework/routerlicious-driver#RouterliciousErrorType}
- *
- * @public
+ * @alpha
  */
 export declare type ICriticalContainerError = IErrorBase;
 
 /**
  * Manages the transmission of ops between the runtime and storage.
- * @public
+ * @alpha
  */
 export declare interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
     /**
@@ -750,7 +674,7 @@ export declare interface IDeltaManager<T, U> extends IEventProvider<IDeltaManage
 
 /**
  * Events emitted by {@link IDeltaManager}.
- * @public
+ * @alpha
  */
 export declare interface IDeltaManagerEvents extends IEvent {
     /**
@@ -820,7 +744,7 @@ export declare interface IDeltaManagerEvents extends IEvent {
 
 /**
  * Queue of ops to be sent to or processed from storage
- * @public
+ * @alpha
  */
 export declare interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
     /**
@@ -866,7 +790,7 @@ export declare interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents
 
 /**
  * Events emitted by {@link IDeltaQueue}.
- * @public
+ * @alpha
  */
 export declare interface IDeltaQueueEvents<T> extends IErrorEvent {
     /**
@@ -907,7 +831,7 @@ export declare interface IDeltaQueueEvents<T> extends IErrorEvent {
 
 /**
  * Contract supporting delivery of outbound messages to the server
- * @public
+ * @alpha
  */
 export declare interface IDeltaSender {
     /**
@@ -918,52 +842,13 @@ export declare interface IDeltaSender {
 
 export { IErrorBase }
 
-/**
- * A Fluid package for specification for browser environments
- * @public
- */
-export declare interface IFluidBrowserPackage extends IFluidPackage {
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid}
-     */
-    fluid: {
-        /**
-         * The browser specific package information for this package
-         */
-        browser: IFluidBrowserPackageEnvironment;
-        /**
-         * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid.environment}
-         */
-        [environment: string]: IFluidPackageEnvironment;
-    };
-}
+/* Excluded from this release type: IFluidBrowserPackage */
 
-/**
- * A specific Fluid package environment for browsers
- * @public
- */
-export declare interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
-    /**
-     * The Universal Module Definition (umd) target specifics the scripts necessary for
-     * loading a packages in a browser environment and finding its entry point.
-     */
-    umd: {
-        /**
-         * The bundled js files for loading this package.
-         * These files will be loaded and executed in order.
-         */
-        files: string[];
-        /**
-         * The global name that the script entry points will be exposed.
-         * This entry point should be an {@link @fluidframework/container-definitions#IFluidModule}.
-         */
-        library: string;
-    };
-}
+/* Excluded from this release type: IFluidBrowserPackageEnvironment */
 
 /**
  * Data structure used to describe the code to load on the Fluid document
- * @public
+ * @alpha
  */
 export declare interface IFluidCodeDetails {
     /**
@@ -981,13 +866,13 @@ export declare interface IFluidCodeDetails {
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
 
 /**
  * Provides capability to compare Fluid code details.
- * @public
+ * @alpha
  */
 export declare interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
     /**
@@ -1016,61 +901,29 @@ export declare interface IFluidCodeDetailsComparer extends IProvideFluidCodeDeta
 
 /**
  * Package manager configuration. Provides a key value mapping of config values
- * @public
+ * @alpha
  */
 export declare interface IFluidCodeDetailsConfig {
     readonly [key: string]: string;
 }
 
-/**
- * Fluid code resolvers take a Fluid code details, and resolve the
- * full Fluid package including absolute urls for the browser file entries.
- * The Fluid code resolver is coupled to a specific cdn and knows how to resolve
- * the code detail for loading from that cdn. This include resolving to the most recent
- * version of package that supports the provided code details.
- * @public
- */
-export declare interface IFluidCodeResolver {
-    /**
-     * Resolves a Fluid code details into a form that can be loaded.
-     * @param details - The Fluid code details to resolve.
-     * @returns A IResolvedFluidCodeDetails where the resolvedPackage's Fluid file entries are absolute urls, and
-     * an optional resolvedPackageCacheId if the loaded package should be cached.
-     */
-    resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;
-}
+/* Excluded from this release type: IFluidCodeResolver */
 
 /**
- * @public
+ * @alpha
  */
 export declare interface IFluidModule {
     fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
 }
 
-/**
- * Encapsulates a module entry point with corresponding code details.
- * @public
- */
-export declare interface IFluidModuleWithDetails {
-    /**
-     * Fluid code module that implements the runtime factory needed to instantiate the container runtime.
-     */
-    module: IFluidModule;
-    /**
-     * Code details associated with the module. Represents a document schema this module supports.
-     * If the code loader implements the {@link @fluidframework/core-interfaces#(IFluidCodeDetailsComparer:interface)}
-     * interface, it'll be called to determine whether the module code details satisfy the new code proposal in the
-     * quorum.
-     */
-    details: IFluidCodeDetails;
-}
+/* Excluded from this release type: IFluidModuleWithDetails */
 
 /**
  * Fluid-specific properties expected on a package to be loaded by the code loader.
  * While compatible with the npm package format it is not necessary that that package is an
  * npm package:
  * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
- * @public
+ * @alpha
  */
 export declare interface IFluidPackage {
     /**
@@ -1097,7 +950,7 @@ export declare interface IFluidPackage {
 
 /**
  * Specifies an environment on Fluid property of a IFluidPackage.
- * @public
+ * @alpha
  */
 export declare interface IFluidPackageEnvironment {
     /**
@@ -1120,7 +973,7 @@ export declare interface IFluidPackageEnvironment {
     };
 }
 
-export { IGenericError }
+/* Excluded from this release type: IGenericError */
 
 /**
  * Defines list of properties expected for getPendingLocalState
@@ -1142,32 +995,11 @@ export declare interface IGetPendingLocalStateProps {
     readonly stopBlobAttachingSignal?: AbortSignal;
 }
 
-/**
- * The Host's view of the Loader, used for loading Containers
- * @public
- */
-export declare interface IHostLoader extends ILoader {
-    /**
-     * Creates a new container using the specified chaincode but in an unattached state. While unattached all
-     * updates will only be local until the user explicitly attaches the container to a service provider.
-     */
-    createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    /**
-     * Creates a new container using the specified snapshot but in an unattached state. While unattached all
-     * updates will only be local until the user explicitly attaches the container to a service provider.
-     */
-    rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-}
+/* Excluded from this release type: IHostLoader */
 
 /**
  * The Runtime's view of the Loader, used for loading Containers
- * @public
+ * @alpha
  */
 export declare interface ILoader extends Partial<IProvideLoader> {
     /**
@@ -1190,28 +1022,10 @@ export declare interface ILoader extends Partial<IProvideLoader> {
     readonly IFluidRouter: IFluidRouter;
 }
 
-/**
- * Set of Request Headers that the Loader understands and may inspect or modify
- * @public
- */
-export declare interface ILoaderHeader {
-    /**
-     * @deprecated This header has been deprecated and will be removed in a future release
-     */
-    [LoaderHeader.cache]: boolean;
-    [LoaderHeader.clientDetails]: IClientDetails;
-    [LoaderHeader.loadMode]: IContainerLoadMode;
-    /**
-     * Loads the container to at least the specified sequence number.
-     * If not defined, behavior will fall back to `IContainerLoadMode.opsBeforeReturn`.
-     */
-    [LoaderHeader.sequenceNumber]: number;
-    [LoaderHeader.reconnect]: boolean;
-    [LoaderHeader.version]: string | undefined;
-}
+/* Excluded from this release type: ILoaderHeader */
 
 /**
- * @public
+ * @alpha
  */
 export declare type ILoaderOptions = {
     [key in string | number]: any;
@@ -1240,58 +1054,35 @@ export declare type ILoaderOptions = {
     maxClientLeaveWaitTime?: number;
 };
 
-/**
- * @deprecated 0.48, This API will be removed in 0.50
- * No replacement since it is not expected anyone will depend on this outside container-loader
- * See {@link https://github.com/microsoft/FluidFramework/issues/9711} for context.
- * @public
- */
-export declare interface IPendingLocalState {
-    url: string;
-    pendingRuntimeState: unknown;
-}
+/* Excluded from this release type: IPendingLocalState */
 
 /**
- * @public
+ * @alpha
  */
 export declare interface IProvideFluidCodeDetailsComparer {
     readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare interface IProvideLoader {
     readonly ILoader: ILoader;
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare interface IProvideRuntimeFactory {
     readonly IRuntimeFactory: IRuntimeFactory;
 }
 
-/**
- * The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails
- * that have been resolved and are ready to load
- * @public
- */
-export declare interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
-    /**
-     * A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.
-     */
-    readonly resolvedPackage: Readonly<IFluidPackage>;
-    /**
-     * If not undefined, this id will be used to cache the entry point for the code package
-     */
-    readonly resolvedPackageCacheId: string | undefined;
-}
+/* Excluded from this release type: IResolvedFluidCodeDetails */
 
 /**
  * The IRuntime represents an instantiation of a code package within a Container.
  * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.
- * @public
+ * @alpha
  */
 export declare interface IRuntime extends IDisposable {
     /**
@@ -1326,8 +1117,6 @@ export declare interface IRuntime extends IDisposable {
     setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
     /**
      * Get pending local state in a serializable format to be given back to a newly loaded container
-     * @alpha
-     * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}
      */
     getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
     /**
@@ -1351,7 +1140,7 @@ export declare interface IRuntime extends IDisposable {
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;
 
@@ -1360,7 +1149,7 @@ export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;
  *
  * Provides the entry point for the ContainerContext to load the proper IRuntime
  * to start up the running instance of the Container.
- * @public
+ * @alpha
  */
 export declare interface IRuntimeFactory extends IProvideRuntimeFactory {
     /**
@@ -1373,32 +1162,18 @@ export declare interface IRuntimeFactory extends IProvideRuntimeFactory {
     instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
 }
 
-/**
- * Determines if any object is an IFluidBrowserPackage
- * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage
- * @public
- */
-export declare const isFluidBrowserPackage: (maybePkg: unknown) => maybePkg is Readonly<IFluidBrowserPackage>;
+/* Excluded from this release type: isFluidBrowserPackage */
 
-/**
- * Determines if any object is an IFluidCodeDetails
- * @public
- */
-export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
+/* Excluded from this release type: isFluidCodeDetails */
 
-/**
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
- * @public
- */
-export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
+/* Excluded from this release type: isFluidPackage */
 
 /**
  * This is used when we rehydrate a container from the snapshot. Here we put the blob contents
  * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.
  *
  * @remarks This is used as the `ContainerContext`'s base snapshot when attaching.
- * @public
+ * @alpha
  */
 export declare interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
     blobsContents: {
@@ -1409,42 +1184,14 @@ export declare interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
     };
 }
 
-export { IThrottlingWarning }
+/* Excluded from this release type: IThrottlingWarning */
 
-export { IUsageError }
+/* Excluded from this release type: IUsageError */
 
-/**
- * Accepted header keys for requests coming to the Loader
- * @public
- */
-export declare enum LoaderHeader {
-    /**
-     * @deprecated This header has been deprecated and will be removed in a future release
-     * Override the Loader's default caching behavior for this container.
-     */
-    cache = "fluid-cache",
-    clientDetails = "fluid-client-details",
-    /**
-     * Start the container in a paused, unconnected state. Defaults to false
-     */
-    loadMode = "loadMode",
-    reconnect = "fluid-reconnect",
-    /**
-     * Loads the container to at least the specified sequence number.
-     * If not defined, behavior will fall back to `IContainerLoadMode.opsBeforeReturn`.
-     */
-    sequenceNumber = "fluid-sequence-number",
-    /**
-     * One of the following:
-     * null or "null": use ops, no snapshots
-     * undefined: fetch latest snapshot
-     * otherwise, version sha to load snapshot
-     */
-    version = "version"
-}
+/* Excluded from this release type: LoaderHeader */
 
 /**
- * @public
+ * @alpha
  */
 export declare type ReadOnlyInfo = {
     readonly readonly: false | undefined;