@fluidframework/runtime-definitions 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

package/src/dataStoreContext.ts

@@ -46,6 +46,7 @@ import { IIdCompressor } from "./id-compressor";
 
 /**
  * Runtime flush mode handling
+ * @internal
  */
 export enum FlushMode {
 	/**
@@ -60,6 +61,9 @@ export enum FlushMode {
 	TurnBased,
 }
 
+/**
+ * @internal
+ */
 export enum FlushModeExperimental {
 	/**
 	 * When in Async flush mode, the runtime will accumulate all operations across JS turns and send them as a single
@@ -76,6 +80,7 @@ export enum FlushModeExperimental {
 /**
  * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible
  * locally within the container only or visible globally to all clients.
+ * @internal
  */
 export const VisibilityState = {
 	/**
@@ -101,8 +106,14 @@ export const VisibilityState = {
 	 */
 	GloballyVisible: "GloballyVisible",
 };
+/**
+ * @internal
+ */
 export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
 
+/**
+ * @internal
+ */
 export interface IContainerRuntimeBaseEvents extends IEvent {
 	(event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void);
 	/**
@@ -122,6 +133,7 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
  * the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded
  * and will be garbage collected. The current datastore cannot be aliased to a different value.
  * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.
+ * @internal
  */
 export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
@@ -130,6 +142,7 @@ export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
  * - Handle to the data store's entryPoint
  * - Fluid router for the data store
  * - Can be assigned an alias
+ * @internal
  */
 export interface IDataStore {
 	/**
@@ -184,6 +197,7 @@ export interface IDataStore {
 /**
  * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
  * TODO: this should be merged into IFluidDataStoreContext
+ * @internal
  */
 export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
 	readonly logger: ITelemetryBaseLogger;
@@ -210,7 +224,6 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
 
 	/**
 	 * @deprecated 0.16 Issue #1537, #3631
-	 * @internal
 	 */
 	_createDataStoreWithProps(
 		pkg: string | string[],
@@ -264,6 +277,7 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
  *
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
+ * @internal
  */
 export interface IFluidDataStoreChannel extends IDisposable {
 	readonly id: string;
@@ -369,6 +383,9 @@ export interface IFluidDataStoreChannel extends IDisposable {
 	readonly IFluidRouter: IFluidRouter;
 }
 
+/**
+ * @internal
+ */
 export type CreateChildSummarizerNodeFn = (
 	summarizeInternal: SummarizeInternalFn,
 	getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
@@ -378,6 +395,9 @@ export type CreateChildSummarizerNodeFn = (
 	getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,
 ) => ISummarizerNodeWithGC;
 
+/**
+ * @internal
+ */
 export interface IFluidDataStoreContextEvents extends IEvent {
 	(event: "attaching" | "attached", listener: () => void);
 }
@@ -385,6 +405,7 @@ export interface IFluidDataStoreContextEvents extends IEvent {
 /**
  * Represents the context for the data store. It is used by the data store runtime to
  * get information and call functionality to the container.
+ * @internal
  */
 export interface IFluidDataStoreContext
 	extends IEventProvider<IFluidDataStoreContextEvents>,
@@ -520,6 +541,9 @@ export interface IFluidDataStoreContext
 	addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
 }
 
+/**
+ * @internal
+ */
 export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
 	/**
 	 * Binds a runtime to the context.

package/src/dataStoreFactory.ts

@@ -5,8 +5,14 @@
 
 import { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreContext";
 
+/**
+ * @internal
+ */
 export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
 
+/**
+ * @internal
+ */
 export interface IProvideFluidDataStoreFactory {
 	readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
 }
@@ -14,6 +20,7 @@ export interface IProvideFluidDataStoreFactory {
 /**
  * IFluidDataStoreFactory create data stores.  It is associated with an identifier (its `type` member)
  * and usually provided to consumers using this mapping through a data store registry.
+ * @internal
  */
 export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
 	/**

package/src/dataStoreRegistry.ts

@@ -8,6 +8,7 @@ import { IProvideFluidDataStoreFactory } from "./dataStoreFactory";
 /**
  * A single registry entry that may be used to create data stores
  * It has to have either factory or registry, or both.
+ * @internal
  */
 export type FluidDataStoreRegistryEntry = Readonly<
 	Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>
@@ -15,16 +16,24 @@ export type FluidDataStoreRegistryEntry = Readonly<
 /**
  * An associated pair of an identifier and registry entry.  Registry entries
  * may be dynamically loaded.
+ * @internal
  */
 export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
 /**
  * An iterable identifier/registry entry pair list
+ * @internal
  */
 export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
+/**
+ * @internal
+ */
 export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =
 	"IFluidDataStoreRegistry";
 
+/**
+ * @internal
+ */
 export interface IProvideFluidDataStoreRegistry {
 	readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
 }
@@ -32,6 +41,7 @@ export interface IProvideFluidDataStoreRegistry {
 /**
  * An association of identifiers to data store registry entries, where the
  * entries can be used to create data stores.
+ * @internal
  */
 export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
 	get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;

package/src/garbageCollection.ts

@@ -3,18 +3,35 @@
  * Licensed under the MIT License.
  */
 
-/** The key for the GC tree in summary. */
+/**
+ * The key for the GC tree in summary.
+ *
+ * @internal
+ */
 export const gcTreeKey = "gc";
-/** They prefix for GC blobs in the GC tree in summary. */
+/**
+ * They prefix for GC blobs in the GC tree in summary.
+ *
+ * @internal
+ */
 export const gcBlobPrefix = "__gc";
-/** The key for tombstone blob in the GC tree in summary. */
+/**
+ * The key for tombstone blob in the GC tree in summary.
+ *
+ * @internal
+ */
 export const gcTombstoneBlobKey = "__tombstones";
-/** The key for deleted nodes blob in the GC tree in summary. */
+/**
+ * The key for deleted nodes blob in the GC tree in summary.
+ *
+ * @internal
+ */
 export const gcDeletedBlobKey = "__deletedNodes";
 
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
+ * @internal
  */
 export interface IGarbageCollectionData {
 	/**
@@ -25,6 +42,7 @@ export interface IGarbageCollectionData {
 
 /**
  * GC details provided to each node during creation.
+ * @internal
  */
 export interface IGarbageCollectionDetailsBase {
 	/**

package/src/id-compressor/idCompressor.ts

@@ -10,6 +10,9 @@ import {
 	SerializedIdCompressorWithOngoingSession,
 } from "./persisted-types";
 
+/**
+ * @internal
+ */
 export interface IIdCompressorCore {
 	/**
 	 * Returns a range of IDs created by this session in a format for sending to the server for finalizing.
@@ -98,7 +101,7 @@ export interface IIdCompressorCore {
  *
  * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
  * should use op-space IDs.
- *
+ * @internal
  */
 export interface IIdCompressor {
 	localSessionId: SessionId;

package/src/id-compressor/identifiers.ts

@@ -7,6 +7,7 @@
  * A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
  * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to
  * the scope of the session (i.e. compressor) that produced them.
+ * @internal
  */
 export type SessionSpaceCompressedId = number & {
 	readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
@@ -16,6 +17,7 @@ export type SessionSpaceCompressedId = number & {
  * A compressed ID that has been normalized into "op space".
  * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require less normalizing when
  * received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.
+ * @internal
  */
 export type OpSpaceCompressedId = number & {
 	readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
@@ -26,10 +28,12 @@ export type OpSpaceCompressedId = number & {
  * A 128-bit Universally Unique IDentifier. Represented here
  * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
  * where x is a lowercase hex digit.
+ * @internal
  */
 export type StableId = string & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a" };
 
 /**
  * A StableId which is suitable for use as a session identifier
+ * @internal
  */
 export type SessionId = StableId & { readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58" };

package/src/id-compressor/persisted-types/0.0.1.ts

@@ -7,6 +7,7 @@ import type { SessionId } from "../identifiers";
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export type SerializedIdCompressor = string & {
 	readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
@@ -14,6 +15,7 @@ export type SerializedIdCompressor = string & {
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
 	readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
@@ -21,6 +23,7 @@ export type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
 	readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
@@ -30,6 +33,7 @@ export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor &
  * Data describing a range of session-local IDs (from a remote or local session).
  *
  * A range is composed of local IDs that were generated.
+ * @internal
  */
 export interface IdCreationRange {
 	readonly sessionId: SessionId;
@@ -42,5 +46,6 @@ export interface IdCreationRange {
 /**
  * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
  * This value must *NOT* change without careful consideration to compatibility.
+ * @internal
  */
 export const initialClusterCapacity = 512;

package/src/protocol.ts

@@ -7,6 +7,7 @@ import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
 
 /**
  * An envelope wraps the contents with the intended target
+ * @internal
  */
 export interface IEnvelope {
 	/**
@@ -20,6 +21,9 @@ export interface IEnvelope {
 	contents: any;
 }
 
+/**
+ * @internal
+ */
 export interface ISignalEnvelope {
 	/**
 	 * The target for the envelope, undefined for the container
@@ -42,6 +46,7 @@ export interface ISignalEnvelope {
 
 /**
  * Represents ISignalMessage with its type.
+ * @internal
  */
 export interface IInboundSignalMessage extends ISignalMessage {
 	type: string;
@@ -50,6 +55,7 @@ export interface IInboundSignalMessage extends ISignalMessage {
 /**
  * Message send by client attaching local data structure.
  * Contains snapshot of data structure which is the current state of this data structure.
+ * @internal
  */
 export interface IAttachMessage {
 	/**
@@ -73,6 +79,7 @@ export interface IAttachMessage {
  * but it should not be used when creating a new attach op.
  * Older versions of attach messages could have null snapshots,
  * so this gives correct typings for writing backward compatible code.
+ * @internal
  */
 export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
 	snapshot: IAttachMessage["snapshot"] | null;

package/src/summary.ts

@@ -15,6 +15,7 @@ import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbage
 
 /**
  * Contains the aggregation data from a Tree/Subtree.
+ * @internal
  */
 export interface ISummaryStats {
 	treeNodeCount: number;
@@ -30,6 +31,7 @@ export interface ISummaryStats {
  * each of its DDS.
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
  * will be taking part of the summarization process.
+ * @internal
  */
 export interface ISummaryTreeWithStats {
 	/**
@@ -45,6 +47,7 @@ export interface ISummaryTreeWithStats {
 
 /**
  * Represents a summary at a current sequence number.
+ * @internal
  */
 export interface ISummarizeResult {
 	stats: ISummaryStats;
@@ -65,6 +68,7 @@ export interface ISummarizeResult {
  *   ...
  *     "path1":
  * ```
+ * @internal
  */
 export interface ISummarizeInternalResult extends ISummarizeResult {
 	id: string;
@@ -77,6 +81,7 @@ export interface ISummarizeInternalResult extends ISummarizeResult {
 /**
  * @experimental - Can be deleted/changed at any time
  * Contains the necessary information to allow DDSes to do incremental summaries
+ * @internal
  */
 export interface IExperimentalIncrementalSummaryContext {
 	/**
@@ -101,6 +106,9 @@ export interface IExperimentalIncrementalSummaryContext {
 	summaryPath: string;
 }
 
+/**
+ * @internal
+ */
 export type SummarizeInternalFn = (
 	fullTree: boolean,
 	trackState: boolean,
@@ -108,6 +116,9 @@ export type SummarizeInternalFn = (
 	incrementalSummaryContext?: IExperimentalIncrementalSummaryContext,
 ) => Promise<ISummarizeInternalResult>;
 
+/**
+ * @internal
+ */
 export interface ISummarizerNodeConfig {
 	/**
 	 * True to reuse previous handle when unchanged since last acked summary.
@@ -126,6 +137,9 @@ export interface ISummarizerNodeConfig {
 	readonly throwOnFailure?: true;
 }
 
+/**
+ * @internal
+ */
 export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
 	/**
 	 * True if GC is disabled. If so, don't track GC related state for a summary.
@@ -134,11 +148,17 @@ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
 	readonly gcDisabled?: boolean;
 }
 
+/**
+ * @internal
+ */
 export enum CreateSummarizerNodeSource {
 	FromSummary,
 	FromAttach,
 	Local,
 }
+/**
+ * @internal
+ */
 export type CreateChildSummarizerNodeParam =
 	| {
 			type: CreateSummarizerNodeSource.FromSummary;
@@ -152,6 +172,9 @@ export type CreateChildSummarizerNodeParam =
 			type: CreateSummarizerNodeSource.Local;
 	  };
 
+/**
+ * @internal
+ */
 export interface ISummarizerNode {
 	/**
 	 * Latest successfully acked summary reference sequence number
@@ -240,6 +263,7 @@ export interface ISummarizerNode {
  * `isReferenced`: This tells whether this node is referenced in the document or not.
  *
  * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
+ * @internal
  */
 export interface ISummarizerNodeWithGC extends ISummarizerNode {
 	createChild(
@@ -298,11 +322,15 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
 	updateUsedRoutes(usedRoutes: string[]): void;
 }
 
+/**
+ * @internal
+ */
 export const channelsTreeName = ".channels";
 
 /**
  * Contains telemetry data relevant to summarization workflows.
  * This object is expected to be modified directly by various summarize methods.
+ * @internal
  */
 export interface ITelemetryContext {
 	/**
@@ -340,6 +368,12 @@ export interface ITelemetryContext {
 	serialize(): string;
 }
 
+/**
+ * @internal
+ */
 export const blobCountPropertyName = "BlobCount";
 
+/**
+ * @internal
+ */
 export const totalBlobSizePropertyName = "TotalBlobSize";