@fluidframework/container-runtime 2.53.1 → 2.60.0

package/src/summary/summarizerTypes.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IDeltaManager,
 	ContainerWarning,
 } from "@fluidframework/container-definitions/internal";
@@ -11,18 +11,18 @@ import type {
 	ISummarizerEvents,
 	SummarizerStopReason,
 } from "@fluidframework/container-runtime-definitions/internal";
-import {
+import type {
 	IEventProvider,
 	ITelemetryBaseProperties,
 	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
-import { ISummaryTree } from "@fluidframework/driver-definitions";
-import {
+import type { ISummaryTree } from "@fluidframework/driver-definitions";
+import type {
 	IDocumentMessage,
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
-import { ISummaryStats } from "@fluidframework/runtime-definitions/internal";
-import {
+import type { ISummaryStats } from "@fluidframework/runtime-definitions/internal";
+import type {
 	ITelemetryLoggerExt,
 	ITelemetryLoggerPropertyBag,
 } from "@fluidframework/telemetry-utils/internal";
@@ -138,8 +138,7 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
 
 /**
  * Options affecting summarize behavior.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummarizeOptions {
 	/**
@@ -171,8 +170,7 @@ export interface ISubmitSummaryOptions extends ISummarizeOptions {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 	/**
@@ -187,8 +185,7 @@ export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 
 /**
  * Options to use when enqueueing a summarize attempt.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
 	/**
@@ -208,8 +205,7 @@ export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
 /**
  * In addition to the normal summary tree + stats, this contains additional stats
  * only relevant at the root of the tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IGeneratedSummaryStats extends ISummaryStats {
 	/**
@@ -240,8 +236,7 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
 
 /**
  * Type for summarization failures that are retriable.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IRetriableFailureError extends Error {
 	readonly retryAfterSeconds?: number;
@@ -249,8 +244,7 @@ export interface IRetriableFailureError extends Error {
 
 /**
  * Base results for all submitSummary attempts.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IBaseSummarizeResult {
 	readonly stage: "base";
@@ -267,8 +261,7 @@ export interface IBaseSummarizeResult {
 
 /**
  * Results of submitSummary after generating the summary tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
 	readonly stage: "generate";
@@ -288,8 +281,7 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
 
 /**
  * Results of submitSummary after uploading the tree to storage.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
 	readonly stage: "upload";
@@ -305,8 +297,7 @@ export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "
 
 /**
  * Results of submitSummary after submitting the summarize op.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
 	readonly stage: "submit";
@@ -335,8 +326,7 @@ export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stag
  * 3. "upload" - the summary was uploaded to storage, and the result contains the server-provided handle
  *
  * 4. "submit" - the summarize op was submitted, and the result contains the op client sequence number.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SubmitSummaryResult =
 	| IBaseSummarizeResult
@@ -346,23 +336,20 @@ export type SubmitSummaryResult =
 
 /**
  * The stages of Summarize, used to describe how far progress succeeded in case of a failure at a later stage.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
 
 /**
  * The data in summarizer result when submit summary stage fails.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface SubmitSummaryFailureData {
 	stage: SummaryStage;
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SummarizeResultPart<TSuccess, TFailure = undefined> =
 	| {
@@ -377,8 +364,7 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> =
 	  };
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
 	/**
@@ -675,8 +661,7 @@ export interface ISummarizeRunnerTelemetry extends ITelemetryLoggerPropertyBag {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryBaseConfiguration {
 	/**
@@ -698,8 +683,7 @@ export interface ISummaryBaseConfiguration {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
 	state: "enabled";
@@ -762,24 +746,21 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryConfigurationDisableSummarizer {
 	state: "disabled";
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
 	state: "disableHeuristics";
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type ISummaryConfiguration =
 	| ISummaryConfigurationDisableSummarizer

package/src/summary/summarizerUtils.ts

@@ -4,11 +4,11 @@
  */
 
 import type { SummarizerStopReason } from "@fluidframework/container-runtime-definitions/internal";
-import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
-import { IPromiseTimerResult } from "@fluidframework/core-utils/internal";
+import type { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
+import type { IPromiseTimerResult } from "@fluidframework/core-utils/internal";
 import { LoggingError } from "@fluidframework/telemetry-utils/internal";
 
-import { ISummaryCancellationToken, type IRetriableFailureError } from "./summarizerTypes.js";
+import type { ISummaryCancellationToken, IRetriableFailureError } from "./summarizerTypes.js";
 
 export type raceTimerResult<T> =
 	| { result: "done"; value: T }

package/src/summary/summaryCollection.ts

@@ -4,30 +4,29 @@
  */
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IDeltaManager } from "@fluidframework/container-definitions/internal";
-import {
+import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
+import type {
 	IDisposable,
 	IEvent,
-	type ITelemetryBaseLogger,
+	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 import {
-	IDocumentMessage,
-	ISummaryAck,
-	ISummaryContent,
-	ISummaryNack,
+	type IDocumentMessage,
+	type ISummaryAck,
+	type ISummaryContent,
+	type ISummaryNack,
 	MessageType,
-	ISequencedDocumentMessage,
+	type ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import {
 	createChildLogger,
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * Interface for summary op messages with typed contents.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryOpMessage extends ISequencedDocumentMessage {
 	type: MessageType.Summarize;
@@ -36,8 +35,7 @@ export interface ISummaryOpMessage extends ISequencedDocumentMessage {
 
 /**
  * Interface for summary ack messages with typed contents.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryAckMessage extends ISequencedDocumentMessage {
 	type: MessageType.SummaryAck;
@@ -46,8 +44,7 @@ export interface ISummaryAckMessage extends ISequencedDocumentMessage {
 
 /**
  * Interface for summary nack messages with typed contents.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryNackMessage extends ISequencedDocumentMessage {
 	type: MessageType.SummaryNack;
@@ -57,8 +54,7 @@ export interface ISummaryNackMessage extends ISequencedDocumentMessage {
 /**
  * A single summary which can be tracked as it goes through its life cycle.
  * The life cycle is: Local to Broadcast to Acked/Nacked.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummary {
 	readonly clientId: string;
@@ -69,8 +65,7 @@ export interface ISummary {
 
 /**
  * A single summary which has already been acked by the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IAckedSummary {
 	readonly summaryOp: ISummaryOpMessage;
@@ -157,8 +152,7 @@ class Summary implements ISummary {
 
 /**
  * Watches summaries created by a specific client.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IClientSummaryWatcher extends IDisposable {
 	watchSummary(clientSequenceNumber: number): ISummary;
@@ -226,8 +220,7 @@ class ClientSummaryWatcher implements IClientSummaryWatcher {
 	}
 }
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type OpActionEventName =
 	| MessageType.Summarize
@@ -236,14 +229,12 @@ export type OpActionEventName =
 	| "default";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type OpActionEventListener = (op: ISequencedDocumentMessage) => void;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryCollectionOpEvents extends IEvent {
 	(event: OpActionEventName, listener: OpActionEventListener);
@@ -253,8 +244,7 @@ export interface ISummaryCollectionOpEvents extends IEvent {
  * Data structure that looks at the op stream to track summaries as they
  * are broadcast, acked and nacked.
  * It provides functionality for watching specific summaries.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
 	// key: clientId

package/src/summary/summaryDelayLoadedModule/index.ts

@@ -9,12 +9,12 @@ export {
 	Summarizer,
 } from "./summarizer.js";
 export {
-	ICancellableSummarizerController,
+	type ICancellableSummarizerController,
 	neverCancelledSummaryToken,
 	RunWhileConnectedCoordinator,
 } from "./runWhileConnectedCoordinator.js";
 
-export {
+export type {
 	EnqueueSummarizeResult,
 	IAckSummaryResult,
 	INackSummaryResult,

package/src/summary/summaryDelayLoadedModule/runWhileConnectedCoordinator.ts

@@ -6,7 +6,7 @@
 import type { SummarizerStopReason } from "@fluidframework/container-runtime-definitions/internal";
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 
-import { IConnectableRuntime, ISummaryCancellationToken } from "../summarizerTypes.js";
+import type { IConnectableRuntime, ISummaryCancellationToken } from "../summarizerTypes.js";
 
 /**
  * Similar to AbortController, but using promise instead of events

package/src/summary/summaryDelayLoadedModule/runningSummarizer.ts

@@ -10,15 +10,15 @@ import type {
 	ISummarizerObservabilityProps,
 	SummarizerStopReason,
 } from "@fluidframework/container-runtime-definitions/internal";
-import { IDisposable, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IDisposable, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { assert, Deferred, PromiseTimer, delay } from "@fluidframework/core-utils/internal";
 import {
 	DriverErrorTypes,
 	MessageType,
-	ISequencedDocumentMessage,
+	type ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import {
-	MonitoringContext,
+	type MonitoringContext,
 	UsageError,
 	createChildLogger,
 	createChildMonitoringContext,
@@ -44,7 +44,7 @@ import type {
 	SubmitSummaryResult,
 } from "../summarizerTypes.js";
 import { raceTimer, RetriableSummaryError, type SummarizeReason } from "../summarizerUtils.js";
-import {
+import type {
 	IAckedSummary,
 	IClientSummaryWatcher,
 	SummaryCollection,

package/src/summary/summaryDelayLoadedModule/summarizer.ts

@@ -8,18 +8,18 @@ import type {
 	ISummarizerEvents,
 	SummarizerStopReason,
 } from "@fluidframework/container-runtime-definitions/internal";
-import { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
+import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
 import { Deferred } from "@fluidframework/core-utils/internal";
 import {
-	IFluidErrorBase,
-	ITelemetryLoggerExt,
+	type IFluidErrorBase,
+	type ITelemetryLoggerExt,
 	LoggingError,
 	UsageError,
 	createChildLogger,
 	wrapErrorAndLog,
 } from "@fluidframework/telemetry-utils/internal";
 
-import {
+import type {
 	IConnectableRuntime,
 	IEnqueueSummarizeOptions,
 	IOnDemandSummarizeOptions,
@@ -28,12 +28,12 @@ import {
 	ISummarizerInternalsProvider,
 	ISummarizerRuntime,
 	ISummarizingWarning,
-	type IRetriableFailureError,
-	type ISummaryConfiguration,
+	IRetriableFailureError,
+	ISummaryConfiguration,
 } from "../summarizerTypes.js";
-import { SummaryCollection } from "../summaryCollection.js";
+import type { SummaryCollection } from "../summaryCollection.js";
 
-import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator.js";
+import type { ICancellableSummarizerController } from "./runWhileConnectedCoordinator.js";
 import { RunningSummarizer } from "./runningSummarizer.js";
 import { SummarizeHeuristicData } from "./summarizerHeuristics.js";
 import { SummarizeResultBuilder } from "./summaryResultBuilder.js";

package/src/summary/summaryDelayLoadedModule/summarizerHeuristics.ts

@@ -4,16 +4,16 @@
  */
 
 import { Timer } from "@fluidframework/core-utils/internal";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
-import type { ISummaryConfigurationHeuristics } from "../summarizerTypes.js";
-import {
+import type {
+	ISummaryConfigurationHeuristics,
 	ISummarizeAttempt,
 	ISummarizeHeuristicData,
 	ISummarizeHeuristicRunner,
 	ISummaryHeuristicStrategy,
 } from "../summarizerTypes.js";
-import { SummarizeReason } from "../summarizerUtils.js";
+import type { SummarizeReason } from "../summarizerUtils.js";
 
 /**
  * Simple implementation of class for tracking summarize heuristic data.

package/src/summary/summaryDelayLoadedModule/summaryGenerator.ts

@@ -3,12 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { assert, IPromiseTimer, Timer } from "@fluidframework/core-utils/internal";
+import { assert, type IPromiseTimer, Timer } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes, MessageType } from "@fluidframework/driver-definitions/internal";
 import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils/internal";
 import {
 	isFluidError,
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 	PerformanceEvent,
 	wrapError,
 } from "@fluidframework/telemetry-utils/internal";
@@ -31,7 +31,7 @@ import {
 import type { IClientSummaryWatcher } from "../summaryCollection.js";
 
 import { SummarizeResultBuilder } from "./summaryResultBuilder.js";
-import { type INackSummaryResult, type ISummarizeResults } from "./summaryResultTypes.js";
+import type { INackSummaryResult, ISummarizeResults } from "./summaryResultTypes.js";
 
 // Send some telemetry if generate summary takes too long
 const maxSummarizeTimeoutTime = 20000; // 20 sec

package/src/summary/summaryDelayLoadedModule/summaryResultBuilder.ts

@@ -5,12 +5,12 @@
 
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 
-import {
+import type {
+	IRetriableFailureError,
 	SubmitSummaryFailureData,
 	SubmitSummaryResult,
 	SummarizeResultPart,
-	type IRetriableFailureError,
-} from "../index.js";
+} from "../summarizerTypes.js";
 
 import type {
 	IAckSummaryResult,

package/src/summary/summaryDelayLoadedModule/summaryResultTypes.ts

@@ -15,8 +15,7 @@ import type {
 } from "../summaryCollection.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IBroadcastSummaryResult {
 	readonly summarizeOp: ISummaryOpMessage;
@@ -24,8 +23,7 @@ export interface IBroadcastSummaryResult {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IAckSummaryResult {
 	readonly summaryAckOp: ISummaryAckMessage;
@@ -33,8 +31,7 @@ export interface IAckSummaryResult {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface INackSummaryResult {
 	readonly summaryNackOp: ISummaryNackMessage;
@@ -42,8 +39,7 @@ export interface INackSummaryResult {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummarizeResults {
 	/**
@@ -65,8 +61,7 @@ export interface ISummarizeResults {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type EnqueueSummarizeResult =
 	| (ISummarizeResults & {

package/src/summary/summaryFormat.ts

@@ -5,27 +5,26 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 import { SummaryType } from "@fluidframework/driver-definitions";
-import {
+import type {
 	ISnapshotTree,
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
 import {
-	ISummaryTreeWithStats,
+	type ISummaryTreeWithStats,
 	channelsTreeName,
 	gcTreeKey,
 	type IRuntimeStorageService,
 } from "@fluidframework/runtime-definitions/internal";
 
 import { blobsTreeName } from "../blobManager/index.js";
-import { IGCMetadata } from "../gc/index.js";
+import type { IGCMetadata } from "../gc/index.js";
 
-import { IDocumentSchema } from "./documentSchema.js";
+import type { IDocumentSchema } from "./documentSchema.js";
 
 /**
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type OmitAttributesVersions<T> = Omit<
 	T,
@@ -34,8 +33,7 @@ export type OmitAttributesVersions<T> = Omit<
 
 /**
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidDataStoreAttributes0 {
 	readonly snapshotFormatVersion?: undefined;
@@ -51,8 +49,7 @@ export interface IFluidDataStoreAttributes0 {
 
 /**
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidDataStoreAttributes1
 	extends OmitAttributesVersions<IFluidDataStoreAttributes0> {
@@ -62,8 +59,7 @@ export interface IFluidDataStoreAttributes1
 
 /**
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IFluidDataStoreAttributes2
 	extends OmitAttributesVersions<IFluidDataStoreAttributes1> {
@@ -87,8 +83,7 @@ export interface IFluidDataStoreAttributes2
  *
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  *
  */
 export type ReadFluidDataStoreAttributes =

package/src/summary/summaryHelpers.ts

@@ -26,8 +26,7 @@ export function isSummariesDisabled(
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const DefaultSummaryConfiguration: ISummaryConfiguration = {
 	state: "enabled",

package/src/summary/summaryManager.ts

@@ -8,7 +8,7 @@ import type {
 	ISummarizerEvents,
 	SummarizerStopReason,
 } from "@fluidframework/container-runtime-definitions/internal";
-import {
+import type {
 	IDisposable,
 	IEvent,
 	IEventProvider,
@@ -17,15 +17,15 @@ import {
 import { assert } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions/internal";
 import {
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 	PerformanceEvent,
 	createChildLogger,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { IThrottler } from "../throttler.js";
+import type { IThrottler } from "../throttler.js";
 
 import type { ISummarizerClientElection } from "./summarizerClientElection.js";
-import {
+import type {
 	IEnqueueSummarizeOptions,
 	IOnDemandSummarizeOptions,
 	ISummarizer,