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

package/src/attribution.ts

@@ -8,7 +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.
- * @internal
+ * @alpha
  */
 export interface OpAttributionKey {
 	/**
@@ -32,7 +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.
- * @internal
+ * @alpha
  */
 export interface DetachedAttributionKey {
 	type: "detached";
@@ -50,7 +50,7 @@ export interface DetachedAttributionKey {
 
 /**
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
- * @internal
+ * @alpha
  */
 export interface LocalAttributionKey {
 	type: "local";
@@ -58,7 +58,7 @@ export interface LocalAttributionKey {
 
 /**
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
- * @internal
+ * @alpha
  */
 export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
 

package/src/dataStoreContext.ts

@@ -31,6 +31,7 @@ import {
 	ISequencedDocumentMessage,
 	ISnapshotTree,
 } from "@fluidframework/protocol-definitions";
+import { IIdCompressor } from "@fluidframework/id-compressor";
 import { IProvideFluidDataStoreFactory } from "./dataStoreFactory";
 import { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry";
 import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollection";
@@ -42,11 +43,10 @@ import {
 	ITelemetryContext,
 	SummarizeInternalFn,
 } from "./summary";
-import { IIdCompressor } from "./id-compressor";
 
 /**
  * Runtime flush mode handling
- * @internal
+ * @alpha
  */
 export enum FlushMode {
 	/**
@@ -80,7 +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
+ * @alpha
  */
 export const VisibilityState = {
 	/**
@@ -107,12 +107,12 @@ export const VisibilityState = {
 	GloballyVisible: "GloballyVisible",
 };
 /**
- * @internal
+ * @alpha
  */
 export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
 
 /**
- * @internal
+ * @alpha
  */
 export interface IContainerRuntimeBaseEvents extends IEvent {
 	(event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void);
@@ -133,7 +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
+ * @alpha
  */
 export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
@@ -142,7 +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
+ * @alpha
  */
 export interface IDataStore {
 	/**
@@ -197,7 +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
+ * @alpha
  */
 export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
 	readonly logger: ITelemetryBaseLogger;
@@ -277,7 +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
+ * @alpha
  */
 export interface IFluidDataStoreChannel extends IDisposable {
 	readonly id: string;
@@ -384,7 +384,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export type CreateChildSummarizerNodeFn = (
 	summarizeInternal: SummarizeInternalFn,
@@ -396,7 +396,7 @@ export type CreateChildSummarizerNodeFn = (
 ) => ISummarizerNodeWithGC;
 
 /**
- * @internal
+ * @alpha
  */
 export interface IFluidDataStoreContextEvents extends IEvent {
 	(event: "attaching" | "attached", listener: () => void);
@@ -405,7 +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
+ * @alpha
  */
 export interface IFluidDataStoreContext
 	extends IEventProvider<IFluidDataStoreContextEvents>,
@@ -542,7 +542,7 @@ export interface IFluidDataStoreContext
 }
 
 /**
- * @internal
+ * @alpha
  */
 export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
 	/**

package/src/dataStoreFactory.ts

@@ -6,12 +6,12 @@
 import { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreContext";
 
 /**
- * @internal
+ * @alpha
  */
 export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
 
 /**
- * @internal
+ * @alpha
  */
 export interface IProvideFluidDataStoreFactory {
 	readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
@@ -20,7 +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
+ * @alpha
  */
 export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
 	/**

package/src/dataStoreRegistry.ts

@@ -8,7 +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
+ * @alpha
  */
 export type FluidDataStoreRegistryEntry = Readonly<
 	Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>
@@ -16,23 +16,23 @@ export type FluidDataStoreRegistryEntry = Readonly<
 /**
  * An associated pair of an identifier and registry entry.  Registry entries
  * may be dynamically loaded.
- * @internal
+ * @alpha
  */
 export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
 /**
  * An iterable identifier/registry entry pair list
- * @internal
+ * @alpha
  */
 export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
 /**
- * @internal
+ * @alpha
  */
 export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =
 	"IFluidDataStoreRegistry";
 
 /**
- * @internal
+ * @alpha
  */
 export interface IProvideFluidDataStoreRegistry {
 	readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
@@ -41,7 +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
+ * @alpha
  */
 export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
 	get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;

package/src/garbageCollection.ts

@@ -31,7 +31,7 @@ export const gcDeletedBlobKey = "__deletedNodes";
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
- * @internal
+ * @alpha
  */
 export interface IGarbageCollectionData {
 	/**
@@ -42,7 +42,7 @@ export interface IGarbageCollectionData {
 
 /**
  * GC details provided to each node during creation.
- * @internal
+ * @alpha
  */
 export interface IGarbageCollectionDetailsBase {
 	/**

package/src/index.ts

@@ -65,16 +65,56 @@ export {
 	SummarizeInternalFn,
 	totalBlobSizePropertyName,
 } from "./summary";
+
+// Re-exports for backwards compatibility.
+// Will be removed in the future.
 export {
-	IIdCompressorCore,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IdCompressor,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	IIdCompressor,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IIdCompressorCore,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IdCreationRange,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	OpSpaceCompressedId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	SerializedIdCompressor,
-	SerializedIdCompressorWithOngoingSession,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	SerializedIdCompressorWithNoSession,
-	SessionSpaceCompressedId,
-	OpSpaceCompressedId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SerializedIdCompressorWithOngoingSession,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	SessionId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SessionSpaceCompressedId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	StableId,
-	IdCreationRange,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
 	initialClusterCapacity,
-} from "./id-compressor";
+} from "@fluidframework/id-compressor";

package/src/protocol.ts

@@ -46,7 +46,7 @@ export interface ISignalEnvelope {
 
 /**
  * Represents ISignalMessage with its type.
- * @internal
+ * @alpha
  */
 export interface IInboundSignalMessage extends ISignalMessage {
 	type: string;

package/src/summary.ts

@@ -15,7 +15,7 @@ import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbage
 
 /**
  * Contains the aggregation data from a Tree/Subtree.
- * @internal
+ * @alpha
  */
 export interface ISummaryStats {
 	treeNodeCount: number;
@@ -31,7 +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
+ * @alpha
  */
 export interface ISummaryTreeWithStats {
 	/**
@@ -47,7 +47,7 @@ export interface ISummaryTreeWithStats {
 
 /**
  * Represents a summary at a current sequence number.
- * @internal
+ * @alpha
  */
 export interface ISummarizeResult {
 	stats: ISummaryStats;
@@ -68,7 +68,7 @@ export interface ISummarizeResult {
  *   ...
  *     "path1":
  * ```
- * @internal
+ * @alpha
  */
 export interface ISummarizeInternalResult extends ISummarizeResult {
 	id: string;
@@ -81,7 +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
+ * @alpha
  */
 export interface IExperimentalIncrementalSummaryContext {
 	/**
@@ -107,7 +107,7 @@ export interface IExperimentalIncrementalSummaryContext {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export type SummarizeInternalFn = (
 	fullTree: boolean,
@@ -117,7 +117,7 @@ export type SummarizeInternalFn = (
 ) => Promise<ISummarizeInternalResult>;
 
 /**
- * @internal
+ * @alpha
  */
 export interface ISummarizerNodeConfig {
 	/**
@@ -138,7 +138,7 @@ export interface ISummarizerNodeConfig {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
 	/**
@@ -149,7 +149,7 @@ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export enum CreateSummarizerNodeSource {
 	FromSummary,
@@ -157,7 +157,7 @@ export enum CreateSummarizerNodeSource {
 	Local,
 }
 /**
- * @internal
+ * @alpha
  */
 export type CreateChildSummarizerNodeParam =
 	| {
@@ -173,7 +173,7 @@ export type CreateChildSummarizerNodeParam =
 	  };
 
 /**
- * @internal
+ * @alpha
  */
 export interface ISummarizerNode {
 	/**
@@ -263,7 +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
+ * @alpha
  */
 export interface ISummarizerNodeWithGC extends ISummarizerNode {
 	createChild(
@@ -330,7 +330,7 @@ export const channelsTreeName = ".channels";
 /**
  * Contains telemetry data relevant to summarization workflows.
  * This object is expected to be modified directly by various summarize methods.
- * @internal
+ * @alpha
  */
 export interface ITelemetryContext {
 	/**

package/dist/id-compressor/idCompressor.d.ts

@@ -1,139 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from "./identifiers";
-import { IdCreationRange, SerializedIdCompressorWithNoSession, 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.
-     * 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;
-}
-/**
- * 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 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;
-}
-//# sourceMappingURL=idCompressor.d.ts.map

package/dist/id-compressor/idCompressor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"idCompressor.d.ts","sourceRoot":"","sources":["../../src/id-compressor/idCompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACnG,OAAO,EACN,eAAe,EACf,mCAAmC,EACnC,wCAAwC,EACxC,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;;OAKG;IACH,qBAAqB,IAAI,eAAe,CAAC;IAEzC;;;OAGG;IACH,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,wCAAwC,CAAC;IAEvE;;;OAGG;IACH,SAAS,CAAC,WAAW,EAAE,KAAK,GAAG,mCAAmC,CAAC;CACnE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAM,WAAW,aAAa;IAC7B,cAAc,EAAE,SAAS,CAAC;IAE1B;;;;OAIG;IACH,oBAAoB,IAAI,wBAAwB,CAAC;IACjD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,GAAG,mBAAmB,CAAC;IACtE;;;;;;;;OAQG;IACH,uBAAuB,CACtB,EAAE,EAAE,mBAAmB,EACvB,eAAe,EAAE,SAAS,GACxB,wBAAwB,CAAC;IAE5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,wBAAwB,GAAG,QAAQ,CAAC;IAEnD;;;;OAIG;IACH,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB,CAAC;IAE7D;;;;OAIG;IACH,aAAa,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB,GAAG,SAAS,CAAC;CAC5E"}

package/dist/id-compressor/idCompressor.js

@@ -1,7 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=idCompressor.js.map

package/dist/id-compressor/idCompressor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"idCompressor.js","sourceRoot":"","sources":["../../src/id-compressor/idCompressor.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from \"./identifiers\";\nimport {\n\tIdCreationRange,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n} from \"./persisted-types\";\n\n/**\n * @internal\n */\nexport interface IIdCompressorCore {\n\t/**\n\t * Returns a range of IDs created by this session in a format for sending to the server for finalizing.\n\t * The range will include all IDs generated via calls to `generateCompressedId` since the last time this method was called.\n\t * @returns the range of IDs, which may be empty. This range must be sent to the server for ordering before\n\t * it is finalized. Ranges must be sent to the server in the order that they are taken via calls to this method.\n\t */\n\ttakeNextCreationRange(): IdCreationRange;\n\n\t/**\n\t * Finalizes the supplied range of IDs (which may be from either a remote or local session).\n\t * @param range - the range of session-local IDs to finalize.\n\t */\n\tfinalizeCreationRange(range: IdCreationRange): void;\n\n\t/**\n\t * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.\n\t * This includes finalized state as well as un-finalized state and is therefore suitable for use in offline scenarios.\n\t */\n\tserialize(withSession: true): SerializedIdCompressorWithOngoingSession;\n\n\t/**\n\t * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.\n\t * This only includes finalized state and is therefore suitable for use in summaries.\n\t */\n\tserialize(withSession: false): SerializedIdCompressorWithNoSession;\n}\n\n/**\n * A distributed UUID generator and compressor.\n *\n * Generates arbitrary non-colliding v4 UUIDs, called stable IDs, for multiple \"sessions\" (which can be distributed across the network),\n * providing each session with the ability to map these UUIDs to `numbers`.\n *\n * A session is a unique identifier that denotes a single compressor. New IDs are created through a single compressor API\n * which should then sent in ranges to the server for total ordering (and are subsequently relayed to other clients). When a new ID is\n * created it is said to be created by the compressor's \"local\" session.\n *\n * For each stable ID created, two numeric IDs are provided by the compressor:\n *\n * 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\n * be serialized for offline usage). Available as soon as the stable ID is allocated. These IDs are session-unique and are thus only\n * safely usable within the scope of the compressor that created it.\n *\n * 2. A final ID, which is stable across serialization and deserialization of an IdCompressor. Available as soon as the range containing\n * the corresponding session-local ID is totally ordered (via consensus) with respect to other sessions' allocations.\n * Final IDs are known to and publicly usable by any compressor that has received them.\n *\n * Compressors will allocate UUIDs in non-random ways to reduce entropy allowing for optimized storage of the data needed\n * to map the UUIDs to the numbers.\n *\n * The following invariants are upheld by IdCompressor:\n *\n * 1. Session-local IDs will always decompress to the same UUIDs for the lifetime of the session.\n *\n * 2. Final IDs will always decompress to the same UUIDs.\n *\n * 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\n * translated by the compressor into the corresponding final ID. For any given session-local ID, this translation will always yield the\n * same final ID.\n *\n * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.\n *\n * Session-local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*\n * be ordered (i.e. sent to the server) in the order they are created in order to preserve the above invariants.\n *\n * Session-local IDs can be used immediately after creation, but will eventually (after being sequenced) have a corresponding final ID. This\n * could make reasoning about equality of those two forms difficult. For example, if a cache is keyed off of a\n * 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\n * produce a cache miss. In order to make using collections of both remotely created and locally created IDs easy, regardless of whether the\n * session-local IDs have been finalized, the compressor defines two \"spaces\" of IDs:\n *\n * 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\n * will be in local form, regardless of if they have been finalized. Remotely created IDs, which could only have been received after\n * 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\n * 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\n * these IDs across compressor objects, as the local IDs are specific to the compressor that created them.\n *\n * 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\n * 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\n * 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\n * out of Op space over time, namely, when a session-local ID in this space becomes finalized, and thereafter has a \"more final form\".\n * Consequentially, it may be useful to restrict parameters of a persisted type to this space (to optimize perf), but it is potentially\n * 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\n * \"local as possible\".\n *\n * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops\n * should use op-space IDs.\n * @internal\n */\nexport interface IIdCompressor {\n\tlocalSessionId: SessionId;\n\n\t/**\n\t * Generates a new compressed ID or returns an existing one.\n\t * This should ONLY be called to generate IDs for local operations.\n\t * @returns A new local ID in session space.\n\t */\n\tgenerateCompressedId(): SessionSpaceCompressedId;\n\t/**\n\t * Normalizes a session space ID into op space.\n\t * @param id - the local ID to normalize.\n\t * @returns the ID in op space.\n\t */\n\tnormalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;\n\t/**\n\t * Normalizes an ID into session space.\n\t * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding\n\t * to `sessionId`.\n\t * @param originSessionId - the session from which `id` originated\n\t * @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\n\t * 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\n\t * range that contained it from the server.\n\t */\n\tnormalizeToSessionSpace(\n\t\tid: OpSpaceCompressedId,\n\t\toriginSessionId: SessionId,\n\t): SessionSpaceCompressedId;\n\n\t/**\n\t * Decompresses a previously compressed ID into a UUID.\n\t * @param id - the compressed ID to be decompressed.\n\t * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.\n\t */\n\tdecompress(id: SessionSpaceCompressedId): StableId;\n\n\t/**\n\t * Recompresses a UUID.\n\t * @param uncompressed - the UUID to recompress.\n\t * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.\n\t */\n\trecompress(uncompressed: StableId): SessionSpaceCompressedId;\n\n\t/**\n\t * Attempts to recompresses a UUID.\n\t * @param uncompressed - the UUID to recompress,\n\t * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.\n\t */\n\ttryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;\n}\n"]}

package/dist/id-compressor/identifiers.d.ts

@@ -1,40 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * 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";
-};
-/**
- * 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";
-};
-/**
- * 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 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";
-};
-//# sourceMappingURL=identifiers.d.ts.map

package/dist/id-compressor/identifiers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"identifiers.d.ts","sourceRoot":"","sources":["../../src/id-compressor/identifiers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG;IAC/C,QAAQ,CAAC,aAAa,EAAE,sCAAsC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG;IAC1C,QAAQ,CAAC,YAAY,EAAE,sCAAsC,CAAC;CAC9D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG;IAAE,QAAQ,CAAC,SAAS,EAAE,sCAAsC,CAAA;CAAE,CAAC"}

package/dist/id-compressor/identifiers.js

@@ -1,7 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=identifiers.js.map

package/dist/id-compressor/identifiers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"identifiers.js","sourceRoot":"","sources":["../../src/id-compressor/identifiers.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * A compressed ID that has been normalized into \"session space\" (see `IdCompressor` for more).\n * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to\n * the scope of the session (i.e. compressor) that produced them.\n * @internal\n */\nexport type SessionSpaceCompressedId = number & {\n\treadonly SessionUnique: \"cea55054-6b82-4cbf-ad19-1fa645ea3b3e\";\n};\n\n/**\n * A compressed ID that has been normalized into \"op space\".\n * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require less normalizing when\n * received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.\n * @internal\n */\nexport type OpSpaceCompressedId = number & {\n\treadonly OpNormalized: \"9209432d-a959-4df7-b2ad-767ead4dbcae\";\n};\n\n/**\n * A version 4, variant 1 uuid (https://datatracker.ietf.org/doc/html/rfc4122).\n * A 128-bit Universally Unique IDentifier. Represented here\n * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,\n * where x is a lowercase hex digit.\n * @internal\n */\nexport type StableId = string & { readonly StableId: \"53172b0d-a3d5-41ea-bd75-b43839c97f5a\" };\n\n/**\n * A StableId which is suitable for use as a session identifier\n * @internal\n */\nexport type SessionId = StableId & { readonly SessionId: \"4498f850-e14e-4be9-8db0-89ec00997e58\" };\n"]}