@microsoft/live-share-react 1.3.1-preview.0 → 1.4.1-preview.0

package/bin/cjs/shared-hooks/internals/tree-node-utils.js

@@ -0,0 +1,193 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildProxy = buildProxy;
+exports.setUpListenersForNodeChildren = setUpListenersForNodeChildren;
+exports.getRawNode = getRawNode;
+const tree_node_constants_js_1 = require("./tree-node-constants.js");
+const tree_node_types_js_1 = require("./tree-node-types.js");
+const fluid_framework_1 = require("fluid-framework");
+// Exported utils
+/**
+ * @internal
+ * Build a proxied version of a node and set its value to the treeMap provided
+ *
+ * @param rawNode the raw proxy node exposed by Fluid
+ * @param treeMap a map where Fluid's proxy node is mapped to our proxied node
+ * @returns TNode instance
+ */
+function buildProxy(rawNode, treeMap) {
+    var _a;
+    const previousProxy = treeMap.get(rawNode);
+    const previousProxyHandler = previousProxy
+        ? getCustomProxyHandler(previousProxy)
+        : undefined;
+    const proxyHandler = {
+        // Add some extra stuff into the handler so we can store the original Fluid TreeNode and access it later
+        // Without overriding the rest of the getters in the object.
+        [tree_node_constants_js_1.rawTNodeKey]: rawNode,
+        [tree_node_constants_js_1.proxiedChildrenKey]: (_a = previousProxyHandler === null || previousProxyHandler === void 0 ? void 0 : previousProxyHandler[tree_node_constants_js_1.proxiedChildrenKey]) !== null && _a !== void 0 ? _a : {},
+        get: (target, prop, _) => {
+            if (prop === "[[Handler]]") {
+                return proxyHandler;
+            }
+            if (typeof prop === "string" &&
+                proxyHandler[tree_node_constants_js_1.proxiedChildrenKey][prop]) {
+                return proxyHandler[tree_node_constants_js_1.proxiedChildrenKey][prop];
+            }
+            // pass in the rawNode so Fluid doesn't get confused by our proxy object and can find the flex node
+            const value = Reflect.get(target, prop, rawNode);
+            return typeof value === "function" &&
+                typeof prop === "string" &&
+                // TODO: need a better way of identifying which types of functions need to be proxied
+                // This is because if a developer uses an array prototype function, we need to return proxied
+                // objects so React can detect changes to those nodes...
+                !["map", "flatMap", "filter", "find", "indexOf"].includes(prop)
+                ? value.bind(rawNode)
+                : value;
+        },
+        set(target, p, newValue, _) {
+            return Reflect.set(target, p, newValue, rawNode);
+        },
+    };
+    const proxy = new Proxy(rawNode, proxyHandler);
+    // Track the proxy for the rawNode
+    treeMap.set(rawNode, proxy);
+    // Set raw node getter so we can access it before things like Tree.on
+    return proxy;
+}
+/**
+ * @internal
+ * Set up listeners for a given TreeNode.
+ * Will recursively call this function for all children nodes of each children until there are no more child nodes.
+ *
+ * @param parentRawNode raw parent node
+ * @param rootNodeForListener root node being listened to in useTreeNode
+ * @param treeMap a map where Fluid's proxy node is mapped to our proxied node
+ * @param unsubscribeListeners list of unsubscribe listeners, where we set the unsubscribe callbacks
+ * @param setProxyNode setter to set the root proxy node listened to in useTreeNode
+ */
+function setUpListenersForNodeChildren(parentRawNode, rootNodeForListener, treeMap, unsubscribeListeners, setProxyNode) {
+    let entries = Object.entries(parentRawNode);
+    for (let i = 0; i < entries.length; i++) {
+        const [key, entry] = entries[i];
+        if (!entry ||
+            ["string", "boolean", "number", "function"].includes(typeof entry) ||
+            !(0, tree_node_types_js_1.isTreeNode)(entry)) {
+            continue;
+        }
+        const rawEntry = getRawNode(entry);
+        const onNodeChanged = () => {
+            onTreeNodeChanged(key, rawEntry, rootNodeForListener, treeMap, setProxyNode);
+        };
+        const unsubscribe = fluid_framework_1.Tree.on(rawEntry, "nodeChanged", onNodeChanged);
+        unsubscribeListeners.push(unsubscribe);
+        // Recursively listen to children nodes of this node
+        setUpListenersForNodeChildren(rawEntry, rootNodeForListener, treeMap, unsubscribeListeners, setProxyNode);
+    }
+}
+/**
+ * @internal
+ * Fluid only knows how to work with their proxied version of a TreeNode.
+ * We store a reference to that node in our proxied instances so we can easily use it when working with Fluid APIs.
+ *
+ * @param node get the raw node from the proxy
+ * @returns the raw proxied node that Fluid expects
+ */
+function getRawNode(node) {
+    if ((0, tree_node_types_js_1.isProxy)(node)) {
+        return getRawNodeFromProxy(node);
+    }
+    return node;
+}
+// Non public utils
+/**
+ * Callback for when a tree node changed
+ *
+ * @param key key where the object is stored in the parent
+ * @param rawNode the raw node that changed
+ * @param rootNodeForListener the root node that is being listened to in useTreeNode
+ * @param treeMap a map where Fluid's proxy node is mapped to our proxied node
+ * @param setProxyNode setter to set the root proxy node listened to in useTreeNode
+ */
+function onTreeNodeChanged(key, rawNode, rootNodeForListener, treeMap, setProxyNode) {
+    const proxyNode = buildProxy(rawNode, treeMap);
+    const parent = fluid_framework_1.Tree.parent(rawNode);
+    if (!parent) {
+        throw new Error("useTreeNode onTreeNodeChanged: no parent found for rawParentNode");
+    }
+    proxyParentForNode(key, parent, proxyNode, rootNodeForListener, treeMap, setProxyNode);
+}
+/**
+ * Proxies the parent and sets reference to the child node that changed.
+ *
+ * @param key key where the object is referenced in its parent node
+ * @param rawParentNode raw parent tree node
+ * @param proxyNode proxied instance of the node that changed
+ * @param rootNodeForListener root node listened to in useTreeNode
+ * @param treeMap a map where Fluid's proxy node is mapped to our proxied node
+ * @param setProxyNode setter to set the root proxy node listened to in useTreeNode
+ */
+function proxyParentForNode(key, rawParentNode, proxyNode, rootNodeForListener, treeMap, setProxyNode) {
+    const parentProxy = buildProxy(rawParentNode, treeMap);
+    let parentProxyHandler = getCustomProxyHandler(parentProxy);
+    if (!parentProxyHandler) {
+        throw new Error("useTreeNode proxyParentForNode: unexpected error, should always find valid proxy handler");
+    }
+    parentProxyHandler[tree_node_constants_js_1.proxiedChildrenKey][key] = proxyNode;
+    if (rawParentNode === rootNodeForListener) {
+        setProxyNode(parentProxy);
+    }
+    else {
+        const parentOfParent = fluid_framework_1.Tree.parent(rawParentNode);
+        if (!parentOfParent) {
+            throw new Error("useTreeNode proxyParentForNode: no parent found for rawParentNode");
+        }
+        const parentKey = findKeyOfNode(rawParentNode, parentOfParent);
+        proxyParentForNode(parentKey, parentOfParent, parentProxy, rootNodeForListener, treeMap, setProxyNode);
+    }
+}
+/**
+ * Returns key where parent[key] == nodeToCheck
+ *
+ * @param nodeToCheck tree node to check
+ * @param parent parent node where nodeToCheck is a child of
+ * @returns the key for node
+ */
+function findKeyOfNode(nodeToCheck, parent) {
+    let entries = Object.entries(parent);
+    for (let i = 0; i < entries.length; i++) {
+        const [key, entry] = entries[i];
+        if (!entry ||
+            ["string", "boolean", "number", "function"].includes(typeof entry) ||
+            !(0, tree_node_types_js_1.isTreeNode)(entry)) {
+            continue;
+        }
+        if (entry === nodeToCheck)
+            return key;
+    }
+    throw new Error("Did not find node as a child of parent");
+}
+// Type utils
+/**
+ * Gets the proxy handler for a given TreeNode, assuming `isCustomProxyHandler` returns true.
+ * @param proxy the proxied TreeNode to get the handler for.
+ * @returns the handler if valid, otherwise undefined
+ */
+function getCustomProxyHandler(proxy) {
+    const handler = proxy["[[Handler]]"];
+    if ((0, tree_node_types_js_1.isCustomProxyHandler)(handler)) {
+        return handler;
+    }
+    return undefined;
+}
+/**
+ * Gets the raw node for a given proxied tree node
+ *
+ * @param proxy the proxied TreeNode to get the raw node for
+ * @returns the raw node if valid, otherwise undefined
+ */
+function getRawNodeFromProxy(proxy) {
+    var _a;
+    return (_a = getCustomProxyHandler(proxy)) === null || _a === void 0 ? void 0 : _a[tree_node_constants_js_1.rawTNodeKey];
+}
+//# sourceMappingURL=tree-node-utils.js.map

package/bin/cjs/shared-hooks/internals/tree-node-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-utils.js","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-utils.ts"],"names":[],"mappings":";;AAoBA,gCA2CC;AAaD,sEA0CC;AAUD,gCAOC;AAvID,qEAA2E;AAC3E,6DAK8B;AAC9B,qDAAiD;AAGjD,iBAAiB;AAEjB;;;;;;;GAOG;AACH,SAAgB,UAAU,CACtB,OAAc,EACd,OAAoC;;IAEpC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,oBAAoB,GAAG,aAAa;QACtC,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,YAAY,GAAwD;QACtE,wGAAwG;QACxG,4DAA4D;QAC5D,CAAC,oCAAW,CAAC,EAAE,OAAO;QACtB,CAAC,2CAAkB,CAAC,EAAE,MAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAG,2CAAkB,CAAC,mCAAI,EAAE;QACtE,GAAG,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;YACrB,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;gBACzB,OAAO,YAAY,CAAC;YACxB,CAAC;YACD,IACI,OAAO,IAAI,KAAK,QAAQ;gBACxB,YAAY,CAAC,2CAAkB,CAAC,CAAC,IAAI,CAAC,EACxC,CAAC;gBACC,OAAO,YAAY,CAAC,2CAAkB,CAAC,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;YACD,mGAAmG;YACnG,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACjD,OAAO,OAAO,KAAK,KAAK,UAAU;gBAC9B,OAAO,IAAI,KAAK,QAAQ;gBACxB,qFAAqF;gBACrF,6FAA6F;gBAC7F,wDAAwD;gBACxD,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC/D,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;gBACrB,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;YACtB,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;KACJ,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/C,kCAAkC;IAClC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,qEAAqE;IACrE,OAAO,KAAc,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,6BAA6B,CAGzC,aAAuB,EACvB,mBAA6B,EAC7B,OAAoC,EACpC,oBAAoC,EACpC,YAA6C;IAE7C,IAAI,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAChC,IACI,CAAC,KAAK;YACN,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAChD,OAAO,KAAK,CACf;YACD,CAAC,IAAA,+BAAU,EAAC,KAAK,CAAC,EACpB,CAAC;YACC,SAAS;QACb,CAAC;QACD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,aAAa,GAAG,GAAG,EAAE;YACvB,iBAAiB,CACb,GAAG,EACH,QAAQ,EACR,mBAAmB,EACnB,OAAO,EACP,YAAY,CACf,CAAC;QACN,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,sBAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;QACpE,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,oDAAoD;QACpD,6BAA6B,CACzB,QAAQ,EACR,mBAAmB,EACnB,OAAO,EACP,oBAAoB,EACpB,YAAY,CACf,CAAC;IACN,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACtB,IAAW;IAEX,IAAI,IAAA,4BAAO,EAAC,IAAI,CAAC,EAAE,CAAC;QAChB,OAAO,mBAAmB,CAAC,IAAI,CAAU,CAAC;IAC9C,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,mBAAmB;AAEnB;;;;;;;;GAQG;AACH,SAAS,iBAAiB,CACtB,GAAW,EACX,OAAiB,EACjB,mBAA6B,EAC7B,OAAoC,EACpC,YAA6C;IAE7C,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,sBAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACX,kEAAkE,CACrE,CAAC;IACN,CAAC;IAED,kBAAkB,CACd,GAAG,EACH,MAAM,EACN,SAAS,EACT,mBAAmB,EACnB,OAAO,EACP,YAAY,CACf,CAAC;AACN,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,kBAAkB,CACvB,GAAW,EACX,aAAuB,EACvB,SAAmB,EACnB,mBAA6B,EAC7B,OAAoC,EACpC,YAA6C;IAE7C,MAAM,WAAW,GAAG,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACvD,IAAI,kBAAkB,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAC5D,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACX,0FAA0F,CAC7F,CAAC;IACN,CAAC;IACD,kBAAkB,CAAC,2CAAkB,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IACxD,IAAI,aAAa,KAAK,mBAAmB,EAAE,CAAC;QACxC,YAAY,CAAC,WAAoB,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,MAAM,cAAc,GAAG,sBAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,cAAc,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACX,mEAAmE,CACtE,CAAC;QACN,CAAC;QACD,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAC/D,kBAAkB,CACd,SAAS,EACT,cAAc,EACd,WAAW,EACX,mBAAmB,EACnB,OAAO,EACP,YAAY,CACf,CAAC;IACN,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,WAAqB,EAAE,MAAgB;IAC1D,IAAI,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAChC,IACI,CAAC,KAAK;YACN,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAChD,OAAO,KAAK,CACf;YACD,CAAC,IAAA,+BAAU,EAAC,KAAK,CAAC,EACpB,CAAC;YACC,SAAS;QACb,CAAC;QACD,IAAI,KAAK,KAAK,WAAW;YAAE,OAAO,GAAG,CAAC;IAC1C,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC9D,CAAC;AAED,aAAa;AAEb;;;;GAIG;AACH,SAAS,qBAAqB,CAAC,KAAe;IAC1C,MAAM,OAAO,GAAI,KAAa,CAAC,aAAa,CAAC,CAAC;IAC9C,IAAI,IAAA,yCAAoB,EAAC,OAAO,CAAC,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,KAAe;;IACxC,OAAO,MAAA,qBAAqB,CAAC,KAAK,CAAC,0CAAG,oCAAW,CAAC,CAAC;AACvD,CAAC"}

package/bin/cjs/shared-hooks/useDynamicDDS.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { FluidObject, IFluidLoadable } from "@fluidframework/core-interfaces";
+import { SharedObjectKind } from "fluid-framework";
+/**
+ * Hook to gets or creates a DDS that corresponds to a given uniqueKey string.
+ *
+ * @remarks
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template T Type of Fluid SharedObjectKind type to load. Must conform to IFluidLoadable interface.
+ * @param uniqueKey uniqueKey value for the data object
+ * @param objectKind Fluid SharedObjectKind<T> to create/load.
+ * @param onFirstInitialize Optional. Callback function for when the DDS is first loaded
+ * @returns the DDS object, which is of type T when loaded and undefined while loading
+ */
+export declare function useDynamicDDS<T extends IFluidLoadable = FluidObject<any> & IFluidLoadable>(uniqueKey: string, objectClass: SharedObjectKind<T>, onFirstInitialize?: (dds: T) => void): {
+    dds: T | undefined;
+    error: Error | undefined;
+};
+//# sourceMappingURL=useDynamicDDS.d.ts.map

package/bin/cjs/shared-hooks/useDynamicDDS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDynamicDDS.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useDynamicDDS.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CACzB,CAAC,SAAS,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,cAAc,EAE5D,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAChC,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GACrC;IACC,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;CAC5B,CA6DA"}

package/bin/cjs/shared-hooks/useDynamicDDS.js

@@ -0,0 +1,87 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDynamicDDS = useDynamicDDS;
+const react_1 = __importDefault(require("react"));
+const AzureProvider_js_1 = require("../providers/AzureProvider.js");
+/**
+ * Hook to gets or creates a DDS that corresponds to a given uniqueKey string.
+ *
+ * @remarks
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template T Type of Fluid SharedObjectKind type to load. Must conform to IFluidLoadable interface.
+ * @param uniqueKey uniqueKey value for the data object
+ * @param objectKind Fluid SharedObjectKind<T> to create/load.
+ * @param onFirstInitialize Optional. Callback function for when the DDS is first loaded
+ * @returns the DDS object, which is of type T when loaded and undefined while loading
+ */
+function useDynamicDDS(uniqueKey, objectClass, onFirstInitialize) {
+    const [dds, setDDS] = react_1.default.useState();
+    const [error, setError] = react_1.default.useState();
+    /**
+     * Import container and DDS object register callbacks from AzureProvider.
+     */
+    const { container, clientRef } = (0, AzureProvider_js_1.useFluidObjectsContext)();
+    const mountedRef = react_1.default.useRef(false);
+    react_1.default.useEffect(() => {
+        mountedRef.current = true;
+        return () => {
+            mountedRef.current = false;
+        };
+    }, []);
+    const getDDSPromisesRef = react_1.default.useRef(new Map());
+    /**
+     * Once container is available, this effect will register the setter method so that the DDS loaded
+     * from `dynamicObjects` that matches `uniqueKey` can be passed back to this hook. If one does not yet exist,
+     * a new DDS is automatically created. If multiple users try to create a DDS at the same time when this component first
+     * mounts, `live-share` ensures it will ultimately self correct using last-writer wins.
+     */
+    react_1.default.useEffect(() => {
+        if (container === undefined)
+            return;
+        // Callback method to set the `initialData` into the map when the DDS is first created.
+        const onGetDDS = () => __awaiter(this, void 0, void 0, function* () {
+            try {
+                let getPromise = getDDSPromisesRef.current.get(uniqueKey);
+                if (!getPromise) {
+                    getPromise = clientRef.current.getDDS(uniqueKey, objectClass, onFirstInitialize);
+                    getDDSPromisesRef.current.set(uniqueKey, getPromise);
+                }
+                const dds = yield getPromise;
+                if (mountedRef.current) {
+                    setDDS(dds);
+                }
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    setError(error);
+                }
+                else {
+                    setError(new Error("useDynamicDDS: an unknown error occurred while getting the DDS"));
+                }
+            }
+        });
+        onGetDDS();
+    }, [container, uniqueKey, onFirstInitialize]);
+    return {
+        dds,
+        error,
+    };
+}
+//# sourceMappingURL=useDynamicDDS.js.map

package/bin/cjs/shared-hooks/useDynamicDDS.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDynamicDDS.js","sourceRoot":"","sources":["../../../src/shared-hooks/useDynamicDDS.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;AAmBH,sCAsEC;AAvFD,kDAA0B;AAE1B,oEAAuE;AAGvE;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAGzB,SAAiB,EACjB,WAAgC,EAChC,iBAAoC;IAKpC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,eAAK,CAAC,QAAQ,EAAK,CAAC;IAC1C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,eAAK,CAAC,QAAQ,EAAS,CAAC;IAClD;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,yCAAsB,GAAE,CAAC;IAE1D,MAAM,UAAU,GAAG,eAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;QAC1B,OAAO,GAAG,EAAE;YACR,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;QAC/B,CAAC,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,iBAAiB,GAAG,eAAK,CAAC,MAAM,CAA0B,IAAI,GAAG,EAAE,CAAC,CAAC;IAE3E;;;;;OAKG;IACH,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO;QACpC,uFAAuF;QACvF,MAAM,QAAQ,GAAG,GAAS,EAAE;YACxB,IAAI,CAAC;gBACD,IAAI,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAC1D,IAAI,CAAC,UAAU,EAAE,CAAC;oBACd,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CACjC,SAAS,EACT,WAAW,EACX,iBAAiB,CACpB,CAAC;oBACF,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;gBACzD,CAAC;gBACD,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC;gBAC7B,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;oBACrB,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChB,CAAC;YACL,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACtB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBACzB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC;qBAAM,CAAC;oBACJ,QAAQ,CACJ,IAAI,KAAK,CACL,gEAAgE,CACnE,CACJ,CAAC;gBACN,CAAC;YACL,CAAC;QACL,CAAC,CAAA,CAAC;QACF,QAAQ,EAAE,CAAC;IACf,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAE9C,OAAO;QACH,GAAG;QACH,KAAK;KACR,CAAC;AACN,CAAC"}

package/bin/cjs/shared-hooks/useSharedMap.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { IUseSharedMapResults, SharedMapInitialData } from "../types/index.js";
+/**
+ * @deprecated use {@link useSharedTree} instead.
+ *
+ * React hook for using a Fluid `SharedMap`.
+ *
+ * @remarks
+ * The primary benefit of using the `useSharedMap` hook rather than the Fluid `SharedMap`
+ * directly is that it integrates nicely with React state and automates repetitive tasks.
+ * If you want to use `SharedMap` this hook creates directly, you can do that as well.
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template TData Optional typing for objects stored in the SharedMap. Default is `any` type.
+ * @param uniqueKey the unique key for the `SharedMap`. If one does not yet exist, a new `SharedMap`
+ * will be created, otherwise it will use the existing one.
+ * @param initialData a JS Map, entries array, or JSON object to insert into the `SharedMap` when creating
+ * the DDS for the first time.
+ * @returns the Fluid `sharedMap`.
+ */
+export declare function useSharedMap<TData = any>(uniqueKey: string, initialData?: SharedMapInitialData<TData>): IUseSharedMapResults<TData>;
+//# sourceMappingURL=useSharedMap.d.ts.map

package/bin/cjs/shared-hooks/useSharedMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedMap.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAU/E;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,KAAK,GAAG,GAAG,EACpC,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC,GAC1C,oBAAoB,CAAC,KAAK,CAAC,CAyH7B"}

package/bin/cjs/shared-hooks/useSharedMap.js

@@ -0,0 +1,134 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSharedMap = useSharedMap;
+const react_1 = __importDefault(require("react"));
+const index_js_1 = require("../utils/index.js");
+const useDynamicDDS_js_1 = require("./useDynamicDDS.js");
+const legacy_1 = require("fluid-framework/legacy");
+const errors_js_1 = require("../internal/errors.js");
+const AzureProvider_js_1 = require("../providers/AzureProvider.js");
+/**
+ * @deprecated use {@link useSharedTree} instead.
+ *
+ * React hook for using a Fluid `SharedMap`.
+ *
+ * @remarks
+ * The primary benefit of using the `useSharedMap` hook rather than the Fluid `SharedMap`
+ * directly is that it integrates nicely with React state and automates repetitive tasks.
+ * If you want to use `SharedMap` this hook creates directly, you can do that as well.
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template TData Optional typing for objects stored in the SharedMap. Default is `any` type.
+ * @param uniqueKey the unique key for the `SharedMap`. If one does not yet exist, a new `SharedMap`
+ * will be created, otherwise it will use the existing one.
+ * @param initialData a JS Map, entries array, or JSON object to insert into the `SharedMap` when creating
+ * the DDS for the first time.
+ * @returns the Fluid `sharedMap`.
+ */
+function useSharedMap(uniqueKey, initialData) {
+    const onFirstInitialize = react_1.default.useCallback((newDDS) => {
+        /**
+         * Callback method to set the `initialData` into the map when the `SharedMap` is first created.
+         * Only should be used as a prop to useDynamicDDS.
+         */
+        getInitialData(initialData).forEach((value, key) => {
+            newDDS.set(key, value);
+        });
+    }, [initialData]);
+    /**
+     * User facing: dynamically load the SharedMap DDS for the given unique key.
+     */
+    const { dds: sharedMap } = (0, useDynamicDDS_js_1.useDynamicDDS)(uniqueKey, legacy_1.SharedMap, onFirstInitialize);
+    const { container } = (0, AzureProvider_js_1.useFluidObjectsContext)();
+    /**
+     * User facing: get a value from the Fluid `SharedMap`.
+     */
+    const getEntry = react_1.default.useCallback((key) => {
+        if (!container) {
+            throw new errors_js_1.ActionContainerNotJoinedError("sharedMap", "getEntry");
+        }
+        if (sharedMap === undefined) {
+            throw new errors_js_1.ActionLiveDataObjectUndefinedError("sharedMap", "getEntry");
+        }
+        return sharedMap.get(key);
+    }, [container, sharedMap]);
+    /**
+     * User facing: set a value to the Fluid `SharedMap`.
+     */
+    const setEntry = react_1.default.useCallback((key, value) => {
+        if (!container) {
+            throw new errors_js_1.ActionContainerNotJoinedError("sharedMap", "setEntry");
+        }
+        if (sharedMap === undefined) {
+            throw new errors_js_1.ActionLiveDataObjectUndefinedError("sharedMap", "setEntry");
+        }
+        sharedMap.set(key, value);
+    }, [container, sharedMap]);
+    /**
+     * User facing: delete a value from the Fluid `SharedMap`.
+     */
+    const deleteEntry = react_1.default.useCallback((key) => {
+        if (!container) {
+            throw new errors_js_1.ActionContainerNotJoinedError("sharedMap", "deleteEntry");
+        }
+        if (sharedMap === undefined) {
+            throw new errors_js_1.ActionLiveDataObjectUndefinedError("sharedMap", "deleteEntry");
+        }
+        sharedMap.delete(key);
+    }, [container, sharedMap]);
+    const [sharedMapProxy, setSharedMapProxy] = react_1.default.useState();
+    // Setup change listeners, initial values, etc.
+    react_1.default.useEffect(() => {
+        if (!sharedMap)
+            return;
+        setSharedMapProxy(sharedMap);
+        class SharedMapProxyHandler {
+        }
+        // Register valueChanged listener for `SharedMap`.
+        const onValueChanged = () => {
+            setSharedMapProxy(new Proxy(sharedMap, new SharedMapProxyHandler()));
+        };
+        sharedMap.on("valueChanged", onValueChanged);
+        // Get initial values from `SharedMap`.
+        onValueChanged();
+        return () => {
+            // Cleanup on component unmount.
+            sharedMap === null || sharedMap === void 0 ? void 0 : sharedMap.off("valueChanged", onValueChanged);
+        };
+    }, [sharedMap]);
+    return {
+        sharedMap: sharedMapProxy,
+        getEntry,
+        setEntry,
+        deleteEntry,
+    };
+}
+/**
+ * Helper method for converting different initial data props into a Map<string, TData> to insert into the Fluid SharedMap
+ * @template TData Optional typing for objects stored in the SharedMap. Default is `object` type.
+ * @param initialData a JS Map, entries array, or JSON object.
+ * @returns A Map<string, TData> with the entries provided.
+ */
+function getInitialData(initialData) {
+    if ((0, index_js_1.isMap)(initialData)) {
+        return initialData;
+    }
+    else if ((0, index_js_1.isEntries)(initialData)) {
+        return new Map(initialData);
+    }
+    else if ((0, index_js_1.isJSON)(initialData)) {
+        const values = Object.keys(initialData).map((key) => {
+            return [key, initialData[key]];
+        });
+        return new Map(values);
+    }
+    return new Map();
+}
+//# sourceMappingURL=useSharedMap.js.map

package/bin/cjs/shared-hooks/useSharedMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedMap.js","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedMap.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAgCH,oCA4HC;AA1JD,kDAA0B;AAC1B,gDAA6D;AAE7D,yDAAmD;AACnD,mDAAmD;AACnD,qDAG+B;AAC/B,oEAAuE;AAGvE;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,YAAY,CACxB,SAAiB,EACjB,WAAyC;IAEzC,MAAM,iBAAiB,GAAG,eAAK,CAAC,WAAW,CACvC,CAAC,MAAiB,EAAQ,EAAE;QACxB;;;WAGG;QACH,cAAc,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC,EACD,CAAC,WAAW,CAAC,CAChB,CAAC;IACF;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,IAAA,gCAAa,EACpC,SAAS,EACT,kBAAS,EACT,iBAAiB,CACpB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,yCAAsB,GAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,QAAQ,GAAG,eAAK,CAAC,WAAW,CAC9B,CAAC,GAAW,EAAE,EAAE;QACZ,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,yCAA6B,CACnC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,8CAAkC,CACxC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,eAAK,CAAC,WAAW,CAC9B,CAAC,GAAW,EAAE,KAAY,EAAE,EAAE;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,yCAA6B,CACnC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,8CAAkC,CACxC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;OAEG;IACH,MAAM,WAAW,GAAG,eAAK,CAAC,WAAW,CACjC,CAAC,GAAW,EAAE,EAAE;QACZ,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,yCAA6B,CACnC,WAAW,EACX,aAAa,CAChB,CAAC;QACN,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,8CAAkC,CACxC,WAAW,EACX,aAAa,CAChB,CAAC;QACN,CAAC;QACD,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,eAAK,CAAC,QAAQ,EAAa,CAAC;IAExE,+CAA+C;IAC/C,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE7B,MAAM,qBAAqB;SAAsC;QAEjE,kDAAkD;QAClD,MAAM,cAAc,GAAG,GAAG,EAAE;YACxB,iBAAiB,CACb,IAAI,KAAK,CAAC,SAAS,EAAE,IAAI,qBAAqB,EAAE,CAAC,CACpD,CAAC;QACN,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC7C,uCAAuC;QACvC,cAAc,EAAE,CAAC;QAEjB,OAAO,GAAG,EAAE;YACR,gCAAgC;YAChC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO;QACH,SAAS,EAAE,cAAc;QACzB,QAAQ;QACR,QAAQ;QACR,WAAW;KACd,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CACnB,WAAwC;IAExC,IAAI,IAAA,gBAAK,EAAC,WAAW,CAAC,EAAE,CAAC;QACrB,OAAO,WAAW,CAAC;IACvB,CAAC;SAAM,IAAI,IAAA,oBAAS,EAAC,WAAW,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,GAAG,CAAgB,WAAW,CAAC,CAAC;IAC/C,CAAC;SAAM,IAAI,IAAA,iBAAM,EAAC,WAAW,CAAC,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAiC,MAAM,CAAC,IAAI,CACpD,WAAW,CACd,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACV,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,GAAG,CAAgB,MAAM,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,IAAI,GAAG,EAAiB,CAAC;AACpC,CAAC"}

package/bin/cjs/shared-hooks/useSharedState.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DisposeSharedStateAction, SetSharedStateAction } from "../types/index.js";
+/**
+ * Inspired by React's `useState` hook, `useSharedState` makes it easy to synchronize state in your app.
+ *
+ * @remarks
+ * Values set through this state is automatically attached to a `SharedMap` that the `AzureProvider`
+ * creates. If you are synchronizing complex data structures that multiple users will be setting simultaneously,
+ * consider using an optimized hook for your data structure (e.g., `useSharedMap`, `useSharedString`, etc.).
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template S Typing for objects stored associated with the `uniqueKey`.
+ * @param uniqueKey the unique key for a `SharedMap`. If you use the same key for multiple components, those components will reference the same state.
+ * @param initialState a default state for the `SharedMap`.
+ *
+ * @returns a stateful value, the function to update it, and an optional dispose method to delete it from the `SharedMap`.
+ */
+export declare function useSharedState<S = any>(uniqueKey: string, initialState: S): [S, SetSharedStateAction<S>, DisposeSharedStateAction];
+//# sourceMappingURL=useSharedState.d.ts.map

package/bin/cjs/shared-hooks/useSharedState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedState.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACH,wBAAwB,EACxB,oBAAoB,EACvB,MAAM,mBAAmB,CAAC;AAI3B;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAAC,CAAC,GAAG,GAAG,EAClC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,CAAC,GAChB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAkExD"}

package/bin/cjs/shared-hooks/useSharedState.js

@@ -0,0 +1,80 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSharedState = useSharedState;
+const react_1 = __importDefault(require("react"));
+const index_js_1 = require("../providers/index.js");
+const uuid_1 = require("uuid");
+const index_js_2 = require("../internal/index.js");
+/**
+ * Inspired by React's `useState` hook, `useSharedState` makes it easy to synchronize state in your app.
+ *
+ * @remarks
+ * Values set through this state is automatically attached to a `SharedMap` that the `AzureProvider`
+ * creates. If you are synchronizing complex data structures that multiple users will be setting simultaneously,
+ * consider using an optimized hook for your data structure (e.g., `useSharedMap`, `useSharedString`, etc.).
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @template S Typing for objects stored associated with the `uniqueKey`.
+ * @param uniqueKey the unique key for a `SharedMap`. If you use the same key for multiple components, those components will reference the same state.
+ * @param initialState a default state for the `SharedMap`.
+ *
+ * @returns a stateful value, the function to update it, and an optional dispose method to delete it from the `SharedMap`.
+ */
+function useSharedState(uniqueKey, initialState) {
+    /**
+     * User facing: stateful value and non-user facing setter.
+     */
+    const [localState, setLocalState] = react_1.default.useState(initialState);
+    /**
+     * Unique ID reference for the component.
+     */
+    const componentIdRef = react_1.default.useRef((0, uuid_1.v4)());
+    /**
+     * Register set state callbacks from AzureProvider and update/delete callbacks for initial object's `stateMap`.
+     */
+    const { registerSharedSetStateAction, unregisterSharedSetStateAction, updateSharedState, deleteSharedState, } = (0, index_js_1.useFluidObjectsContext)();
+    /**
+     * User facing: callback to change the shared state.
+     */
+    const setSharedState = react_1.default.useCallback((state) => {
+        setLocalState((prevState) => {
+            const valueToSet = (0, index_js_2.isPrevStateCallback)(state)
+                ? state(prevState)
+                : state;
+            updateSharedState(uniqueKey, valueToSet);
+            return valueToSet;
+        });
+    }, [uniqueKey, setLocalState, updateSharedState]);
+    /**
+     * User facing: callback to dispose the shared state from the `stateMap`.
+     */
+    const disposeSharedState = react_1.default.useCallback(() => {
+        deleteSharedState(uniqueKey);
+    }, [uniqueKey, deleteSharedState]);
+    /**
+     * Once container is available, this effect will register the setter method so that the `S` value
+     * from `stateMap` that matches `uniqueKey` can be passed back to this hook whenever changed.
+     *
+     * @see registerSharedSetStateAction to see how new values from `stateMap` are passed to this hook.
+     * @see unregisterSharedSetStateAction to see how this component stops listening to changes in the `stateMap`.
+     */
+    react_1.default.useEffect(() => {
+        registerSharedSetStateAction(uniqueKey, componentIdRef.current, setLocalState);
+        return () => {
+            unregisterSharedSetStateAction(uniqueKey, componentIdRef.current);
+        };
+    }, [
+        uniqueKey,
+        registerSharedSetStateAction,
+        unregisterSharedSetStateAction,
+    ]);
+    return [localState, setSharedState, disposeSharedState];
+}
+//# sourceMappingURL=useSharedState.js.map

package/bin/cjs/shared-hooks/useSharedState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedState.js","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AA0BH,wCAqEC;AA7FD,kDAA0B;AAC1B,oDAA+D;AAK/D,+BAAkC;AAClC,mDAA2D;AAE3D;;;;;;;;;;;;;;GAcG;AACH,SAAgB,cAAc,CAC1B,SAAiB,EACjB,YAAe;IAEf;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,eAAK,CAAC,QAAQ,CAAI,YAAY,CAAC,CAAC;IACpE;;OAEG;IACH,MAAM,cAAc,GAAG,eAAK,CAAC,MAAM,CAAC,IAAA,SAAI,GAAE,CAAC,CAAC;IAC5C;;OAEG;IACH,MAAM,EACF,4BAA4B,EAC5B,8BAA8B,EAC9B,iBAAiB,EACjB,iBAAiB,GACpB,GAAG,IAAA,iCAAsB,GAAE,CAAC;IAE7B;;OAEG;IACH,MAAM,cAAc,GAA4B,eAAK,CAAC,WAAW,CAC7D,CAAC,KAAgC,EAAE,EAAE;QACjC,aAAa,CAAC,CAAC,SAAS,EAAE,EAAE;YACxB,MAAM,UAAU,GAAG,IAAA,8BAAmB,EAAI,KAAK,CAAC;gBAC5C,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;gBAClB,CAAC,CAAC,KAAK,CAAC;YACZ,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACzC,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;IACP,CAAC,EACD,CAAC,SAAS,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAChD,CAAC;IAEF;;OAEG;IACH,MAAM,kBAAkB,GACpB,eAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACnB,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,4BAA4B,CACxB,SAAS,EACT,cAAc,CAAC,OAAO,EACtB,aAAa,CAChB,CAAC;QACF,OAAO,GAAG,EAAE;YACR,8BAA8B,CAAC,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;QACtE,CAAC,CAAC;IACN,CAAC,EAAE;QACC,SAAS;QACT,4BAA4B;QAC5B,8BAA8B;KACjC,CAAC,CAAC;IAEH,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC;AAC5D,CAAC"}

package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DeleteSharedStateAction, IAzureContainerResults, RegisterSharedSetStateAction, UnregisterSharedSetStateAction, UpdateSharedStateAction } from "../types/index.js";
+/**
+ * Response for the {@link useSharedStateRegistry} hook.
+ */
+export interface ISharedStateRegistryResponse {
+    /**
+     * Register a set state action callback
+     */
+    registerSharedSetStateAction: RegisterSharedSetStateAction;
+    /**
+     * Unregister a set state action callback
+     */
+    unregisterSharedSetStateAction: UnregisterSharedSetStateAction;
+    /**
+     * Setter callback to update the shared state
+     */
+    updateSharedState: UpdateSharedStateAction;
+    /**
+     * Delete a shared state value
+     */
+    deleteSharedState: DeleteSharedStateAction;
+}
+/**
+ * Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
+ *
+ * @remarks
+ * Use this if you are building a custom `LiveShareProvider` or `AzureProvider` implementation in your app.
+ *
+ * @param results IAzureContainerResults response or undefined
+ * @returns ISharedStateRegistryResponse object
+ */
+export declare const useSharedStateRegistry: (results: IAzureContainerResults | undefined) => ISharedStateRegistryResponse;
+//# sourceMappingURL=useSharedStateRegistry.d.ts.map

package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedStateRegistry.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAE5B,8BAA8B,EAC9B,uBAAuB,EAC1B,MAAM,mBAAmB,CAAC;AAQ3B;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,4BAA4B,EAAE,4BAA4B,CAAC;IAC3D;;OAEG;IACH,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,YACtB,sBAAsB,GAAG,SAAS,KAC5C,4BAgHF,CAAC"}