@fluidframework/runtime-utils 2.113.0-411909 → 2.114.0

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # @fluidframework/runtime-utils
 
+## 2.114.0
+
+### Minor Changes
+
+- Add new @alpha ServiceClient API for creating and loading Fluid containers ([#27693](https://github.com/microsoft/FluidFramework/pull/27693)) [ee47192d4a](https://github.com/microsoft/FluidFramework/commit/ee47192d4ae91bc28f9154c4d1ead2acad762f3c)
+
+  This introduces an experimental (`@alpha`), service-agnostic API for working with Fluid containers whose root is an arbitrary data store, along with an in-memory implementation for testing.
+
+  The new surface is made up of:
+  - `ServiceClient` (`@fluidframework/driver-definitions`): the entry point for creating and loading containers. Along with it come the supporting container types (`FluidContainer`, `FluidContainerWithService`, `FluidContainerAttached`), the data store model (`DataStoreKind`, `DataStoreKey`, `DataStoreRegistry`, `DataStoreCreator`), and the generic registry primitives (`Registry`, `RegistryKey`, `lookupInRegistry`, `createBasicRegistryKey`).
+  - `defineDataStore` and `sharedObjectRegistryFromIterable` (`@fluidframework/shared-object-base`): build a `DataStoreKind` from a root shared object and a registry of shared object kinds.
+  - `defineTreeDataStore` and `instantiateTreeFirstTime` (`@fluidframework/tree`): a SharedTree-specific convenience wrapper that produces a `DataStoreKind` backed by a `TreeView`.
+  - `startEphemeralService` (`@fluidframework/local-driver`): starts an in-memory `EphemeralService` for tests. The service owns the lifetime of the in-memory documents and resources, and produces `ServiceClient`s connected to it (via `EphemeralService.newClient` or `EphemeralService.defaultClient`). The helpers `cleanupEphemeralService` and `getDefaultEphemeralService` manage an optional default service instance.
+
+  Apart from the `@fluidframework/local-driver` helpers (which come from `@fluidframework/local-driver/alpha`), these APIs are also re-exported from `fluid-framework`. None reference any `@legacy` types.
+
+  Example:
+
+  ```typescript
+  import { startEphemeralService } from "@fluidframework/local-driver/alpha";
+  import {
+    ServiceClient,
+    defineTreeDataStore,
+    TreeViewConfiguration,
+    SchemaFactory,
+  } from "fluid-framework/alpha";
+  import { strict as assert } from "node:assert";
+
+  // Start an ephemeral in-memory service and get a ServiceClient connected to it.
+  const service = startEphemeralService();
+  const client: ServiceClient = service.defaultClient;
+  // Define a DataStoreKind which uses a SharedTree.
+  // In this case the schema is for a single number with an initializer that starts the it at 1.
+  // This schema is captures in the type allowing for strongly typed access to the data in the tree,
+  // where the type matches the schema based runtime enforcement of the schema.
+  const numberStore = defineTreeDataStore({
+    type: "my-app-root",
+    config: new TreeViewConfiguration({ schema: SchemaFactory.number }),
+    initializer: () => 1,
+  });
+
+  // Create a container in the service with the above DataStoreKind.
+  // Ideally this creation would use a service independent API, and only the attach call would be service dependent,
+  // but that is not supported yet.
+  const detachedContainer1 = await client.createContainer(numberStore);
+  const container1 = await detachedContainer1.attach();
+
+  // We now have easy and type safe access to the data in the tree, which will be synced over the service.
+  assert.equal(container1.data.root, 1);
+
+  // A second client can load the same container from the service, and will see the same data.
+  const container2 = await client.loadContainer(container1.id, numberStore);
+  assert.equal(container2.data.root, 1);
+
+  // Both clients can modify the data, and the changes will be synced over the service.
+  container2.data.root = 2;
+  // Since we are using an ephemeral service, we can await the synchronization using service.synchronize.
+  await service.synchronize();
+
+  // And now the changes are visible for all clients.
+  assert.equal(container1.data.root, 2);
+  assert.equal(container2.data.root, 2);
+  ```
+
+  Note that this example does a couple of things which are difficult to do with the other API surfaces:
+  1. It creates a container, then loads a second copy of it, allowing for collaboration. There is currently no non-legacy API surface which allows this without spawning a server process. This is also cleaner than the exacting legacy API options, and can replace the test specific APIs for this as well.
+  2. It creates a container which has a SharedTree at the root, and nothing else. This avoids depending on legacy DDS implementations, which is great for long-term document support and bundle size. This is currently impossible using `fluid-static`, which forces a special root data store. It is also impossible if using `aqueduct`, which forces a root directory in every data store. It can be done using the low level legacy APIs directly, but this new API for it is much simpler.
+  3. There is a common interface all services implement (`ServiceClient`), making the container creation part of the code work for any service implementation.
+
+## 2.113.0
+
+Dependency updates only.
+
 ## 2.112.0
 
 Dependency updates only.

package/api-report/runtime-utils.legacy.alpha.api.md

@@ -10,6 +10,9 @@ export function asLegacyAlpha(runtime: IContainerRuntimeBase): ContainerRuntimeB
 // @alpha @legacy
 export function asLegacyAlpha(runtime: IFluidDataStoreRuntime): IFluidDataStoreRuntimeAlpha;
 
+// @alpha @sealed
+export type Audience = IAudience;
+
 // @public
 export function compareFluidHandles(a: IFluidHandle, b: IFluidHandle): boolean;
 
@@ -34,6 +37,9 @@ export abstract class FluidHandleBase<T> implements IFluidHandleInternal<T> {
     abstract readonly isAttached: boolean;
 }
 
+// @alpha
+export function getContainerAudience(container: FluidContainerAttached): Audience;
+
 // @public
 export function isFluidHandle(value: unknown): value is IFluidHandle;
 

package/dist/index.d.ts

@@ -19,4 +19,8 @@ export { isSnapshotFetchRequiredForLoadingGroupId } from "./snapshotUtils.js";
 export { toDeltaManagerErased, toDeltaManagerInternal, } from "./deltaManager.js";
 export { configValueToMinVersionForCollab, defaultMinVersionForCollab, validateConfigMapOverrides, getConfigForMinVersionForCollab, getConfigsForMinVersionForCollab, isValidMinVersionForCollab, validateMinimumVersionForCollab, lowestMinVersionForCollab, getConfigForMinVersionForCollabIterable, cleanedPackageVersion, selectVersionRoundedDown, } from "./compatibilityBase.js";
 export type { ConfigMap, ConfigMapEntry, ConfigValidationMap, MinimumMinorSemanticVersion, SemanticVersion, } from "./compatibilityBase.js";
+export type { Audience } from "./serviceClientBase.js";
+export { DataStoreKindImplementation, ServiceContainerBase, getContainerAudience, } from "./serviceClientBase.js";
+export { convertRegistry, makeCodeLoader, normalizeRegistry, rootDataStoreId, ServiceClientImplementation, } from "./serviceClientUtils.js";
+export type { ContainerRuntimeLoader, ContainerRuntimeLoaderParams, ServiceContainerStatics, } from "./serviceClientUtils.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EACN,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,2BAA2B,GAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,mBAAmB,EACnB,4BAA4B,EAC5B,eAAe,EACf,aAAa,EACb,mCAAmC,EACnC,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACN,mCAAmC,EACnC,mBAAmB,GACnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,EACb,WAAW,EACX,UAAU,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EACN,cAAc,EACd,WAAW,EACX,uBAAuB,GACvB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EACN,oBAAoB,EACpB,sBAAsB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACN,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,EAC1B,+BAA+B,EAC/B,gCAAgC,EAChC,0BAA0B,EAC1B,+BAA+B,EAC/B,yBAAyB,EACzB,uCAAuC,EACvC,qBAAqB,EACrB,wBAAwB,GACxB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,eAAe,GACf,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EACN,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,2BAA2B,GAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,mBAAmB,EACnB,4BAA4B,EAC5B,eAAe,EACf,aAAa,EACb,mCAAmC,EACnC,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACN,mCAAmC,EACnC,mBAAmB,GACnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EACN,gBAAgB,EAChB,2BAA2B,EAC3B,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,6BAA6B,EAC7B,aAAa,EACb,WAAW,EACX,UAAU,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,GACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EACN,cAAc,EACd,WAAW,EACX,uBAAuB,GACvB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EACN,oBAAoB,EACpB,sBAAsB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACN,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,EAC1B,+BAA+B,EAC/B,gCAAgC,EAChC,0BAA0B,EAC1B,+BAA+B,EAC/B,yBAAyB,EACzB,uCAAuC,EACvC,qBAAqB,EACrB,wBAAwB,GACxB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,eAAe,GACf,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EACN,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,2BAA2B,GAC3B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,uBAAuB,GACvB,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -5,7 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfigsForMinVersionForCollab = exports.getConfigForMinVersionForCollab = exports.validateConfigMapOverrides = exports.defaultMinVersionForCollab = exports.configValueToMinVersionForCollab = exports.toDeltaManagerInternal = exports.toDeltaManagerErased = exports.isSnapshotFetchRequiredForLoadingGroupId = exports.encodeCompactIdToString = exports.seqFromTree = exports.RuntimeHeaders = exports.unpackChildNodesUsedRoutes = exports.utf8ByteLength = exports.TelemetryContext = exports.SummaryTreeBuilder = exports.processAttachMessageGCData = exports.mergeStats = exports.getBlobSize = exports.GCDataBuilder = exports.convertToSummaryTreeWithStats = exports.convertToSummaryTree = exports.convertSummaryTreeToITree = exports.convertSnapshotTreeToSummaryTree = exports.calculateStats = exports.addSummarizeResultToSummary = exports.addBlobToSummary = exports.RuntimeFactoryHelper = exports.RequestParser = exports.RemoteFluidObjectHandle = exports.listBlobsAtTreePath = exports.getNormalizedObjectStoragePathParts = exports.ObjectStoragePartition = exports.toFluidHandleInternal = exports.toFluidHandleErased = exports.lookupTemporaryBlobStorageId = exports.isSerializedHandle = exports.isLocalFluidHandle = exports.isFluidHandlePayloadPending = exports.isFluidHandleInternalPayloadPending = exports.isFluidHandle = exports.FluidHandleBase = exports.encodeHandleForSerialization = exports.compareFluidHandles = exports.dataStoreLoadTelemetryProps = exports.asLegacyAlpha = exports.responseToException = exports.exceptionToResponse = exports.createResponseError = exports.create404Response = exports.generateHandleContextPath = void 0;
-exports.selectVersionRoundedDown = exports.cleanedPackageVersion = exports.getConfigForMinVersionForCollabIterable = exports.lowestMinVersionForCollab = exports.validateMinimumVersionForCollab = exports.isValidMinVersionForCollab = void 0;
+exports.ServiceClientImplementation = exports.rootDataStoreId = exports.normalizeRegistry = exports.makeCodeLoader = exports.convertRegistry = exports.getContainerAudience = exports.ServiceContainerBase = exports.DataStoreKindImplementation = exports.selectVersionRoundedDown = exports.cleanedPackageVersion = exports.getConfigForMinVersionForCollabIterable = exports.lowestMinVersionForCollab = exports.validateMinimumVersionForCollab = exports.isValidMinVersionForCollab = void 0;
 var dataStoreHandleContextUtils_js_1 = require("./dataStoreHandleContextUtils.js");
 Object.defineProperty(exports, "generateHandleContextPath", { enumerable: true, get: function () { return dataStoreHandleContextUtils_js_1.generateHandleContextPath; } });
 var dataStoreHelpers_js_1 = require("./dataStoreHelpers.js");
@@ -76,4 +76,14 @@ Object.defineProperty(exports, "lowestMinVersionForCollab", { enumerable: true,
 Object.defineProperty(exports, "getConfigForMinVersionForCollabIterable", { enumerable: true, get: function () { return compatibilityBase_js_1.getConfigForMinVersionForCollabIterable; } });
 Object.defineProperty(exports, "cleanedPackageVersion", { enumerable: true, get: function () { return compatibilityBase_js_1.cleanedPackageVersion; } });
 Object.defineProperty(exports, "selectVersionRoundedDown", { enumerable: true, get: function () { return compatibilityBase_js_1.selectVersionRoundedDown; } });
+var serviceClientBase_js_1 = require("./serviceClientBase.js");
+Object.defineProperty(exports, "DataStoreKindImplementation", { enumerable: true, get: function () { return serviceClientBase_js_1.DataStoreKindImplementation; } });
+Object.defineProperty(exports, "ServiceContainerBase", { enumerable: true, get: function () { return serviceClientBase_js_1.ServiceContainerBase; } });
+Object.defineProperty(exports, "getContainerAudience", { enumerable: true, get: function () { return serviceClientBase_js_1.getContainerAudience; } });
+var serviceClientUtils_js_1 = require("./serviceClientUtils.js");
+Object.defineProperty(exports, "convertRegistry", { enumerable: true, get: function () { return serviceClientUtils_js_1.convertRegistry; } });
+Object.defineProperty(exports, "makeCodeLoader", { enumerable: true, get: function () { return serviceClientUtils_js_1.makeCodeLoader; } });
+Object.defineProperty(exports, "normalizeRegistry", { enumerable: true, get: function () { return serviceClientUtils_js_1.normalizeRegistry; } });
+Object.defineProperty(exports, "rootDataStoreId", { enumerable: true, get: function () { return serviceClientUtils_js_1.rootDataStoreId; } });
+Object.defineProperty(exports, "ServiceClientImplementation", { enumerable: true, get: function () { return serviceClientUtils_js_1.ServiceClientImplementation; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,mFAA6E;AAApE,2IAAA,yBAAyB,OAAA;AAClC,6DAO+B;AAN9B,wHAAA,iBAAiB,OAAA;AACjB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AACnB,oHAAA,aAAa,OAAA;AACb,kIAAA,2BAA2B,OAAA;AAE5B,2CAYsB;AAXrB,iHAAA,mBAAmB,OAAA;AACnB,0HAAA,4BAA4B,OAAA;AAC5B,6GAAA,eAAe,OAAA;AACf,2GAAA,aAAa,OAAA;AACb,iIAAA,mCAAmC,OAAA;AACnC,yHAAA,2BAA2B,OAAA;AAC3B,gHAAA,kBAAkB,OAAA;AAClB,gHAAA,kBAAkB,OAAA;AAClB,0HAAA,4BAA4B,OAAA;AAC5B,iHAAA,mBAAmB,OAAA;AACnB,mHAAA,qBAAqB,OAAA;AAGtB,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,iEAGiC;AAFhC,4IAAA,mCAAmC,OAAA;AACnC,4HAAA,mBAAmB,OAAA;AAEpB,2EAAuE;AAA9D,qIAAA,uBAAuB,OAAA;AAChC,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AACtB,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA;AAC7B,qDAe2B;AAd1B,mHAAA,gBAAgB,OAAA;AAChB,8HAAA,2BAA2B,OAAA;AAC3B,iHAAA,cAAc,OAAA;AACd,mIAAA,gCAAgC,OAAA;AAChC,4HAAA,yBAAyB,OAAA;AACzB,uHAAA,oBAAoB,OAAA;AACpB,gIAAA,6BAA6B,OAAA;AAC7B,gHAAA,aAAa,OAAA;AACb,8GAAA,WAAW,OAAA;AACX,6GAAA,UAAU,OAAA;AACV,6HAAA,0BAA0B,OAAA;AAC1B,qHAAA,kBAAkB,OAAA;AAClB,mHAAA,gBAAgB,OAAA;AAChB,iHAAA,cAAc,OAAA;AAEf,6DAAmE;AAA1D,iIAAA,0BAA0B,OAAA;AACnC,uCAIoB;AAHnB,0GAAA,cAAc,OAAA;AACd,uGAAA,WAAW,OAAA;AACX,mHAAA,uBAAuB,OAAA;AAGxB,uDAA8E;AAArE,4IAAA,wCAAwC,OAAA;AACjD,qDAG2B;AAF1B,uHAAA,oBAAoB,OAAA;AACpB,yHAAA,sBAAsB,OAAA;AAEvB,+DAYgC;AAX/B,wIAAA,gCAAgC,OAAA;AAChC,kIAAA,0BAA0B,OAAA;AAC1B,kIAAA,0BAA0B,OAAA;AAC1B,uIAAA,+BAA+B,OAAA;AAC/B,wIAAA,gCAAgC,OAAA;AAChC,kIAAA,0BAA0B,OAAA;AAC1B,uIAAA,+BAA+B,OAAA;AAC/B,iIAAA,yBAAyB,OAAA;AACzB,+IAAA,uCAAuC,OAAA;AACvC,6HAAA,qBAAqB,OAAA;AACrB,gIAAA,wBAAwB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils.js\";\nexport {\n\tcreate404Response,\n\tcreateResponseError,\n\texceptionToResponse,\n\tresponseToException,\n\tasLegacyAlpha,\n\tdataStoreLoadTelemetryProps,\n} from \"./dataStoreHelpers.js\";\nexport {\n\tcompareFluidHandles,\n\tencodeHandleForSerialization,\n\tFluidHandleBase,\n\tisFluidHandle,\n\tisFluidHandleInternalPayloadPending,\n\tisFluidHandlePayloadPending,\n\tisLocalFluidHandle,\n\tisSerializedHandle,\n\tlookupTemporaryBlobStorageId,\n\ttoFluidHandleErased,\n\ttoFluidHandleInternal,\n} from \"./handles.js\";\nexport type { ISerializedHandle } from \"./handles.js\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition.js\";\nexport {\n\tgetNormalizedObjectStoragePathParts,\n\tlistBlobsAtTreePath,\n} from \"./objectstorageutils.js\";\nexport { RemoteFluidObjectHandle } from \"./remoteFluidObjectHandle.js\";\nexport { RequestParser } from \"./requestParser.js\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper.js\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tGCDataBuilder,\n\tgetBlobSize,\n\tmergeStats,\n\tprocessAttachMessageGCData,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils.js\";\nexport { unpackChildNodesUsedRoutes } from \"./unpackUsedRoutes.js\";\nexport {\n\tRuntimeHeaders,\n\tseqFromTree,\n\tencodeCompactIdToString,\n} from \"./utils.js\";\nexport type { ReadAndParseBlob } from \"./utils.js\";\nexport { isSnapshotFetchRequiredForLoadingGroupId } from \"./snapshotUtils.js\";\nexport {\n\ttoDeltaManagerErased,\n\ttoDeltaManagerInternal,\n} from \"./deltaManager.js\";\nexport {\n\tconfigValueToMinVersionForCollab,\n\tdefaultMinVersionForCollab,\n\tvalidateConfigMapOverrides,\n\tgetConfigForMinVersionForCollab,\n\tgetConfigsForMinVersionForCollab,\n\tisValidMinVersionForCollab,\n\tvalidateMinimumVersionForCollab,\n\tlowestMinVersionForCollab,\n\tgetConfigForMinVersionForCollabIterable,\n\tcleanedPackageVersion,\n\tselectVersionRoundedDown,\n} from \"./compatibilityBase.js\";\nexport type {\n\tConfigMap,\n\tConfigMapEntry,\n\tConfigValidationMap,\n\tMinimumMinorSemanticVersion,\n\tSemanticVersion,\n} from \"./compatibilityBase.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,mFAA6E;AAApE,2IAAA,yBAAyB,OAAA;AAClC,6DAO+B;AAN9B,wHAAA,iBAAiB,OAAA;AACjB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA;AACnB,oHAAA,aAAa,OAAA;AACb,kIAAA,2BAA2B,OAAA;AAE5B,2CAYsB;AAXrB,iHAAA,mBAAmB,OAAA;AACnB,0HAAA,4BAA4B,OAAA;AAC5B,6GAAA,eAAe,OAAA;AACf,2GAAA,aAAa,OAAA;AACb,iIAAA,mCAAmC,OAAA;AACnC,yHAAA,2BAA2B,OAAA;AAC3B,gHAAA,kBAAkB,OAAA;AAClB,gHAAA,kBAAkB,OAAA;AAClB,0HAAA,4BAA4B,OAAA;AAC5B,iHAAA,mBAAmB,OAAA;AACnB,mHAAA,qBAAqB,OAAA;AAGtB,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,iEAGiC;AAFhC,4IAAA,mCAAmC,OAAA;AACnC,4HAAA,mBAAmB,OAAA;AAEpB,2EAAuE;AAA9D,qIAAA,uBAAuB,OAAA;AAChC,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AACtB,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA;AAC7B,qDAe2B;AAd1B,mHAAA,gBAAgB,OAAA;AAChB,8HAAA,2BAA2B,OAAA;AAC3B,iHAAA,cAAc,OAAA;AACd,mIAAA,gCAAgC,OAAA;AAChC,4HAAA,yBAAyB,OAAA;AACzB,uHAAA,oBAAoB,OAAA;AACpB,gIAAA,6BAA6B,OAAA;AAC7B,gHAAA,aAAa,OAAA;AACb,8GAAA,WAAW,OAAA;AACX,6GAAA,UAAU,OAAA;AACV,6HAAA,0BAA0B,OAAA;AAC1B,qHAAA,kBAAkB,OAAA;AAClB,mHAAA,gBAAgB,OAAA;AAChB,iHAAA,cAAc,OAAA;AAEf,6DAAmE;AAA1D,iIAAA,0BAA0B,OAAA;AACnC,uCAIoB;AAHnB,0GAAA,cAAc,OAAA;AACd,uGAAA,WAAW,OAAA;AACX,mHAAA,uBAAuB,OAAA;AAGxB,uDAA8E;AAArE,4IAAA,wCAAwC,OAAA;AACjD,qDAG2B;AAF1B,uHAAA,oBAAoB,OAAA;AACpB,yHAAA,sBAAsB,OAAA;AAEvB,+DAYgC;AAX/B,wIAAA,gCAAgC,OAAA;AAChC,kIAAA,0BAA0B,OAAA;AAC1B,kIAAA,0BAA0B,OAAA;AAC1B,uIAAA,+BAA+B,OAAA;AAC/B,wIAAA,gCAAgC,OAAA;AAChC,kIAAA,0BAA0B,OAAA;AAC1B,uIAAA,+BAA+B,OAAA;AAC/B,iIAAA,yBAAyB,OAAA;AACzB,+IAAA,uCAAuC,OAAA;AACvC,6HAAA,qBAAqB,OAAA;AACrB,gIAAA,wBAAwB,OAAA;AAUzB,+DAIgC;AAH/B,mIAAA,2BAA2B,OAAA;AAC3B,4HAAA,oBAAoB,OAAA;AACpB,4HAAA,oBAAoB,OAAA;AAErB,iEAMiC;AALhC,wHAAA,eAAe,OAAA;AACf,uHAAA,cAAc,OAAA;AACd,0HAAA,iBAAiB,OAAA;AACjB,wHAAA,eAAe,OAAA;AACf,oIAAA,2BAA2B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { generateHandleContextPath } from \"./dataStoreHandleContextUtils.js\";\nexport {\n\tcreate404Response,\n\tcreateResponseError,\n\texceptionToResponse,\n\tresponseToException,\n\tasLegacyAlpha,\n\tdataStoreLoadTelemetryProps,\n} from \"./dataStoreHelpers.js\";\nexport {\n\tcompareFluidHandles,\n\tencodeHandleForSerialization,\n\tFluidHandleBase,\n\tisFluidHandle,\n\tisFluidHandleInternalPayloadPending,\n\tisFluidHandlePayloadPending,\n\tisLocalFluidHandle,\n\tisSerializedHandle,\n\tlookupTemporaryBlobStorageId,\n\ttoFluidHandleErased,\n\ttoFluidHandleInternal,\n} from \"./handles.js\";\nexport type { ISerializedHandle } from \"./handles.js\";\nexport { ObjectStoragePartition } from \"./objectstoragepartition.js\";\nexport {\n\tgetNormalizedObjectStoragePathParts,\n\tlistBlobsAtTreePath,\n} from \"./objectstorageutils.js\";\nexport { RemoteFluidObjectHandle } from \"./remoteFluidObjectHandle.js\";\nexport { RequestParser } from \"./requestParser.js\";\nexport { RuntimeFactoryHelper } from \"./runtimeFactoryHelper.js\";\nexport {\n\taddBlobToSummary,\n\taddSummarizeResultToSummary,\n\tcalculateStats,\n\tconvertSnapshotTreeToSummaryTree,\n\tconvertSummaryTreeToITree,\n\tconvertToSummaryTree,\n\tconvertToSummaryTreeWithStats,\n\tGCDataBuilder,\n\tgetBlobSize,\n\tmergeStats,\n\tprocessAttachMessageGCData,\n\tSummaryTreeBuilder,\n\tTelemetryContext,\n\tutf8ByteLength,\n} from \"./summaryUtils.js\";\nexport { unpackChildNodesUsedRoutes } from \"./unpackUsedRoutes.js\";\nexport {\n\tRuntimeHeaders,\n\tseqFromTree,\n\tencodeCompactIdToString,\n} from \"./utils.js\";\nexport type { ReadAndParseBlob } from \"./utils.js\";\nexport { isSnapshotFetchRequiredForLoadingGroupId } from \"./snapshotUtils.js\";\nexport {\n\ttoDeltaManagerErased,\n\ttoDeltaManagerInternal,\n} from \"./deltaManager.js\";\nexport {\n\tconfigValueToMinVersionForCollab,\n\tdefaultMinVersionForCollab,\n\tvalidateConfigMapOverrides,\n\tgetConfigForMinVersionForCollab,\n\tgetConfigsForMinVersionForCollab,\n\tisValidMinVersionForCollab,\n\tvalidateMinimumVersionForCollab,\n\tlowestMinVersionForCollab,\n\tgetConfigForMinVersionForCollabIterable,\n\tcleanedPackageVersion,\n\tselectVersionRoundedDown,\n} from \"./compatibilityBase.js\";\nexport type {\n\tConfigMap,\n\tConfigMapEntry,\n\tConfigValidationMap,\n\tMinimumMinorSemanticVersion,\n\tSemanticVersion,\n} from \"./compatibilityBase.js\";\nexport type { Audience } from \"./serviceClientBase.js\";\nexport {\n\tDataStoreKindImplementation,\n\tServiceContainerBase,\n\tgetContainerAudience,\n} from \"./serviceClientBase.js\";\nexport {\n\tconvertRegistry,\n\tmakeCodeLoader,\n\tnormalizeRegistry,\n\trootDataStoreId,\n\tServiceClientImplementation,\n} from \"./serviceClientUtils.js\";\nexport type {\n\tContainerRuntimeLoader,\n\tContainerRuntimeLoaderParams,\n\tServiceContainerStatics,\n} from \"./serviceClientUtils.js\";\n"]}

package/dist/legacyAlpha.d.ts

@@ -28,6 +28,11 @@ export {
 	toFluidHandleInternal,
 	// #endregion
  
+	// #region @alpha APIs
+	Audience, 
+	getContainerAudience,
+	// #endregion
+ 
 	// #region @legacyAlpha APIs
 	asLegacyAlpha, 
 	lookupTemporaryBlobStorageId

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/runtime-utils";
-export declare const pkgVersion = "2.113.0-411909";
+export declare const pkgVersion = "2.114.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,kCAAkC,CAAC;AACvD,eAAO,MAAM,UAAU,mBAAmB,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,kCAAkC,CAAC;AACvD,eAAO,MAAM,UAAU,YAAY,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/runtime-utils";
-exports.pkgVersion = "2.113.0-411909";
+exports.pkgVersion = "2.114.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/runtime-utils\";\nexport const pkgVersion = \"2.113.0-411909\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/runtime-utils\";\nexport const pkgVersion = \"2.114.0\";\n"]}

package/dist/serviceClientBase.d.ts

@@ -0,0 +1,96 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IAudience } from "@fluidframework/container-definitions";
+import { type IContainer } from "@fluidframework/container-definitions/internal";
+import type { IRequest } from "@fluidframework/core-interfaces";
+import { ErasedTypeImplementation } from "@fluidframework/core-interfaces/internal";
+import { type DataStoreKey, type DataStoreKind, type FluidContainerAttached, type FluidContainerWithService, type Registry } from "@fluidframework/driver-definitions/internal";
+import type { IContainerRuntimeBase, IFluidDataStoreChannel, IFluidDataStoreContext, IFluidDataStoreFactory } from "@fluidframework/runtime-definitions/internal";
+/**
+ * Implementation of `DataStoreKind`.
+ * @internal
+ */
+export declare class DataStoreKindImplementation<T> extends ErasedTypeImplementation<DataStoreKind<T>> implements DataStoreKind<T>, IFluidDataStoreFactory {
+    private readonly factory;
+    /**
+     * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+     */
+    static guard<T>(value: T): value is DataStoreKindImplementation<T extends DataStoreKind<infer T2> ? T2 : never> & T;
+    /**
+     * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+     */
+    static narrowGeneric<T>(value: T): asserts value is DataStoreKindImplementation<T extends DataStoreKind<infer T2> ? T2 : never> & T;
+    readonly type: string;
+    readonly createDataStore?: (context: IFluidDataStoreContext) => {
+        readonly runtime: IFluidDataStoreChannel;
+    };
+    constructor(factory: Pick<DataStoreKindImplementation<T>, "type" | "instantiateDataStore" | "createDataStore">);
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
+    get IFluidDataStoreFactory(): IFluidDataStoreFactory;
+    adapt(value: Promise<DataStoreKind>): Promise<DataStoreKind<T>>;
+}
+/**
+ * Shared base class for all `ServiceClient` container implementations.
+ *
+ * @remarks
+ * Extends `ErasedTypeImplementation` so that
+ * {@link getContainerAudience} can narrow via `ServiceContainerBase.narrow()`.
+ *
+ * @internal
+ */
+export declare abstract class ServiceContainerBase<TData, TOptions = unknown> extends ErasedTypeImplementation<FluidContainerWithService<TData>> implements FluidContainerWithService<TData> {
+    readonly registry: Registry<Promise<DataStoreKind<TData>>>;
+    readonly options: TOptions;
+    readonly container: IContainer;
+    readonly data: TData;
+    id: string | undefined;
+    /**
+     * True if an attempt to attach has been started. This is used to prevent multiple concurrent attach attempts.
+     */
+    private startedAttach;
+    protected constructor(registry: Registry<Promise<DataStoreKind<TData>>>, options: TOptions, container: IContainer, data: TData, id: string | undefined);
+    /**
+     * Creates the service-specific request used to attach this container.
+     * @remarks
+     * Called by {@link ServiceContainerBase.attach} after validating that no attach is already in progress.
+     */
+    protected abstract createAttachRequest(): IRequest;
+    /**
+     * Extracts the container ID from {@link ServiceContainerBase.container}'s resolved URL after attachment.
+     * @remarks
+     * Override when the service's resolved URL stores the id in a non-standard field.
+     */
+    protected getContainerId(): string;
+    attach(): Promise<FluidContainerAttached<TData>>;
+    get audience(): IAudience;
+    getRuntime(): IContainerRuntimeBase;
+    close(): void;
+    createDataStore<T>(key: DataStoreKey<T>): Promise<T>;
+}
+/**
+ * All clients connected to the op stream, both read-only and read/write.
+ * @remarks
+ * Currently just {@link @fluidframework/container-definitions#IAudience}, but may diverge before stabilizing.
+ * @privateRemarks
+ * This is currently just an alias for IAudience, but it is defined separately to allow for:
+ * 1. Following the no I prefix naming convention.
+ * 2. The possibility of diverging from IAudience in the future if desired.
+ * 3. Make it easy for the reexport from fluid-framework to be `@alpha` so the name is not locked down prematurely.
+ * @sealed @alpha
+ */
+export type Audience = IAudience;
+/**
+ * Gets the {@link Audience} from a Fluid container
+ * created by any {@link @fluidframework/driver-definitions#ServiceClient}.
+ * @privateRemarks
+ * This is exposed via a free function rather than as a property of FluidContainerAttached
+ * for a few minor reasons:
+ * 1. This allows stabilizing the FluidContainerAttached API independently committing to how we want to expose the audience.
+ * 2. This demonstrates the pattern of how we can have possible less stable APIs to expose service specific features without them being part of the core FluidContainer API.
+ * This will be important for both new feature stabilization, and also exposing anything needed for legacy interop.
+ * @alpha
+ */
+export declare function getContainerAudience(container: FluidContainerAttached): Audience;
+//# sourceMappingURL=serviceClientBase.d.ts.map

package/dist/serviceClientBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientBase.d.ts","sourceRoot":"","sources":["../src/serviceClientBase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,gDAAgD,CAAC;AAC9F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AAEpF,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,QAAQ,EAEb,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,8CAA8C,CAAC;AAOtD;;;GAGG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACzC,SAAQ,wBAAwB,CAAC,aAAa,CAAC,CAAC,CAAC,CACjD,YAAW,aAAa,CAAC,CAAC,CAAC,EAAE,sBAAsB;IA+BlD,OAAO,CAAC,QAAQ,CAAC,OAAO;IA7BzB;;OAEG;WACW,KAAK,CAAC,CAAC,EACpB,KAAK,EAAE,CAAC,GACN,KAAK,IAAI,2BAA2B,CAAC,CAAC,SAAS,aAAa,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC;IAI3F;;OAEG;WACW,aAAa,CAAC,CAAC,EAC5B,KAAK,EAAE,CAAC,GACN,OAAO,CAAC,KAAK,IAAI,2BAA2B,CAC9C,CAAC,SAAS,aAAa,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAC9C,GACA,CAAC;IAMF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK;QACtE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;KACzC,CAAC;gBAGgB,OAAO,EAAE,IAAI,CAC7B,2BAA2B,CAAC,CAAC,CAAC,EAC9B,MAAM,GAAG,sBAAsB,GAAG,iBAAiB,CACnD;IASW,oBAAoB,CAChC,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,sBAAsB,CAAC;IAIlC,IAAW,sBAAsB,IAAI,sBAAsB,CAE1D;IAEY,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAY5E;AAED;;;;;;;;GAQG;AACH,8BAAsB,oBAAoB,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CACnE,SAAQ,wBAAwB,CAAC,yBAAyB,CAAC,KAAK,CAAC,CACjE,YAAW,yBAAyB,CAAC,KAAK,CAAC;aAQ1B,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD,OAAO,EAAE,QAAQ;aACjB,SAAS,EAAE,UAAU;aACrB,IAAI,EAAE,KAAK;IACpB,EAAE,EAAE,MAAM,GAAG,SAAS;IAV9B;;OAEG;IACH,OAAO,CAAC,aAAa,CAAS;IAE9B,SAAS,aACQ,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,EACjD,OAAO,EAAE,QAAQ,EACjB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,KAAK,EACpB,EAAE,EAAE,MAAM,GAAG,SAAS;IAK9B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,IAAI,QAAQ;IAElD;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAOrB,MAAM,IAAI,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IA2B7D,IAAW,QAAQ,IAAI,SAAS,CAE/B;IAEM,UAAU,IAAI,qBAAqB;IAqBnC,KAAK,IAAI,IAAI;IAcP,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAcjE;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC;AAEjC;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,sBAAsB,GAAG,QAAQ,CAGhF"}

package/dist/serviceClientBase.js

@@ -0,0 +1,165 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContainerAudience = exports.ServiceContainerBase = exports.DataStoreKindImplementation = void 0;
+const internal_1 = require("@fluidframework/container-definitions/internal");
+const internal_2 = require("@fluidframework/core-interfaces/internal");
+const internal_3 = require("@fluidframework/core-utils/internal");
+const internal_4 = require("@fluidframework/driver-definitions/internal");
+const internal_5 = require("@fluidframework/telemetry-utils/internal");
+/*
+ * This file provides common implementation logic for ServiceClient implementations.
+ */
+/**
+ * Implementation of `DataStoreKind`.
+ * @internal
+ */
+class DataStoreKindImplementation extends internal_2.ErasedTypeImplementation {
+    /**
+     * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+     */
+    static guard(value) {
+        return value instanceof DataStoreKindImplementation;
+    }
+    /**
+     * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+     */
+    static narrowGeneric(value) {
+        if (!DataStoreKindImplementation.guard(value)) {
+            throw new Error("Invalid DataStoreKindImplementation");
+        }
+    }
+    constructor(factory) {
+        super();
+        this.factory = factory;
+        this.type = factory.type;
+        if (factory.createDataStore !== undefined) {
+            this.createDataStore = factory.createDataStore.bind(factory);
+        }
+    }
+    async instantiateDataStore(context, existing) {
+        return this.factory.instantiateDataStore(context, existing);
+    }
+    get IFluidDataStoreFactory() {
+        return this;
+    }
+    async adapt(value) {
+        const input = await value;
+        if (input === this) {
+            return this;
+        }
+        if (input.type === this.type) {
+            throw new internal_5.UsageError(`Conflicting DataStoreKinds with same type: ${this.type}`);
+        }
+        throw new internal_5.UsageError(`Mismatched DataStoreKind type. Expected: ${this.type}, got: ${input.type}`);
+    }
+}
+exports.DataStoreKindImplementation = DataStoreKindImplementation;
+/**
+ * Shared base class for all `ServiceClient` container implementations.
+ *
+ * @remarks
+ * Extends `ErasedTypeImplementation` so that
+ * {@link getContainerAudience} can narrow via `ServiceContainerBase.narrow()`.
+ *
+ * @internal
+ */
+class ServiceContainerBase extends internal_2.ErasedTypeImplementation {
+    constructor(registry, options, container, data, id) {
+        super();
+        this.registry = registry;
+        this.options = options;
+        this.container = container;
+        this.data = data;
+        this.id = id;
+        /**
+         * True if an attempt to attach has been started. This is used to prevent multiple concurrent attach attempts.
+         */
+        this.startedAttach = false;
+    }
+    /**
+     * Extracts the container ID from {@link ServiceContainerBase.container}'s resolved URL after attachment.
+     * @remarks
+     * Override when the service's resolved URL stores the id in a non-standard field.
+     */
+    getContainerId() {
+        if (this.container.resolvedUrl === undefined) {
+            throw new Error("Resolved URL unexpectedly missing!");
+        }
+        return this.container.resolvedUrl.id;
+    }
+    async attach() {
+        if (this.id !== undefined) {
+            throw new internal_5.UsageError("Container already attached");
+        }
+        if (this.startedAttach) {
+            throw new internal_5.UsageError("Container attach already in progress");
+        }
+        (0, internal_3.assert)(this.container.attachState === internal_1.AttachState.Detached, 0xd15 /* Container not detached */);
+        this.startedAttach = true;
+        // TODO: support setting where attach can fail, and leave the container in a valid (non-closed) state.
+        // Likely the best way to support this is by adding a `tryAttach(request): Promise<FluidContainerAttached<TData> | undefined>`.
+        await this.container.attach(this.createAttachRequest());
+        // This type cast is needed to work around the fact that TypeScript assumes the "attach" methods can't modify "attachState".
+        (0, internal_3.assert)(this.container.attachState === internal_1.AttachState.Attached, 0xd16 /* Container failed to attach */);
+        this.id = this.getContainerId();
+        return this;
+    }
+    get audience() {
+        return this.container.audience;
+    }
+    getRuntime() {
+        const container = this.container;
+        if (container.runtime === undefined) {
+            throw new Error("Container does not expose a runtime: incompatible container implementation.");
+        }
+        return container.runtime;
+    }
+    close() {
+        // TODO: `container.close()` cancels the container runtime's GC timers, but a couple of
+        // container-level timers are only bounded `setTimeout`s that survive close (they are not
+        // cancelled here, nor even on `dispose`):
+        // - The container-loader `NoopHeuristic` timer (~2s), which has no disposal hook.
+        // - The container-runtime `SummaryManager` "delay before creating summarizer" timer, whose
+        //   pending timeout is not cleared when the SummaryManager is torn down.
+        // These self-expire, so they do not cause indefinite hangs, but until they fire they keep the
+        // Node.js event loop alive, delaying a clean process exit after close. That is a common reason
+        // tests resort to Mocha's `--exit` flag. Ideally close() (via the runtime's close path) would
+        // cancel these too so that closing a single container is sufficient to release all its timers.
+        this.container.close();
+    }
+    async createDataStore(key) {
+        const kind = await (0, internal_4.lookupInRegistry)(this.registry, key);
+        DataStoreKindImplementation.narrowGeneric(kind);
+        const containerRuntime = this.getRuntime();
+        // TODO: There should probably be a higher level more type safe way to do this.
+        const context = containerRuntime.createDetachedDataStore([kind.type]);
+        const channel = await kind.instantiateDataStore(context, false);
+        const dataStore = await context.attachRuntime(kind, channel);
+        const entryPoint = await dataStore.entryPoint.get();
+        // The data store's entry point type is erased at the registry boundary;
+        // the DataStoreKind<T> used to create it guarantees the entry point is a T.
+        return entryPoint;
+    }
+}
+exports.ServiceContainerBase = ServiceContainerBase;
+/**
+ * Gets the {@link Audience} from a Fluid container
+ * created by any {@link @fluidframework/driver-definitions#ServiceClient}.
+ * @privateRemarks
+ * This is exposed via a free function rather than as a property of FluidContainerAttached
+ * for a few minor reasons:
+ * 1. This allows stabilizing the FluidContainerAttached API independently committing to how we want to expose the audience.
+ * 2. This demonstrates the pattern of how we can have possible less stable APIs to expose service specific features without them being part of the core FluidContainer API.
+ * This will be important for both new feature stabilization, and also exposing anything needed for legacy interop.
+ * @alpha
+ */
+function getContainerAudience(container) {
+    ServiceContainerBase.narrow(container);
+    return container.audience;
+}
+exports.getContainerAudience = getContainerAudience;
+//# sourceMappingURL=serviceClientBase.js.map

package/dist/serviceClientBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientBase.js","sourceRoot":"","sources":["../src/serviceClientBase.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,6EAA8F;AAE9F,uEAAoF;AACpF,kEAA6D;AAC7D,0EAOqD;AAOrD,uEAAsE;AAEtE;;GAEG;AAEH;;;GAGG;AACH,MAAa,2BACZ,SAAQ,mCAA0C;IAGlD;;OAEG;IACI,MAAM,CAAC,KAAK,CAClB,KAAQ;QAER,OAAO,KAAK,YAAY,2BAA2B,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,aAAa,CAC1B,KAAQ;QAKR,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACxD,CAAC;IACF,CAAC;IAOD,YACkB,OAGhB;QAED,KAAK,EAAE,CAAC;QALS,YAAO,GAAP,OAAO,CAGvB;QAGD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAChC,OAA+B,EAC/B,QAAiB;QAEjB,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,KAA6B;QAC/C,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC;QAC1B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACb,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAC9B,MAAM,IAAI,qBAAU,CAAC,8CAA8C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,IAAI,qBAAU,CACnB,4CAA4C,IAAI,CAAC,IAAI,UAAU,KAAK,CAAC,IAAI,EAAE,CAC3E,CAAC;IACH,CAAC;CACD;AApED,kEAoEC;AAED;;;;;;;;GAQG;AACH,MAAsB,oBACrB,SAAQ,mCAA0D;IAQlE,YACiB,QAAiD,EACjD,OAAiB,EACjB,SAAqB,EACrB,IAAW,EACpB,EAAsB;QAE7B,KAAK,EAAE,CAAC;QANQ,aAAQ,GAAR,QAAQ,CAAyC;QACjD,YAAO,GAAP,OAAO,CAAU;QACjB,cAAS,GAAT,SAAS,CAAY;QACrB,SAAI,GAAJ,IAAI,CAAO;QACpB,OAAE,GAAF,EAAE,CAAoB;QAV9B;;WAEG;QACK,kBAAa,GAAG,KAAK,CAAC;IAU9B,CAAC;IASD;;;;OAIG;IACO,cAAc;QACvB,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,MAAM;QAClB,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,qBAAU,CAAC,4BAA4B,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,qBAAU,CAAC,sCAAsC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAA,iBAAM,EACL,IAAI,CAAC,SAAS,CAAC,WAAW,KAAK,sBAAW,CAAC,QAAQ,EACnD,KAAK,CAAC,4BAA4B,CAClC,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE1B,sGAAsG;QACtG,+HAA+H;QAE/H,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACxD,4HAA4H;QAC5H,IAAA,iBAAM,EACL,IAAI,CAAC,SAAS,CAAC,WAAW,KAAM,sBAAW,CAAC,QAAwB,EACpE,KAAK,CAAC,gCAAgC,CACtC,CAAC;QACF,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAChC,OAAO,IAAoC,CAAC;IAC7C,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IAChC,CAAC;IAEM,UAAU;QAYhB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAkC,CAAC;QAC1D,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACd,6EAA6E,CAC7E,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC;IAC1B,CAAC;IAEM,KAAK;QACX,uFAAuF;QACvF,yFAAyF;QACzF,0CAA0C;QAC1C,kFAAkF;QAClF,2FAA2F;QAC3F,yEAAyE;QACzE,8FAA8F;QAC9F,+FAA+F;QAC/F,8FAA8F;QAC9F,+FAA+F;QAC/F,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAI,GAAoB;QACnD,MAAM,IAAI,GAAG,MAAM,IAAA,2BAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACxD,2BAA2B,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAE3C,+EAA+E;QAC/E,MAAM,OAAO,GAAG,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACpD,wEAAwE;QACxE,4EAA4E;QAC5E,OAAO,UAAe,CAAC;IACxB,CAAC;CACD;AAtHD,oDAsHC;AAeD;;;;;;;;;;GAUG;AACH,SAAgB,oBAAoB,CAAC,SAAiC;IACrE,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,SAAS,CAAC,QAAQ,CAAC;AAC3B,CAAC;AAHD,oDAGC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IAudience } from \"@fluidframework/container-definitions\";\nimport { AttachState, type IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\nimport { ErasedTypeImplementation } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\ttype DataStoreKey,\n\ttype DataStoreKind,\n\ttype FluidContainerAttached,\n\ttype FluidContainerWithService,\n\ttype Registry,\n\tlookupInRegistry,\n} from \"@fluidframework/driver-definitions/internal\";\nimport type {\n\tIContainerRuntimeBase,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n\tIFluidDataStoreFactory,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\n/*\n * This file provides common implementation logic for ServiceClient implementations.\n */\n\n/**\n * Implementation of `DataStoreKind`.\n * @internal\n */\nexport class DataStoreKindImplementation<T>\n\textends ErasedTypeImplementation<DataStoreKind<T>>\n\timplements DataStoreKind<T>, IFluidDataStoreFactory\n{\n\t/**\n\t * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.\n\t */\n\tpublic static guard<T>(\n\t\tvalue: T,\n\t): value is DataStoreKindImplementation<T extends DataStoreKind<infer T2> ? T2 : never> & T {\n\t\treturn value instanceof DataStoreKindImplementation;\n\t}\n\n\t/**\n\t * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.\n\t */\n\tpublic static narrowGeneric<T>(\n\t\tvalue: T,\n\t): asserts value is DataStoreKindImplementation<\n\t\tT extends DataStoreKind<infer T2> ? T2 : never\n\t> &\n\t\tT {\n\t\tif (!DataStoreKindImplementation.guard(value)) {\n\t\t\tthrow new Error(\"Invalid DataStoreKindImplementation\");\n\t\t}\n\t}\n\n\tpublic readonly type: string;\n\tpublic readonly createDataStore?: (context: IFluidDataStoreContext) => {\n\t\treadonly runtime: IFluidDataStoreChannel;\n\t};\n\n\tpublic constructor(\n\t\tprivate readonly factory: Pick<\n\t\t\tDataStoreKindImplementation<T>,\n\t\t\t\"type\" | \"instantiateDataStore\" | \"createDataStore\"\n\t\t>,\n\t) {\n\t\tsuper();\n\t\tthis.type = factory.type;\n\t\tif (factory.createDataStore !== undefined) {\n\t\t\tthis.createDataStore = factory.createDataStore.bind(factory);\n\t\t}\n\t}\n\n\tpublic async instantiateDataStore(\n\t\tcontext: IFluidDataStoreContext,\n\t\texisting: boolean,\n\t): Promise<IFluidDataStoreChannel> {\n\t\treturn this.factory.instantiateDataStore(context, existing);\n\t}\n\n\tpublic get IFluidDataStoreFactory(): IFluidDataStoreFactory {\n\t\treturn this;\n\t}\n\n\tpublic async adapt(value: Promise<DataStoreKind>): Promise<DataStoreKind<T>> {\n\t\tconst input = await value;\n\t\tif (input === this) {\n\t\t\treturn this;\n\t\t}\n\t\tif (input.type === this.type) {\n\t\t\tthrow new UsageError(`Conflicting DataStoreKinds with same type: ${this.type}`);\n\t\t}\n\t\tthrow new UsageError(\n\t\t\t`Mismatched DataStoreKind type. Expected: ${this.type}, got: ${input.type}`,\n\t\t);\n\t}\n}\n\n/**\n * Shared base class for all `ServiceClient` container implementations.\n *\n * @remarks\n * Extends `ErasedTypeImplementation` so that\n * {@link getContainerAudience} can narrow via `ServiceContainerBase.narrow()`.\n *\n * @internal\n */\nexport abstract class ServiceContainerBase<TData, TOptions = unknown>\n\textends ErasedTypeImplementation<FluidContainerWithService<TData>>\n\timplements FluidContainerWithService<TData>\n{\n\t/**\n\t * True if an attempt to attach has been started. This is used to prevent multiple concurrent attach attempts.\n\t */\n\tprivate startedAttach = false;\n\n\tprotected constructor(\n\t\tpublic readonly registry: Registry<Promise<DataStoreKind<TData>>>,\n\t\tpublic readonly options: TOptions,\n\t\tpublic readonly container: IContainer,\n\t\tpublic readonly data: TData,\n\t\tpublic id: string | undefined,\n\t) {\n\t\tsuper();\n\t}\n\n\t/**\n\t * Creates the service-specific request used to attach this container.\n\t * @remarks\n\t * Called by {@link ServiceContainerBase.attach} after validating that no attach is already in progress.\n\t */\n\tprotected abstract createAttachRequest(): IRequest;\n\n\t/**\n\t * Extracts the container ID from {@link ServiceContainerBase.container}'s resolved URL after attachment.\n\t * @remarks\n\t * Override when the service's resolved URL stores the id in a non-standard field.\n\t */\n\tprotected getContainerId(): string {\n\t\tif (this.container.resolvedUrl === undefined) {\n\t\t\tthrow new Error(\"Resolved URL unexpectedly missing!\");\n\t\t}\n\t\treturn this.container.resolvedUrl.id;\n\t}\n\n\tpublic async attach(): Promise<FluidContainerAttached<TData>> {\n\t\tif (this.id !== undefined) {\n\t\t\tthrow new UsageError(\"Container already attached\");\n\t\t}\n\t\tif (this.startedAttach) {\n\t\t\tthrow new UsageError(\"Container attach already in progress\");\n\t\t}\n\n\t\tassert(\n\t\t\tthis.container.attachState === AttachState.Detached,\n\t\t\t0xd15 /* Container not detached */,\n\t\t);\n\t\tthis.startedAttach = true;\n\n\t\t// TODO: support setting where attach can fail, and leave the container in a valid (non-closed) state.\n\t\t// Likely the best way to support this is by adding a `tryAttach(request): Promise<FluidContainerAttached<TData> | undefined>`.\n\n\t\tawait this.container.attach(this.createAttachRequest());\n\t\t// This type cast is needed to work around the fact that TypeScript assumes the \"attach\" methods can't modify \"attachState\".\n\t\tassert(\n\t\t\tthis.container.attachState === (AttachState.Attached as AttachState),\n\t\t\t0xd16 /* Container failed to attach */,\n\t\t);\n\t\tthis.id = this.getContainerId();\n\t\treturn this as typeof this & { id: string };\n\t}\n\n\tpublic get audience(): IAudience {\n\t\treturn this.container.audience;\n\t}\n\n\tpublic getRuntime(): IContainerRuntimeBase {\n\t\t// The runtime is not part of the public IContainer surface, so it is reached via a structural cast.\n\t\t// This relies on an implementation detail of the containers produced by the loader\n\t\t// (createDetachedContainer / loadExistingContainer): they carry a `runtime` property.\n\t\t// The undefined guard below turns an incompatible container implementation into a clear error\n\t\t// instead of a confusing failure later when the missing runtime is used.\n\t\t// This is extra risky since IContainer is not marked sealed.\n\t\t// TODO: Replace this with a supported, type-safe accessor once the loader exposes one.\n\t\tinterface IContainerWithRuntime extends IContainer {\n\t\t\treadonly runtime?: IContainerRuntimeBase;\n\t\t}\n\n\t\tconst container = this.container as IContainerWithRuntime;\n\t\tif (container.runtime === undefined) {\n\t\t\tthrow new Error(\n\t\t\t\t\"Container does not expose a runtime: incompatible container implementation.\",\n\t\t\t);\n\t\t}\n\t\treturn container.runtime;\n\t}\n\n\tpublic close(): void {\n\t\t// TODO: `container.close()` cancels the container runtime's GC timers, but a couple of\n\t\t// container-level timers are only bounded `setTimeout`s that survive close (they are not\n\t\t// cancelled here, nor even on `dispose`):\n\t\t// - The container-loader `NoopHeuristic` timer (~2s), which has no disposal hook.\n\t\t// - The container-runtime `SummaryManager` \"delay before creating summarizer\" timer, whose\n\t\t//   pending timeout is not cleared when the SummaryManager is torn down.\n\t\t// These self-expire, so they do not cause indefinite hangs, but until they fire they keep the\n\t\t// Node.js event loop alive, delaying a clean process exit after close. That is a common reason\n\t\t// tests resort to Mocha's `--exit` flag. Ideally close() (via the runtime's close path) would\n\t\t// cancel these too so that closing a single container is sufficient to release all its timers.\n\t\tthis.container.close();\n\t}\n\n\tpublic async createDataStore<T>(key: DataStoreKey<T>): Promise<T> {\n\t\tconst kind = await lookupInRegistry(this.registry, key);\n\t\tDataStoreKindImplementation.narrowGeneric(kind);\n\t\tconst containerRuntime = this.getRuntime();\n\n\t\t// TODO: There should probably be a higher level more type safe way to do this.\n\t\tconst context = containerRuntime.createDetachedDataStore([kind.type]);\n\t\tconst channel = await kind.instantiateDataStore(context, false);\n\t\tconst dataStore = await context.attachRuntime(kind, channel);\n\t\tconst entryPoint = await dataStore.entryPoint.get();\n\t\t// The data store's entry point type is erased at the registry boundary;\n\t\t// the DataStoreKind<T> used to create it guarantees the entry point is a T.\n\t\treturn entryPoint as T;\n\t}\n}\n\n/**\n * All clients connected to the op stream, both read-only and read/write.\n * @remarks\n * Currently just {@link @fluidframework/container-definitions#IAudience}, but may diverge before stabilizing.\n * @privateRemarks\n * This is currently just an alias for IAudience, but it is defined separately to allow for:\n * 1. Following the no I prefix naming convention.\n * 2. The possibility of diverging from IAudience in the future if desired.\n * 3. Make it easy for the reexport from fluid-framework to be `@alpha` so the name is not locked down prematurely.\n * @sealed @alpha\n */\nexport type Audience = IAudience;\n\n/**\n * Gets the {@link Audience} from a Fluid container\n * created by any {@link @fluidframework/driver-definitions#ServiceClient}.\n * @privateRemarks\n * This is exposed via a free function rather than as a property of FluidContainerAttached\n * for a few minor reasons:\n * 1. This allows stabilizing the FluidContainerAttached API independently committing to how we want to expose the audience.\n * 2. This demonstrates the pattern of how we can have possible less stable APIs to expose service specific features without them being part of the core FluidContainer API.\n * This will be important for both new feature stabilization, and also exposing anything needed for legacy interop.\n * @alpha\n */\nexport function getContainerAudience(container: FluidContainerAttached): Audience {\n\tServiceContainerBase.narrow(container);\n\treturn container.audience;\n}\n"]}

package/dist/serviceClientUtils.d.ts

@@ -0,0 +1,90 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ICodeDetailsLoader, IContainerContext, IRuntime } from "@fluidframework/container-definitions/internal";
+import type { FluidObject } from "@fluidframework/core-interfaces";
+import { type DataStoreKey, type DataStoreKind, type DataStoreRegistry, type FluidContainerAttached, type FluidContainerWithService, type Registry, type ServiceClient } from "@fluidframework/driver-definitions/internal";
+import type { IContainerRuntimeBase, IFluidDataStoreRegistry, MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+/**
+ * The constant ID used for the root data store alias in service containers.
+ * @internal
+ */
+export declare const rootDataStoreId = "root";
+/**
+ * Converts a `DataStoreRegistry` to the `IFluidDataStoreRegistry` interface expected by the container runtime.
+ * @remarks
+ * This does not leverage the ability for `IFluidDataStoreRegistry.get` to return undefined.
+ * Note that all use-cases of `IFluidDataStoreRegistry.get` returning undefined currently end up as a fatal error.
+ * Therefore it should be fine for the error to instead be thrown by the registry function, which is what this function does.
+ * @internal
+ */
+export declare function convertRegistry<T>(registry: DataStoreRegistry<T>): IFluidDataStoreRegistry;
+/**
+ * Normalizes a `DataStoreKind` or registry function into a registry function.
+ * @internal
+ */
+export declare function normalizeRegistry<T>(input: DataStoreKind<T> | Registry<Promise<DataStoreKind<T>>>): Registry<Promise<DataStoreKind<T>>>;
+/**
+ * Parameters passed to a {@link ContainerRuntimeLoader}.
+ * @internal
+ */
+export interface ContainerRuntimeLoaderParams {
+    context: IContainerContext;
+    registry: IFluidDataStoreRegistry;
+    provideEntryPoint: (runtime: IContainerRuntimeBase) => Promise<FluidObject>;
+    existing: boolean;
+    minVersionForCollab: MinimumVersionForCollab;
+    /**
+     * The type string of the root data store to create. Only set when `existing` is false.
+     */
+    newContainerRootType: string | undefined;
+}
+/**
+ * A service-specific callback that creates or loads the container runtime.
+ *
+ * @remarks
+ * Receives the runtime parameters assembled by {@link makeCodeLoader} and is responsible for
+ * calling the concrete runtime factory (e.g. `ContainerRuntime.loadRuntime2`) and, when
+ * `existing` is `false`, initializing the root data store before returning.
+ *
+ * @internal
+ */
+export type ContainerRuntimeLoader = (parameters: ContainerRuntimeLoaderParams) => Promise<IRuntime>;
+/**
+ * Creates an `ICodeDetailsLoader` that wires up the container runtime via the supplied
+ * `loadRuntime` callback.
+ *
+ * @remarks
+ * The `loadRuntime` callback is responsible for invoking the concrete runtime factory and,
+ * when `parameters.existing` is `false` and `parameters.newContainerRootType` is set, creating and
+ * aliasing the root data store.
+ *
+ * This loader never does any code loading, and always assumes it is compatible.
+ * TODO: We should reevaluate this before promoting ServiceClient APIs to beta.
+ *
+ * @internal
+ */
+export declare function makeCodeLoader<T>(registry: DataStoreRegistry<T>, minVersionForCollab: MinimumVersionForCollab, loadRuntime: ContainerRuntimeLoader, root?: DataStoreKind<T>): ICodeDetailsLoader;
+/**
+ * Minimal interface for the static container factory methods used by {@link ServiceClientImplementation}.
+ * @internal
+ */
+export interface ServiceContainerStatics<TOptions> {
+    createDetached<T>(registry: DataStoreRegistry<T>, options: TOptions, root: DataStoreKind<T>): Promise<FluidContainerWithService<T>>;
+    load<T>(registry: DataStoreRegistry<T>, options: TOptions, id: string): Promise<FluidContainerAttached<T>>;
+}
+/**
+ * Creates a {@link @fluidframework/driver-definitions#ServiceClient} that delegates container
+ * creation and loading to the supplied container class statics.
+ * @internal
+ */
+export declare class ServiceClientImplementation<TOptions> implements ServiceClient {
+    private readonly options;
+    private readonly statics;
+    constructor(options: TOptions, statics: ServiceContainerStatics<TOptions>);
+    createContainer<T>(root: DataStoreKind<T>): Promise<FluidContainerWithService<T>>;
+    createContainer<T>(root: DataStoreKey<T>, registry: Registry<Promise<DataStoreKind>>): Promise<FluidContainerWithService<T>>;
+    loadContainer<T>(id: string, root: DataStoreKind<T> | Registry<Promise<DataStoreKind<T>>>): Promise<FluidContainerAttached<T>>;
+}
+//# sourceMappingURL=serviceClientUtils.d.ts.map

package/dist/serviceClientUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientUtils.d.ts","sourceRoot":"","sources":["../src/serviceClientUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,kBAAkB,EAClB,iBAAiB,EAIjB,QAAQ,EAER,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,QAAQ,EAEb,KAAK,aAAa,EAClB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EAEX,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,8CAA8C,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,eAAe,SAAS,CAAC;AAEtC;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAW1F;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAClC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3D,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAMrC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,uBAAuB,CAAC;IAClC,iBAAiB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5E,QAAQ,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACpC,UAAU,EAAE,4BAA4B,KACpC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC/B,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC9B,mBAAmB,EAAE,uBAAuB,EAC5C,WAAW,EAAE,sBAAsB,EACnC,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GACrB,kBAAkB,CAoDpB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,QAAQ;IAChD,cAAc,CAAC,CAAC,EACf,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC9B,OAAO,EAAE,QAAQ,EACjB,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,GACpB,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzC,IAAI,CAAC,CAAC,EACL,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC9B,OAAO,EAAE,QAAQ,EACjB,EAAE,EAAE,MAAM,GACR,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;CACtC;AAED;;;;GAIG;AACH,qBAAa,2BAA2B,CAAC,QAAQ,CAAE,YAAW,aAAa;IAEzE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,OAAO,EAAE,QAAQ,EACjB,OAAO,EAAE,uBAAuB,CAAC,QAAQ,CAAC;IAGrD,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAEjF,eAAe,CAAC,CAAC,EACvB,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAe3B,aAAa,CAAC,CAAC,EAC3B,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1D,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;CAGrC"}