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

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

@@ -34,12 +34,13 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
  * 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 declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
 /**
  * Attribution information associated with a change.
- * @alpha
+ * @internal
  */
 export declare interface AttributionInfo {
     /**
@@ -54,20 +55,32 @@ export declare interface AttributionInfo {
 
 /**
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
- * @alpha
+ * @internal
  */
 export declare type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
 
+/**
+ * @internal
+ */
 export declare const blobCountPropertyName = "BlobCount";
 
+/**
+ * @internal
+ */
 export declare const channelsTreeName = ".channels";
 
+/**
+ * @internal
+ */
 export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>, 
 /**
  * @deprecated The functionality to get base GC details has been moved to summarizer node.
  */
 getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
 
+/**
+ * @internal
+ */
 export declare type CreateChildSummarizerNodeParam = {
     type: CreateSummarizerNodeSource.FromSummary;
 } | {
@@ -78,6 +91,9 @@ export declare type CreateChildSummarizerNodeParam = {
     type: CreateSummarizerNodeSource.Local;
 };
 
+/**
+ * @internal
+ */
 export declare enum CreateSummarizerNodeSource {
     FromSummary = 0,
     FromAttach = 1,
@@ -91,8 +107,7 @@ export declare enum CreateSummarizerNodeSource {
  * is currently unsupported, as applications can effectively modify content anonymously while detached.
  * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting
  * this functionality if the host provided additional context to their attributor or attach calls.
- *
- * @alpha
+ * @internal
  */
 export declare interface DetachedAttributionKey {
     type: "detached";
@@ -110,11 +125,13 @@ export declare interface DetachedAttributionKey {
 /**
  * A single registry entry that may be used to create data stores
  * It has to have either factory or registry, or both.
+ * @internal
  */
 export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
 
 /**
  * Runtime flush mode handling
+ * @internal
  */
 export declare enum FlushMode {
     /**
@@ -128,6 +145,9 @@ export declare enum FlushMode {
     TurnBased = 1
 }
 
+/**
+ * @internal
+ */
 export declare enum FlushModeExperimental {
     /**
      * When in Async flush mode, the runtime will accumulate all operations across JS turns and send them as a single
@@ -141,21 +161,38 @@ export declare enum FlushModeExperimental {
     Async = 2
 }
 
-/** They prefix for GC blobs in the GC tree in summary. */
+/**
+ * They prefix for GC blobs in the GC tree in summary.
+ *
+ * @internal
+ */
 export declare const gcBlobPrefix = "__gc";
 
-/** 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 declare const gcDeletedBlobKey = "__deletedNodes";
 
-/** The key for tombstone blob in the GC tree in summary. */
+/**
+ * The key for tombstone blob in the GC tree in summary.
+ *
+ * @internal
+ */
 export declare const gcTombstoneBlobKey = "__tombstones";
 
-/** The key for the GC tree in summary. */
+/**
+ * The key for the GC tree in summary.
+ *
+ * @internal
+ */
 export declare const gcTreeKey = "gc";
 
 /**
  * Message send by client attaching local data structure.
  * Contains snapshot of data structure which is the current state of this data structure.
+ * @internal
  */
 export declare interface IAttachMessage {
     /**
@@ -175,6 +212,7 @@ export declare interface IAttachMessage {
 /**
  * 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 declare interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
     readonly logger: ITelemetryBaseLogger;
@@ -197,7 +235,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
     submitSignal(type: string, content: any): void;
     /**
      * @deprecated 0.16 Issue #1537, #3631
-     * @internal
      */
     _createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
     /**
@@ -235,6 +272,9 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 
+/**
+ * @internal
+ */
 export declare interface IContainerRuntimeBaseEvents extends IEvent {
     (event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void): any;
     /**
@@ -251,6 +291,7 @@ export declare interface IContainerRuntimeBaseEvents extends IEvent {
  * - Handle to the data store's entryPoint
  * - Fluid router for the data store
  * - Can be assigned an alias
+ * @internal
  */
 export declare interface IDataStore {
     /**
@@ -304,6 +345,7 @@ export declare interface IDataStore {
  * 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 declare interface IdCreationRange {
     readonly sessionId: SessionId;
@@ -315,6 +357,7 @@ export declare interface IdCreationRange {
 
 /**
  * An envelope wraps the contents with the intended target
+ * @internal
  */
 export declare interface IEnvelope {
     /**
@@ -330,6 +373,7 @@ export declare interface IEnvelope {
 /**
  * @experimental - Can be deleted/changed at any time
  * Contains the necessary information to allow DDSes to do incremental summaries
+ * @internal
  */
 export declare interface IExperimentalIncrementalSummaryContext {
     /**
@@ -358,6 +402,7 @@ export declare interface IExperimentalIncrementalSummaryContext {
  *
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
+ * @internal
  */
 export declare interface IFluidDataStoreChannel extends IDisposable {
     readonly id: string;
@@ -444,6 +489,7 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
 /**
  * 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 declare interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreContextEvents>, Partial<IProvideFluidDataStoreRegistry>, IProvideFluidHandleContext {
     readonly id: string;
@@ -560,6 +606,9 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
     addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
 }
 
+/**
+ * @internal
+ */
 export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
     /**
      * Binds a runtime to the context.
@@ -567,15 +616,22 @@ export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreC
     attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<void>;
 }
 
+/**
+ * @internal
+ */
 export declare interface IFluidDataStoreContextEvents extends IEvent {
     (event: "attaching" | "attached", listener: () => void): any;
 }
 
+/**
+ * @internal
+ */
 export declare const IFluidDataStoreFactory: keyof 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 declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
     /**
@@ -590,11 +646,15 @@ export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFa
     instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
 }
 
+/**
+ * @internal
+ */
 export declare const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
 
 /**
  * An association of identifiers to data store registry entries, where the
  * entries can be used to create data stores.
+ * @internal
  */
 export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
     get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
@@ -603,6 +663,7 @@ export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreR
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
+ * @internal
  */
 export declare interface IGarbageCollectionData {
     /**
@@ -615,6 +676,7 @@ export declare interface IGarbageCollectionData {
 
 /**
  * GC details provided to each node during creation.
+ * @internal
  */
 export declare interface IGarbageCollectionDetailsBase {
     /**
@@ -687,7 +749,7 @@ export declare interface IGarbageCollectionDetailsBase {
  *
  * 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 declare interface IIdCompressor {
     localSessionId: SessionId;
@@ -733,6 +795,9 @@ export declare interface IIdCompressor {
     tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
 }
 
+/**
+ * @internal
+ */
 export declare interface IIdCompressorCore {
     /**
      * Returns a range of IDs created by this session in a format for sending to the server for finalizing.
@@ -760,6 +825,7 @@ export declare interface IIdCompressorCore {
 
 /**
  * Represents ISignalMessage with its type.
+ * @internal
  */
 export declare interface IInboundSignalMessage extends ISignalMessage {
     type: string;
@@ -770,6 +836,7 @@ export declare interface IInboundSignalMessage extends ISignalMessage {
  * 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 declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
     snapshot: IAttachMessage["snapshot"] | null;
@@ -778,17 +845,27 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
 /**
  * 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 declare const initialClusterCapacity = 512;
 
+/**
+ * @internal
+ */
 export declare interface IProvideFluidDataStoreFactory {
     readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
 }
 
+/**
+ * @internal
+ */
 export declare interface IProvideFluidDataStoreRegistry {
     readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
 }
 
+/**
+ * @internal
+ */
 export declare interface ISignalEnvelope {
     /**
      * The target for the envelope, undefined for the container
@@ -821,6 +898,7 @@ export declare interface ISignalEnvelope {
  *   ...
  *     "path1":
  * ```
+ * @internal
  */
 export declare interface ISummarizeInternalResult extends ISummarizeResult {
     id: string;
@@ -832,12 +910,16 @@ export declare interface ISummarizeInternalResult extends ISummarizeResult {
 
 /**
  * Represents a summary at a current sequence number.
+ * @internal
  */
 export declare interface ISummarizeResult {
     stats: ISummaryStats;
     summary: SummaryTree;
 }
 
+/**
+ * @internal
+ */
 export declare interface ISummarizerNode {
     /**
      * Latest successfully acked summary reference sequence number
@@ -897,6 +979,9 @@ export declare interface ISummarizerNode {
     isSummaryInProgress?(): boolean;
 }
 
+/**
+ * @internal
+ */
 export declare interface ISummarizerNodeConfig {
     /**
      * True to reuse previous handle when unchanged since last acked summary.
@@ -915,6 +1000,9 @@ export declare interface ISummarizerNodeConfig {
     readonly throwOnFailure?: true;
 }
 
+/**
+ * @internal
+ */
 export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
     /**
      * True if GC is disabled. If so, don't track GC related state for a summary.
@@ -944,6 +1032,7 @@ export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConf
  * `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 declare interface ISummarizerNodeWithGC extends ISummarizerNode {
     createChild(
@@ -997,6 +1086,7 @@ export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
 
 /**
  * Contains the aggregation data from a Tree/Subtree.
+ * @internal
  */
 export declare interface ISummaryStats {
     treeNodeCount: number;
@@ -1012,6 +1102,7 @@ export declare 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 declare interface ISummaryTreeWithStats {
     /**
@@ -1028,6 +1119,7 @@ export declare interface ISummaryTreeWithStats {
 /**
  * Contains telemetry data relevant to summarization workflows.
  * This object is expected to be modified directly by various summarize methods.
+ * @internal
  */
 export declare interface ITelemetryContext {
     /**
@@ -1060,8 +1152,7 @@ export declare interface ITelemetryContext {
 
 /**
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
- *
- * @alpha
+ * @internal
  */
 export declare interface LocalAttributionKey {
     type: "local";
@@ -1069,20 +1160,21 @@ export declare interface LocalAttributionKey {
 
 /**
  * An iterable identifier/registry entry pair list
+ * @internal
  */
 export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
 /**
  * An associated pair of an identifier and registry entry.  Registry entries
  * may be dynamically loaded.
+ * @internal
  */
 export declare type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
 
 /**
  * AttributionKey representing a reference to some op in the op stream.
  * Content associated with this key aligns with content modified by that op.
- *
- * @alpha
+ * @internal
  */
 export declare interface OpAttributionKey {
     /**
@@ -1102,6 +1194,7 @@ export declare interface OpAttributionKey {
  * 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 declare type OpSpaceCompressedId = number & {
     readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
@@ -1109,6 +1202,7 @@ export declare type OpSpaceCompressedId = number & {
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export declare type SerializedIdCompressor = string & {
     readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
@@ -1116,6 +1210,7 @@ export declare type SerializedIdCompressor = string & {
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
     readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
@@ -1123,6 +1218,7 @@ export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor
 
 /**
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
+ * @internal
  */
 export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
     readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
@@ -1130,6 +1226,7 @@ export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompr
 
 /**
  * A StableId which is suitable for use as a session identifier
+ * @internal
  */
 export declare type SessionId = StableId & {
     readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
@@ -1139,6 +1236,7 @@ export declare type SessionId = StableId & {
  * 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 declare type SessionSpaceCompressedId = number & {
     readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
@@ -1149,18 +1247,26 @@ export declare type SessionSpaceCompressedId = 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 declare type StableId = string & {
     readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
 };
 
+/**
+ * @internal
+ */
 export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
 
+/**
+ * @internal
+ */
 export declare const totalBlobSizePropertyName = "TotalBlobSize";
 
 /**
  * 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 declare const VisibilityState: {
     /**
@@ -1185,6 +1291,9 @@ export declare const VisibilityState: {
     GloballyVisible: string;
 };
 
+/**
+ * @internal
+ */
 export declare type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-dev.7.4.0.215747",
+  "version": "2.0.0-dev.7.4.0.216897",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,9 +14,9 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.215747",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215747",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215747",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/protocol-definitions": "^3.0.0"
   },
   "devDependencies": {
@@ -65,12 +65,13 @@
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",

package/src/attribution.ts

@@ -8,8 +8,7 @@ import type { IUser } from "@fluidframework/protocol-definitions";
 /**
  * AttributionKey representing a reference to some op in the op stream.
  * Content associated with this key aligns with content modified by that op.
- *
- * @alpha
+ * @internal
  */
 export interface OpAttributionKey {
 	/**
@@ -33,8 +32,7 @@ export interface OpAttributionKey {
  * is currently unsupported, as applications can effectively modify content anonymously while detached.
  * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting
  * this functionality if the host provided additional context to their attributor or attach calls.
- *
- * @alpha
+ * @internal
  */
 export interface DetachedAttributionKey {
 	type: "detached";
@@ -52,8 +50,7 @@ export interface DetachedAttributionKey {
 
 /**
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
- *
- * @alpha
+ * @internal
  */
 export interface LocalAttributionKey {
 	type: "local";
@@ -61,13 +58,13 @@ export interface LocalAttributionKey {
 
 /**
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
- * @alpha
+ * @internal
  */
 export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
 
 /**
  * Attribution information associated with a change.
- * @alpha
+ * @internal
  */
 export interface AttributionInfo {
 	/**