@fluidframework/shared-object-base 2.113.0-411909 → 2.114.0

package/CHANGELOG.md

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

package/dist/dataStoreKind.d.ts

@@ -0,0 +1,118 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IFluidLoadable } from "@fluidframework/core-interfaces";
+import { type Registry, type DataStoreKind } from "@fluidframework/driver-definitions/internal";
+import type { SharedObjectKey, SharedObjectKindAlpha } from "./sharedObject.js";
+/**
+ * This file provides the implementation of {@link @fluidframework/driver-definitions#DataStoreKind}
+ * and is therefore a key part of the implementation of the {@link @fluidframework/driver-definitions#ServiceClient} API surface.
+ *
+ * Note that much of the API surface beyond {@link defineDataStore} could be removed/deduplicated
+ * if the unification noted in the TODOs in {@link SharedObjectRegistry} is implemented.
+ */
+/**
+ * A {@link @fluidframework/driver-definitions#Registry} of shared object kinds that can be created or loaded within a data store.
+ * @remarks
+ * Supports lazy code loading in a limited way (a single lazy load per registry).
+ * @privateRemarks
+ * TODO: The framework provided SharedObjects should be exposed in a way indistinguishable from custom sub-data stores.
+ * This can be done by unifying the DataStoreKind and SharedObjectKindAlpha types.
+ * For now, this would mean having DataStoreKind extend SharedObjectKindAlpha, since we can allow a data store in all places SharedObjects are allowed,
+ * but do not allow SharedObjects at the root.
+ * Fixing this, and allowing shared objects at the root (maybe use a trivial wrapper data store) could simplify things, allowing data stores and Containers to share some types (like how they create detached contents, have registries, have a root etc).
+ *
+ * Part of this unification could be to relax the output from the factories / registries. Allowing the output to be an arbitrary type, which might be a promise, and might not be one could help.
+ * Removal of the IFluidLoadable requirement, and allowing the returned type to expose handles to itself however it wants (or not at all) might be viable and simplify typing and allow for strongly typed handles at creation time at least).
+ * Maybe when Registry(type) gives a promise, it could instead give a factory which outputs a promise wrapped type? The check that the provided creation key is valid for that factory can be deferred until the promise resolves.
+ *
+ * Idea: creation key can have an interface that subsets the factory / SharedObjectKindAlpha / DataStoreKind so they can be used, or some branded key (string, and/or object with stronger identity what knows the type string) can be used.
+ * Have Key interface contain validation function to check that the factory used (or maybe the value produced from it) is valid for that key.
+ * During load, validation would simply check the factory's type string matches the key's type string.
+ * When using SharedObjectKindAlpha or DataStoreKind, validation can check factory object identity against key.
+ *
+ * Goal: Mostly unify container, data store and shared object abstractions.
+ * Maybe unify a bit with service client since it also has a way to create detached things with an initialized root then attach them.
+ * SharedObjects are just built in leaf data stores.
+ *
+ * @input
+ * @alpha
+ */
+export type SharedObjectRegistry = () => Promise<Registry<SharedObjectKindAlpha<IFluidLoadable>>>;
+/**
+ * Creates a {@link SharedObjectRegistry} from an iterable of {@link SharedObjectKindAlpha}s or async getters for them.
+ * @alpha
+ */
+export declare function sharedObjectRegistryFromIterable(entries: Iterable<SharedObjectKindAlpha<IFluidLoadable> | {
+    type: string;
+    kind: () => Promise<SharedObjectKindAlpha<IFluidLoadable>>;
+}>): SharedObjectRegistry;
+/**
+ * Options which define how to construct a particular {@link @fluidframework/driver-definitions#DataStoreKind}.
+ * @remarks
+ * Use {@link defineDataStore} to create a {@link @fluidframework/driver-definitions#DataStoreKind} from these options.
+ * @input
+ * @alpha
+ */
+export interface DataStoreOptions<in out TRoot extends IFluidLoadable, out TOutput> {
+    /**
+     * The type identifier for the data object factory.
+     * @remarks
+     * Persisted identifier which specifies which {@link @fluidframework/driver-definitions#DataStoreKind} to use when loading it.
+     * @privateRemarks
+     * Equivalent to `DataObjectFactoryProps.type`.
+     */
+    readonly type: string;
+    /**
+     * The registry of shared object kinds (including other data stores) that can be loaded or created within this data store.
+     *
+     * TODO: actually allow this to contain data stores.
+     */
+    readonly registry: SharedObjectRegistry;
+    /**
+     * Create the initial content of the data store, and return the root shared object.
+     * @privateRemarks
+     * TODO:
+     * This requires the caller to produce a single root shared object (which is keyed by {@link rootSharedObjectId}).
+     * This should be fine for new code, but code migrated from legacy APIs might need more flexibility.
+     * Such use-cases could be accommodated providing a legacy alternative to `defineDataStore` where `instantiateFirstTime` and `view` directly expose access to named root shared objects.
+     * This should be easy to implement, but is currently not included.
+     */
+    instantiateFirstTime(rootCreator: SharedObjectCreator<TRoot>, context: DataStoreContext): Promise<TRoot>;
+    /**
+     * Construct a view of the data store's root shared object.
+     *
+     * @param root - The root shared object of the data store, created by `instantiateFirstTime` (though possibly created by another client and loaded by this one).
+     * @param context - A {@link DataStoreContext} that can be used to create additional shared objects.
+     */
+    view(root: TRoot, context: DataStoreContext): Promise<TOutput>;
+}
+/**
+ * Creates a {@link @fluidframework/driver-definitions#DataStoreKind} from {@link DataStoreOptions}.
+ * @alpha
+ */
+export declare function defineDataStore<T, TRoot extends IFluidLoadable>(options: DataStoreOptions<TRoot, T>): DataStoreKind<T>;
+/**
+ * Creates instances of SharedObjectKinds.
+ * @privateRemarks
+ * See IFluidContainer.create.
+ * @sealed
+ * @alpha
+ */
+export interface SharedObjectCreator<TConstraint = IFluidLoadable> {
+    /**
+     * Create an instance of `kind`, which must be registered in the registry of the surrounding data store.
+     */
+    createSharedObject<T extends TConstraint>(kind: SharedObjectKey<T>): Promise<T>;
+}
+/**
+ * Contextual information about a data store which is provided when instantiating or loading it.
+ * @privateRemarks
+ * TODO: this can expose more contextual information about the data store as needed.
+ * @sealed
+ * @alpha
+ */
+export interface DataStoreContext extends SharedObjectCreator {
+}
+//# sourceMappingURL=dataStoreKind.d.ts.map

package/dist/dataStoreKind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataStoreKind.d.ts","sourceRoot":"","sources":["../src/dataStoreKind.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAe,MAAM,iCAAiC,CAAC;AAMnF,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,aAAa,EAElB,MAAM,6CAA6C,CAAC;AAQrD,OAAO,KAAK,EAEX,eAAe,EACf,qBAAqB,EACrB,MAAM,mBAAmB,CAAC;AAG3B;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAC/C,QAAQ,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC,CAC/C,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gCAAgC,CAC/C,OAAO,EAAE,QAAQ,CACd,qBAAqB,CAAC,cAAc,CAAC,GACrC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC,CAAA;CAAE,CAC9E,GACC,oBAAoB,CAkBtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,cAAc,EAAE,GAAG,CAAC,OAAO;IACjF;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;IAExC;;;;;;;;OAQG;IACH,oBAAoB,CACnB,WAAW,EAAE,mBAAmB,CAAC,KAAK,CAAC,EACvC,OAAO,EAAE,gBAAgB,GACvB,OAAO,CAAC,KAAK,CAAC,CAAC;IAElB;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,SAAS,cAAc,EAC9D,OAAO,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,GACjC,aAAa,CAAC,CAAC,CAAC,CAUlB;AAsHD;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB,CAAC,WAAW,GAAG,cAAc;IAChE;;OAEG;IACH,kBAAkB,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAChF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;CAAG"}

package/dist/dataStoreKind.js

@@ -0,0 +1,137 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineDataStore = exports.sharedObjectRegistryFromIterable = void 0;
+const internal_1 = require("@fluidframework/datastore/internal");
+const internal_2 = require("@fluidframework/driver-definitions/internal");
+const internal_3 = require("@fluidframework/runtime-utils/internal");
+const internal_4 = require("@fluidframework/telemetry-utils/internal");
+/**
+ * Creates a {@link SharedObjectRegistry} from an iterable of {@link SharedObjectKindAlpha}s or async getters for them.
+ * @alpha
+ */
+function sharedObjectRegistryFromIterable(entries) {
+    return async () => {
+        const map = new Map();
+        for (const entry of entries) {
+            if ("kind" in entry) {
+                map.set(entry.type, await entry.kind());
+            }
+            else {
+                map.set(asSharedObjectKind(entry).getFactory().type, entry);
+            }
+        }
+        return (type) => {
+            const entry = map.get(type);
+            if (entry === undefined) {
+                throw new internal_4.UsageError(`Unknown shared object type: ${type}`);
+            }
+            return entry;
+        };
+    };
+}
+exports.sharedObjectRegistryFromIterable = sharedObjectRegistryFromIterable;
+/**
+ * Creates a {@link @fluidframework/driver-definitions#DataStoreKind} from {@link DataStoreOptions}.
+ * @alpha
+ */
+function defineDataStore(options) {
+    return new internal_3.DataStoreKindImplementation({
+        type: options.type,
+        async instantiateDataStore(context, existing) {
+            return createDataStore(context, existing, options);
+        },
+    });
+}
+exports.defineDataStore = defineDataStore;
+/**
+ * Casts a {@link SharedObjectKindAlpha} to its encapsulated {@link ISharedObjectKind} view.
+ *
+ * @remarks
+ * {@link SharedObjectKindAlpha} is a sealed type,
+ * so we can assume it implements {@link ISharedObjectKind} and down cast to it.
+ */
+function asSharedObjectKind(kind) {
+    const candidate = kind;
+    // Sanity check to help catch misuse since SharedObjectKindAlpha is typed structurally and seems implementable.
+    if (typeof candidate.getFactory !== "function" || typeof candidate.create !== "function") {
+        throw new internal_4.UsageError("Invalid SharedObjectKindAlpha: this type is sealed and may not have custom implementations.");
+    }
+    return candidate;
+}
+function convertRegistry(lookup) {
+    return {
+        get: (type) => {
+            const entry = lookup(type);
+            return asSharedObjectKind(entry).getFactory();
+        },
+    };
+}
+/**
+ * Data stores keep their shared objects inside channels which get names.
+ * This is the name of the channel which we conventionally use for the root shared object of a data store in most cases.
+ * @remarks
+ * There can be other named channels, or the root could use a different name, but we are trying to migrate away from such patterns.
+ * Currently the DataStoreKind pattern used in this file follows and requires this convention,
+ * but we may relax that in the future for interop with legacy data if necessary.
+ */
+const rootSharedObjectId = "root";
+/**
+ * Creates a data store channel.
+ * @param context - The data store context.
+ * @param existing - Whether the data store already exists. When true, this loads it, when false a new one is created.
+ * @param options - The data store options.
+ * @returns A promise that resolves to the created data store channel.
+ * @remarks
+ * Currently this is limited to data stores which have a single named channel,
+ * which must have the {@link rootSharedObjectId} and is attached at creation time.
+ * This limitation may be relaxed in the future.
+ */
+async function createDataStore(context, existing, options) {
+    const sharedObjectRegistry = await options.registry();
+    const runtime = new internal_1.FluidDataStoreRuntime(context, convertRegistry(sharedObjectRegistry), existing, async (runtimeInner) => {
+        const innerContext = {
+            async createSharedObject(key) {
+                const kind = (0, internal_2.lookupInRegistry)(sharedObjectRegistry, key);
+                // Create detached channel.
+                return asSharedObjectKind(kind).create(runtimeInner);
+            },
+        };
+        let createdRoot;
+        const rootCreator = {
+            async createSharedObject(key) {
+                // Create named channel under the root id.
+                // Error if called twice.
+                if (createdRoot !== undefined) {
+                    throw new internal_4.UsageError("Root shared object already created");
+                }
+                const kind = (0, internal_2.lookupInRegistry)(sharedObjectRegistry, key);
+                const result = asSharedObjectKind(kind).create(runtimeInner, rootSharedObjectId);
+                // Every shared object is also an ISharedObject;
+                const rootSharedObject = result;
+                // bind the newly created root so it becomes part of this data store.
+                rootSharedObject.bindToContext();
+                createdRoot = result;
+                return result;
+            },
+        };
+        let root;
+        if (existing) {
+            // getChannel returns the type-erased IChannel; the registered root kind guarantees it is a TRoot.
+            root = (await runtimeInner.getChannel(rootSharedObjectId));
+        }
+        else {
+            root = await options.instantiateFirstTime(rootCreator, innerContext);
+            if (root !== createdRoot) {
+                throw new internal_4.UsageError("instantiateFirstTime did not return root created with rootCreator");
+            }
+        }
+        // view returns the data store's output type; the runtime only needs it as an opaque FluidObject entry point.
+        return (await options.view(root, innerContext));
+    });
+    return runtime;
+}
+//# sourceMappingURL=dataStoreKind.js.map

package/dist/dataStoreKind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataStoreKind.js","sourceRoot":"","sources":["../src/dataStoreKind.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iEAG4C;AAE5C,0EAIqD;AAKrD,qEAAqF;AACrF,uEAAsE;AAgDtE;;;GAGG;AACH,SAAgB,gCAAgC,CAC/C,OAGC;IAED,OAAO,KAAK,IAAI,EAAE;QACjB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAiD,CAAC;QACrE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;gBACrB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACP,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC7D,CAAC;QACF,CAAC;QACD,OAAO,CAAC,IAAY,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,IAAI,qBAAU,CAAC,+BAA+B,IAAI,EAAE,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,KAAK,CAAC;QACd,CAAC,CAAC;IACH,CAAC,CAAC;AACH,CAAC;AAvBD,4EAuBC;AAiDD;;;GAGG;AACH,SAAgB,eAAe,CAC9B,OAAmC;IAEnC,OAAO,IAAI,sCAA2B,CAAI;QACzC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,KAAK,CAAC,oBAAoB,CACzB,OAA+B,EAC/B,QAAiB;YAEjB,OAAO,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;KACD,CAAC,CAAC;AACJ,CAAC;AAZD,0CAYC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAC1B,IAA8B;IAE9B,MAAM,SAAS,GAAG,IAAgD,CAAC;IACnE,+GAA+G;IAC/G,IAAI,OAAO,SAAS,CAAC,UAAU,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC1F,MAAM,IAAI,qBAAU,CACnB,6FAA6F,CAC7F,CAAC;IACH,CAAC;IACD,OAAO,SAAiC,CAAC;AAC1C,CAAC;AAED,SAAS,eAAe,CACvB,MAAuD;IAEvD,OAAO;QACN,GAAG,EAAE,CAAC,IAAY,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/C,CAAC;KACD,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAElC;;;;;;;;;;GAUG;AACH,KAAK,UAAU,eAAe,CAC7B,OAA+B,EAC/B,QAAiB,EACjB,OAAmC;IAEnC,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IACtD,MAAM,OAAO,GAA0B,IAAI,gCAAqB,CAC/D,OAAO,EACP,eAAe,CAAC,oBAAoB,CAAC,EACrC,QAAQ,EACR,KAAK,EAAE,YAAoC,EAAE,EAAE;QAC9C,MAAM,YAAY,GAAqB;YACtC,KAAK,CAAC,kBAAkB,CACvB,GAAwB;gBAExB,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;gBACzD,2BAA2B;gBAC3B,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YACtD,CAAC;SACD,CAAC;QAEF,IAAI,WAA8B,CAAC;QAEnC,MAAM,WAAW,GAA+B;YAC/C,KAAK,CAAC,kBAAkB,CAAmB,GAAwB;gBAClE,0CAA0C;gBAC1C,yBAAyB;gBACzB,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC/B,MAAM,IAAI,qBAAU,CAAC,oCAAoC,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;gBACzD,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;gBAEjF,gDAAgD;gBAChD,MAAM,gBAAgB,GAAG,MAAyC,CAAC;gBACnE,qEAAqE;gBACrE,gBAAgB,CAAC,aAAa,EAAE,CAAC;gBAEjC,WAAW,GAAG,MAAM,CAAC;gBACrB,OAAO,MAAM,CAAC;YACf,CAAC;SACD,CAAC;QAEF,IAAI,IAAuB,CAAC;QAC5B,IAAI,QAAQ,EAAE,CAAC;YACd,kGAAkG;YAClG,IAAI,GAAG,CAAC,MAAM,YAAY,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAA4B,CAAC;QACvF,CAAC;aAAM,CAAC;YACP,IAAI,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YACrE,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC1B,MAAM,IAAI,qBAAU,CACnB,mEAAmE,CACnE,CAAC;YACH,CAAC;QACF,CAAC;QAED,6GAA6G;QAC7G,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAA2B,CAAC;IAC3E,CAAC,CACD,CAAC;IAEF,OAAO,OAAO,CAAC;AAChB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidLoadable, FluidObject } from \"@fluidframework/core-interfaces\";\nimport {\n\ttype ISharedObjectRegistry,\n\tFluidDataStoreRuntime,\n} from \"@fluidframework/datastore/internal\";\nimport type { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions/internal\";\nimport {\n\ttype Registry,\n\ttype DataStoreKind,\n\tlookupInRegistry,\n} from \"@fluidframework/driver-definitions/internal\";\nimport type {\n\tIFluidDataStoreContext,\n\tIFluidDataStoreChannel,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { DataStoreKindImplementation } from \"@fluidframework/runtime-utils/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport type {\n\tISharedObjectKind,\n\tSharedObjectKey,\n\tSharedObjectKindAlpha,\n} from \"./sharedObject.js\";\nimport type { ISharedObject } from \"./types.js\";\n\n/**\n * This file provides the implementation of {@link @fluidframework/driver-definitions#DataStoreKind}\n * and is therefore a key part of the implementation of the {@link @fluidframework/driver-definitions#ServiceClient} API surface.\n *\n * Note that much of the API surface beyond {@link defineDataStore} could be removed/deduplicated\n * if the unification noted in the TODOs in {@link SharedObjectRegistry} is implemented.\n */\n\n/**\n * A {@link @fluidframework/driver-definitions#Registry} of shared object kinds that can be created or loaded within a data store.\n * @remarks\n * Supports lazy code loading in a limited way (a single lazy load per registry).\n * @privateRemarks\n * TODO: The framework provided SharedObjects should be exposed in a way indistinguishable from custom sub-data stores.\n * This can be done by unifying the DataStoreKind and SharedObjectKindAlpha types.\n * For now, this would mean having DataStoreKind extend SharedObjectKindAlpha, since we can allow a data store in all places SharedObjects are allowed,\n * but do not allow SharedObjects at the root.\n * Fixing this, and allowing shared objects at the root (maybe use a trivial wrapper data store) could simplify things, allowing data stores and Containers to share some types (like how they create detached contents, have registries, have a root etc).\n *\n * Part of this unification could be to relax the output from the factories / registries. Allowing the output to be an arbitrary type, which might be a promise, and might not be one could help.\n * Removal of the IFluidLoadable requirement, and allowing the returned type to expose handles to itself however it wants (or not at all) might be viable and simplify typing and allow for strongly typed handles at creation time at least).\n * Maybe when Registry(type) gives a promise, it could instead give a factory which outputs a promise wrapped type? The check that the provided creation key is valid for that factory can be deferred until the promise resolves.\n *\n * Idea: creation key can have an interface that subsets the factory / SharedObjectKindAlpha / DataStoreKind so they can be used, or some branded key (string, and/or object with stronger identity what knows the type string) can be used.\n * Have Key interface contain validation function to check that the factory used (or maybe the value produced from it) is valid for that key.\n * During load, validation would simply check the factory's type string matches the key's type string.\n * When using SharedObjectKindAlpha or DataStoreKind, validation can check factory object identity against key.\n *\n * Goal: Mostly unify container, data store and shared object abstractions.\n * Maybe unify a bit with service client since it also has a way to create detached things with an initialized root then attach them.\n * SharedObjects are just built in leaf data stores.\n *\n * @input\n * @alpha\n */\nexport type SharedObjectRegistry = () => Promise<\n\tRegistry<SharedObjectKindAlpha<IFluidLoadable>>\n>;\n\n/**\n * Creates a {@link SharedObjectRegistry} from an iterable of {@link SharedObjectKindAlpha}s or async getters for them.\n * @alpha\n */\nexport function sharedObjectRegistryFromIterable(\n\tentries: Iterable<\n\t\t| SharedObjectKindAlpha<IFluidLoadable>\n\t\t| { type: string; kind: () => Promise<SharedObjectKindAlpha<IFluidLoadable>> }\n\t>,\n): SharedObjectRegistry {\n\treturn async () => {\n\t\tconst map = new Map<string, SharedObjectKindAlpha<IFluidLoadable>>();\n\t\tfor (const entry of entries) {\n\t\t\tif (\"kind\" in entry) {\n\t\t\t\tmap.set(entry.type, await entry.kind());\n\t\t\t} else {\n\t\t\t\tmap.set(asSharedObjectKind(entry).getFactory().type, entry);\n\t\t\t}\n\t\t}\n\t\treturn (type: string) => {\n\t\t\tconst entry = map.get(type);\n\t\t\tif (entry === undefined) {\n\t\t\t\tthrow new UsageError(`Unknown shared object type: ${type}`);\n\t\t\t}\n\t\t\treturn entry;\n\t\t};\n\t};\n}\n\n/**\n * Options which define how to construct a particular {@link @fluidframework/driver-definitions#DataStoreKind}.\n * @remarks\n * Use {@link defineDataStore} to create a {@link @fluidframework/driver-definitions#DataStoreKind} from these options.\n * @input\n * @alpha\n */\nexport interface DataStoreOptions<in out TRoot extends IFluidLoadable, out TOutput> {\n\t/**\n\t * The type identifier for the data object factory.\n\t * @remarks\n\t * Persisted identifier which specifies which {@link @fluidframework/driver-definitions#DataStoreKind} to use when loading it.\n\t * @privateRemarks\n\t * Equivalent to `DataObjectFactoryProps.type`.\n\t */\n\treadonly type: string;\n\n\t/**\n\t * The registry of shared object kinds (including other data stores) that can be loaded or created within this data store.\n\t *\n\t * TODO: actually allow this to contain data stores.\n\t */\n\treadonly registry: SharedObjectRegistry;\n\n\t/**\n\t * Create the initial content of the data store, and return the root shared object.\n\t * @privateRemarks\n\t * TODO:\n\t * This requires the caller to produce a single root shared object (which is keyed by {@link rootSharedObjectId}).\n\t * This should be fine for new code, but code migrated from legacy APIs might need more flexibility.\n\t * Such use-cases could be accommodated providing a legacy alternative to `defineDataStore` where `instantiateFirstTime` and `view` directly expose access to named root shared objects.\n\t * This should be easy to implement, but is currently not included.\n\t */\n\tinstantiateFirstTime(\n\t\trootCreator: SharedObjectCreator<TRoot>,\n\t\tcontext: DataStoreContext,\n\t): Promise<TRoot>;\n\n\t/**\n\t * Construct a view of the data store's root shared object.\n\t *\n\t * @param root - The root shared object of the data store, created by `instantiateFirstTime` (though possibly created by another client and loaded by this one).\n\t * @param context - A {@link DataStoreContext} that can be used to create additional shared objects.\n\t */\n\tview(root: TRoot, context: DataStoreContext): Promise<TOutput>;\n}\n\n/**\n * Creates a {@link @fluidframework/driver-definitions#DataStoreKind} from {@link DataStoreOptions}.\n * @alpha\n */\nexport function defineDataStore<T, TRoot extends IFluidLoadable>(\n\toptions: DataStoreOptions<TRoot, T>,\n): DataStoreKind<T> {\n\treturn new DataStoreKindImplementation<T>({\n\t\ttype: options.type,\n\t\tasync instantiateDataStore(\n\t\t\tcontext: IFluidDataStoreContext,\n\t\t\texisting: boolean,\n\t\t): Promise<IFluidDataStoreChannel> {\n\t\t\treturn createDataStore(context, existing, options);\n\t\t},\n\t});\n}\n\n/**\n * Casts a {@link SharedObjectKindAlpha} to its encapsulated {@link ISharedObjectKind} view.\n *\n * @remarks\n * {@link SharedObjectKindAlpha} is a sealed type,\n * so we can assume it implements {@link ISharedObjectKind} and down cast to it.\n */\nfunction asSharedObjectKind<T extends IFluidLoadable>(\n\tkind: SharedObjectKindAlpha<T>,\n): ISharedObjectKind<T> {\n\tconst candidate = kind as unknown as Partial<ISharedObjectKind<T>>;\n\t// Sanity check to help catch misuse since SharedObjectKindAlpha is typed structurally and seems implementable.\n\tif (typeof candidate.getFactory !== \"function\" || typeof candidate.create !== \"function\") {\n\t\tthrow new UsageError(\n\t\t\t\"Invalid SharedObjectKindAlpha: this type is sealed and may not have custom implementations.\",\n\t\t);\n\t}\n\treturn candidate as ISharedObjectKind<T>;\n}\n\nfunction convertRegistry(\n\tlookup: Registry<SharedObjectKindAlpha<IFluidLoadable>>,\n): ISharedObjectRegistry {\n\treturn {\n\t\tget: (type: string) => {\n\t\t\tconst entry = lookup(type);\n\t\t\treturn asSharedObjectKind(entry).getFactory();\n\t\t},\n\t};\n}\n\n/**\n * Data stores keep their shared objects inside channels which get names.\n * This is the name of the channel which we conventionally use for the root shared object of a data store in most cases.\n * @remarks\n * There can be other named channels, or the root could use a different name, but we are trying to migrate away from such patterns.\n * Currently the DataStoreKind pattern used in this file follows and requires this convention,\n * but we may relax that in the future for interop with legacy data if necessary.\n */\nconst rootSharedObjectId = \"root\";\n\n/**\n * Creates a data store channel.\n * @param context - The data store context.\n * @param existing - Whether the data store already exists. When true, this loads it, when false a new one is created.\n * @param options - The data store options.\n * @returns A promise that resolves to the created data store channel.\n * @remarks\n * Currently this is limited to data stores which have a single named channel,\n * which must have the {@link rootSharedObjectId} and is attached at creation time.\n * This limitation may be relaxed in the future.\n */\nasync function createDataStore<T, TRoot extends IFluidLoadable>(\n\tcontext: IFluidDataStoreContext,\n\texisting: boolean,\n\toptions: DataStoreOptions<TRoot, T>,\n): Promise<IFluidDataStoreChannel> {\n\tconst sharedObjectRegistry = await options.registry();\n\tconst runtime: FluidDataStoreRuntime = new FluidDataStoreRuntime(\n\t\tcontext,\n\t\tconvertRegistry(sharedObjectRegistry),\n\t\texisting,\n\t\tasync (runtimeInner: IFluidDataStoreRuntime) => {\n\t\t\tconst innerContext: DataStoreContext = {\n\t\t\t\tasync createSharedObject<T2 extends IFluidLoadable>(\n\t\t\t\t\tkey: SharedObjectKey<T2>,\n\t\t\t\t): Promise<T2> {\n\t\t\t\t\tconst kind = lookupInRegistry(sharedObjectRegistry, key);\n\t\t\t\t\t// Create detached channel.\n\t\t\t\t\treturn asSharedObjectKind(kind).create(runtimeInner);\n\t\t\t\t},\n\t\t\t};\n\n\t\t\tlet createdRoot: TRoot | undefined;\n\n\t\t\tconst rootCreator: SharedObjectCreator<TRoot> = {\n\t\t\t\tasync createSharedObject<T2 extends TRoot>(key: SharedObjectKey<T2>): Promise<T2> {\n\t\t\t\t\t// Create named channel under the root id.\n\t\t\t\t\t// Error if called twice.\n\t\t\t\t\tif (createdRoot !== undefined) {\n\t\t\t\t\t\tthrow new UsageError(\"Root shared object already created\");\n\t\t\t\t\t}\n\t\t\t\t\tconst kind = lookupInRegistry(sharedObjectRegistry, key);\n\t\t\t\t\tconst result = asSharedObjectKind(kind).create(runtimeInner, rootSharedObjectId);\n\n\t\t\t\t\t// Every shared object is also an ISharedObject;\n\t\t\t\t\tconst rootSharedObject = result as IFluidLoadable as ISharedObject;\n\t\t\t\t\t// bind the newly created root so it becomes part of this data store.\n\t\t\t\t\trootSharedObject.bindToContext();\n\n\t\t\t\t\tcreatedRoot = result;\n\t\t\t\t\treturn result;\n\t\t\t\t},\n\t\t\t};\n\n\t\t\tlet root: TRoot | undefined;\n\t\t\tif (existing) {\n\t\t\t\t// getChannel returns the type-erased IChannel; the registered root kind guarantees it is a TRoot.\n\t\t\t\troot = (await runtimeInner.getChannel(rootSharedObjectId)) as IFluidLoadable as TRoot;\n\t\t\t} else {\n\t\t\t\troot = await options.instantiateFirstTime(rootCreator, innerContext);\n\t\t\t\tif (root !== createdRoot) {\n\t\t\t\t\tthrow new UsageError(\n\t\t\t\t\t\t\"instantiateFirstTime did not return root created with rootCreator\",\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// view returns the data store's output type; the runtime only needs it as an opaque FluidObject entry point.\n\t\t\treturn (await options.view(root, innerContext)) as unknown as FluidObject;\n\t\t},\n\t);\n\n\treturn runtime;\n}\n\n/**\n * Creates instances of SharedObjectKinds.\n * @privateRemarks\n * See IFluidContainer.create.\n * @sealed\n * @alpha\n */\nexport interface SharedObjectCreator<TConstraint = IFluidLoadable> {\n\t/**\n\t * Create an instance of `kind`, which must be registered in the registry of the surrounding data store.\n\t */\n\tcreateSharedObject<T extends TConstraint>(kind: SharedObjectKey<T>): Promise<T>;\n}\n\n/**\n * Contextual information about a data store which is provided when instantiating or loading it.\n * @privateRemarks\n * TODO: this can expose more contextual information about the data store as needed.\n * @sealed\n * @alpha\n */\nexport interface DataStoreContext extends SharedObjectCreator {}\n"]}

package/dist/index.d.ts

@@ -4,9 +4,12 @@
  */
 export { type ISharedObjectHandle, isISharedObjectHandle } from "./handle.js";
 export { FluidSerializer, type IFluidSerializer } from "./serializer.js";
-export { SharedObject, SharedObjectCore, type ISharedObjectKind, type SharedObjectKind, createSharedObjectKind, } from "./sharedObject.js";
+export { SharedObject, SharedObjectCore, type ISharedObjectKind, type SharedObjectKind, type SharedObjectKindAlpha, createSharedObjectKind, createSharedObjectKindAlpha, type SharedObjectKey, } from "./sharedObject.js";
 export type { ISharedObject, ISharedObjectEvents } from "./types.js";
 export { createSingleBlobSummary, makeHandlesSerializable, parseHandles, serializeHandles, bindHandles, type IChannelView, } from "./utils.js";
 export { ValueType } from "./valueType.js";
 export { type SharedKernel, thisWrap, type KernelArgs, makeSharedObjectKind, type SharedKernelFactory, type FactoryOut, type SharedObjectOptions, mergeAPIs, } from "./sharedObjectKernel.js";
+export { defineDataStore, sharedObjectRegistryFromIterable } from "./dataStoreKind.js";
+export { makeStubDataStoreKind } from "./stubSharedObject.js";
+export type { DataStoreOptions, SharedObjectCreator, SharedObjectRegistry, DataStoreContext, } from "./dataStoreKind.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EACN,YAAY,EACZ,gBAAgB,EAChB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,sBAAsB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EACN,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,gBAAgB,EAChB,WAAW,EACX,KAAK,YAAY,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACN,KAAK,YAAY,EACjB,QAAQ,EACR,KAAK,UAAU,EACf,oBAAoB,EACpB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,SAAS,GACT,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EACN,YAAY,EACZ,gBAAgB,EAChB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,sBAAsB,EACtB,2BAA2B,EAC3B,KAAK,eAAe,GACpB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EACN,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,gBAAgB,EAChB,WAAW,EACX,KAAK,YAAY,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACN,KAAK,YAAY,EACjB,QAAQ,EACR,KAAK,UAAU,EACf,oBAAoB,EACpB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,SAAS,GACT,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,YAAY,EACX,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,GAChB,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeAPIs = exports.makeSharedObjectKind = exports.thisWrap = exports.ValueType = exports.bindHandles = exports.serializeHandles = exports.parseHandles = exports.makeHandlesSerializable = exports.createSingleBlobSummary = exports.createSharedObjectKind = exports.SharedObjectCore = exports.SharedObject = exports.FluidSerializer = exports.isISharedObjectHandle = void 0;
+exports.makeStubDataStoreKind = exports.sharedObjectRegistryFromIterable = exports.defineDataStore = exports.mergeAPIs = exports.makeSharedObjectKind = exports.thisWrap = exports.ValueType = exports.bindHandles = exports.serializeHandles = exports.parseHandles = exports.makeHandlesSerializable = exports.createSingleBlobSummary = exports.createSharedObjectKindAlpha = exports.createSharedObjectKind = exports.SharedObjectCore = exports.SharedObject = exports.FluidSerializer = exports.isISharedObjectHandle = void 0;
 var handle_js_1 = require("./handle.js");
 Object.defineProperty(exports, "isISharedObjectHandle", { enumerable: true, get: function () { return handle_js_1.isISharedObjectHandle; } });
 var serializer_js_1 = require("./serializer.js");
@@ -13,6 +13,7 @@ var sharedObject_js_1 = require("./sharedObject.js");
 Object.defineProperty(exports, "SharedObject", { enumerable: true, get: function () { return sharedObject_js_1.SharedObject; } });
 Object.defineProperty(exports, "SharedObjectCore", { enumerable: true, get: function () { return sharedObject_js_1.SharedObjectCore; } });
 Object.defineProperty(exports, "createSharedObjectKind", { enumerable: true, get: function () { return sharedObject_js_1.createSharedObjectKind; } });
+Object.defineProperty(exports, "createSharedObjectKindAlpha", { enumerable: true, get: function () { return sharedObject_js_1.createSharedObjectKindAlpha; } });
 var utils_js_1 = require("./utils.js");
 Object.defineProperty(exports, "createSingleBlobSummary", { enumerable: true, get: function () { return utils_js_1.createSingleBlobSummary; } });
 Object.defineProperty(exports, "makeHandlesSerializable", { enumerable: true, get: function () { return utils_js_1.makeHandlesSerializable; } });
@@ -25,4 +26,9 @@ var sharedObjectKernel_js_1 = require("./sharedObjectKernel.js");
 Object.defineProperty(exports, "thisWrap", { enumerable: true, get: function () { return sharedObjectKernel_js_1.thisWrap; } });
 Object.defineProperty(exports, "makeSharedObjectKind", { enumerable: true, get: function () { return sharedObjectKernel_js_1.makeSharedObjectKind; } });
 Object.defineProperty(exports, "mergeAPIs", { enumerable: true, get: function () { return sharedObjectKernel_js_1.mergeAPIs; } });
+var dataStoreKind_js_1 = require("./dataStoreKind.js");
+Object.defineProperty(exports, "defineDataStore", { enumerable: true, get: function () { return dataStoreKind_js_1.defineDataStore; } });
+Object.defineProperty(exports, "sharedObjectRegistryFromIterable", { enumerable: true, get: function () { return dataStoreKind_js_1.sharedObjectRegistryFromIterable; } });
+var stubSharedObject_js_1 = require("./stubSharedObject.js");
+Object.defineProperty(exports, "makeStubDataStoreKind", { enumerable: true, get: function () { return stubSharedObject_js_1.makeStubDataStoreKind; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yCAA8E;AAA3C,kHAAA,qBAAqB,OAAA;AACxD,iDAAyE;AAAhE,gHAAA,eAAe,OAAA;AACxB,qDAM2B;AAL1B,+GAAA,YAAY,OAAA;AACZ,mHAAA,gBAAgB,OAAA;AAGhB,yHAAA,sBAAsB,OAAA;AAGvB,uCAOoB;AANnB,mHAAA,uBAAuB,OAAA;AACvB,mHAAA,uBAAuB,OAAA;AACvB,wGAAA,YAAY,OAAA;AACZ,4GAAA,gBAAgB,OAAA;AAChB,uGAAA,WAAW,OAAA;AAGZ,+CAA2C;AAAlC,yGAAA,SAAS,OAAA;AAClB,iEASiC;AAPhC,iHAAA,QAAQ,OAAA;AAER,6HAAA,oBAAoB,OAAA;AAIpB,kHAAA,SAAS,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { type ISharedObjectHandle, isISharedObjectHandle } from \"./handle.js\";\nexport { FluidSerializer, type IFluidSerializer } from \"./serializer.js\";\nexport {\n\tSharedObject,\n\tSharedObjectCore,\n\ttype ISharedObjectKind,\n\ttype SharedObjectKind,\n\tcreateSharedObjectKind,\n} from \"./sharedObject.js\";\nexport type { ISharedObject, ISharedObjectEvents } from \"./types.js\";\nexport {\n\tcreateSingleBlobSummary,\n\tmakeHandlesSerializable,\n\tparseHandles,\n\tserializeHandles,\n\tbindHandles,\n\ttype IChannelView,\n} from \"./utils.js\";\nexport { ValueType } from \"./valueType.js\";\nexport {\n\ttype SharedKernel,\n\tthisWrap,\n\ttype KernelArgs,\n\tmakeSharedObjectKind,\n\ttype SharedKernelFactory,\n\ttype FactoryOut,\n\ttype SharedObjectOptions,\n\tmergeAPIs,\n} from \"./sharedObjectKernel.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yCAA8E;AAA3C,kHAAA,qBAAqB,OAAA;AACxD,iDAAyE;AAAhE,gHAAA,eAAe,OAAA;AACxB,qDAS2B;AAR1B,+GAAA,YAAY,OAAA;AACZ,mHAAA,gBAAgB,OAAA;AAIhB,yHAAA,sBAAsB,OAAA;AACtB,8HAAA,2BAA2B,OAAA;AAI5B,uCAOoB;AANnB,mHAAA,uBAAuB,OAAA;AACvB,mHAAA,uBAAuB,OAAA;AACvB,wGAAA,YAAY,OAAA;AACZ,4GAAA,gBAAgB,OAAA;AAChB,uGAAA,WAAW,OAAA;AAGZ,+CAA2C;AAAlC,yGAAA,SAAS,OAAA;AAClB,iEASiC;AAPhC,iHAAA,QAAQ,OAAA;AAER,6HAAA,oBAAoB,OAAA;AAIpB,kHAAA,SAAS,OAAA;AAEV,uDAAuF;AAA9E,mHAAA,eAAe,OAAA;AAAE,oIAAA,gCAAgC,OAAA;AAC1D,6DAA8D;AAArD,4HAAA,qBAAqB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { type ISharedObjectHandle, isISharedObjectHandle } from \"./handle.js\";\nexport { FluidSerializer, type IFluidSerializer } from \"./serializer.js\";\nexport {\n\tSharedObject,\n\tSharedObjectCore,\n\ttype ISharedObjectKind,\n\ttype SharedObjectKind,\n\ttype SharedObjectKindAlpha,\n\tcreateSharedObjectKind,\n\tcreateSharedObjectKindAlpha,\n\ttype SharedObjectKey,\n} from \"./sharedObject.js\";\nexport type { ISharedObject, ISharedObjectEvents } from \"./types.js\";\nexport {\n\tcreateSingleBlobSummary,\n\tmakeHandlesSerializable,\n\tparseHandles,\n\tserializeHandles,\n\tbindHandles,\n\ttype IChannelView,\n} from \"./utils.js\";\nexport { ValueType } from \"./valueType.js\";\nexport {\n\ttype SharedKernel,\n\tthisWrap,\n\ttype KernelArgs,\n\tmakeSharedObjectKind,\n\ttype SharedKernelFactory,\n\ttype FactoryOut,\n\ttype SharedObjectOptions,\n\tmergeAPIs,\n} from \"./sharedObjectKernel.js\";\nexport { defineDataStore, sharedObjectRegistryFromIterable } from \"./dataStoreKind.js\";\nexport { makeStubDataStoreKind } from \"./stubSharedObject.js\";\nexport type {\n\tDataStoreOptions,\n\tSharedObjectCreator,\n\tSharedObjectRegistry,\n\tDataStoreContext,\n} from \"./dataStoreKind.js\";\n"]}

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.d.ts.map

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

package/dist/packageVersion.js

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

package/dist/packageVersion.js.map

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

package/dist/sharedObject.d.ts

@@ -7,7 +7,7 @@ import type { IDeltaManager } from "@fluidframework/container-definitions/intern
 import type { ErasedType } from "@fluidframework/core-interfaces";
 import type { IFluidHandleInternal, IFluidLoadable } from "@fluidframework/core-interfaces/internal";
 import type { IChannelServices, IChannelStorageService, IChannelAttributes, IChannelFactory, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions/internal";
-import type { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { IDocumentMessage, ISequencedDocumentMessage, RegistryKey } from "@fluidframework/driver-definitions/internal";
 import { type IExperimentalIncrementalSummaryContext, type ISummaryTreeWithStats, type ITelemetryContext, type IGarbageCollectionData, type IRuntimeMessageCollection } from "@fluidframework/runtime-definitions/internal";
 import { EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils/internal";
 import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/legacy";
@@ -431,6 +431,28 @@ export interface SharedObjectKind<out TSharedObject = unknown> extends ErasedTyp
      */
     is(value: IFluidLoadable): value is IFluidLoadable & TSharedObject;
 }
+/**
+ * A {@link @fluidframework/driver-definitions#RegistryKey} for a {@link SharedObjectKind}.
+ * @remarks
+ * This is implemented by {@link SharedObjectKind}, but alternative implementations can be used if needed.
+ *
+ * If you want lazy loading and need a key that does not eagerly load the {@link SharedObjectKind}, an alternative {@link SharedObjectKey} can be implemented.
+ * @privateRemarks
+ * TODO: A built in common pattern for the lazy key case should be provided.
+ * TODO: things probably break if "adapt" does anything except throw or return the result from the input promise.
+ * @input
+ * @alpha
+ */
+export type SharedObjectKey<T> = RegistryKey<SharedObjectKindAlpha<T>, SharedObjectKindAlpha>;
+/**
+ * A {@link SharedObjectKind} that also implements {@link SharedObjectKey}.
+ * @privateRemarks
+ * All concrete shared object kinds (produced by {@link createSharedObjectKind}) implement this interface.
+ * @sealed
+ * @alpha
+ */
+export interface SharedObjectKindAlpha<out TSharedObject = unknown> extends SharedObjectKind<TSharedObject>, SharedObjectKey<TSharedObject> {
+}
 /**
  * Utility for creating ISharedObjectKind instances.
  * @remarks
@@ -443,4 +465,16 @@ export interface SharedObjectKind<out TSharedObject = unknown> extends ErasedTyp
 export declare function createSharedObjectKind<TSharedObject>(factory: (new () => IChannelFactory<TSharedObject>) & {
     readonly Type: string;
 }): ISharedObjectKind<TSharedObject> & SharedObjectKind<TSharedObject>;
+/**
+ * Utility for creating ISharedObjectKind instances.
+ * @remarks
+ * This takes in a class which implements IChannelFactory,
+ * and uses it to return a single value which is intended to be used as the API entry point for the corresponding shared object type.
+ * The returned value implements {@link ISharedObjectKind} for use in the encapsulated API, as well as the type erased {@link SharedObjectKind} used by the declarative API.
+ * See {@link @fluidframework/fluid-static#ContainerSchema} for how this is used in the declarative API.
+ * @internal
+ */
+export declare function createSharedObjectKindAlpha<TSharedObject>(factory: (new () => IChannelFactory<TSharedObject>) & {
+    readonly Type: string;
+}): ISharedObjectKind<TSharedObject> & SharedObjectKindAlpha<TSharedObject>;
 //# sourceMappingURL=sharedObject.d.ts.map

package/dist/sharedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EAA4B,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,KAAK,EACX,oBAAoB,EACpB,cAAc,EACd,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EACX,gBAAgB,EAChB,sBAAsB,EAEtB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EAGtB,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EACX,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,KAAK,sCAAsC,EAC3C,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAG3B,KAAK,yBAAyB,EAE9B,MAAM,8CAA8C,CAAC;AAKtD,OAAO,EAEN,6BAA6B,EAU7B,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAKlF,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAYrE;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,gBAAgB,CACpC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAEzD,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAoD/B;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,sBAAsB;IACzC;;OAEG;aACa,UAAU,EAAE,kBAAkB;IA7D/C,IAAW,cAAc,IAAI,IAAI,CAEhC;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAGjC;IACF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkC;IAElE;;OAEG;IACH,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;;IAGA;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACO,OAAO,EAAE,sBAAsB;IACzC;;OAEG;IACa,UAAU,EAAE,kBAAkB;IA6B/C;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAEvF;IAED;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAuCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAOtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,uBAAuB;IAmB/B;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAY5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAWhD;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,yBAAyB,GAAG,IAAI;IAE3F;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,gBAAgB,CAAC;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAiB1F;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIxE;;;;;;OAMG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAc5E;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAqBb,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA2B1B;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,eAAe;IAgDvB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ;IAQhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIpE;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAEzD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAOlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,gBAAgB;CAMxB;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IA8BhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAhCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;gBAGA,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAC9B;;OAEG;IACc,sBAAsB,EAAE,MAAM;IAOhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAoBxB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAoBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA0BjE;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAO/D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,EAClE,QAAQ,CAAC,EAAE,OAAO,GAChB,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAmBhC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iBAAiB,CAAC,aAAa;IAC/C;;;;;;;;;OASG;IACH,UAAU,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAE7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CACpE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAC5D,SAAQ,UAAU,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IAChE;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,cAAc,GAAG,aAAa,CAAC;CACnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EACnD,OAAO,EAAE,CAAC,UAAU,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E,iBAAiB,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAiBpE"}
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EAA4B,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,KAAK,EACX,oBAAoB,EACpB,cAAc,EACd,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EACX,gBAAgB,EAChB,sBAAsB,EAEtB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EAGtB,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EACX,gBAAgB,EAChB,yBAAyB,EACzB,WAAW,EACX,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,KAAK,sCAAsC,EAC3C,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAG3B,KAAK,yBAAyB,EAE9B,MAAM,8CAA8C,CAAC;AAKtD,OAAO,EAEN,6BAA6B,EAW7B,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAKlF,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAYrE;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,gBAAgB,CACpC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAEzD,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAoD/B;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,sBAAsB;IACzC;;OAEG;aACa,UAAU,EAAE,kBAAkB;IA7D/C,IAAW,cAAc,IAAI,IAAI,CAEhC;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAGjC;IACF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkC;IAElE;;OAEG;IACH,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;;IAGA;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACO,OAAO,EAAE,sBAAsB;IACzC;;OAEG;IACa,UAAU,EAAE,kBAAkB;IA6B/C;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAEvF;IAED;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAuCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAOtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,uBAAuB;IAmB/B;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAY5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAWhD;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,yBAAyB,GAAG,IAAI;IAE3F;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,gBAAgB,CAAC;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAiB1F;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIxE;;;;;;OAMG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAc5E;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAqBb,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA2B1B;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,eAAe;IAgDvB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ;IAQhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIpE;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAEzD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAOlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,gBAAgB;CAMxB;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IA8BhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAhCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;gBAGA,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAC9B;;OAEG;IACc,sBAAsB,EAAE,MAAM;IAOhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAoBxB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAoBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA0BjE;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAO/D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,EAClE,QAAQ,CAAC,EAAE,OAAO,GAChB,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAmBhC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iBAAiB,CAAC,aAAa;IAC/C;;;;;;;;;OASG;IACH,UAAU,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAE7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CACpE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAC5D,SAAQ,UAAU,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IAChE;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,cAAc,GAAG,aAAa,CAAC;CACnE;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAE9F;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CACjE,SAAQ,gBAAgB,CAAC,aAAa,CAAC,EACtC,eAAe,CAAC,aAAa,CAAC;CAAG;AAEnC;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EACnD,OAAO,EAAE,CAAC,UAAU,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E,iBAAiB,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAEpE;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EACxD,OAAO,EAAE,CAAC,UAAU,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E,iBAAiB,CAAC,aAAa,CAAC,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAiCzE"}

package/dist/sharedObject.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSharedObjectKind = exports.SharedObject = exports.SharedObjectCore = void 0;
+exports.createSharedObjectKindAlpha = exports.createSharedObjectKind = exports.SharedObject = exports.SharedObjectCore = void 0;
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/core-utils/internal");
 const internal_2 = require("@fluidframework/runtime-definitions/internal");
@@ -594,6 +594,19 @@ exports.SharedObject = SharedObject;
  * @internal
  */
 function createSharedObjectKind(factory) {
+    return createSharedObjectKindAlpha(factory);
+}
+exports.createSharedObjectKind = createSharedObjectKind;
+/**
+ * Utility for creating ISharedObjectKind instances.
+ * @remarks
+ * This takes in a class which implements IChannelFactory,
+ * and uses it to return a single value which is intended to be used as the API entry point for the corresponding shared object type.
+ * The returned value implements {@link ISharedObjectKind} for use in the encapsulated API, as well as the type erased {@link SharedObjectKind} used by the declarative API.
+ * See {@link @fluidframework/fluid-static#ContainerSchema} for how this is used in the declarative API.
+ * @internal
+ */
+function createSharedObjectKindAlpha(factory) {
     const result = {
         getFactory() {
             return new factory();
@@ -604,10 +617,21 @@ function createSharedObjectKind(factory) {
         is(value) {
             return isChannel(value) && value.attributes.type === factory.Type;
         },
+        type: factory.Type,
+        adapt: (value) => {
+            if (value === resultFinal) {
+                return resultFinal;
+            }
+            if (value.type === result.type) {
+                throw new internal_4.UsageError(`Conflicting SharedObjectKinds with same type: ${result.type}`);
+            }
+            throw new internal_4.UsageError(`Mismatched SharedObjectKind type. Expected: ${result.type}, got: ${value.type}`);
+        },
     };
-    return result;
+    const resultFinal = result;
+    return resultFinal;
 }
-exports.createSharedObjectKind = createSharedObjectKind;
+exports.createSharedObjectKindAlpha = createSharedObjectKindAlpha;
 function isChannel(loadable) {
     // This assumes no other IFluidLoadable has an `attributes` field, and thus may not be fully robust.
     return loadable.attributes !== undefined;