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

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

@@ -51,24 +51,24 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
  * Legacy ID for the built-in AgentScheduler.  To minimize disruption while removing it, retaining this as a
  * special-case for document dirty state.  Ultimately we should have no special-cases from the
  * ContainerRuntime's perspective.
- * @public
+ * @internal
  */
 export declare const agentSchedulerId = "_scheduler";
 
 /**
  * [IRRELEVANT IF throwOnInactiveLoad OPTION NOT SET] True if an inactive object should be returned without erroring
- * @public
+ * @internal
  */
 export declare const AllowInactiveRequestHeaderKey = "allowInactive";
 
 /** True if a tombstoned object should be returned without erroring
- * @public
+ * @internal
  */
 export declare const AllowTombstoneRequestHeaderKey = "allowTombstone";
 
 /**
  * Asserts that the given string is a stable ID.
- * @public
+ * @internal
  */
 export declare function assertIsStableId(stableId: string): StableId;
 
@@ -85,14 +85,14 @@ export declare type CompatModeBehavior =
 
 /**
  * Available compression algorithms for op compression.
- * @public
+ * @internal
  */
 export declare enum CompressionAlgorithms {
     lz4 = "lz4"
 }
 
 /**
- * @public
+ * @internal
  */
 export declare enum ContainerMessageType {
     FluidDataStoreOp = "component",
@@ -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.
- * @public
+ * @internal
  */
 export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
     private readonly registry;
@@ -307,9 +307,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * The id of the version used to initially load this runtime, or undefined if it's newly created.
      */
     private readonly loadedFromVersionId;
-    /**
-     * @internal
-     */
+    /***/
     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);
     /**
      * Initializes the state from the base snapshot this container runtime loaded from.
@@ -393,7 +391,6 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     createDataStore(pkg: string | string[]): Promise<IDataStore>;
     /**
      * @deprecated 0.16 Issue #1537, #3631
-     * @internal
      */
     _createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
     private canSendOps;
@@ -634,12 +631,12 @@ export declare interface ContainerRuntimeMessage {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare const DefaultSummaryConfiguration: ISummaryConfiguration;
 
 /**
- * @public
+ * @internal
  */
 export declare type EnqueueSummarizeResult = (ISummarizeResults & {
     /**
@@ -666,7 +663,7 @@ export declare type EnqueueSummarizeResult = (ISummarizeResults & {
 };
 
 /**
- * @public
+ * @internal
  */
 export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
     private readonly map;
@@ -677,7 +674,7 @@ export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
 
 /**
  * @see IGCMetadata.gcFeatureMatrix
- * @public
+ * @internal
  */
 export declare interface GCFeatureMatrix {
     /**
@@ -696,7 +693,7 @@ export declare interface GCFeatureMatrix {
 
 /**
  * The types of GC nodes in the GC reference graph.
- * @public
+ * @internal
  */
 export declare const GCNodeType: {
     DataStore: string;
@@ -706,24 +703,24 @@ export declare const GCNodeType: {
 };
 
 /**
- * @public
+ * @internal
  */
 export declare type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
 /**
- * @public
+ * @internal
  */
 export declare type GCVersion = number;
 
 /**
  * Generate a random stable ID
- * @public
+ * @internal
  */
 export declare function generateStableId(): StableId;
 
 /**
  * A single summary which has already been acked by the server.
- * @public
+ * @internal
  */
 export declare interface IAckedSummary {
     readonly summaryOp: ISummaryOpMessage;
@@ -731,7 +728,7 @@ export declare interface IAckedSummary {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IAckSummaryResult {
     readonly summaryAckOp: ISummaryAckMessage;
@@ -740,7 +737,7 @@ export declare interface IAckSummaryResult {
 
 /**
  * Base results for all submitSummary attempts.
- * @public
+ * @internal
  */
 export declare interface IBaseSummarizeResult {
     readonly stage: "base";
@@ -753,7 +750,7 @@ export declare interface IBaseSummarizeResult {
 
 /**
  * Information from a snapshot needed to load BlobManager
- * @public
+ * @internal
  */
 export declare interface IBlobManagerLoadInfo {
     ids?: string[];
@@ -761,7 +758,7 @@ export declare interface IBlobManagerLoadInfo {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IBroadcastSummaryResult {
     readonly summarizeOp: ISummaryOpMessage;
@@ -770,7 +767,7 @@ export declare interface IBroadcastSummaryResult {
 
 /**
  * Similar to AbortController, but using promise instead of events
- * @public
+ * @internal
  */
 export declare interface ICancellableSummarizerController extends ISummaryCancellationToken {
     stop(reason: SummarizerStopReason): void;
@@ -779,7 +776,7 @@ export declare interface ICancellableSummarizerController extends ISummaryCancel
 /**
  * Similar to AbortSignal, but using promise instead of events
  * @param T - cancellation reason type
- * @public
+ * @internal
  */
 export declare interface ICancellationToken<T> {
     /** Tells if this cancellable token is cancelled */
@@ -792,7 +789,7 @@ export declare interface ICancellationToken<T> {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IChunkedOp {
     chunkId: number;
@@ -805,7 +802,7 @@ export declare interface IChunkedOp {
 
 /**
  * Watches summaries created by a specific client.
- * @public
+ * @internal
  */
 export declare interface IClientSummaryWatcher extends IDisposable {
     watchSummary(clientSequenceNumber: number): ISummary;
@@ -814,7 +811,7 @@ export declare interface IClientSummaryWatcher extends IDisposable {
 
 /**
  * Options for op compression.
- * @public
+ * @internal
  */
 export declare interface ICompressionRuntimeOptions {
     /**
@@ -830,7 +827,7 @@ export declare interface ICompressionRuntimeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IConnectableRuntime {
     readonly disposed: boolean;
@@ -850,7 +847,7 @@ export declare interface IContainerRuntimeMessageCompatDetails {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
@@ -868,7 +865,7 @@ export declare interface IContainerRuntimeMetadata extends ICreateContainerMetad
 
 /**
  * Options for container runtime.
- * @public
+ * @internal
  */
 export declare interface IContainerRuntimeOptions {
     readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -947,7 +944,7 @@ export declare interface IContainerRuntimeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ICreateContainerMetadata {
     /** Runtime version of the container when it was first created */
@@ -958,7 +955,7 @@ export declare interface ICreateContainerMetadata {
 
 /**
  * Options to use when enqueueing a summarize attempt.
- * @public
+ * @internal
  */
 export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
     /** If specified, The summarize attempt will not occur until after this sequence number. */
@@ -973,7 +970,7 @@ export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOpti
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IGCMetadata {
     /**
@@ -1011,7 +1008,7 @@ export declare interface IGCMetadata {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IGCRuntimeOptions {
     /**
@@ -1049,7 +1046,7 @@ export declare interface IGCRuntimeOptions {
 
 /**
  * The statistics of the system state after a garbage collection run.
- * @public
+ * @internal
  */
 export declare interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
 }
@@ -1057,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.
- * @public
+ * @internal
  */
 export declare interface IGeneratedSummaryStats extends ISummaryStats {
     /** The total number of data stores in the container. */
@@ -1076,7 +1073,7 @@ export declare interface IGeneratedSummaryStats extends ISummaryStats {
 
 /**
  * Results of submitSummary after generating the summary tree.
- * @public
+ * @internal
  */
 export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
     readonly stage: "generate";
@@ -1092,7 +1089,7 @@ export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeR
 
 /**
  * The statistics of the system state after a garbage collection mark phase run.
- * @public
+ * @internal
  */
 export declare interface IMarkPhaseStats {
     /** The number of nodes in the container. */
@@ -1116,7 +1113,7 @@ export declare interface IMarkPhaseStats {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface INackSummaryResult extends IRetriableFailureResult {
     readonly summaryNackOp: ISummaryNackMessage;
@@ -1125,12 +1122,12 @@ export declare interface INackSummaryResult extends IRetriableFailureResult {
 
 /**
  * Inactive error responses will have this header set to true
- * @public
+ * @internal
  */
 export declare const InactiveResponseHeaderKey = "isInactive";
 
 /**
- * @public
+ * @internal
  */
 export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
     /** Reason for generating summary. */
@@ -1139,7 +1136,7 @@ export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 
 /**
  * Data required to update internal tracking state after receiving a Summary Ack.
- * @public
+ * @internal
  */
 export declare interface IRefreshSummaryAckOptions {
     /** Handle from the ack's summary op. */
@@ -1154,7 +1151,7 @@ export declare interface IRefreshSummaryAckOptions {
 
 /**
  * Type for summarization failures that are retriable.
- * @public
+ * @internal
  */
 export declare interface IRetriableFailureResult {
     readonly retryAfterSeconds?: number;
@@ -1162,7 +1159,7 @@ export declare interface IRetriableFailureResult {
 
 /**
  * Serialized state of IOrderedClientElection.
- * @public
+ * @internal
  */
 export declare interface ISerializedElection {
     /** Sequence number at the time of the latest election. */
@@ -1182,20 +1179,20 @@ export declare interface ISerializedElection {
 
 /**
  * @deprecated please use version in driver-utils
- * @public
+ * @internal
  */
 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'
- * @public
+ * @internal
  */
 export declare function isStableId(str: string): str is StableId;
 
 /**
  * Results of submitSummary after submitting the summarize op.
- * @public
+ * @internal
  */
 export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
     readonly stage: "submit";
@@ -1206,7 +1203,7 @@ export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResul
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
     /** Logger to use for correlated summary events */
@@ -1218,7 +1215,7 @@ export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizeEventProps {
     result: "success" | "failure" | "canceled";
@@ -1229,7 +1226,7 @@ export declare interface ISummarizeEventProps {
 
 /**
  * Options affecting summarize behavior.
- * @public
+ * @internal
  */
 export declare interface ISummarizeOptions {
     /** True to generate the full tree with no handle reuse optimizations; defaults to false */
@@ -1244,7 +1241,7 @@ export declare interface ISummarizeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizer extends IEventProvider<ISummarizerEvents> {
     /**
@@ -1280,7 +1277,7 @@ export declare interface ISummarizer extends IEventProvider<ISummarizerEvents> {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizeResults {
     /** Resolves when we generate, upload, and submit the summary. */
@@ -1292,14 +1289,14 @@ export declare interface ISummarizeResults {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizerEvents extends IEvent {
     (event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizerInternalsProvider {
     /** Encapsulates the work to walk the internals of the running container to generate a summary */
@@ -1309,7 +1306,7 @@ export declare interface ISummarizerInternalsProvider {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizerRuntime extends IConnectableRuntime {
     readonly logger: ITelemetryLoggerExt;
@@ -1323,7 +1320,7 @@ export declare interface ISummarizerRuntime extends IConnectableRuntime {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummarizingWarning extends ContainerWarning {
     readonly errorType: "summarizingError";
@@ -1333,7 +1330,7 @@ export declare interface ISummarizingWarning extends ContainerWarning {
 /**
  * A single summary which can be tracked as it goes through its life cycle.
  * The life cycle is: Local to Broadcast to Acked/Nacked.
- * @public
+ * @internal
  */
 export declare interface ISummary {
     readonly clientId: string;
@@ -1344,7 +1341,7 @@ export declare interface ISummary {
 
 /**
  * Interface for summary ack messages with typed contents.
- * @public
+ * @internal
  */
 export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryAck;
@@ -1352,7 +1349,7 @@ export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryBaseConfiguration {
     /**
@@ -1374,38 +1371,38 @@ export declare interface ISummaryBaseConfiguration {
 
 /**
  * Similar to AbortSignal, but using promise instead of events
- * @public
+ * @internal
  */
 export declare type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryCollectionOpEvents extends IEvent {
     (event: OpActionEventName, listener: OpActionEventListener): any;
 }
 
 /**
- * @public
+ * @internal
  */
 export declare type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
     state: "disableHeuristics";
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryConfigurationDisableSummarizer {
     state: "disabled";
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
     state: "enabled";
@@ -1468,13 +1465,13 @@ export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseCon
 
 /**
  * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.
- * @public
+ * @internal
  */
 export declare type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
 
 /**
  * Interface for summary nack messages with typed contents.
- * @public
+ * @internal
  */
 export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
     type: MessageType.SummaryNack;
@@ -1483,7 +1480,7 @@ export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
 
 /**
  * Interface for summary op messages with typed contents.
- * @public
+ * @internal
  */
 export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
     type: MessageType.Summarize;
@@ -1491,7 +1488,7 @@ export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISummaryRuntimeOptions {
     /** Override summary configurations set by the server. */
@@ -1507,7 +1504,7 @@ export declare interface ISummaryRuntimeOptions {
 
 /**
  * The statistics of the system state after a garbage collection sweep phase run.
- * @public
+ * @internal
  */
 export declare interface ISweepPhaseStats {
     /** The number of nodes in the lifetime of the container. */
@@ -1526,7 +1523,7 @@ export declare interface ISweepPhaseStats {
 
 /**
  * Results of submitSummary after uploading the tree to storage.
- * @public
+ * @internal
  */
 export declare interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
     readonly stage: "upload";
@@ -1539,17 +1536,17 @@ export declare interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeR
 /**
  * Can be useful in testing as well as in places where caller does not use cancellation.
  * This object implements ISummaryCancellationToken interface but cancellation is never leveraged.
- * @public
+ * @internal
  */
 export declare const neverCancelledSummaryToken: ISummaryCancellationToken;
 
 /**
- * @public
+ * @internal
  */
 export declare type OpActionEventListener = (op: ISequencedDocumentMessage) => void;
 
 /**
- * @public
+ * @internal
  */
 export declare type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | "default";
 
@@ -1564,7 +1561,7 @@ export declare interface RecentlyAddedContainerRuntimeMessageDetails {
 
 /**
  * Accepted header keys for requests coming to the runtime.
- * @public
+ * @internal
  */
 export declare enum RuntimeHeaders {
     /** True to wait for a data store to be created and loaded before returning it. */
@@ -1575,7 +1572,7 @@ export declare enum RuntimeHeaders {
 
 /**
  * @deprecated use ContainerRuntimeMessageType instead
- * @public
+ * @internal
  */
 export declare enum RuntimeMessage {
     FluidDataStoreOp = "component",
@@ -1589,7 +1586,7 @@ export declare enum RuntimeMessage {
 
 /**
  * The data in summarizer result when submit summary stage fails.
- * @public
+ * @internal
  */
 export declare interface SubmitSummaryFailureData extends IRetriableFailureResult {
     stage: SummaryStage;
@@ -1610,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.
- * @public
+ * @internal
  */
 export declare type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
 
@@ -1618,7 +1615,7 @@ export declare type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummar
  * Summarizer is responsible for coordinating when to generate and send summaries.
  * It is the main entry point for summary work.
  * It is created only by summarizing container (i.e. one with clientType === "summarizer")
- * @public
+ * @internal
  */
 export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
     /** Reference to runtime that created this object.
@@ -1699,7 +1696,7 @@ export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> imp
 }
 
 /**
- * @public
+ * @internal
  */
 export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
     success: true;
@@ -1712,7 +1709,7 @@ export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
 };
 
 /**
- * @public
+ * @internal
  */
 export declare type SummarizerStopReason = 
 /** Summarizer client failed to summarize in all 3 consecutive attempts. */
@@ -1744,7 +1741,7 @@ export declare type SummarizerStopReason =
  * 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.
- * @public
+ * @internal
  */
 export declare class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
     private readonly deltaManager;
@@ -1796,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.
- * @public
+ * @internal
  */
 export declare type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
 
@@ -1808,7 +1805,7 @@ export declare function TEST_requestSummarizer(loader: ILoader, url: string): Pr
 
 /**
  * Tombstone error responses will have this header set to true
- * @public
+ * @internal
  */
 export declare const TombstoneResponseHeaderKey = "isTombstoned";