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

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

@@ -85,7 +85,7 @@ export declare type CompatModeBehavior =
 
 /**
  * Available compression algorithms for op compression.
- * @internal
+ * @alpha
  */
 export declare enum CompressionAlgorithms {
     lz4 = "lz4"
@@ -112,7 +112,7 @@ export declare enum ContainerMessageType {
 /**
  * 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;
@@ -636,7 +636,7 @@ export declare interface ContainerRuntimeMessage {
 export declare const DefaultSummaryConfiguration: ISummaryConfiguration;
 
 /**
- * @internal
+ * @alpha
  */
 export declare type EnqueueSummarizeResult = (ISummarizeResults & {
     /**
@@ -674,7 +674,7 @@ export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
 
 /**
  * @see IGCMetadata.gcFeatureMatrix
- * @internal
+ * @alpha
  */
 export declare interface GCFeatureMatrix {
     /**
@@ -693,7 +693,7 @@ export declare interface GCFeatureMatrix {
 
 /**
  * The types of GC nodes in the GC reference graph.
- * @internal
+ * @alpha
  */
 export declare const GCNodeType: {
     DataStore: string;
@@ -703,12 +703,12 @@ export declare const GCNodeType: {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
 /**
- * @internal
+ * @alpha
  */
 export declare type GCVersion = number;
 
@@ -728,7 +728,7 @@ export declare interface IAckedSummary {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IAckSummaryResult {
     readonly summaryAckOp: ISummaryAckMessage;
@@ -737,7 +737,7 @@ export declare interface IAckSummaryResult {
 
 /**
  * Base results for all submitSummary attempts.
- * @internal
+ * @alpha
  */
 export declare interface IBaseSummarizeResult {
     readonly stage: "base";
@@ -750,7 +750,7 @@ export declare interface IBaseSummarizeResult {
 
 /**
  * Information from a snapshot needed to load BlobManager
- * @internal
+ * @alpha
  */
 export declare interface IBlobManagerLoadInfo {
     ids?: string[];
@@ -758,7 +758,7 @@ export declare interface IBlobManagerLoadInfo {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IBroadcastSummaryResult {
     readonly summarizeOp: ISummaryOpMessage;
@@ -776,7 +776,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 +811,7 @@ export declare interface IClientSummaryWatcher extends IDisposable {
 
 /**
  * Options for op compression.
- * @internal
+ * @alpha
  */
 export declare interface ICompressionRuntimeOptions {
     /**
@@ -827,7 +827,7 @@ export declare interface ICompressionRuntimeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IConnectableRuntime {
     readonly disposed: boolean;
@@ -847,7 +847,7 @@ export declare interface IContainerRuntimeMessageCompatDetails {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
@@ -865,7 +865,7 @@ export declare interface IContainerRuntimeMetadata extends ICreateContainerMetad
 
 /**
  * Options for container runtime.
- * @internal
+ * @alpha
  */
 export declare interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -944,7 +944,7 @@ export declare interface IContainerRuntimeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ICreateContainerMetadata {
     /** Runtime version of the container when it was first created */
@@ -955,7 +955,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 +970,7 @@ export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOpti
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IGCMetadata {
     /**
@@ -1008,7 +1008,7 @@ export declare interface IGCMetadata {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IGCRuntimeOptions {
     /**
@@ -1046,7 +1046,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 +1054,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 +1073,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 +1089,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 +1113,7 @@ export declare interface IMarkPhaseStats {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface INackSummaryResult extends IRetriableFailureResult {
     readonly summaryNackOp: ISummaryNackMessage;
@@ -1127,7 +1127,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 +1136,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 +1151,7 @@ export declare interface IRefreshSummaryAckOptions {
 
 /**
  * Type for summarization failures that are retriable.
- * @internal
+ * @alpha
  */
 export declare interface IRetriableFailureResult {
     readonly retryAfterSeconds?: number;
@@ -1159,7 +1159,7 @@ export declare interface IRetriableFailureResult {
 
 /**
  * Serialized state of IOrderedClientElection.
- * @internal
+ * @alpha
  */
 export declare interface ISerializedElection {
     /** Sequence number at the time of the latest election. */
@@ -1192,7 +1192,7 @@ export declare function isStableId(str: string): str is StableId;
 
 /**
  * Results of submitSummary after submitting the summarize op.
- * @internal
+ * @alpha
  */
 export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
     readonly stage: "submit";
@@ -1203,7 +1203,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 +1215,7 @@ export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeEventProps {
     result: "success" | "failure" | "canceled";
@@ -1226,7 +1226,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 +1277,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 +1289,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 +1306,7 @@ export declare interface ISummarizerInternalsProvider {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerRuntime extends IConnectableRuntime {
     readonly logger: ITelemetryLoggerExt;
@@ -1341,7 +1341,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 +1349,7 @@ export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryBaseConfiguration {
     /**
@@ -1371,7 +1371,7 @@ export declare interface ISummaryBaseConfiguration {
 
 /**
  * Similar to AbortSignal, but using promise instead of events
- * @internal
+ * @alpha
  */
 export declare type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
@@ -1383,26 +1383,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 +1465,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 +1480,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 +1488,7 @@ export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummaryRuntimeOptions {
     /** Override summary configurations set by the server. */
@@ -1504,7 +1504,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 +1523,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 +1586,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 +1607,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 +1696,7 @@ export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> imp
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     success: true;
@@ -1709,7 +1709,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 +1793,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";
 

package/dist/containerRuntime.d.ts

@@ -16,7 +16,7 @@ import { IContainerRuntimeMetadata, ISerializedElection, SubmitSummaryResult, IS
 import { GCNodeType, IGCRuntimeOptions, IGCStats } from "./gc";
 import { IBatch } from "./opLifecycle";
 /**
- * @internal
+ * @alpha
  */
 export interface ISummaryBaseConfiguration {
     /**
@@ -36,7 +36,7 @@ export interface ISummaryBaseConfiguration {
     maxOpsSinceLastSummary: number;
 }
 /**
- * @internal
+ * @alpha
  */
 export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
     state: "enabled";
@@ -97,19 +97,19 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
     nonRuntimeHeuristicThreshold?: number;
 }
 /**
- * @internal
+ * @alpha
  */
 export interface ISummaryConfigurationDisableSummarizer {
     state: "disabled";
 }
 /**
- * @internal
+ * @alpha
  */
 export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
     state: "disableHeuristics";
 }
 /**
- * @internal
+ * @alpha
  */
 export type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
 /**
@@ -117,7 +117,7 @@ export type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISu
  */
 export declare const DefaultSummaryConfiguration: ISummaryConfiguration;
 /**
- * @internal
+ * @alpha
  */
 export interface ISummaryRuntimeOptions {
     /** Override summary configurations set by the server. */
@@ -132,7 +132,7 @@ export interface ISummaryRuntimeOptions {
 }
 /**
  * Options for op compression.
- * @internal
+ * @alpha
  */
 export interface ICompressionRuntimeOptions {
     /**
@@ -148,7 +148,7 @@ export interface ICompressionRuntimeOptions {
 }
 /**
  * Options for container runtime.
- * @internal
+ * @alpha
  */
 export interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -267,7 +267,7 @@ export interface RuntimeHeaderData {
 export declare const defaultRuntimeHeaderData: Required<RuntimeHeaderData>;
 /**
  * Available compression algorithms for op compression.
- * @internal
+ * @alpha
  */
 export declare enum CompressionAlgorithms {
     lz4 = "lz4"
@@ -341,7 +341,7 @@ export declare function TEST_requestSummarizer(loader: ILoader, url: string): Pr
 /**
  * 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;

package/dist/containerRuntime.js

@@ -118,7 +118,7 @@ exports.defaultRuntimeHeaderData = {
 };
 /**
  * Available compression algorithms for op compression.
- * @internal
+ * @alpha
  */
 var CompressionAlgorithms;
 (function (CompressionAlgorithms) {
@@ -252,7 +252,7 @@ exports.TEST_requestSummarizer = TEST_requestSummarizer;
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
- * @internal
+ * @alpha
  */
 class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**