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

package/src/containerRuntime.ts

@@ -213,7 +213,7 @@ function compatBehaviorAllowsMessageType(
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummaryBaseConfiguration {
 	/**
@@ -235,7 +235,7 @@ export interface ISummaryBaseConfiguration {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
 	state: "enabled";
@@ -298,21 +298,21 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummaryConfigurationDisableSummarizer {
 	state: "disabled";
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
 	state: "disableHeuristics";
 }
 
 /**
- * @public
+ * @internal
  */
 export type ISummaryConfiguration =
 	| ISummaryConfigurationDisableSummarizer
@@ -320,7 +320,7 @@ export type ISummaryConfiguration =
 	| ISummaryConfigurationHeuristics;
 
 /**
- * @public
+ * @internal
  */
 export const DefaultSummaryConfiguration: ISummaryConfiguration = {
 	state: "enabled",
@@ -349,7 +349,7 @@ export const DefaultSummaryConfiguration: ISummaryConfiguration = {
 };
 
 /**
- * @public
+ * @internal
  */
 export interface ISummaryRuntimeOptions {
 	/** Override summary configurations set by the server. */
@@ -366,7 +366,7 @@ export interface ISummaryRuntimeOptions {
 
 /**
  * Options for op compression.
- * @public
+ * @internal
  */
 export interface ICompressionRuntimeOptions {
 	/**
@@ -384,7 +384,7 @@ export interface ICompressionRuntimeOptions {
 
 /**
  * Options for container runtime.
- * @public
+ * @internal
  */
 export interface IContainerRuntimeOptions {
 	readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -466,7 +466,7 @@ export interface IContainerRuntimeOptions {
 
 /**
  * Accepted header keys for requests coming to the runtime.
- * @public
+ * @internal
  */
 export enum RuntimeHeaders {
 	/** True to wait for a data store to be created and loaded before returning it. */
@@ -476,23 +476,23 @@ export enum RuntimeHeaders {
 }
 
 /** True if a tombstoned object should be returned without erroring
- * @public
+ * @internal
  */
 export const AllowTombstoneRequestHeaderKey = "allowTombstone"; // Belongs in the enum above, but avoiding the breaking change
 /**
  * [IRRELEVANT IF throwOnInactiveLoad OPTION NOT SET] True if an inactive object should be returned without erroring
- * @public
+ * @internal
  */
 export const AllowInactiveRequestHeaderKey = "allowInactive"; // Belongs in the enum above, but avoiding the breaking change
 
 /**
  * Tombstone error responses will have this header set to true
- * @public
+ * @internal
  */
 export const TombstoneResponseHeaderKey = "isTombstoned";
 /**
  * Inactive error responses will have this header set to true
- * @public
+ * @internal
  */
 export const InactiveResponseHeaderKey = "isInactive";
 
@@ -516,7 +516,7 @@ export const defaultRuntimeHeaderData: Required<RuntimeHeaderData> = {
 
 /**
  * Available compression algorithms for op compression.
- * @public
+ * @internal
  */
 export enum CompressionAlgorithms {
 	lz4 = "lz4",
@@ -585,7 +585,7 @@ const defaultCloseSummarizerDelayMs = 5000; // 5 seconds
 
 /**
  * @deprecated use ContainerRuntimeMessageType instead
- * @public
+ * @internal
  */
 export enum RuntimeMessage {
 	FluidDataStoreOp = "component",
@@ -599,7 +599,7 @@ export enum RuntimeMessage {
 
 /**
  * @deprecated please use version in driver-utils
- * @public
+ * @internal
  */
 export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean {
 	return (Object.values(RuntimeMessage) as string[]).includes(message.type);
@@ -609,7 +609,7 @@ export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean {
  * 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 const agentSchedulerId = "_scheduler";
 
@@ -718,7 +718,7 @@ export async function TEST_requestSummarizer(loader: ILoader, url: string): Prom
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
- * @public
+ * @internal
  */
 export class ContainerRuntime
 	extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents>
@@ -1215,9 +1215,7 @@ export class ContainerRuntime
 	 */
 	private readonly loadedFromVersionId: string | undefined;
 
-	/**
-	 * @internal
-	 */
+	/***/
 	protected constructor(
 		context: IContainerContext,
 		private readonly registry: IFluidDataStoreRegistry,
@@ -2583,7 +2581,6 @@ export class ContainerRuntime
 
 	/**
 	 * @deprecated 0.16 Issue #1537, #3631
-	 * @internal
 	 */
 	public async _createDataStoreWithProps(
 		pkg: string | string[],

package/src/dataStoreRegistry.ts

@@ -10,7 +10,7 @@ import {
 } from "@fluidframework/runtime-definitions";
 
 /**
- * @public
+ * @internal
  */
 export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
 	private readonly map: Map<

package/src/gc/gcDefinitions.ts

@@ -22,7 +22,7 @@ import {
 import { RuntimeHeaderData } from "../containerRuntime";
 
 /**
- * @public
+ * @internal
  */
 export type GCVersion = number;
 
@@ -92,7 +92,7 @@ export const defaultSessionExpiryDurationMs = 30 * oneDayMs; // 30 days
 
 /**
  * @see IGCMetadata.gcFeatureMatrix
- * @public
+ * @internal
  */
 export interface GCFeatureMatrix {
 	/**
@@ -110,7 +110,7 @@ export interface GCFeatureMatrix {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IGCMetadata {
 	/**
@@ -150,7 +150,7 @@ export interface IGCMetadata {
 
 /**
  * The statistics of the system state after a garbage collection mark phase run.
- * @public
+ * @internal
  */
 export interface IMarkPhaseStats {
 	/** The number of nodes in the container. */
@@ -175,7 +175,7 @@ export interface IMarkPhaseStats {
 
 /**
  * The statistics of the system state after a garbage collection sweep phase run.
- * @public
+ * @internal
  */
 export interface ISweepPhaseStats {
 	/** The number of nodes in the lifetime of the container. */
@@ -194,13 +194,13 @@ export interface ISweepPhaseStats {
 
 /**
  * The statistics of the system state after a garbage collection run.
- * @public
+ * @internal
  */
 export interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {}
 
 /**
  * The types of GC nodes in the GC reference graph.
- * @public
+ * @internal
  */
 export const GCNodeType = {
 	// Nodes that are for data stores.
@@ -214,7 +214,7 @@ export const GCNodeType = {
 };
 
 /**
- * @public
+ * @internal
  */
 export type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
 
@@ -320,7 +320,7 @@ export interface IGarbageCollectorCreateParams {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IGCRuntimeOptions {
 	/**

package/src/id-compressor/utilities.ts

@@ -35,7 +35,7 @@ export function createSessionId(): SessionId {
 
 /**
  * Asserts that the given string is a stable ID.
- * @public
+ * @internal
  */
 export function assertIsStableId(stableId: string): StableId {
 	assert(isStableId(stableId), 0x4a3 /* Expected a StableId */);
@@ -52,7 +52,7 @@ export function assertIsSessionId(stableId: string): SessionId {
 
 /**
  * Generate a random stable ID
- * @public
+ * @internal
  */
 export function generateStableId(): StableId {
 	return assertIsStableId(v4());
@@ -61,7 +61,7 @@ export function generateStableId(): StableId {
 /**
  * Returns true iff the given string is a valid Version 4, variant 2 UUID
  * 'xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx'
- * @public
+ * @internal
  */
 export function isStableId(str: string): str is StableId {
 	if (str.length !== 36) {

package/src/messageTypes.ts

@@ -14,7 +14,7 @@ import { IDataStoreAliasMessage } from "./dataStore";
 import { IChunkedOp } from "./opLifecycle";
 
 /**
- * @public
+ * @internal
  */
 export enum ContainerMessageType {
 	// An op to be delivered to store
@@ -71,7 +71,8 @@ export interface IContainerRuntimeMessageCompatDetails {
  * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.
  * This way stringified values can be compared.
  */
-interface TypedContainerRuntimeMessage<TType extends ContainerMessageType, TContents> {
+interface TypedContainerRuntimeMessage<TType extends ContainerMessageType, TContents>
+	extends Partial<RecentlyAddedContainerRuntimeMessageDetails> {
 	/** Type of the op, within the ContainerRuntime's domain */
 	type: TType;
 	/** Domain-specific contents, interpreted according to the type */

package/src/opLifecycle/definitions.ts

@@ -53,7 +53,7 @@ export interface IBatchCheckpoint {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IChunkedOp {
 	chunkId: number;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.0.0-dev.7.4.0.215930";
+export const pkgVersion = "2.0.0-dev.7.4.0.216897";

package/src/summary/orderedClientElection.ts

@@ -227,7 +227,7 @@ export interface IOrderedClientElectionEvents extends IEvent {
 
 /**
  * Serialized state of IOrderedClientElection.
- * @public
+ * @internal
  */
 export interface ISerializedElection {
 	/** Sequence number at the time of the latest election. */

package/src/summary/runWhileConnectedCoordinator.ts

@@ -12,7 +12,7 @@ import {
 
 /**
  * Similar to AbortController, but using promise instead of events
- * @public
+ * @internal
  */
 export interface ICancellableSummarizerController extends ISummaryCancellationToken {
 	stop(reason: SummarizerStopReason): void;
@@ -21,7 +21,7 @@ export interface ICancellableSummarizerController extends ISummaryCancellationTo
 /**
  * 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 const neverCancelledSummaryToken: ISummaryCancellationToken = {
 	cancelled: false,

package/src/summary/summarizer.ts

@@ -69,7 +69,7 @@ export const createSummarizingWarning = (errorMessage: string, logged: boolean)
  * 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 class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
 	public get ISummarizer() {

package/src/summary/summarizerTypes.ts

@@ -19,7 +19,7 @@ import { SummarizeReason } from "./summaryGenerator";
 /**
  * Similar to AbortSignal, but using promise instead of events
  * @param T - cancellation reason type
- * @public
+ * @internal
  */
 export interface ICancellationToken<T> {
 	/** Tells if this cancellable token is cancelled */
@@ -33,13 +33,13 @@ export interface ICancellationToken<T> {
 
 /**
  * Similar to AbortSignal, but using promise instead of events
- * @public
+ * @internal
  */
 export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
 
 /**
  * Data required to update internal tracking state after receiving a Summary Ack.
- * @public
+ * @internal
  */
 export interface IRefreshSummaryAckOptions {
 	/** Handle from the ack's summary op. */
@@ -53,7 +53,7 @@ export interface IRefreshSummaryAckOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizerInternalsProvider {
 	/** Encapsulates the work to walk the internals of the running container to generate a summary */
@@ -78,7 +78,7 @@ export interface ISummarizerOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizingWarning extends ContainerWarning {
 	readonly errorType: "summarizingError";
@@ -86,7 +86,7 @@ export interface ISummarizingWarning extends ContainerWarning {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IConnectableRuntime {
 	readonly disposed: boolean;
@@ -96,7 +96,7 @@ export interface IConnectableRuntime {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizerRuntime extends IConnectableRuntime {
 	readonly logger: ITelemetryLoggerExt;
@@ -117,7 +117,7 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
 
 /**
  * Options affecting summarize behavior.
- * @public
+ * @internal
  */
 export interface ISummarizeOptions {
 	/** True to generate the full tree with no handle reuse optimizations; defaults to false */
@@ -132,7 +132,7 @@ export interface ISummarizeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISubmitSummaryOptions extends ISummarizeOptions {
 	/** Logger to use for correlated summary events */
@@ -144,7 +144,7 @@ export interface ISubmitSummaryOptions extends ISummarizeOptions {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 	/** Reason for generating summary. */
@@ -153,7 +153,7 @@ export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 
 /**
  * Options to use when enqueueing a summarize attempt.
- * @public
+ * @internal
  */
 export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
 	/** If specified, The summarize attempt will not occur until after this sequence number. */
@@ -171,7 +171,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.
- * @public
+ * @internal
  */
 export interface IGeneratedSummaryStats extends ISummaryStats {
 	/** The total number of data stores in the container. */
@@ -190,7 +190,7 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
 
 /**
  * Base results for all submitSummary attempts.
- * @public
+ * @internal
  */
 export interface IBaseSummarizeResult {
 	readonly stage: "base";
@@ -203,7 +203,7 @@ export interface IBaseSummarizeResult {
 
 /**
  * Results of submitSummary after generating the summary tree.
- * @public
+ * @internal
  */
 export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
 	readonly stage: "generate";
@@ -219,7 +219,7 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
 
 /**
  * Results of submitSummary after uploading the tree to storage.
- * @public
+ * @internal
  */
 export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
 	readonly stage: "upload";
@@ -231,7 +231,7 @@ export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "
 
 /**
  * Results of submitSummary after submitting the summarize op.
- * @public
+ * @internal
  */
 export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
 	readonly stage: "submit";
@@ -256,7 +256,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.
- * @public
+ * @internal
  */
 export type SubmitSummaryResult =
 	| IBaseSummarizeResult
@@ -266,13 +266,13 @@ export type SubmitSummaryResult =
 
 /**
  * The stages of Summarize, used to describe how far progress succeeded in case of a failure at a later stage.
- * @public
+ * @internal
  */
 export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
 
 /**
  * Type for summarization failures that are retriable.
- * @public
+ * @internal
  */
 export interface IRetriableFailureResult {
 	readonly retryAfterSeconds?: number;
@@ -280,14 +280,14 @@ export interface IRetriableFailureResult {
 
 /**
  * The data in summarizer result when submit summary stage fails.
- * @public
+ * @internal
  */
 export interface SubmitSummaryFailureData extends IRetriableFailureResult {
 	stage: SummaryStage;
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IBroadcastSummaryResult {
 	readonly summarizeOp: ISummaryOpMessage;
@@ -295,7 +295,7 @@ export interface IBroadcastSummaryResult {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface IAckSummaryResult {
 	readonly summaryAckOp: ISummaryAckMessage;
@@ -303,7 +303,7 @@ export interface IAckSummaryResult {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface INackSummaryResult extends IRetriableFailureResult {
 	readonly summaryNackOp: ISummaryNackMessage;
@@ -311,7 +311,7 @@ export interface INackSummaryResult extends IRetriableFailureResult {
 }
 
 /**
- * @public
+ * @internal
  */
 export type SummarizeResultPart<TSuccess, TFailure = undefined> =
 	| {
@@ -326,7 +326,7 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> =
 	  };
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizeResults {
 	/** Resolves when we generate, upload, and submit the summary. */
@@ -342,7 +342,7 @@ export interface ISummarizeResults {
 }
 
 /**
- * @public
+ * @internal
  */
 export type EnqueueSummarizeResult =
 	| (ISummarizeResults & {
@@ -372,7 +372,7 @@ export type EnqueueSummarizeResult =
 	  };
 
 /**
- * @public
+ * @internal
  */
 export type SummarizerStopReason =
 	/** Summarizer client failed to summarize in all 3 consecutive attempts. */
@@ -401,7 +401,7 @@ export type SummarizerStopReason =
 	| "latestSummaryStateStale";
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizeEventProps {
 	result: "success" | "failure" | "canceled";
@@ -411,14 +411,14 @@ export interface ISummarizeEventProps {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizerEvents extends IEvent {
 	(event: "summarize", listener: (props: ISummarizeEventProps) => void);
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
 	/**