@fluidframework/container-runtime 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

package/lib/container-runtime-untrimmed.d.ts

@@ -1,8 +1,10 @@
+import { assertIsStableId } from '@fluidframework/id-compressor';
 import { AttachState } from '@fluidframework/container-definitions';
 import { ContainerWarning } from '@fluidframework/container-definitions';
 import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
 import { FluidObject } from '@fluidframework/core-interfaces';
 import { FlushMode } from '@fluidframework/runtime-definitions';
+import { generateStableId } from '@fluidframework/id-compressor';
 import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
 import { IContainerContext } from '@fluidframework/container-definitions';
@@ -23,8 +25,8 @@ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
 import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
-import { IIdCompressor } from '@fluidframework/runtime-definitions';
-import { IIdCompressorCore } from '@fluidframework/runtime-definitions';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IIdCompressorCore } from '@fluidframework/id-compressor';
 import { ILoader } from '@fluidframework/container-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
@@ -34,6 +36,7 @@ import { IResponse } from '@fluidframework/core-interfaces';
 import { IRuntime } from '@fluidframework/container-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { isStableId } from '@fluidframework/id-compressor';
 import { ISummaryAck } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryNack } from '@fluidframework/protocol-definitions';
@@ -44,7 +47,6 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
 import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { MessageType } from '@fluidframework/protocol-definitions';
 import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
-import { StableId } from '@fluidframework/runtime-definitions';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
@@ -66,11 +68,7 @@ export declare const AllowInactiveRequestHeaderKey = "allowInactive";
  */
 export declare const AllowTombstoneRequestHeaderKey = "allowTombstone";
 
-/**
- * Asserts that the given string is a stable ID.
- * @internal
- */
-export declare function assertIsStableId(stableId: string): StableId;
+export { assertIsStableId }
 
 /**
  * How should an older client handle an unrecognized remote op type?
@@ -85,7 +83,7 @@ export declare type CompatModeBehavior =
 
 /**
  * Available compression algorithms for op compression.
- * @internal
+ * @alpha
  */
 export declare enum CompressionAlgorithms {
     lz4 = "lz4"
@@ -106,13 +104,18 @@ export declare enum ContainerMessageType {
      * the last allocation op was sent.
      * See the [IdCompressor README](./id-compressor/README.md) for more details.
      */
-    IdAllocation = "idAllocation"
+    IdAllocation = "idAllocation",
+    /**
+     * Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC
+     * state across all clients.
+     */
+    GC = "GC"
 }
 
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
- * @internal
+ * @alpha
  */
 export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
     private readonly registry;
@@ -471,27 +474,27 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * @param usedRoutes - The routes that are used in all nodes in this Container.
      * @see IGarbageCollectionRuntime.updateUsedRoutes
      */
-    updateUsedRoutes(usedRoutes: string[]): void;
+    updateUsedRoutes(usedRoutes: readonly string[]): void;
     /**
      * This is called to update objects whose routes are unused.
      * @param unusedRoutes - Data store and attachment blob routes that are unused in this Container.
      */
-    updateUnusedRoutes(unusedRoutes: string[]): void;
+    updateUnusedRoutes(unusedRoutes: readonly string[]): void;
     /**
      * @deprecated Replaced by deleteSweepReadyNodes.
      */
-    deleteUnusedNodes(unusedRoutes: string[]): string[];
+    deleteUnusedNodes(unusedRoutes: readonly string[]): string[];
     /**
      * After GC has run and identified nodes that are sweep ready, this is called to delete the sweep ready nodes.
      * @param sweepReadyRoutes - The routes of nodes that are sweep ready and should be deleted.
      * @returns The routes of nodes that were deleted.
      */
-    deleteSweepReadyNodes(sweepReadyRoutes: string[]): string[];
+    deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
     /**
      * This is called to update objects that are tombstones.
      * @param tombstonedRoutes - Data store and attachment blob routes that are tombstones in this Container.
      */
-    updateTombstonedRoutes(tombstonedRoutes: string[]): void;
+    updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
     /**
      * Returns a server generated referenced timestamp to be used to track unreferenced nodes by GC.
      */
@@ -546,7 +549,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
     /**
-     * This helper is called during summarization. If there are pending ops, it will return a failed summarize result
+     * This helper is called during summarization. If the container is dirty, it will return a failed summarize result
      * (IBaseSummarizeResult) unless this is the final summarize attempt and SkipFailingIncorrectSummary option is set.
      * @param logger - The logger to be used for sending telemetry.
      * @param referenceSequenceNumber - The reference sequence number of the summary attempt.
@@ -577,6 +580,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we
      * reconnect and there are pending messages.
+     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
      * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
@@ -636,7 +640,7 @@ export declare interface ContainerRuntimeMessage {
 export declare const DefaultSummaryConfiguration: ISummaryConfiguration;
 
 /**
- * @internal
+ * @alpha
  */
 export declare type EnqueueSummarizeResult = (ISummarizeResults & {
     /**
@@ -673,27 +677,29 @@ export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
 }
 
 /**
- * @see IGCMetadata.gcFeatureMatrix
- * @internal
+ * @see IGCMetadata.gcFeatureMatrix and @see gcGenerationOptionName
+ * @alpha
  */
-export declare interface GCFeatureMatrix {
+export declare type GCFeatureMatrix = {
     /**
-     * The Tombstone Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Tombstone enforcement.
+     * The GC Generation value in effect when this file was created.
+     * Gives a way for an app to disqualify old files from GC Sweep.
      * Provided via Container Runtime Options.
      */
-    tombstoneGeneration?: number;
+    gcGeneration?: number;
+    /** Deprecated property from legacy type. Will not be set concurrently with gcGeneration */
+    tombstoneGeneration?: undefined;
+} | {
     /**
-     * The Sweep Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Sweep.
-     * Provided via Container Runtime Options.
+     * The Tombstone Generation value in effect when this file was created.
+     * Legacy - new containers would get gcGeneration instead (if anything)
      */
-    sweepGeneration?: number;
-}
+    tombstoneGeneration: number;
+};
 
 /**
  * The types of GC nodes in the GC reference graph.
- * @internal
+ * @alpha
  */
 export declare const GCNodeType: {
     DataStore: string;
@@ -703,20 +709,16 @@ export declare const GCNodeType: {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
 /**
- * @internal
+ * @alpha
  */
 export declare type GCVersion = number;
 
-/**
- * Generate a random stable ID
- * @internal
- */
-export declare function generateStableId(): StableId;
+export { generateStableId }
 
 /**
  * A single summary which has already been acked by the server.
@@ -728,7 +730,7 @@ export declare interface IAckedSummary {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IAckSummaryResult {
     readonly summaryAckOp: ISummaryAckMessage;
@@ -737,7 +739,7 @@ export declare interface IAckSummaryResult {
 
 /**
  * Base results for all submitSummary attempts.
- * @internal
+ * @alpha
  */
 export declare interface IBaseSummarizeResult {
     readonly stage: "base";
@@ -750,7 +752,7 @@ export declare interface IBaseSummarizeResult {
 
 /**
  * Information from a snapshot needed to load BlobManager
- * @internal
+ * @alpha
  */
 export declare interface IBlobManagerLoadInfo {
     ids?: string[];
@@ -758,7 +760,7 @@ export declare interface IBlobManagerLoadInfo {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IBroadcastSummaryResult {
     readonly summarizeOp: ISummaryOpMessage;
@@ -776,7 +778,7 @@ export declare interface ICancellableSummarizerController extends ISummaryCancel
 /**
  * Similar to AbortSignal, but using promise instead of events
  * @param T - cancellation reason type
- * @internal
+ * @alpha
  */
 export declare interface ICancellationToken<T> {
     /** Tells if this cancellable token is cancelled */
@@ -811,7 +813,7 @@ export declare interface IClientSummaryWatcher extends IDisposable {
 
 /**
  * Options for op compression.
- * @internal
+ * @alpha
  */
 export declare interface ICompressionRuntimeOptions {
     /**
@@ -827,7 +829,7 @@ export declare interface ICompressionRuntimeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IConnectableRuntime {
     readonly disposed: boolean;
@@ -847,7 +849,7 @@ export declare interface IContainerRuntimeMessageCompatDetails {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
@@ -865,7 +867,7 @@ export declare interface IContainerRuntimeMetadata extends ICreateContainerMetad
 
 /**
  * Options for container runtime.
- * @internal
+ * @alpha
  */
 export declare interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -944,7 +946,7 @@ export declare interface IContainerRuntimeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ICreateContainerMetadata {
     /** Runtime version of the container when it was first created */
@@ -955,7 +957,7 @@ export declare interface ICreateContainerMetadata {
 
 /**
  * Options to use when enqueueing a summarize attempt.
- * @internal
+ * @alpha
  */
 export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
     /** If specified, The summarize attempt will not occur until after this sequence number. */
@@ -970,7 +972,7 @@ export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOpti
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IGCMetadata {
     /**
@@ -998,7 +1000,7 @@ export declare interface IGCMetadata {
      * - True means sweep phase is enabled.
      * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
      *
-     * @deprecated use GCFeatureMatrix.sweepGeneration instead. @see GCFeatureMatrix.sweepGeneration
+     * @deprecated use GCFeatureMatrix.gcGeneration instead. @see GCFeatureMatrix.gcGeneration
      */
     readonly sweepEnabled?: boolean;
     /** If this is present, the session for this container will expire after this time and the container will close */
@@ -1008,7 +1010,7 @@ export declare interface IGCMetadata {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IGCRuntimeOptions {
     /**
@@ -1017,7 +1019,7 @@ export declare interface IGCRuntimeOptions {
      * GC has mark phase and sweep phase. In mark phase, unreferenced objects are identified
      * and marked as such in the summary. This option enables the mark phase.
      * In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions.
-     * Sweep phase can be enabled using the "gcSweepGeneration" option.
+     * Sweep phase can be enabled using the "enableGCSweep" option.
      *
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
@@ -1027,6 +1029,16 @@ export declare interface IGCRuntimeOptions {
      * Can be used to disable running GC on containers where it is allowed via the gcAllowed option.
      */
     disableGC?: boolean;
+    /**
+     * Flag that if true, will enable the full Sweep Phase of garbage collection for this session,
+     * where Tombstoned objects are permanently deleted from the container.
+     *
+     * IMPORTANT: This only applies if this document is allowed to run Sweep Phase.
+     *
+     * Current default behavior is for Sweep Phase not to delete Tombstoned objects,
+     * but merely to prevent them from being loaded.
+     */
+    enableGCSweep?: true;
     /**
      * Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node
      * changed or not.
@@ -1038,6 +1050,12 @@ export declare interface IGCRuntimeOptions {
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
     sessionExpiryTimeoutMs?: number;
+    /**
+     * Delay between when Tombstone should run and when the object should be deleted.
+     * This grace period gives a chance to intervene to recover if needed, before Sweep deletes the object.
+     * If not present, a default (non-zero) value will be used.
+     */
+    sweepGracePeriodMs?: number;
     /**
      * Allows additional GC options to be passed.
      */
@@ -1046,7 +1064,7 @@ export declare interface IGCRuntimeOptions {
 
 /**
  * The statistics of the system state after a garbage collection run.
- * @internal
+ * @alpha
  */
 export declare interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 }
@@ -1054,7 +1072,7 @@ export declare interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 /**
  * In addition to the normal summary tree + stats, this contains additional stats
  * only relevant at the root of the tree.
- * @internal
+ * @alpha
  */
 export declare interface IGeneratedSummaryStats extends ISummaryStats {
     /** The total number of data stores in the container. */
@@ -1073,7 +1091,7 @@ export declare interface IGeneratedSummaryStats extends ISummaryStats {
 
 /**
  * Results of submitSummary after generating the summary tree.
- * @internal
+ * @alpha
  */
 export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
     readonly stage: "generate";
@@ -1089,7 +1107,7 @@ export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeR
 
 /**
  * The statistics of the system state after a garbage collection mark phase run.
- * @internal
+ * @alpha
  */
 export declare interface IMarkPhaseStats {
     /** The number of nodes in the container. */
@@ -1113,7 +1131,7 @@ export declare interface IMarkPhaseStats {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface INackSummaryResult extends IRetriableFailureResult {
     readonly summaryNackOp: ISummaryNackMessage;
@@ -1127,7 +1145,7 @@ export declare interface INackSummaryResult extends IRetriableFailureResult {
 export declare const InactiveResponseHeaderKey = "isInactive";
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
     /** Reason for generating summary. */
@@ -1136,7 +1154,7 @@ export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 
 /**
  * Data required to update internal tracking state after receiving a Summary Ack.
- * @internal
+ * @alpha
  */
 export declare interface IRefreshSummaryAckOptions {
     /** Handle from the ack's summary op. */
@@ -1151,7 +1169,7 @@ export declare interface IRefreshSummaryAckOptions {
 
 /**
  * Type for summarization failures that are retriable.
- * @internal
+ * @alpha
  */
 export declare interface IRetriableFailureResult {
     readonly retryAfterSeconds?: number;
@@ -1159,7 +1177,7 @@ export declare interface IRetriableFailureResult {
 
 /**
  * Serialized state of IOrderedClientElection.
- * @internal
+ * @alpha
  */
 export declare interface ISerializedElection {
     /** Sequence number at the time of the latest election. */
@@ -1183,16 +1201,11 @@ export declare interface ISerializedElection {
  */
 export declare function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
 
-/**
- * Returns true iff the given string is a valid Version 4, variant 2 UUID
- * 'xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx'
- * @internal
- */
-export declare function isStableId(str: string): str is StableId;
+export { isStableId }
 
 /**
  * Results of submitSummary after submitting the summarize op.
- * @internal
+ * @alpha
  */
 export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
     readonly stage: "submit";
@@ -1203,7 +1216,7 @@ export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResul
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
     /** Logger to use for correlated summary events */
@@ -1215,7 +1228,7 @@ export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeEventProps {
     result: "success" | "failure" | "canceled";
@@ -1226,7 +1239,7 @@ export declare interface ISummarizeEventProps {
 
 /**
  * Options affecting summarize behavior.
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeOptions {
     /** True to generate the full tree with no handle reuse optimizations; defaults to false */
@@ -1277,7 +1290,7 @@ export declare interface ISummarizer extends IEventProvider<ISummarizerEvents> {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeResults {
     /** Resolves when we generate, upload, and submit the summary. */
@@ -1289,14 +1302,14 @@ export declare interface ISummarizeResults {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerEvents extends IEvent {
     (event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerInternalsProvider {
     /** Encapsulates the work to walk the internals of the running container to generate a summary */
@@ -1306,7 +1319,7 @@ export declare interface ISummarizerInternalsProvider {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerRuntime extends IConnectableRuntime {
     readonly logger: ITelemetryLoggerExt;
@@ -1341,7 +1354,7 @@ export declare interface ISummary {
 
 /**
  * Interface for summary ack messages with typed contents.
- * @internal
+ * @alpha
  */
 export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryAck;
@@ -1349,7 +1362,7 @@ export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryBaseConfiguration {
     /**
@@ -1371,7 +1384,7 @@ export declare interface ISummaryBaseConfiguration {
 
 /**
  * Similar to AbortSignal, but using promise instead of events
- * @internal
+ * @alpha
  */
 export declare type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
@@ -1383,26 +1396,26 @@ export declare interface ISummaryCollectionOpEvents extends IEvent {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
     state: "disableHeuristics";
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryConfigurationDisableSummarizer {
     state: "disabled";
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
     state: "enabled";
@@ -1465,13 +1478,13 @@ export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseCon
 
 /**
  * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.
- * @internal
+ * @alpha
  */
 export declare type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
 
 /**
  * Interface for summary nack messages with typed contents.
- * @internal
+ * @alpha
  */
 export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryNack;
@@ -1480,7 +1493,7 @@ export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
 
 /**
  * Interface for summary op messages with typed contents.
- * @internal
+ * @alpha
  */
 export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
     type: MessageType.Summarize;
@@ -1488,7 +1501,7 @@ export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryRuntimeOptions {
     /** Override summary configurations set by the server. */
@@ -1504,7 +1517,7 @@ export declare interface ISummaryRuntimeOptions {
 
 /**
  * The statistics of the system state after a garbage collection sweep phase run.
- * @internal
+ * @alpha
  */
 export declare interface ISweepPhaseStats {
     /** The number of nodes in the lifetime of the container. */
@@ -1523,7 +1536,7 @@ export declare interface ISweepPhaseStats {
 
 /**
  * Results of submitSummary after uploading the tree to storage.
- * @internal
+ * @alpha
  */
 export declare interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
     readonly stage: "upload";
@@ -1586,7 +1599,7 @@ export declare enum RuntimeMessage {
 
 /**
  * The data in summarizer result when submit summary stage fails.
- * @internal
+ * @alpha
  */
 export declare interface SubmitSummaryFailureData extends IRetriableFailureResult {
     stage: SummaryStage;
@@ -1607,7 +1620,7 @@ export declare interface SubmitSummaryFailureData extends IRetriableFailureResul
  * 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.
- * @internal
+ * @alpha
  */
 export declare type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
 
@@ -1696,7 +1709,7 @@ export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> imp
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     success: true;
@@ -1709,7 +1722,7 @@ export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare type SummarizerStopReason = 
 /** Summarizer client failed to summarize in all 3 consecutive attempts. */
@@ -1793,7 +1806,7 @@ export declare class SummaryCollection extends TypedEventEmitter<ISummaryCollect
 
 /**
  * The stages of Summarize, used to describe how far progress succeeded in case of a failure at a later stage.
- * @internal
+ * @alpha
  */
 export declare type SummaryStage = SubmitSummaryResult["stage"] | "unknown";