@fluidframework/runtime-definitions 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191457

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-dev.5.3.2.178189",
+  "version": "2.0.0-dev.6.4.0.191457",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,23 +14,21 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/core-interfaces": "2.0.0-dev.5.3.2.178189",
-    "@fluidframework/driver-definitions": "2.0.0-dev.5.3.2.178189",
+    "@fluidframework/container-definitions": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/core-interfaces": "2.0.0-dev.6.4.0.191457",
+    "@fluidframework/driver-definitions": "2.0.0-dev.6.4.0.191457",
     "@fluidframework/protocol-definitions": "^1.1.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.21.0",
-    "@fluidframework/build-common": "^1.2.0",
-    "@fluidframework/build-tools": "^0.21.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.5.2.0",
+    "@fluid-tools/build-cli": "^0.22.0",
+    "@fluidframework/build-common": "^2.0.0",
+    "@fluidframework/build-tools": "^0.22.0",
+    "@fluidframework/eslint-config-fluid": "^2.1.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.6.3.0",
     "@microsoft/api-extractor": "^7.34.4",
-    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
+    "eslint-plugin-deprecation": "~1.5.0",
     "prettier": "~2.6.2",
     "rimraf": "^4.4.0",
     "typescript": "~4.5.5"
@@ -44,7 +42,7 @@
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist *.tsbuildinfo *.build.log",
+    "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",

package/src/aliasing.md

@@ -0,0 +1,42 @@
+# Aliasing and root datastores
+
+## What is a root datastore? What is an aliased datastore?
+
+A root datastore is a datastore which is addressable by a custom identifier (client supplied) and is a direct child of the container runtime. A root datastore will never be garbage collected and it is a singleton with regards to the runtime it belongs to. The concept of a root datastore is considered legacy, mainly due to the previous (deprecated and removed) APIs which referred to such datastores as root. 'Aliased datastore' is the preferred current term to refer to such datastores.
+
+## When to alias datastores?
+
+Alias needs to happen for datastores which:
+
+-   must be referenced by a custom id
+-   must never be garbage collected (as they are bound to a custom id which may be stored by the client, they must always be available to be referenced)
+-   must be singletons in the container
+
+Creating root datastores was vulnerable to name conflicts, as two clients attempting to create the same root datastore with the same id risks corrupting the document. Aliasing changed the way to achieve the same goal, by enabling an asynchronous 'aliasing' operation on any newly created datastore. So in order to create such a datastore, the client needs to create an anonymous datastore (which will receive a newly generated UUID) and then explicitly attempt to bind it to a custom id (the alias) within a different operation which is decoupled from its creation.
+
+## Aliasing API
+
+The process of aliasing a datastore is split in two parts:
+
+-   Creating a regular datastore using the `IContainerRuntimeBase.createDataStore(pkg: string | string[]): Promise<IDataStore>` function
+-   Aliasing the resulting datastore by using the `IDataStore.trySetAlias(alias: string): Promise<AliasResult>` function and specifying a string value to serve as the alias to which the datastore needs to be bound. If successful, `"Success"` will be returned, and a call to `getAliasedDataStoreEntryPoint` with the alias as parameter will return the same datastore's entry point.
+
+The alias API can fail in the following situations, per the `AliasResult` type (see `@fluidframework/runtime-definitions`) type:
+
+-   `"Conflict"` - the alias has already been taken. In this case, the client can call `getAliasedDataStoreEntryPoint` to get the entry point of the datastore already aliased for that value. The current datastore can be left alone unreferenced so it can eventually be garbage collected.
+-   `"AlreadyAliased"` - the datastore has already been aliased to a different id.
+
+The alias API is idempotent. Repeatedly calling the trySetAlias function on the same datastore will return Success when the datastore has already been aliased to the same value.
+
+Example:
+
+```typescript
+const dataStore = await dataObject.context.containerRuntime.createDataStore("packageName");
+// One client will receive "Success", the other client will receive "Conflict".
+const aliasResult = await dataStore.trySetAlias("alias");
+// Both clients will get the actual aliased datastore. However, the client with the "Conflict" result must fetch the datastore by name
+const finalDataStore =
+	aliasResult === "Success"
+		? dataStore
+		: await dataObject.context.containerRuntime.getAliasedDataStoreEntryPoint("alias");
+```

package/src/attribution.ts

@@ -29,7 +29,7 @@ export interface OpAttributionKey {
 /**
  * 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
+ * @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.
@@ -42,7 +42,7 @@ export interface DetachedAttributionKey {
 	/**
 	 * Arbitrary discriminator associated with content inserted while detached.
 	 *
-	 * @remarks - For now, the runtime assumes all content created while detached is associated
+	 * @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.

package/src/dataStoreContext.ts

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
 import {
+	IEvent,
+	IEventProvider,
 	ITelemetryBaseLogger,
 	IDisposable,
 	IFluidRouter,
@@ -115,8 +116,8 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
  * Encapsulates the return codes of the aliasing API.
  *
  * 'Success' - the datastore has been successfully aliased. It can now be used.
- * 'Conflict' - there is already a datastore bound to the provided alias. To acquire a handle to it,
- * use the `IContainerRuntime.getRootDataStore` function. The current datastore should be discarded
+ * 'Conflict' - there is already a datastore bound to the provided alias. To acquire it's entry point, use
+ * 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.
  */
@@ -128,13 +129,14 @@ export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
  * - Fluid router for the data store
  * - Can be assigned an alias
  */
-export interface IDataStore extends IFluidRouter {
+export interface IDataStore {
 	/**
 	 * Attempt to assign an alias to the datastore.
 	 * If the operation succeeds, the datastore can be referenced
 	 * by the supplied alias and will not be garbage collected.
 	 *
 	 * @param alias - Given alias for this datastore.
+	 * @returns A promise with the {@link AliasResult}
 	 */
 	trySetAlias(alias: string): Promise<AliasResult>;
 
@@ -148,6 +150,37 @@ export interface IDataStore extends IFluidRouter {
 	 * the data store's entryPoint.
 	 */
 	readonly entryPoint?: IFluidHandle<FluidObject>;
+
+	/**
+	 * IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
+	 * The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
+	 * Once that API is mandatory on IDataStore, this overload will be deprecated.
+	 *
+	 * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
+	 *
+	 * @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
+	 */
+	request(request: { url: "/"; headers?: undefined }): Promise<IResponse>;
+
+	/**
+	 * Issue a request against the DataStore for a resource within it.
+	 * @param request - The request to be issued against the DataStore
+	 *
+	 * @deprecated - Requesting an arbitrary URL with headers will not be supported in a future major release.
+	 * Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
+	 * app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
+	 *
+	 * NOTE: IDataStore.request(\{url: "/"\}) is not yet deprecated. If and only if the DataStore implementation supports it,
+	 * that overload may be used as a proxy for getting the entryPoint until {@link IDataStore.entryPoint} is mandatory.
+	 *
+	 * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
+	 */
+	request(request: IRequest): Promise<IResponse>;
+
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	readonly IFluidRouter: IFluidRouter;
 }
 
 /**
@@ -211,7 +244,7 @@ export interface IContainerRuntimeBase
 	 */
 	getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
 
-	uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
+	uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
 
 	/**
 	 * Returns the current quorum.
@@ -230,7 +263,7 @@ export interface IContainerRuntimeBase
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
  */
-export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
+export interface IFluidDataStoreChannel extends IDisposable {
 	readonly id: string;
 
 	/**
@@ -330,6 +363,16 @@ export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
 	 * the component's entryPoint.
 	 */
 	readonly entryPoint?: IFluidHandle<FluidObject>;
+
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	request(request: IRequest): Promise<IResponse>;
+
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	readonly IFluidRouter: IFluidRouter;
 }
 
 export type CreateChildSummarizerNodeFn = (
@@ -469,7 +512,7 @@ export interface IFluidDataStoreContext
 		createParam: CreateChildSummarizerNodeParam,
 	): CreateChildSummarizerNodeFn;
 
-	uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
+	uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
 
 	/**
 	 * @deprecated - The functionality to get base GC details has been moved to summarizer node.

package/src/id-compressor/idCompressor.ts

@@ -3,13 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import {
-	SessionSpaceCompressedId,
-	OpSpaceCompressedId,
-	SessionId,
-	FinalCompressedId,
-	StableId,
-} from "./identifiers";
+import { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from "./identifiers";
 import {
 	IdCreationRange,
 	SerializedIdCompressorWithNoSession,
@@ -17,7 +11,13 @@ import {
 } from "./persisted-types";
 
 export interface IIdCompressorCore {
-	clusterCapacity: number;
+	/**
+	 * 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).
@@ -25,14 +25,6 @@ export interface IIdCompressorCore {
 	 */
 	finalizeCreationRange(range: IdCreationRange): void;
 
-	/**
-	 * Returns a range of local IDs created by this session in a format for sending to the server for finalizing.
-	 * The range will include all local IDs generated via calls to `generateCompressedId` since the last time this method was called.
-	 * @returns the range of session-local 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;
-
 	/**
 	 * 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.
@@ -58,38 +50,35 @@ export interface IIdCompressorCore {
  *
  * For each stable ID created, two numeric IDs are provided by the compressor:
  *
- * 1. A 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. Local IDs are session-unique and are thus only
- * publicly usable by the compressor that created the stable ID.
+ * 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 local ID is totally ordered (via consensus) with respect to other sessions' allocations.
+ * 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.
  *
- * A client may optionally supply an "override" for any generated ID, associating an arbitrary string with the local/final ID rather than
- * the UUID that would otherwise be created.
- *
  * The following invariants are upheld by IdCompressor:
  *
- * 1. Local IDs will always decompress to the same UUIDs (or override string) for the lifetime of the session.
+ * 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 (or override string).
+ * 2. Final IDs will always decompress to the same UUIDs.
  *
- * 3. After a server-processed range of local IDs (from any session) is received by a compressor, any of those local IDs may be
- * translated by the compressor into the corresponding final ID. For any given local ID, this translation will always yield the
+ * 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 (or override string) will always compress into the same session-space ID for the lifetime of the session.
+ * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.
  *
- * Local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*
+ * 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 (the local and final) difficult. For example, if a cache is keyed off of a
- * local ID but is later queried using the final ID (which is semantically equal, as it decompresses to the same UUID/string) it will
+ * 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:
  *
@@ -102,7 +91,7 @@ export interface IIdCompressorCore {
  * 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 local ID in this space becomes finalized, and thereafter has a "more final form".
+ * 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".
@@ -117,11 +106,9 @@ export interface IIdCompressor {
 	/**
 	 * Generates a new compressed ID or returns an existing one.
 	 * This should ONLY be called to generate IDs for local operations.
-	 * @param override - Specifies a specific string to be associated with the returned compressed ID.
-	 * Performance note: assigning override strings incurs a performance overhead.
-	 * @returns an existing ID if one already exists for `override`, and a new local ID otherwise. The returned ID is in session space.
+	 * @returns A new local ID in session space.
 	 */
-	generateCompressedId(override?: string): SessionSpaceCompressedId;
+	generateCompressedId(): SessionSpaceCompressedId;
 	/**
 	 * Normalizes a session space ID into op space.
 	 * @param id - the local ID to normalize.
@@ -143,37 +130,23 @@ export interface IIdCompressor {
 	): SessionSpaceCompressedId;
 
 	/**
-	 * Normalizes a final ID into session space.
-	 * @param id - the final ID to normalize.
-	 * @returns the session-space ID corresponding to `id`.
-	 */
-	normalizeToSessionSpace(id: FinalCompressedId): SessionSpaceCompressedId;
-
-	/**
-	 * Decompresses a previously compressed ID into a UUID or override string.
-	 * @param id - the compressed ID to be decompressed.
-	 * @returns the UUID or override string associated with the compressed ID. Fails if the ID was not generated by this compressor.
-	 */
-	decompress(id: SessionSpaceCompressedId | FinalCompressedId): StableId | string;
-
-	/**
-	 * Attempts to decompress a previously compressed ID into a UUID or override string.
+	 * Decompresses a previously compressed ID into a UUID.
 	 * @param id - the compressed ID to be decompressed.
-	 * @returns the UUID or override string associated with the compressed ID, or undefined if the ID was not generated by this compressor.
+	 * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.
 	 */
-	tryDecompress(id: SessionSpaceCompressedId | FinalCompressedId): StableId | string | undefined;
+	decompress(id: SessionSpaceCompressedId): StableId;
 
 	/**
-	 * Recompresses a decompressed ID, which could be a UUID or an override string.
-	 * @param uncompressed - the UUID or override string to recompress.
+	 * 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: string): SessionSpaceCompressedId;
+	recompress(uncompressed: StableId): SessionSpaceCompressedId;
 
 	/**
-	 * Attempts to recompresses a decompressed ID, which could be a UUID or an override string.
-	 * @param uncompressed - the UUID or override string to recompress,
+	 * 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: string): SessionSpaceCompressedId | undefined;
+	tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
 }

package/src/id-compressor/identifiers.ts

@@ -3,79 +3,31 @@
  * Licensed under the MIT License.
  */
 
-/**
- * An identifier (UUID) that has been shortened by a distributed compression algorithm.
- * @alpha
- */
-export type CompressedId = FinalCompressedId | LocalCompressedId;
-
-/**
- * A brand for identity types that are unique within a particular session (SharedTree instance).
- */
-export interface SessionUnique {
-	readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
-}
-
 /**
  * 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
- * compressor that produced them.
- * @alpha
+ * 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.
  */
-export type SessionSpaceCompressedId = CompressedId & SessionUnique;
-
-/**
- * A compressed ID that has been normalized into "op space" (see `IdCompressor` for more).
- * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require no 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.
- */
-export type OpSpaceCompressedId = CompressedId & {
-	readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
+export type SessionSpaceCompressedId = number & {
+	readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
 };
 
 /**
- * A compressed ID that is local to a document. Stable across all revisions of a document starting from the one in which it was created.
- * It should not be persisted outside of the history as it can only be decompressed in the context of the originating document.
- * If external persistence is needed (e.g. by a client), a StableId should be used instead.
- * @alpha
+ * 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.
  */
-export type FinalCompressedId = number & {
-	readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
-
-	// Same brand as OpNormalizedCompressedId, as final IDs are always finally normalized
+export type OpSpaceCompressedId = number & {
 	readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
 };
 
 /**
- * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).
- * It should not be persisted outside of the history as it can only be decompressed in the context of the originating session.
- * If external persistence is needed (e.g. by a client), a StableId should be used instead.
- * @alpha
- */
-export type LocalCompressedId = number & {
-	readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";
-} & SessionUnique; // Same brand as CompressedId, as local IDs are always locally normalized
-
-export interface NodeIdBrand {
-	readonly NodeId: "e53e7d6b-c8b9-431a-8805-4843fc639342";
-}
-
-/**
- * Type-safe identifiers for specific use cases.
- */
-
-/**
+ * 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.
- * @public
- */
-export type UuidString = string & { readonly UuidString: "9d40d0ae-90d9-44b1-9482-9f55d59d5465" };
-
-/**
- * A version 4, variant 2 uuid (https://datatracker.ietf.org/doc/html/rfc4122).
  */
-export type StableId = UuidString & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a" };
+export type StableId = string & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a" };
 
 /**
  * A StableId which is suitable for use as a session identifier

package/src/id-compressor/index.ts

@@ -5,30 +5,13 @@
 
 export {
 	IdCreationRange,
-	SerializedCluster,
-	SerializedClusterOverrides,
 	SerializedIdCompressor,
 	SerializedIdCompressorWithNoSession,
 	SerializedIdCompressorWithOngoingSession,
-	SerializedLocalOverrides,
-	SerializedLocalState,
-	SerializedSessionData,
-	SerializedSessionIdNormalizer,
-	UnackedLocalId,
-	VersionedSerializedIdCompressor,
 	IdCreationRangeWithStashedState,
+	initialClusterCapacity,
 } from "./persisted-types";
 
 export { IIdCompressorCore, IIdCompressor } from "./idCompressor";
 
-export {
-	SessionSpaceCompressedId,
-	OpSpaceCompressedId,
-	SessionId,
-	FinalCompressedId,
-	StableId,
-	UuidString,
-	CompressedId,
-	SessionUnique,
-	LocalCompressedId,
-} from "./identifiers";
+export { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from "./identifiers";