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

package/api-report/container-runtime.api.md

@@ -72,7 +72,7 @@ export type CompatModeBehavior =
 /** Fail processing immediately. (The container will close) */
 | "FailToProcess";
 
-// @internal
+// @alpha
 export enum CompressionAlgorithms {
     // (undocumented)
     lz4 = "lz4"
@@ -95,7 +95,7 @@ export enum ContainerMessageType {
     Rejoin = "rejoin"
 }
 
-// @internal
+// @alpha
 export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
     protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, logger: ITelemetryLoggerExt, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, idCompressor: (IIdCompressor & IIdCompressorCore) | undefined, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration);
     // (undocumented)
@@ -242,7 +242,7 @@ export interface ContainerRuntimeMessage {
 // @internal (undocumented)
 export const DefaultSummaryConfiguration: ISummaryConfiguration;
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type EnqueueSummarizeResult = (ISummarizeResults & {
     readonly alreadyEnqueued?: undefined;
 }) | (ISummarizeResults & {
@@ -262,13 +262,13 @@ export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
     get IFluidDataStoreRegistry(): this;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface GCFeatureMatrix {
     sweepGeneration?: number;
     tombstoneGeneration?: number;
 }
 
-// @internal
+// @alpha
 export const GCNodeType: {
     DataStore: string;
     SubDataStore: string;
@@ -276,10 +276,10 @@ export const GCNodeType: {
     Other: string;
 };
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type GCVersion = number;
 
 // @internal
@@ -293,7 +293,7 @@ export interface IAckedSummary {
     readonly summaryOp: ISummaryOpMessage;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IAckSummaryResult {
     // (undocumented)
     readonly ackNackDuration: number;
@@ -301,7 +301,7 @@ export interface IAckSummaryResult {
     readonly summaryAckOp: ISummaryAckMessage;
 }
 
-// @internal
+// @alpha
 export interface IBaseSummarizeResult {
     readonly error: any;
     // (undocumented)
@@ -311,7 +311,7 @@ export interface IBaseSummarizeResult {
     readonly stage: "base";
 }
 
-// @internal
+// @alpha
 export interface IBlobManagerLoadInfo {
     // (undocumented)
     ids?: string[];
@@ -319,7 +319,7 @@ export interface IBlobManagerLoadInfo {
     redirectTable?: [string, string][];
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IBroadcastSummaryResult {
     // (undocumented)
     readonly broadcastDuration: number;
@@ -333,7 +333,7 @@ export interface ICancellableSummarizerController extends ISummaryCancellationTo
     stop(reason: SummarizerStopReason): void;
 }
 
-// @internal
+// @alpha
 export interface ICancellationToken<T> {
     readonly cancelled: boolean;
     readonly waitCancelled: Promise<T>;
@@ -363,13 +363,13 @@ export interface IClientSummaryWatcher extends IDisposable {
     watchSummary(clientSequenceNumber: number): ISummary;
 }
 
-// @internal
+// @alpha
 export interface ICompressionRuntimeOptions {
     readonly compressionAlgorithm: CompressionAlgorithms;
     readonly minimumBatchSizeInBytes: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IConnectableRuntime {
     // (undocumented)
     readonly clientId: string | undefined;
@@ -386,7 +386,7 @@ export interface IContainerRuntimeMessageCompatDetails {
     behavior: CompatModeBehavior;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly disableIsolatedChannels?: true;
     readonly idCompressorEnabled?: boolean;
@@ -397,7 +397,7 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
     readonly telemetryDocumentId?: string;
 }
 
-// @internal
+// @alpha
 export interface IContainerRuntimeOptions {
     readonly chunkSizeInBytes?: number;
     readonly compressionOptions?: ICompressionRuntimeOptions;
@@ -413,19 +413,19 @@ export interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ICreateContainerMetadata {
     createContainerRuntimeVersion?: string;
     createContainerTimestamp?: number;
 }
 
-// @internal
+// @alpha
 export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
     readonly afterSequenceNumber?: number;
     readonly override?: boolean;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IGCMetadata {
     readonly gcFeature?: GCVersion;
     readonly gcFeatureMatrix?: GCFeatureMatrix;
@@ -435,7 +435,7 @@ export interface IGCMetadata {
     readonly sweepTimeoutMs?: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IGCRuntimeOptions {
     [key: string]: any;
     disableGC?: boolean;
@@ -444,11 +444,11 @@ export interface IGCRuntimeOptions {
     sessionExpiryTimeoutMs?: number;
 }
 
-// @internal
+// @alpha
 export interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 }
 
-// @internal
+// @alpha
 export interface IGeneratedSummaryStats extends ISummaryStats {
     readonly dataStoreCount: number;
     readonly gcBlobNodeCount?: number;
@@ -458,7 +458,7 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
     readonly summaryNumber: number;
 }
 
-// @internal
+// @alpha
 export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
     readonly forcedFullTree: boolean;
     readonly generateDuration: number;
@@ -468,7 +468,7 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
     readonly summaryTree: ISummaryTree;
 }
 
-// @internal
+// @alpha
 export interface IMarkPhaseStats {
     attachmentBlobCount: number;
     dataStoreCount: number;
@@ -481,7 +481,7 @@ export interface IMarkPhaseStats {
     updatedNodeCount: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface INackSummaryResult extends IRetriableFailureResult {
     // (undocumented)
     readonly ackNackDuration: number;
@@ -492,12 +492,12 @@ export interface INackSummaryResult extends IRetriableFailureResult {
 // @internal
 export const InactiveResponseHeaderKey = "isInactive";
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
     readonly reason: string;
 }
 
-// @internal
+// @alpha
 export interface IRefreshSummaryAckOptions {
     readonly ackHandle: string;
     readonly proposalHandle: string | undefined;
@@ -505,13 +505,13 @@ export interface IRefreshSummaryAckOptions {
     readonly summaryRefSeq: number;
 }
 
-// @internal
+// @alpha
 export interface IRetriableFailureResult {
     // (undocumented)
     readonly retryAfterSeconds?: number;
 }
 
-// @internal
+// @alpha
 export interface ISerializedElection {
     readonly electedClientId: string | undefined;
     readonly electedParentId: string | undefined;
@@ -524,7 +524,7 @@ export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
 // @internal
 export function isStableId(str: string): str is StableId;
 
-// @internal
+// @alpha
 export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
     readonly clientSequenceNumber: number;
     // (undocumented)
@@ -532,14 +532,14 @@ export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stag
     readonly submitOpDuration: number;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISubmitSummaryOptions extends ISummarizeOptions {
     readonly cancellationToken: ISummaryCancellationToken;
     readonly finalAttempt?: boolean;
     readonly summaryLogger: ITelemetryLoggerExt;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummarizeEventProps {
     // (undocumented)
     currentAttempt: number;
@@ -551,7 +551,7 @@ export interface ISummarizeEventProps {
     result: "success" | "failure" | "canceled";
 }
 
-// @internal
+// @alpha
 export interface ISummarizeOptions {
     readonly fullTree?: boolean;
     // @deprecated
@@ -571,26 +571,26 @@ export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
     summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummarizeResults {
     readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;
     readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;
     readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummarizerEvents extends IEvent {
     // (undocumented)
     (event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummarizerInternalsProvider {
     refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummarizerRuntime extends IConnectableRuntime {
     // (undocumented)
     closeFn(): void;
@@ -627,7 +627,7 @@ export interface ISummary {
     waitBroadcast(): Promise<ISummaryOpMessage>;
 }
 
-// @internal
+// @alpha
 export interface ISummaryAckMessage extends ISequencedDocumentMessage {
     // (undocumented)
     contents: ISummaryAck;
@@ -635,14 +635,14 @@ export interface ISummaryAckMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryAck;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryBaseConfiguration {
     initialSummarizerDelayMs: number;
     maxAckWaitTime: number;
     maxOpsSinceLastSummary: number;
 }
 
-// @internal
+// @alpha
 export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
 // @internal (undocumented)
@@ -651,22 +651,22 @@ export interface ISummaryCollectionOpEvents extends IEvent {
     (event: OpActionEventName, listener: OpActionEventListener): any;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
     // (undocumented)
     state: "disableHeuristics";
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryConfigurationDisableSummarizer {
     // (undocumented)
     state: "disabled";
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
     maxIdleTime: number;
     maxOps: number;
@@ -680,10 +680,10 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
     state: "enabled";
 }
 
-// @internal
+// @alpha
 export type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
 
-// @internal
+// @alpha
 export interface ISummaryNackMessage extends ISequencedDocumentMessage {
     // (undocumented)
     contents: ISummaryNack;
@@ -691,7 +691,7 @@ export interface ISummaryNackMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryNack;
 }
 
-// @internal
+// @alpha
 export interface ISummaryOpMessage extends ISequencedDocumentMessage {
     // (undocumented)
     contents: ISummaryContent;
@@ -699,14 +699,14 @@ export interface ISummaryOpMessage extends ISequencedDocumentMessage {
     type: MessageType.Summarize;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryRuntimeOptions {
     // @deprecated
     initialSummarizerDelayMs?: number;
     summaryConfigOverrides?: ISummaryConfiguration;
 }
 
-// @internal
+// @alpha
 export interface ISweepPhaseStats {
     deletedAttachmentBlobCount: number;
     deletedDataStoreCount: number;
@@ -716,7 +716,7 @@ export interface ISweepPhaseStats {
     lifetimeNodeCount: number;
 }
 
-// @internal
+// @alpha
 export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
     readonly handle: string;
     // (undocumented)
@@ -762,13 +762,13 @@ export enum RuntimeMessage {
     Rejoin = "rejoin"
 }
 
-// @internal
+// @alpha
 export interface SubmitSummaryFailureData extends IRetriableFailureResult {
     // (undocumented)
     stage: SummaryStage;
 }
 
-// @internal
+// @alpha
 export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
 
 // @internal
@@ -797,7 +797,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
     readonly summaryCollection: SummaryCollection;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     success: true;
     data: TSuccess;
@@ -808,7 +808,7 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     error: any;
 };
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export type SummarizerStopReason =
 /** Summarizer client failed to summarize in all 3 consecutive attempts. */
 "failToSummarize"
@@ -859,7 +859,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
     waitSummaryAck(referenceSequenceNumber: number): Promise<IAckedSummary>;
 }
 
-// @internal
+// @alpha
 export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
 
 // @internal

package/dist/blobManager.d.ts

@@ -31,7 +31,7 @@ export declare class BlobHandle implements IFluidHandle<ArrayBufferLike> {
 }
 /**
  * Information from a snapshot needed to load BlobManager
- * @internal
+ * @alpha
  */
 export interface IBlobManagerLoadInfo {
     ids?: string[];