@fluidframework/runtime-utils 2.113.0-411909 → 2.114.0

package/lib/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"}

package/lib/serviceClientUtils.js

@@ -0,0 +1,121 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/core-utils/internal";
+import { createBasicRegistryKey, lookupInRegistry, } from "@fluidframework/driver-definitions/internal";
+import { DataStoreKindImplementation } from "./serviceClientBase.js";
+/**
+ * The constant ID used for the root data store alias in service containers.
+ * @internal
+ */
+export 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 function convertRegistry(registry) {
+    return {
+        async get(name) {
+            const dataStoreKind = await lookupInRegistry(registry, createBasicRegistryKey(name));
+            DataStoreKindImplementation.narrowGeneric(dataStoreKind);
+            return dataStoreKind;
+        },
+        get IFluidDataStoreRegistry() {
+            return this;
+        },
+    };
+}
+/**
+ * Normalizes a `DataStoreKind` or registry function into a registry function.
+ * @internal
+ */
+export function normalizeRegistry(input) {
+    if (DataStoreKindImplementation.guard(input)) {
+        return async () => input;
+    }
+    assert(typeof input === "function", 0xd17 /* Registry must be a function */);
+    return input;
+}
+/**
+ * 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 function makeCodeLoader(registry, minVersionForCollab, loadRuntime, root) {
+    const fluidExport = {
+        async instantiateRuntime(context, existing) {
+            const provideEntryPoint = async (entryPointRuntime) => {
+                const data = await entryPointRuntime.getAliasedDataStoreEntryPoint(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 };
+        },
+    };
+}
+/**
+ * Creates a {@link @fluidframework/driver-definitions#ServiceClient} that delegates container
+ * creation and loading to the supplied container class statics.
+ * @internal
+ */
+export class ServiceClientImplementation {
+    constructor(options, statics) {
+        this.options = options;
+        this.statics = statics;
+    }
+    async createContainer(root, registry) {
+        if (registry === undefined) {
+            DataStoreKindImplementation.narrowGeneric(root);
+            return this.statics.createDetached(normalizeRegistry(root), this.options, root);
+        }
+        else {
+            const result = await lookupInRegistry(registry, root);
+            return this.statics.createDetached(registry, this.options, result);
+        }
+    }
+    async loadContainer(id, root) {
+        return this.statics.load(normalizeRegistry(root), this.options, id);
+    }
+}
+//# sourceMappingURL=serviceClientUtils.js.map

package/lib/serviceClientUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceClientUtils.js","sourceRoot":"","sources":["../src/serviceClientUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACN,sBAAsB,EAOtB,gBAAgB,GAEhB,MAAM,6CAA6C,CAAC;AAQrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AAEtC;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAI,QAA8B;IAChE,OAAO;QACN,KAAK,CAAC,GAAG,CAAC,IAAY;YACrB,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;YACrF,2BAA2B,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;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAChC,KAA6D;IAE7D,IAAI,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,MAAM,CAAC,OAAO,KAAK,KAAK,UAAU,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC7E,OAAO,KAAK,CAAC;AACd,CAAC;AAgCD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,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,eAAe,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;AAoBD;;;;GAIG;AACH,MAAM,OAAO,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,2BAA2B,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,gBAAgB,CAAC,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","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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.113.0-411909",
+  "version": "2.114.0",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -79,27 +79,27 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.113.0-411909",
-    "@fluidframework/container-definitions": "2.113.0-411909",
-    "@fluidframework/container-runtime-definitions": "2.113.0-411909",
-    "@fluidframework/core-interfaces": "2.113.0-411909",
-    "@fluidframework/core-utils": "2.113.0-411909",
-    "@fluidframework/datastore-definitions": "2.113.0-411909",
-    "@fluidframework/driver-definitions": "2.113.0-411909",
-    "@fluidframework/driver-utils": "2.113.0-411909",
-    "@fluidframework/runtime-definitions": "2.113.0-411909",
-    "@fluidframework/telemetry-utils": "2.113.0-411909",
+    "@fluid-internal/client-utils": "~2.114.0",
+    "@fluidframework/container-definitions": "~2.114.0",
+    "@fluidframework/container-runtime-definitions": "~2.114.0",
+    "@fluidframework/core-interfaces": "~2.114.0",
+    "@fluidframework/core-utils": "~2.114.0",
+    "@fluidframework/datastore-definitions": "~2.114.0",
+    "@fluidframework/driver-definitions": "~2.114.0",
+    "@fluidframework/driver-utils": "~2.114.0",
+    "@fluidframework/runtime-definitions": "~2.114.0",
+    "@fluidframework/telemetry-utils": "~2.114.0",
     "semver-ts": "^1.0.3"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "2.113.0-411909",
+    "@fluid-internal/mocha-test-setup": "~2.114.0",
     "@fluid-tools/build-cli": "^0.65.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.65.0",
     "@fluidframework/eslint-config-fluid": "^13.0.0",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.111.0",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.112.0",
     "@microsoft/api-extractor": "7.58.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "~22.19.17",
@@ -122,9 +122,6 @@
     "entrypoint": "legacy"
   },
   "scripts": {
-    "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
     "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
@@ -132,9 +129,12 @@
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "api-extractor run --local",
+    "build:entrypoints": "fluid-build . --task build:entrypoints",
+    "build:entrypoints:cjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./dist",
+    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacyAlpha --outDir ./lib --node10TypeCompat",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
-    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test": "concurrently npm:build:test:esm npm:build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
     "check:are-the-types-wrong": "attw --pack .",

package/src/index.ts

@@ -82,3 +82,21 @@ export type {
 	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";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "2.113.0-411909";
+export const pkgVersion = "2.114.0";

package/src/serviceClientBase.ts

@@ -0,0 +1,261 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { IAudience } from "@fluidframework/container-definitions";
+import { AttachState, type IContainer } from "@fluidframework/container-definitions/internal";
+import type { IRequest } from "@fluidframework/core-interfaces";
+import { ErasedTypeImplementation } from "@fluidframework/core-interfaces/internal";
+import { assert } from "@fluidframework/core-utils/internal";
+import {
+	type DataStoreKey,
+	type DataStoreKind,
+	type FluidContainerAttached,
+	type FluidContainerWithService,
+	type Registry,
+	lookupInRegistry,
+} from "@fluidframework/driver-definitions/internal";
+import type {
+	IContainerRuntimeBase,
+	IFluidDataStoreChannel,
+	IFluidDataStoreContext,
+	IFluidDataStoreFactory,
+} from "@fluidframework/runtime-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<T>
+	extends ErasedTypeImplementation<DataStoreKind<T>>
+	implements DataStoreKind<T>, IFluidDataStoreFactory
+{
+	/**
+	 * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+	 */
+	public static guard<T>(
+		value: T,
+	): value is DataStoreKindImplementation<T extends DataStoreKind<infer T2> ? T2 : never> & T {
+		return value instanceof DataStoreKindImplementation;
+	}
+
+	/**
+	 * Type guard for narrowing unions which contain DataStoreKind<T> to DataStoreKind<T>.
+	 */
+	public static narrowGeneric<T>(
+		value: T,
+	): asserts value is DataStoreKindImplementation<
+		T extends DataStoreKind<infer T2> ? T2 : never
+	> &
+		T {
+		if (!DataStoreKindImplementation.guard(value)) {
+			throw new Error("Invalid DataStoreKindImplementation");
+		}
+	}
+
+	public readonly type: string;
+	public readonly createDataStore?: (context: IFluidDataStoreContext) => {
+		readonly runtime: IFluidDataStoreChannel;
+	};
+
+	public constructor(
+		private readonly factory: Pick<
+			DataStoreKindImplementation<T>,
+			"type" | "instantiateDataStore" | "createDataStore"
+		>,
+	) {
+		super();
+		this.type = factory.type;
+		if (factory.createDataStore !== undefined) {
+			this.createDataStore = factory.createDataStore.bind(factory);
+		}
+	}
+
+	public async instantiateDataStore(
+		context: IFluidDataStoreContext,
+		existing: boolean,
+	): Promise<IFluidDataStoreChannel> {
+		return this.factory.instantiateDataStore(context, existing);
+	}
+
+	public get IFluidDataStoreFactory(): IFluidDataStoreFactory {
+		return this;
+	}
+
+	public async adapt(value: Promise<DataStoreKind>): Promise<DataStoreKind<T>> {
+		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 abstract class ServiceContainerBase<TData, TOptions = unknown>
+	extends ErasedTypeImplementation<FluidContainerWithService<TData>>
+	implements FluidContainerWithService<TData>
+{
+	/**
+	 * True if an attempt to attach has been started. This is used to prevent multiple concurrent attach attempts.
+	 */
+	private startedAttach = false;
+
+	protected constructor(
+		public readonly registry: Registry<Promise<DataStoreKind<TData>>>,
+		public readonly options: TOptions,
+		public readonly container: IContainer,
+		public readonly data: TData,
+		public id: string | undefined,
+	) {
+		super();
+	}
+
+	/**
+	 * 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 {
+		if (this.container.resolvedUrl === undefined) {
+			throw new Error("Resolved URL unexpectedly missing!");
+		}
+		return this.container.resolvedUrl.id;
+	}
+
+	public async attach(): Promise<FluidContainerAttached<TData>> {
+		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 as AttachState),
+			0xd16 /* Container failed to attach */,
+		);
+		this.id = this.getContainerId();
+		return this as typeof this & { id: string };
+	}
+
+	public get audience(): IAudience {
+		return this.container.audience;
+	}
+
+	public getRuntime(): IContainerRuntimeBase {
+		// The runtime is not part of the public IContainer surface, so it is reached via a structural cast.
+		// This relies on an implementation detail of the containers produced by the loader
+		// (createDetachedContainer / loadExistingContainer): they carry a `runtime` property.
+		// The undefined guard below turns an incompatible container implementation into a clear error
+		// instead of a confusing failure later when the missing runtime is used.
+		// This is extra risky since IContainer is not marked sealed.
+		// TODO: Replace this with a supported, type-safe accessor once the loader exposes one.
+		interface IContainerWithRuntime extends IContainer {
+			readonly runtime?: IContainerRuntimeBase;
+		}
+
+		const container = this.container as IContainerWithRuntime;
+		if (container.runtime === undefined) {
+			throw new Error(
+				"Container does not expose a runtime: incompatible container implementation.",
+			);
+		}
+		return container.runtime;
+	}
+
+	public close(): void {
+		// 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();
+	}
+
+	public async createDataStore<T>(key: DataStoreKey<T>): Promise<T> {
+		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 as 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 function getContainerAudience(container: FluidContainerAttached): Audience {
+	ServiceContainerBase.narrow(container);
+	return container.audience;
+}