@fluidframework/container-definitions 2.53.0 → 2.60.0

package/src/error.ts

@@ -8,8 +8,7 @@ import { FluidErrorTypes } from "@fluidframework/core-interfaces/internal";
 
 /**
  * Different error types the ClientSession may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const ContainerErrorTypes = {
 	...FluidErrorTypes,
@@ -22,16 +21,14 @@ export const ContainerErrorTypes = {
 
 /**
  * {@inheritDoc (ContainerErrorTypes:variable)}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type ContainerErrorTypes =
 	(typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes];
 
 /**
  * Represents warnings raised on container.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ContainerWarning extends IErrorBase {
 	/**

package/src/fluidModule.ts

@@ -9,8 +9,7 @@ import type { IProvideFluidCodeDetailsComparer } from "./fluidPackage.js";
 import type { IRuntimeFactory } from "./runtime.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidModule {
 	fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;

package/src/fluidPackage.ts

@@ -5,8 +5,7 @@
 
 /**
  * Specifies an environment on Fluid property of a IFluidPackage.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidPackageEnvironment {
 	/**
@@ -37,8 +36,7 @@ export interface IFluidPackageEnvironment {
  * 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}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidPackage {
 	/**
@@ -66,8 +64,7 @@ export interface IFluidPackage {
 /**
  * Check if the package.json defines a Fluid package
  * @param pkg - the package json data to check if it is a Fluid package.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const isFluidPackage = (pkg: unknown): pkg is Readonly<IFluidPackage> =>
 	typeof pkg === "object" &&
@@ -76,8 +73,7 @@ export const isFluidPackage = (pkg: unknown): pkg is Readonly<IFluidPackage> =>
 
 /**
  * Package manager configuration. Provides a key value mapping of config values
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidCodeDetailsConfig {
 	readonly [key: string]: string;
@@ -85,8 +81,7 @@ export interface IFluidCodeDetailsConfig {
 
 /**
  * Data structure used to describe the code to load on the Fluid document
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidCodeDetails {
 	/**
@@ -121,15 +116,13 @@ export const isFluidCodeDetails = (
 };
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer =
 	"IFluidCodeDetailsComparer";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IProvideFluidCodeDetailsComparer {
 	readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
@@ -137,8 +130,7 @@ export interface IProvideFluidCodeDetailsComparer {
 
 /**
  * Provides capability to compare Fluid code details.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
 	/**

package/src/loader.ts

@@ -35,8 +35,7 @@ import type { AttachState } from "./runtime.js";
 
 /**
  * Encapsulates a module entry point with corresponding code details.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidModuleWithDetails {
 	/**
@@ -56,8 +55,7 @@ export interface IFluidModuleWithDetails {
 /**
  * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
  * a package name and package version range.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
 	/**
@@ -105,8 +103,7 @@ export interface IFluidCodeResolver {
 
 /**
  * Events emitted by the {@link IContainer} "upwards" to the Loader and Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainerEvents extends IEvent {
 	/**
@@ -333,8 +330,7 @@ export type ConnectionState =
 
 /**
  * The Host's view of a Container and its connection to storage
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainer extends IEventProvider<IContainerEvents> {
 	/**
@@ -545,8 +541,7 @@ export interface IContainer extends IEventProvider<IContainerEvents> {
 
 /**
  * The Runtime's view of the Loader, used for loading Containers
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ILoader extends Partial<IProvideLoader> {
 	/**
@@ -563,8 +558,7 @@ export interface ILoader extends Partial<IProvideLoader> {
 
 /**
  * The Host's view of the Loader, used for loading Containers
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IHostLoader extends ILoader {
 	/**
@@ -594,8 +588,7 @@ export interface IHostLoader extends ILoader {
 
 /**
  * Options to configure various behaviors of the ILoader.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export type ILoaderOptions = {
@@ -637,8 +630,7 @@ export type ILoaderOptions = {
 
 /**
  * Policies to have various behaviors during container create and load.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export type IContainerPolicies = {
@@ -650,8 +642,7 @@ export type IContainerPolicies = {
 
 /**
  * Accepted header keys for requests coming to the Loader
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum LoaderHeader {
 	/**
@@ -683,8 +674,7 @@ export enum LoaderHeader {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainerLoadMode {
 	opsBeforeReturn?: /*
@@ -741,8 +731,7 @@ export interface ILoaderHeader {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IProvideLoader {
 	readonly ILoader: ILoader;
@@ -753,8 +742,7 @@ export interface IProvideLoader {
  * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.
  *
  * @remarks This is used as the `ContainerContext`'s base snapshot when attaching.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
 	blobsContents?: { [path: string]: ArrayBufferLike };

package/src/runtime.ts

@@ -62,8 +62,7 @@ export enum AttachState {
  * 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.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IRuntime extends IDisposable {
 	/**
@@ -124,8 +123,7 @@ export interface IRuntime extends IDisposable {
 
 /**
  * Payload type for IContainerContext.submitBatchFn()
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IBatchMessage {
 	contents?: string;
@@ -142,8 +140,7 @@ export interface IBatchMessage {
  * allows the Runtime to not support layer compatibility with the Driver layer. Instead, it supports compatibility
  * with the Loader layer which it already does.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainerStorageService {
 	/**
@@ -255,8 +252,7 @@ export interface IContainerStorageService {
  * TODO: once `@alpha` tag is removed, `unknown` should be removed from submitSignalFn.
  * See {@link https://dev.azure.com/fluidframework/internal/_workitems/edit/7462}
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainerContext {
 	/**
@@ -357,14 +353,12 @@ export interface IContainerContext {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const IRuntimeFactory: keyof IProvideRuntimeFactory = "IRuntimeFactory";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IProvideRuntimeFactory {
 	readonly IRuntimeFactory: IRuntimeFactory;
@@ -375,8 +369,7 @@ export interface IProvideRuntimeFactory {
  *
  * Provides the entry point for the ContainerContext to load the proper IRuntime
  * to start up the running instance of the Container.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IRuntimeFactory extends IProvideRuntimeFactory {
 	/**
@@ -391,8 +384,7 @@ export interface IRuntimeFactory extends IProvideRuntimeFactory {
 
 /**
  * Defines list of properties expected for getPendingLocalState
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IGetPendingLocalStateProps {
 	/**