@fluidframework/runtime-utils 2.113.0-411909 → 2.114.0

package/dist/serviceClientUtils.js

@@ -0,0 +1,128 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceClientImplementation = exports.makeCodeLoader = exports.normalizeRegistry = exports.convertRegistry = exports.rootDataStoreId = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/driver-definitions/internal");
+const serviceClientBase_js_1 = require("./serviceClientBase.js");
+/**
+ * The constant ID used for the root data store alias in service containers.
+ * @internal
+ */
+exports.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
+ */
+function convertRegistry(registry) {
+    return {
+        async get(name) {
+            const dataStoreKind = await (0, internal_2.lookupInRegistry)(registry, (0, internal_2.createBasicRegistryKey)(name));
+            serviceClientBase_js_1.DataStoreKindImplementation.narrowGeneric(dataStoreKind);
+            return dataStoreKind;
+        },
+        get IFluidDataStoreRegistry() {
+            return this;
+        },
+    };
+}
+exports.convertRegistry = convertRegistry;
+/**
+ * Normalizes a `DataStoreKind` or registry function into a registry function.
+ * @internal
+ */
+function normalizeRegistry(input) {
+    if (serviceClientBase_js_1.DataStoreKindImplementation.guard(input)) {
+        return async () => input;
+    }
+    (0, internal_1.assert)(typeof input === "function", 0xd17 /* Registry must be a function */);
+    return input;
+}
+exports.normalizeRegistry = normalizeRegistry;
+/**
+ * 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
+ */
+function makeCodeLoader(registry, minVersionForCollab, loadRuntime, root) {
+    const fluidExport = {
+        async instantiateRuntime(context, existing) {
+            const provideEntryPoint = async (entryPointRuntime) => {
+                const data = await entryPointRuntime.getAliasedDataStoreEntryPoint(exports.rootDataStoreId);
+                if (data === undefined) {
+                    throw new Error("Root data store missing!");
+                }
+                const rootDataStore = await data.get();
+                return rootDataStore;
+            };
+            return loadRuntime({
+                context,
+                registry: convertRegistry(registry),
+                provideEntryPoint,
+                existing,
+                minVersionForCollab,
+                newContainerRootType: root?.type,
+            });
+        },
+        async satisfies(candidate, constraint) {
+            return true;
+        },
+        async compare(a, b) {
+            return 0;
+        },
+        get IRuntimeFactory() {
+            return fluidExport;
+        },
+        get IFluidCodeDetailsComparer() {
+            return fluidExport;
+        },
+    };
+    return {
+        load: async (details) => {
+            return { module: { fluidExport }, details };
+        },
+    };
+}
+exports.makeCodeLoader = makeCodeLoader;
+/**
+ * Creates a {@link @fluidframework/driver-definitions#ServiceClient} that delegates container
+ * creation and loading to the supplied container class statics.
+ * @internal
+ */
+class ServiceClientImplementation {
+    constructor(options, statics) {
+        this.options = options;
+        this.statics = statics;
+    }
+    async createContainer(root, registry) {
+        if (registry === undefined) {
+            serviceClientBase_js_1.DataStoreKindImplementation.narrowGeneric(root);
+            return this.statics.createDetached(normalizeRegistry(root), this.options, root);
+        }
+        else {
+            const result = await (0, internal_2.lookupInRegistry)(registry, root);
+            return this.statics.createDetached(registry, this.options, result);
+        }
+    }
+    async loadContainer(id, root) {
+        return this.statics.load(normalizeRegistry(root), this.options, id);
+    }
+}
+exports.ServiceClientImplementation = ServiceClientImplementation;
+//# sourceMappingURL=serviceClientUtils.js.map

package/dist/serviceClientUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientUtils.js","sourceRoot":"","sources":["../src/serviceClientUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH,kEAA6D;AAC7D,0EAUqD;AAQrD,iEAAqE;AAErE;;;GAGG;AACU,QAAA,eAAe,GAAG,MAAM,CAAC;AAEtC;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAI,QAA8B;IAChE,OAAO;QACN,KAAK,CAAC,GAAG,CAAC,IAAY;YACrB,MAAM,aAAa,GAAG,MAAM,IAAA,2BAAgB,EAAC,QAAQ,EAAE,IAAA,iCAAsB,EAAC,IAAI,CAAC,CAAC,CAAC;YACrF,kDAA2B,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YACzD,OAAO,aAAa,CAAC;QACtB,CAAC;QACD,IAAI,uBAAuB;YAC1B,OAAO,IAAI,CAAC;QACb,CAAC;KACD,CAAC;AACH,CAAC;AAXD,0CAWC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAChC,KAA6D;IAE7D,IAAI,kDAA2B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,IAAA,iBAAM,EAAC,OAAO,KAAK,KAAK,UAAU,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC7E,OAAO,KAAK,CAAC;AACd,CAAC;AARD,8CAQC;AAgCD;;;;;;;;;;;;;GAaG;AACH,SAAgB,cAAc,CAC7B,QAA8B,EAC9B,mBAA4C,EAC5C,WAAmC,EACnC,IAAuB;IAEvB,MAAM,WAAW,GAAgD;QAChE,KAAK,CAAC,kBAAkB,CACvB,OAA0B,EAC1B,QAAiB;YAEjB,MAAM,iBAAiB,GAAG,KAAK,EAC9B,iBAAwC,EACb,EAAE;gBAC7B,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,6BAA6B,CAAC,uBAAe,CAAC,CAAC;gBACpF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;gBAC7C,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvC,OAAO,aAAgC,CAAC;YACzC,CAAC,CAAC;YAEF,OAAO,WAAW,CAAC;gBAClB,OAAO;gBACP,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC;gBACnC,iBAAiB;gBACjB,QAAQ;gBACR,mBAAmB;gBACnB,oBAAoB,EAAE,IAAI,EAAE,IAAI;aAChC,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,SAAS,CACd,SAA4B,EAC5B,UAA6B;YAE7B,OAAO,IAAI,CAAC;QACb,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,CAAoB,EAAE,CAAoB;YACvD,OAAO,CAAC,CAAC;QACV,CAAC;QAED,IAAI,eAAe;YAClB,OAAO,WAAW,CAAC;QACpB,CAAC;QAED,IAAI,yBAAyB;YAC5B,OAAO,WAAW,CAAC;QACpB,CAAC;KACD,CAAC;IAEF,OAAO;QACN,IAAI,EAAE,KAAK,EAAE,OAA0B,EAAoC,EAAE;YAC5E,OAAO,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC;QAC7C,CAAC;KACD,CAAC;AACH,CAAC;AAzDD,wCAyDC;AAoBD;;;;GAIG;AACH,MAAa,2BAA2B;IACvC,YACkB,OAAiB,EACjB,OAA0C;QAD1C,YAAO,GAAP,OAAO,CAAU;QACjB,YAAO,GAAP,OAAO,CAAmC;IACzD,CAAC;IASG,KAAK,CAAC,eAAe,CAC3B,IAAwC,EACxC,QAA8C;QAE9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC5B,kDAA2B,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjF,CAAC;aAAM,CAAC;YACP,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAgB,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpE,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,EAAU,EACV,IAA4D;QAE5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;CACD;AAhCD,kEAgCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tICodeDetailsLoader,\n\tIContainerContext,\n\tIFluidCodeDetails,\n\tIFluidCodeDetailsComparer,\n\tIFluidModuleWithDetails,\n\tIRuntime,\n\tIRuntimeFactory,\n} from \"@fluidframework/container-definitions/internal\";\nimport type { FluidObject } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tcreateBasicRegistryKey,\n\ttype DataStoreKey,\n\ttype DataStoreKind,\n\ttype DataStoreRegistry,\n\ttype FluidContainerAttached,\n\ttype FluidContainerWithService,\n\ttype Registry,\n\tlookupInRegistry,\n\ttype ServiceClient,\n} from \"@fluidframework/driver-definitions/internal\";\nimport type {\n\tFluidDataStoreRegistryEntry,\n\tIContainerRuntimeBase,\n\tIFluidDataStoreRegistry,\n\tMinimumVersionForCollab,\n} from \"@fluidframework/runtime-definitions/internal\";\n\nimport { DataStoreKindImplementation } from \"./serviceClientBase.js\";\n\n/**\n * The constant ID used for the root data store alias in service containers.\n * @internal\n */\nexport const rootDataStoreId = \"root\";\n\n/**\n * Converts a `DataStoreRegistry` to the `IFluidDataStoreRegistry` interface expected by the container runtime.\n * @remarks\n * This does not leverage the ability for `IFluidDataStoreRegistry.get` to return undefined.\n * Note that all use-cases of `IFluidDataStoreRegistry.get` returning undefined currently end up as a fatal error.\n * Therefore it should be fine for the error to instead be thrown by the registry function, which is what this function does.\n * @internal\n */\nexport function convertRegistry<T>(registry: DataStoreRegistry<T>): IFluidDataStoreRegistry {\n\treturn {\n\t\tasync get(name: string): Promise<FluidDataStoreRegistryEntry | undefined> {\n\t\t\tconst dataStoreKind = await lookupInRegistry(registry, createBasicRegistryKey(name));\n\t\t\tDataStoreKindImplementation.narrowGeneric(dataStoreKind);\n\t\t\treturn dataStoreKind;\n\t\t},\n\t\tget IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\t\treturn this;\n\t\t},\n\t};\n}\n\n/**\n * Normalizes a `DataStoreKind` or registry function into a registry function.\n * @internal\n */\nexport function normalizeRegistry<T>(\n\tinput: DataStoreKind<T> | Registry<Promise<DataStoreKind<T>>>,\n): Registry<Promise<DataStoreKind<T>>> {\n\tif (DataStoreKindImplementation.guard(input)) {\n\t\treturn async () => input;\n\t}\n\tassert(typeof input === \"function\", 0xd17 /* Registry must be a function */);\n\treturn input;\n}\n\n/**\n * Parameters passed to a {@link ContainerRuntimeLoader}.\n * @internal\n */\nexport interface ContainerRuntimeLoaderParams {\n\tcontext: IContainerContext;\n\tregistry: IFluidDataStoreRegistry;\n\tprovideEntryPoint: (runtime: IContainerRuntimeBase) => Promise<FluidObject>;\n\texisting: boolean;\n\tminVersionForCollab: MinimumVersionForCollab;\n\t/**\n\t * The type string of the root data store to create. Only set when `existing` is false.\n\t */\n\tnewContainerRootType: string | undefined;\n}\n\n/**\n * A service-specific callback that creates or loads the container runtime.\n *\n * @remarks\n * Receives the runtime parameters assembled by {@link makeCodeLoader} and is responsible for\n * calling the concrete runtime factory (e.g. `ContainerRuntime.loadRuntime2`) and, when\n * `existing` is `false`, initializing the root data store before returning.\n *\n * @internal\n */\nexport type ContainerRuntimeLoader = (\n\tparameters: ContainerRuntimeLoaderParams,\n) => Promise<IRuntime>;\n\n/**\n * Creates an `ICodeDetailsLoader` that wires up the container runtime via the supplied\n * `loadRuntime` callback.\n *\n * @remarks\n * The `loadRuntime` callback is responsible for invoking the concrete runtime factory and,\n * when `parameters.existing` is `false` and `parameters.newContainerRootType` is set, creating and\n * aliasing the root data store.\n *\n * This loader never does any code loading, and always assumes it is compatible.\n * TODO: We should reevaluate this before promoting ServiceClient APIs to beta.\n *\n * @internal\n */\nexport function makeCodeLoader<T>(\n\tregistry: DataStoreRegistry<T>,\n\tminVersionForCollab: MinimumVersionForCollab,\n\tloadRuntime: ContainerRuntimeLoader,\n\troot?: DataStoreKind<T>,\n): ICodeDetailsLoader {\n\tconst fluidExport: IRuntimeFactory & IFluidCodeDetailsComparer = {\n\t\tasync instantiateRuntime(\n\t\t\tcontext: IContainerContext,\n\t\t\texisting: boolean,\n\t\t): Promise<IRuntime> {\n\t\t\tconst provideEntryPoint = async (\n\t\t\t\tentryPointRuntime: IContainerRuntimeBase,\n\t\t\t): Promise<T & FluidObject> => {\n\t\t\t\tconst data = await entryPointRuntime.getAliasedDataStoreEntryPoint(rootDataStoreId);\n\t\t\t\tif (data === undefined) {\n\t\t\t\t\tthrow new Error(\"Root data store missing!\");\n\t\t\t\t}\n\t\t\t\tconst rootDataStore = await data.get();\n\t\t\t\treturn rootDataStore as T & FluidObject;\n\t\t\t};\n\n\t\t\treturn loadRuntime({\n\t\t\t\tcontext,\n\t\t\t\tregistry: convertRegistry(registry),\n\t\t\t\tprovideEntryPoint,\n\t\t\t\texisting,\n\t\t\t\tminVersionForCollab,\n\t\t\t\tnewContainerRootType: root?.type,\n\t\t\t});\n\t\t},\n\n\t\tasync satisfies(\n\t\t\tcandidate: IFluidCodeDetails,\n\t\t\tconstraint: IFluidCodeDetails,\n\t\t): Promise<boolean> {\n\t\t\treturn true;\n\t\t},\n\n\t\tasync compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined> {\n\t\t\treturn 0;\n\t\t},\n\n\t\tget IRuntimeFactory(): IRuntimeFactory {\n\t\t\treturn fluidExport;\n\t\t},\n\n\t\tget IFluidCodeDetailsComparer(): IFluidCodeDetailsComparer {\n\t\t\treturn fluidExport;\n\t\t},\n\t};\n\n\treturn {\n\t\tload: async (details: IFluidCodeDetails): Promise<IFluidModuleWithDetails> => {\n\t\t\treturn { module: { fluidExport }, details };\n\t\t},\n\t};\n}\n\n/**\n * Minimal interface for the static container factory methods used by {@link ServiceClientImplementation}.\n * @internal\n */\nexport interface ServiceContainerStatics<TOptions> {\n\tcreateDetached<T>(\n\t\tregistry: DataStoreRegistry<T>,\n\t\toptions: TOptions,\n\t\troot: DataStoreKind<T>,\n\t): Promise<FluidContainerWithService<T>>;\n\n\tload<T>(\n\t\tregistry: DataStoreRegistry<T>,\n\t\toptions: TOptions,\n\t\tid: string,\n\t): Promise<FluidContainerAttached<T>>;\n}\n\n/**\n * Creates a {@link @fluidframework/driver-definitions#ServiceClient} that delegates container\n * creation and loading to the supplied container class statics.\n * @internal\n */\nexport class ServiceClientImplementation<TOptions> implements ServiceClient {\n\tpublic constructor(\n\t\tprivate readonly options: TOptions,\n\t\tprivate readonly statics: ServiceContainerStatics<TOptions>,\n\t) {}\n\n\tpublic createContainer<T>(root: DataStoreKind<T>): Promise<FluidContainerWithService<T>>;\n\n\tpublic createContainer<T>(\n\t\troot: DataStoreKey<T>,\n\t\tregistry: Registry<Promise<DataStoreKind>>,\n\t): Promise<FluidContainerWithService<T>>;\n\n\tpublic async createContainer<T>(\n\t\troot: DataStoreKey<T> | DataStoreKind<T>,\n\t\tregistry?: Registry<Promise<DataStoreKind<T>>>,\n\t): Promise<FluidContainerWithService<T>> {\n\t\tif (registry === undefined) {\n\t\t\tDataStoreKindImplementation.narrowGeneric(root);\n\t\t\treturn this.statics.createDetached(normalizeRegistry(root), this.options, root);\n\t\t} else {\n\t\t\tconst result = await lookupInRegistry(registry, root);\n\t\t\treturn this.statics.createDetached(registry, this.options, result);\n\t\t}\n\t}\n\n\tpublic async loadContainer<T>(\n\t\tid: string,\n\t\troot: DataStoreKind<T> | Registry<Promise<DataStoreKind<T>>>,\n\t): Promise<FluidContainerAttached<T>> {\n\t\treturn this.statics.load(normalizeRegistry(root), this.options, id);\n\t}\n}\n"]}

package/lib/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/lib/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/lib/index.js

@@ -16,4 +16,6 @@ export { RuntimeHeaders, seqFromTree, encodeCompactIdToString, } from "./utils.j
 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 { DataStoreKindImplementation, ServiceContainerBase, getContainerAudience, } from "./serviceClientBase.js";
+export { convertRegistry, makeCodeLoader, normalizeRegistry, rootDataStoreId, ServiceClientImplementation, } from "./serviceClientUtils.js";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","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;AAEtB,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;AAEpB,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","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,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;AAEtB,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;AAEpB,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;AAShC,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","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/lib/legacyAlpha.d.ts

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

package/lib/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/lib/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/lib/packageVersion.js

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

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,+BAA+B,CAAC;AACvD,MAAM,CAAC,MAAM,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;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,+BAA+B,CAAC;AACvD,MAAM,CAAC,MAAM,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/lib/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/lib/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/lib/serviceClientBase.js

@@ -0,0 +1,159 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AttachState } from "@fluidframework/container-definitions/internal";
+import { ErasedTypeImplementation } from "@fluidframework/core-interfaces/internal";
+import { assert } from "@fluidframework/core-utils/internal";
+import { lookupInRegistry, } from "@fluidframework/driver-definitions/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+/*
+ * This file provides common implementation logic for ServiceClient implementations.
+ */
+/**
+ * Implementation of `DataStoreKind`.
+ * @internal
+ */
+export class DataStoreKindImplementation extends 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 UsageError(`Conflicting DataStoreKinds with same type: ${this.type}`);
+        }
+        throw new UsageError(`Mismatched DataStoreKind type. Expected: ${this.type}, got: ${input.type}`);
+    }
+}
+/**
+ * Shared base class for all `ServiceClient` container implementations.
+ *
+ * @remarks
+ * Extends `ErasedTypeImplementation` so that
+ * {@link getContainerAudience} can narrow via `ServiceContainerBase.narrow()`.
+ *
+ * @internal
+ */
+export class ServiceContainerBase extends 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 UsageError("Container already attached");
+        }
+        if (this.startedAttach) {
+            throw new UsageError("Container attach already in progress");
+        }
+        assert(this.container.attachState === 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".
+        assert(this.container.attachState === 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 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;
+    }
+}
+/**
+ * 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 function getContainerAudience(container) {
+    ServiceContainerBase.narrow(container);
+    return container.audience;
+}
+//# sourceMappingURL=serviceClientBase.js.map

package/lib/serviceClientBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientBase.js","sourceRoot":"","sources":["../src/serviceClientBase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAmB,MAAM,gDAAgD,CAAC;AAE9F,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAMN,gBAAgB,GAChB,MAAM,6CAA6C,CAAC;AAOrD,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEtE;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,2BACZ,SAAQ,wBAA0C;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,UAAU,CAAC,8CAA8C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,IAAI,UAAU,CACnB,4CAA4C,IAAI,CAAC,IAAI,UAAU,KAAK,CAAC,IAAI,EAAE,CAC3E,CAAC;IACH,CAAC;CACD;AAED;;;;;;;;GAQG;AACH,MAAM,OAAgB,oBACrB,SAAQ,wBAA0D;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,UAAU,CAAC,4BAA4B,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,sCAAsC,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,CACL,IAAI,CAAC,SAAS,CAAC,WAAW,KAAK,WAAW,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,MAAM,CACL,IAAI,CAAC,SAAS,CAAC,WAAW,KAAM,WAAW,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,gBAAgB,CAAC,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;AAeD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAiC;IACrE,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,SAAS,CAAC,QAAQ,CAAC;AAC3B,CAAC","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/lib/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