@fluidframework/runtime-definitions 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

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

@@ -2,6 +2,8 @@ import { AttachState } from '@fluidframework/container-definitions';
 import { FluidObject } from '@fluidframework/core-interfaces';
 import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IdCompressor } from '@fluidframework/id-compressor';
+import { IdCreationRange } from '@fluidframework/id-compressor';
 import { IDeltaManager } from '@fluidframework/container-definitions';
 import { IDisposable } from '@fluidframework/core-interfaces';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
@@ -11,7 +13,10 @@ import { IEventProvider } from '@fluidframework/core-interfaces';
 import { IFluidHandle } from '@fluidframework/core-interfaces';
 import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
+import { IIdCompressor } from '@fluidframework/id-compressor';
+import { IIdCompressorCore } from '@fluidframework/id-compressor';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { initialClusterCapacity } from '@fluidframework/id-compressor';
 import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
 import { IRequest } from '@fluidframework/core-interfaces';
@@ -23,6 +28,13 @@ import { ISummaryTree } from '@fluidframework/protocol-definitions';
 import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITree } from '@fluidframework/protocol-definitions';
 import type { IUser } from '@fluidframework/protocol-definitions';
+import { OpSpaceCompressedId } from '@fluidframework/id-compressor';
+import { SerializedIdCompressor } from '@fluidframework/id-compressor';
+import { SerializedIdCompressorWithNoSession } from '@fluidframework/id-compressor';
+import { SerializedIdCompressorWithOngoingSession } from '@fluidframework/id-compressor';
+import { SessionId } from '@fluidframework/id-compressor';
+import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
+import { StableId } from '@fluidframework/id-compressor';
 import { SummaryTree } from '@fluidframework/protocol-definitions';
 import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
 
@@ -34,7 +46,7 @@ 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
+ * @alpha
  */
 export declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
@@ -55,7 +67,7 @@ export declare interface AttributionInfo {
 
 /**
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
- * @internal
+ * @alpha
  */
 export declare type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
 
@@ -70,7 +82,7 @@ export declare const blobCountPropertyName = "BlobCount";
 export declare const channelsTreeName = ".channels";
 
 /**
- * @internal
+ * @alpha
  */
 export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>, 
 /**
@@ -79,7 +91,7 @@ export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeI
 getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
 
 /**
- * @internal
+ * @alpha
  */
 export declare type CreateChildSummarizerNodeParam = {
     type: CreateSummarizerNodeSource.FromSummary;
@@ -92,7 +104,7 @@ export declare type CreateChildSummarizerNodeParam = {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare enum CreateSummarizerNodeSource {
     FromSummary = 0,
@@ -107,7 +119,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.
- * @internal
+ * @alpha
  */
 export declare interface DetachedAttributionKey {
     type: "detached";
@@ -125,13 +137,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
+ * @alpha
  */
 export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
 
 /**
  * Runtime flush mode handling
- * @internal
+ * @alpha
  */
 export declare enum FlushMode {
     /**
@@ -212,7 +224,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
+ * @alpha
  */
 export declare interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
     readonly logger: ITelemetryBaseLogger;
@@ -273,7 +285,7 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IContainerRuntimeBaseEvents extends IEvent {
     (event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void): any;
@@ -291,7 +303,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
+ * @alpha
  */
 export declare interface IDataStore {
     /**
@@ -341,19 +353,9 @@ export declare interface IDataStore {
     readonly IFluidRouter: IFluidRouter;
 }
 
-/**
- * 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;
-    readonly ids?: {
-        readonly firstGenCount: number;
-        readonly count: number;
-    };
-}
+export { IdCompressor }
+
+export { IdCreationRange }
 
 /**
  * An envelope wraps the contents with the intended target
@@ -373,7 +375,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
+ * @alpha
  */
 export declare interface IExperimentalIncrementalSummaryContext {
     /**
@@ -402,7 +404,7 @@ export declare interface IExperimentalIncrementalSummaryContext {
  *
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
- * @internal
+ * @alpha
  */
 export declare interface IFluidDataStoreChannel extends IDisposable {
     readonly id: string;
@@ -489,7 +491,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
+ * @alpha
  */
 export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreContextEvents>, Partial<IProvideFluidDataStoreRegistry>, IProvideFluidHandleContext {
     readonly id: string;
@@ -607,7 +609,7 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
     /**
@@ -617,21 +619,21 @@ export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreC
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IFluidDataStoreContextEvents extends IEvent {
     (event: "attaching" | "attached", listener: () => void): any;
 }
 
 /**
- * @internal
+ * @alpha
  */
 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
+ * @alpha
  */
 export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
     /**
@@ -647,14 +649,14 @@ export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFa
 }
 
 /**
- * @internal
+ * @alpha
  */
 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
+ * @alpha
  */
 export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
     get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
@@ -663,7 +665,7 @@ export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreR
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
- * @internal
+ * @alpha
  */
 export declare interface IGarbageCollectionData {
     /**
@@ -676,7 +678,7 @@ export declare interface IGarbageCollectionData {
 
 /**
  * GC details provided to each node during creation.
- * @internal
+ * @alpha
  */
 export declare interface IGarbageCollectionDetailsBase {
     /**
@@ -689,143 +691,13 @@ export declare interface IGarbageCollectionDetailsBase {
     gcData?: IGarbageCollectionData;
 }
 
-/**
- * A distributed UUID generator and compressor.
- *
- * Generates arbitrary non-colliding v4 UUIDs, called stable IDs, for multiple "sessions" (which can be distributed across the network),
- * providing each session with the ability to map these UUIDs to `numbers`.
- *
- * A session is a unique identifier that denotes a single compressor. New IDs are created through a single compressor API
- * which should then sent in ranges to the server for total ordering (and are subsequently relayed to other clients). When a new ID is
- * created it is said to be created by the compressor's "local" session.
- *
- * For each stable ID created, two numeric IDs are provided by the compressor:
- *
- * 1. A session-local ID, which is stable for the lifetime of the session (which could be longer than that of the compressor object, as it may
- * be serialized for offline usage). Available as soon as the stable ID is allocated. These IDs are session-unique and are thus only
- * safely usable within the scope of the compressor that created it.
- *
- * 2. A final ID, which is stable across serialization and deserialization of an IdCompressor. Available as soon as the range containing
- * the corresponding session-local ID is totally ordered (via consensus) with respect to other sessions' allocations.
- * Final IDs are known to and publicly usable by any compressor that has received them.
- *
- * Compressors will allocate UUIDs in non-random ways to reduce entropy allowing for optimized storage of the data needed
- * to map the UUIDs to the numbers.
- *
- * The following invariants are upheld by IdCompressor:
- *
- * 1. Session-local IDs will always decompress to the same UUIDs for the lifetime of the session.
- *
- * 2. Final IDs will always decompress to the same UUIDs.
- *
- * 3. After a server-processed range of session-local IDs (from any session) is received by a compressor, any of those session-local IDs may be
- * translated by the compressor into the corresponding final ID. For any given session-local ID, this translation will always yield the
- * same final ID.
- *
- * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.
- *
- * Session-local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*
- * be ordered (i.e. sent to the server) in the order they are created in order to preserve the above invariants.
- *
- * Session-local IDs can be used immediately after creation, but will eventually (after being sequenced) have a corresponding final ID. This
- * could make reasoning about equality of those two forms difficult. For example, if a cache is keyed off of a
- * session-local ID but is later queried using the final ID (which is semantically equal, as it decompresses to the same UUID/string) it will
- * produce a cache miss. In order to make using collections of both remotely created and locally created IDs easy, regardless of whether the
- * session-local IDs have been finalized, the compressor defines two "spaces" of IDs:
- *
- * 1. Session space: in this space, all IDs are normalized to their "most local form". This means that all IDs created by the local session
- * will be in local form, regardless of if they have been finalized. Remotely created IDs, which could only have been received after
- * finalizing and will never have a local form for the compressor, will of course be final IDs. This space should be used with consumer APIs
- * and data structures, as the lifetime of the IDs is guaranteed to be the same as the compressor object. Care must be taken to not use
- * these IDs across compressor objects, as the local IDs are specific to the compressor that created them.
- *
- * 2. Op space: in this space, all IDs are normalized to their "most final form". This means that all IDs except session-local IDs that
- * have not yet been finalized will be in final ID form. This space is useful for serialization in ops (e.g. references), as other clients
- * that receive them need not do any work to normalize them to *their* session-space in the common case. Note that IDs in op space may move
- * out of Op space over time, namely, when a session-local ID in this space becomes finalized, and thereafter has a "more final form".
- * Consequentially, it may be useful to restrict parameters of a persisted type to this space (to optimize perf), but it is potentially
- * incorrect to use this type for a runtime variable. This is an asymmetry that does not affect session space, as local IDs are always as
- * "local as possible".
- *
- * 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;
-    /**
-     * Generates a new compressed ID or returns an existing one.
-     * This should ONLY be called to generate IDs for local operations.
-     * @returns A new local ID in session space.
-     */
-    generateCompressedId(): SessionSpaceCompressedId;
-    /**
-     * Normalizes a session space ID into op space.
-     * @param id - the local ID to normalize.
-     * @returns the ID in op space.
-     */
-    normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
-    /**
-     * Normalizes an ID into session space.
-     * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding
-     * to `sessionId`.
-     * @param originSessionId - the session from which `id` originated
-     * @returns the session-space ID corresponding to `id`, which might not have been a final ID if the client that created it had not yet
-     * finalized it. This can occur when a client references an ID during the window of time in which it is waiting to receive the ordered
-     * range that contained it from the server.
-     */
-    normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
-    /**
-     * Decompresses a previously compressed ID into a UUID.
-     * @param id - the compressed ID to be decompressed.
-     * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.
-     */
-    decompress(id: SessionSpaceCompressedId): StableId;
-    /**
-     * Recompresses a UUID.
-     * @param uncompressed - the UUID to recompress.
-     * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.
-     */
-    recompress(uncompressed: StableId): SessionSpaceCompressedId;
-    /**
-     * Attempts to recompresses a UUID.
-     * @param uncompressed - the UUID to recompress,
-     * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.
-     */
-    tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
-}
+export { IIdCompressor }
 
-/**
- * @internal
- */
-export declare interface IIdCompressorCore {
-    /**
-     * Returns a range of IDs created by this session in a format for sending to the server for finalizing.
-     * The range will include all IDs generated via calls to `generateCompressedId` since the last time this method was called.
-     * @returns the range of IDs, which may be empty. This range must be sent to the server for ordering before
-     * it is finalized. Ranges must be sent to the server in the order that they are taken via calls to this method.
-     */
-    takeNextCreationRange(): IdCreationRange;
-    /**
-     * Finalizes the supplied range of IDs (which may be from either a remote or local session).
-     * @param range - the range of session-local IDs to finalize.
-     */
-    finalizeCreationRange(range: IdCreationRange): void;
-    /**
-     * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.
-     * This includes finalized state as well as un-finalized state and is therefore suitable for use in offline scenarios.
-     */
-    serialize(withSession: true): SerializedIdCompressorWithOngoingSession;
-    /**
-     * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.
-     * This only includes finalized state and is therefore suitable for use in summaries.
-     */
-    serialize(withSession: false): SerializedIdCompressorWithNoSession;
-}
+export { IIdCompressorCore }
 
 /**
  * Represents ISignalMessage with its type.
- * @internal
+ * @alpha
  */
 export declare interface IInboundSignalMessage extends ISignalMessage {
     type: string;
@@ -842,22 +714,17 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
     snapshot: IAttachMessage["snapshot"] | null;
 };
 
-/**
- * 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;
+export { initialClusterCapacity }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidDataStoreFactory {
     readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidDataStoreRegistry {
     readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
@@ -898,7 +765,7 @@ export declare interface ISignalEnvelope {
  *   ...
  *     "path1":
  * ```
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeInternalResult extends ISummarizeResult {
     id: string;
@@ -910,7 +777,7 @@ export declare interface ISummarizeInternalResult extends ISummarizeResult {
 
 /**
  * Represents a summary at a current sequence number.
- * @internal
+ * @alpha
  */
 export declare interface ISummarizeResult {
     stats: ISummaryStats;
@@ -918,7 +785,7 @@ export declare interface ISummarizeResult {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerNode {
     /**
@@ -980,7 +847,7 @@ export declare interface ISummarizerNode {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerNodeConfig {
     /**
@@ -1001,7 +868,7 @@ export declare interface ISummarizerNodeConfig {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
     /**
@@ -1032,7 +899,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
+ * @alpha
  */
 export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
     createChild(
@@ -1086,7 +953,7 @@ export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
 
 /**
  * Contains the aggregation data from a Tree/Subtree.
- * @internal
+ * @alpha
  */
 export declare interface ISummaryStats {
     treeNodeCount: number;
@@ -1102,7 +969,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
+ * @alpha
  */
 export declare interface ISummaryTreeWithStats {
     /**
@@ -1119,7 +986,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
+ * @alpha
  */
 export declare interface ITelemetryContext {
     /**
@@ -1152,7 +1019,7 @@ export declare interface ITelemetryContext {
 
 /**
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
- * @internal
+ * @alpha
  */
 export declare interface LocalAttributionKey {
     type: "local";
@@ -1160,21 +1027,21 @@ export declare interface LocalAttributionKey {
 
 /**
  * An iterable identifier/registry entry pair list
- * @internal
+ * @alpha
  */
 export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
 /**
  * An associated pair of an identifier and registry entry.  Registry entries
  * may be dynamically loaded.
- * @internal
+ * @alpha
  */
 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.
- * @internal
+ * @alpha
  */
 export declare interface OpAttributionKey {
     /**
@@ -1190,71 +1057,22 @@ export declare interface OpAttributionKey {
     seq: 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 declare type OpSpaceCompressedId = number & {
-    readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
-};
+export { OpSpaceCompressedId }
 
-/**
- * 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";
-};
+export { SerializedIdCompressor }
 
-/**
- * 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";
-};
+export { SerializedIdCompressorWithNoSession }
 
-/**
- * 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";
-};
+export { SerializedIdCompressorWithOngoingSession }
 
-/**
- * A StableId which is suitable for use as a session identifier
- * @internal
- */
-export declare type SessionId = StableId & {
-    readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
-};
+export { SessionId }
 
-/**
- * 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";
-};
+export { SessionSpaceCompressedId }
 
-/**
- * A version 4, variant 1 uuid (https://datatracker.ietf.org/doc/html/rfc4122).
- * 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";
-};
+export { StableId }
 
 /**
- * @internal
+ * @alpha
  */
 export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
 
@@ -1266,7 +1084,7 @@ 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
+ * @alpha
  */
 export declare const VisibilityState: {
     /**
@@ -1292,7 +1110,7 @@ export declare const VisibilityState: {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-dev.7.4.0.217212",
+  "version": "2.0.0-dev.7.4.0.221926",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,12 +14,14 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/id-compressor": "2.0.0-dev.7.4.0.221926",
     "@fluidframework/protocol-definitions": "^3.0.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
@@ -65,6 +67,7 @@
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack",
     "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",