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

package/dist/runtime-definitions-alpha.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';
 
@@ -40,7 +52,11 @@ export declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
 /* Excluded from this release type: AttributionInfo */
 
-/* Excluded from this release type: AttributionKey */
+/**
+ * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
+ * @alpha
+ */
+export declare type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
 
 /* Excluded from this release type: blobCountPropertyName */
 
@@ -77,7 +93,27 @@ export declare enum CreateSummarizerNodeSource {
     Local = 2
 }
 
-/* Excluded from this release type: DetachedAttributionKey */
+/**
+ * AttributionKey associated with content that was inserted while the container was in a detached state.
+ *
+ * @remarks Retrieving an {@link AttributionInfo} from content associated with detached attribution keys
+ * 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
+ */
+export declare interface DetachedAttributionKey {
+    type: "detached";
+    /**
+     * Arbitrary discriminator associated with content inserted while detached.
+     *
+     * @remarks For now, the runtime assumes all content created while detached is associated
+     * with the same user/timestamp.
+     * We could weaken this assumption in the future with further API support and
+     * allow arbitrary strings or numbers as part of this key.
+     */
+    id: 0;
+}
 
 /**
  * A single registry entry that may be used to create data stores
@@ -246,19 +282,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.
- * @alpha
- */
-export declare interface IdCreationRange {
-    readonly sessionId: SessionId;
-    readonly ids?: {
-        readonly firstGenCount: number;
-        readonly count: number;
-    };
-}
+export { IdCompressor }
+
+export { IdCreationRange }
 
 /* Excluded from this release type: IEnvelope */
 
@@ -581,139 +607,9 @@ 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.
- * @alpha
- */
-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 }
 
-/**
- * @alpha
- */
-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.
@@ -1009,7 +905,13 @@ export declare interface ITelemetryContext {
     serialize(): string;
 }
 
-/* Excluded from this release type: LocalAttributionKey */
+/**
+ * AttributionKey associated with content that has been made locally but not yet acked by the server.
+ * @alpha
+ */
+export declare interface LocalAttributionKey {
+    type: "local";
+}
 
 /**
  * An iterable identifier/registry entry pair list
@@ -1024,70 +926,38 @@ export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidData
  */
 export declare type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
 
-/* Excluded from this release type: 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.
+ * AttributionKey representing a reference to some op in the op stream.
+ * Content associated with this key aligns with content modified by that op.
  * @alpha
  */
-export declare type OpSpaceCompressedId = number & {
-    readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
-};
+export declare interface OpAttributionKey {
+    /**
+     * The type of attribution this key corresponds to.
+     *
+     * Keys currently all represent op-based attribution, so have the form `{ type: "op", key: sequenceNumber }`.
+     * Thus, they can be used with an `OpStreamAttributor` to recover timestamp/user information.
+     */
+    type: "op";
+    /**
+     * The sequenceNumber of the op this attribution key is for.
+     */
+    seq: number;
+}
 
-/**
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
- * @alpha
- */
-export declare type SerializedIdCompressor = string & {
-    readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
-};
+export { OpSpaceCompressedId }
 
-/**
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
- * @alpha
- */
-export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
-    readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
-};
+export { SerializedIdCompressor }
 
-/**
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
- * @alpha
- */
-export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
-    readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
-};
+export { SerializedIdCompressorWithNoSession }
 
-/**
- * A StableId which is suitable for use as a session identifier
- * @alpha
- */
-export declare type SessionId = StableId & {
-    readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
-};
+export { SerializedIdCompressorWithOngoingSession }
 
-/**
- * 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.
- * @alpha
- */
-export declare type SessionSpaceCompressedId = number & {
-    readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
-};
+export { SessionId }
 
-/**
- * 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.
- * @alpha
- */
-export declare type StableId = string & {
-    readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
-};
+export { SessionSpaceCompressedId }
+
+export { StableId }
 
 /**
  * @alpha

package/dist/runtime-definitions-beta.d.ts

@@ -1,13 +1,42 @@
+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';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+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';
+import { IResponse } from '@fluidframework/core-interfaces';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
 import { ISnapshotTree } from '@fluidframework/protocol-definitions';
 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';
 
 /* Excluded from this release type: AliasResult */
 
@@ -55,6 +84,8 @@ import { SummaryTree } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: IDataStore */
 
+/* Excluded from this release type: IdCompressor */
+
 /* Excluded from this release type: IdCreationRange */
 
 /* Excluded from this release type: IDeltaManager */

package/dist/runtime-definitions-public.d.ts

@@ -1,13 +1,42 @@
+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';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+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';
+import { IResponse } from '@fluidframework/core-interfaces';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
 import { ISnapshotTree } from '@fluidframework/protocol-definitions';
 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';
 
 /* Excluded from this release type: AliasResult */
 
@@ -55,6 +84,8 @@ import { SummaryTree } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: IDataStore */
 
+/* Excluded from this release type: IdCompressor */
+
 /* Excluded from this release type: IdCreationRange */
 
 /* Excluded from this release type: IDeltaManager */