@microsoft/live-share-react 2.0.0-internal.2 → 2.0.0-internal.20

package/bin/esm/providers/LiveShareProvider.js

@@ -0,0 +1,196 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from "react";
+import { useSharedStateRegistry } from "../shared-hooks/index.js";
+import { LiveShareClient, } from "@microsoft/live-share";
+import { FluidContext } from "./AzureProvider.js";
+import { isITeamsJsSdkError } from "../internal/index.js";
+/**
+ * @hidden
+ */
+export const LiveShareContext = React.createContext({});
+/**
+ * Hook to get the latest React context state for `LiveShareContext`.
+ *
+ * @remarks
+ * This hook can only be used in a child component of `<LiveShareProvider>`.
+ * See `useFluidObjectsContext` for other information related to the Live Share session, such as the `container`.
+ *
+ * @returns current state of `LiveShareContext`
+ *
+ * @example
+ ```jsx
+// LiveShareApp.jsx
+import { LiveShareProvider } from "@microsoft/live-share-react";
+import { LiveShareHost } from "@microsoft/teams-js";
+
+const host = LiveShareHost.create();
+
+export function LiveShareApp() {
+    // Call app.initialize() from teams-js before rendering LiveShareProvider
+
+    return (
+        <LiveShareProvider
+            joinOnLoad={true}
+            host={host}
+        >
+            <LiveShareLoader>
+                <LiveCheckbox />
+            </LiveShareLoader>
+        </LiveShareProvider>
+    );
+}
+
+// LiveShareLoader.jsx
+import { useLiveShareContext } from "@microsoft/live-share-react";
+
+export function LiveShareLoader({ children }) {
+    const { joined, joinError } = useLiveShareContext();
+
+    if (joinError) return <>{joinError.message}</>;
+    if (!joined) return <>Joining Live Share session...</>;
+    return <>{children}</>
+}
+
+// LiveCheckbox.jsx
+import { useLiveState } from "@microsoft/live-share-react";
+
+export function LiveCheckbox() {
+    const [checked, setChecked] = useLiveState("MY-UNIQUE-ID", false);
+    return (
+        <input
+            type="checkbox"
+            checked={checked}
+            onChange={() => {
+                setChecked(!checked);
+            }}
+        />
+    );
+}
+ ```
+ */
+export const useLiveShareContext = () => {
+    const context = React.useContext(LiveShareContext);
+    if (!isLiveShareContext(context)) {
+        throw new Error("@microsoft/live-share-react: attempting to use `useLiveShareContext()` from a component that is not a child of `<LiveShareProvider>`.\nTo fix this error, ensure that you are only using Live Share hooks (e.g., `useLiveState`) from a child component of `<LiveShareProvider>`.");
+    }
+    return context;
+};
+/**
+ * React Context provider component for using Live Share data objects & joining a Live Share session using `LiveShareClient`.
+ *
+ * @example
+ ```jsx
+// LiveShareApp.jsx
+import { LiveShareProvider } from "@microsoft/live-share-react";
+import { LiveShareHost } from "@microsoft/teams-js";
+
+const host = LiveShareHost.create();
+
+export function LiveShareApp() {
+    // Call app.initialize() from teams-js before rendering LiveShareProvider
+
+    return (
+        <LiveShareProvider
+            joinOnLoad={true}
+            host={host}
+        >
+            <LiveShareLoader>
+                <LiveCheckbox />
+            </LiveShareLoader>
+        </LiveShareProvider>
+    );
+}
+
+// LiveShareLoader.jsx
+import { useLiveShareContext } from "@microsoft/live-share-react";
+
+export function LiveShareLoader({ children }) {
+    const { joined, joinError } = useLiveShareContext();
+
+    if (joinError) return <>{joinError.message}</>;
+    if (!joined) return <>Joining Live Share session...</>;
+    return <>{children}</>
+}
+
+// LiveCheckbox.jsx
+import { useLiveState } from "@microsoft/live-share-react";
+
+export function LiveCheckbox() {
+    const [checked, setChecked] = useLiveState("MY-UNIQUE-ID", false);
+    return (
+        <input
+            type="checkbox"
+            checked={checked}
+            onChange={() => {
+                setChecked(!checked);
+            }}
+        />
+    );
+}
+ ```
+ */
+export const LiveShareProvider = (props) => {
+    const startedRef = React.useRef(false);
+    const clientRef = React.useRef(new LiveShareClient(props.host, props.clientOptions));
+    const [results, setResults] = React.useState();
+    const [joinError, setJoinError] = React.useState();
+    const stateRegistryCallbacks = useSharedStateRegistry(results);
+    /**
+     * Join container callback for joining the Live Share session
+     */
+    const join = React.useCallback(async (fluidContainerSchema, onInitializeContainer) => {
+        startedRef.current = true;
+        const results = await clientRef.current.join(fluidContainerSchema, onInitializeContainer);
+        setResults(results);
+        return results;
+    }, []);
+    /**
+     * Joins the container on load if `props.joinOnLoad` is true
+     */
+    React.useEffect(() => {
+        // This hook should only be called once, so we use a ref to track if it has been called.
+        // This is a workaround for the fact that useEffect is called twice on initial render in React V18.
+        // We are not doing this here for backwards compatibility. View the README for more information.
+        if (results !== undefined || startedRef.current || !props.joinOnLoad)
+            return;
+        join(props.fluidContainerSchema).catch((error) => {
+            console.error(error);
+            if (error instanceof Error) {
+                setJoinError(error);
+            }
+            else if (isITeamsJsSdkError(error)) {
+                setJoinError(new Error(`[${error.errorCode}] ${error.message ??
+                    "An unknown error occurred while joining container."}`));
+            }
+            else if (typeof error == "string") {
+                setJoinError(new Error(error));
+            }
+            else {
+                setJoinError(new Error("LiveShareProvider: An unknown error occurred while joining container."));
+            }
+        });
+    }, [results, props.joinOnLoad, props.fluidContainerSchema, join]);
+    return (_jsx(LiveShareContext.Provider, { value: {
+            created: !!results?.created,
+            timestampProvider: results?.timestampProvider,
+            joined: !!results?.container,
+            joinError,
+            join,
+        }, children: _jsx(FluidContext.Provider, { value: {
+                clientRef,
+                container: results?.container,
+                services: results?.services,
+                joinError,
+                getContainer: async () => {
+                    throw new Error("Cannot join new container through getContainer in LiveShareProvider");
+                },
+                createContainer: async () => {
+                    throw new Error("Cannot create new container through createContainer in LiveShareProvider");
+                },
+                ...stateRegistryCallbacks,
+            }, children: props.children }) }));
+};
+function isLiveShareContext(value) {
+    return (typeof value?.created === "boolean" && typeof value?.join === "function");
+}
+//# sourceMappingURL=LiveShareProvider.js.map

package/bin/esm/providers/LiveShareProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveShareProvider.js","sourceRoot":"","sources":["../../../src/providers/LiveShareProvider.tsx"],"names":[],"mappings":";AAMA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAKH,eAAe,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAA0B,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AA2C1D;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAC/C,EAAuB,CAC1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAsB,EAAE;IACvD,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACnD,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACX,mRAAmR,CACtR,CAAC;IACN,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AA+BF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAsC,CAAC,KAAK,EAAE,EAAE;IAC1E,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAC1B,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CACvD,CAAC;IACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,EAEzC,CAAC;IACJ,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAqB,CAAC;IAEtE,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAE/D;;OAEG;IACH,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAC1B,KAAK,EACD,oBAAsC,EACtC,qBAA4D,EAC9B,EAAE;QAChC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;QAC1B,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CACxC,oBAAoB,EACpB,qBAAqB,CACxB,CAAC;QACF,UAAU,CAAC,OAAO,CAAC,CAAC;QACpB,OAAO,OAAO,CAAC;IACnB,CAAC,EACD,EAAE,CACL,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,wFAAwF;QACxF,mGAAmG;QACnG,gGAAgG;QAChG,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU;YAChE,OAAO;QACX,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBACzB,YAAY,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;iBAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnC,YAAY,CACR,IAAI,KAAK,CACL,IAAI,KAAK,CAAC,SAAS,KACf,KAAK,CAAC,OAAO;oBACb,oDACJ,EAAE,CACL,CACJ,CAAC;YACN,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAClC,YAAY,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACJ,YAAY,CACR,IAAI,KAAK,CACL,uEAAuE,CAC1E,CACJ,CAAC;YACN,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,CAAC;IAElE,OAAO,CACH,KAAC,gBAAgB,CAAC,QAAQ,IACtB,KAAK,EAAE;YACH,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO;YAC3B,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;YAC7C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS;YAC5B,SAAS;YACT,IAAI;SACP,YAED,KAAC,YAAY,CAAC,QAAQ,IAClB,KAAK,EAAE;gBACH,SAAS;gBACT,SAAS,EAAE,OAAO,EAAE,SAAS;gBAC7B,QAAQ,EAAE,OAAO,EAAE,QAAQ;gBAC3B,SAAS;gBACT,YAAY,EAAE,KAAK,IAAI,EAAE;oBACrB,MAAM,IAAI,KAAK,CACX,qEAAqE,CACxE,CAAC;gBACN,CAAC;gBACD,eAAe,EAAE,KAAK,IAAI,EAAE;oBACxB,MAAM,IAAI,KAAK,CACX,0EAA0E,CAC7E,CAAC;gBACN,CAAC;gBACD,GAAG,sBAAsB;aAC5B,YAEA,KAAK,CAAC,QAAQ,GACK,GACA,CAC/B,CAAC;AACN,CAAC,CAAC;AAEF,SAAS,kBAAkB,CAAC,KAAU;IAClC,OAAO,CACH,OAAO,KAAK,EAAE,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,EAAE,IAAI,KAAK,UAAU,CAC3E,CAAC;AACN,CAAC"}

package/bin/esm/providers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./AzureProvider.js";
+export * from "./LiveShareProvider.js";
+//# sourceMappingURL=index.d.ts.map

package/bin/esm/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

package/bin/esm/providers/index.js

@@ -0,0 +1,3 @@
+export * from "./AzureProvider.js";
+export * from "./LiveShareProvider.js";
+//# sourceMappingURL=index.js.map

package/bin/esm/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

package/bin/esm/shared-hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./useSharedState.js";
+export * from "./useSharedMap.js";
+export * from "./useDynamicDDS.js";
+export * from "./useSharedStateRegistry.js";
+export * from "./useSharedTree.js";
+export * from "./useTreeNode.js";
+//# sourceMappingURL=index.d.ts.map

package/bin/esm/shared-hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/bin/esm/shared-hooks/index.js

@@ -0,0 +1,7 @@
+export * from "./useSharedState.js";
+export * from "./useSharedMap.js";
+export * from "./useDynamicDDS.js";
+export * from "./useSharedStateRegistry.js";
+export * from "./useSharedTree.js";
+export * from "./useTreeNode.js";
+//# sourceMappingURL=index.js.map

package/bin/esm/shared-hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/shared-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/bin/esm/shared-hooks/internals/tree-node-constants.d.ts

@@ -0,0 +1,3 @@
+export declare const rawTNodeKey = "[[FluidTreeNode]]";
+export declare const proxiedChildrenKey = "[[FluidChildNodes]]";
+//# sourceMappingURL=tree-node-constants.d.ts.map

package/bin/esm/shared-hooks/internals/tree-node-constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-constants.d.ts","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAC/C,eAAO,MAAM,kBAAkB,wBAAwB,CAAC"}

package/bin/esm/shared-hooks/internals/tree-node-constants.js

@@ -0,0 +1,3 @@
+export const rawTNodeKey = "[[FluidTreeNode]]";
+export const proxiedChildrenKey = "[[FluidChildNodes]]";
+//# sourceMappingURL=tree-node-constants.js.map

package/bin/esm/shared-hooks/internals/tree-node-constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-constants.js","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAC/C,MAAM,CAAC,MAAM,kBAAkB,GAAG,qBAAqB,CAAC"}

package/bin/esm/shared-hooks/internals/tree-node-types.d.ts

@@ -0,0 +1,10 @@
+import { TreeNode } from "fluid-framework";
+import { proxiedChildrenKey, rawTNodeKey } from "./tree-node-constants.js";
+export interface ICustomProxyHandler<TNode extends TreeNode = TreeNode> {
+    [rawTNodeKey]: TNode;
+    [proxiedChildrenKey]: Record<string, TreeNode>;
+}
+export declare function isProxy(value: any): value is typeof Proxy;
+export declare function isCustomProxyHandler<TNode extends TreeNode = TreeNode>(value: any): value is ICustomProxyHandler<TNode>;
+export declare function isTreeNode(value: any): value is TreeNode;
+//# sourceMappingURL=tree-node-types.d.ts.map

package/bin/esm/shared-hooks/internals/tree-node-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-types.d.ts","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAQ,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE3E,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ;IAClE,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;IACrB,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CAClD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,OAAO,KAAK,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ,EAClE,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAErC;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,QAAQ,CAOxD"}

package/bin/esm/shared-hooks/internals/tree-node-types.js

@@ -0,0 +1,18 @@
+import { Tree } from "fluid-framework";
+import { proxiedChildrenKey, rawTNodeKey } from "./tree-node-constants.js";
+export function isProxy(value) {
+    return value && value["[[Handler]]"];
+}
+export function isCustomProxyHandler(value) {
+    return value?.[rawTNodeKey] !== undefined;
+}
+export function isTreeNode(value) {
+    try {
+        Tree.schema(value);
+        return true;
+    }
+    catch (_) {
+        return false;
+    }
+}
+//# sourceMappingURL=tree-node-types.js.map

package/bin/esm/shared-hooks/internals/tree-node-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-types.js","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAO3E,MAAM,UAAU,OAAO,CAAC,KAAU;IAC9B,OAAO,KAAK,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAChC,KAAU;IAEV,OAAO,KAAK,EAAE,CAAC,WAAW,CAAC,KAAK,SAAS,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAU;IACjC,IAAI,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC"}

package/bin/esm/shared-hooks/internals/tree-node-utils.d.ts

@@ -0,0 +1,33 @@
+import { TreeNode } from "fluid-framework";
+import { Dispatch, SetStateAction } from "react";
+/**
+ * @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
+ */
+export declare function buildProxy<TNode extends TreeNode = TreeNode>(rawNode: TNode, treeMap: WeakMap<TreeNode, TreeNode>): TNode;
+/**
+ * @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
+ */
+export declare function setUpListenersForNodeChildren<TNode extends TreeNode = TreeNode>(parentRawNode: TreeNode, rootNodeForListener: TreeNode, treeMap: WeakMap<TreeNode, TreeNode>, unsubscribeListeners: (() => void)[], setProxyNode: Dispatch<SetStateAction<TNode>>): void;
+/**
+ * @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
+ */
+export declare function getRawNode<TNode extends TreeNode | undefined = TreeNode>(node: TNode): TNode;
+//# sourceMappingURL=tree-node-utils.d.ts.map

package/bin/esm/shared-hooks/internals/tree-node-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-node-utils.d.ts","sourceRoot":"","sources":["../../../../src/shared-hooks/internals/tree-node-utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAQ,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAIjD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ,EACxD,OAAO,EAAE,KAAK,EACd,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,GACrC,KAAK,CAwCP;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,6BAA6B,CACzC,KAAK,SAAS,QAAQ,GAAG,QAAQ,EAEjC,aAAa,EAAE,QAAQ,EACvB,mBAAmB,EAAE,QAAQ,EAC7B,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACpC,oBAAoB,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,EACpC,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,QAmChD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,SAAS,QAAQ,GAAG,SAAS,GAAG,QAAQ,EACpE,IAAI,EAAE,KAAK,GACZ,KAAK,CAKP"}

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

@@ -0,0 +1,186 @@
+import { proxiedChildrenKey, rawTNodeKey } from "./tree-node-constants.js";
+import { isCustomProxyHandler, isTreeNode, isProxy, } from "./tree-node-types.js";
+import { Tree } from "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
+ */
+export function buildProxy(rawNode, treeMap) {
+    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.
+        [rawTNodeKey]: rawNode,
+        [proxiedChildrenKey]: previousProxyHandler?.[proxiedChildrenKey] ?? {},
+        get: (target, prop, _) => {
+            if (prop === "[[Handler]]") {
+                return proxyHandler;
+            }
+            if (typeof prop === "string" &&
+                proxyHandler[proxiedChildrenKey][prop]) {
+                return proxyHandler[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
+ */
+export 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) ||
+            !isTreeNode(entry)) {
+            continue;
+        }
+        const rawEntry = getRawNode(entry);
+        const onNodeChanged = () => {
+            onTreeNodeChanged(key, rawEntry, rootNodeForListener, treeMap, setProxyNode);
+        };
+        const unsubscribe = 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
+ */
+export function getRawNode(node) {
+    if (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 = 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[proxiedChildrenKey][key] = proxyNode;
+    if (rawParentNode === rootNodeForListener) {
+        setProxyNode(parentProxy);
+    }
+    else {
+        const parentOfParent = 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) ||
+            !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 (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) {
+    return getCustomProxyHandler(proxy)?.[rawTNodeKey];
+}
+//# sourceMappingURL=tree-node-utils.js.map

package/bin/esm/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":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAEH,oBAAoB,EACpB,UAAU,EACV,OAAO,GACV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAY,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAGjD,iBAAiB;AAEjB;;;;;;;GAOG;AACH,MAAM,UAAU,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,WAAW,CAAC,EAAE,OAAO;QACtB,CAAC,kBAAkB,CAAC,EAAE,oBAAoB,EAAE,CAAC,kBAAkB,CAAC,IAAI,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,kBAAkB,CAAC,CAAC,IAAI,CAAC,EACxC,CAAC;gBACC,OAAO,YAAY,CAAC,kBAAkB,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,MAAM,UAAU,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,UAAU,CAAC,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,IAAI,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,MAAM,UAAU,UAAU,CACtB,IAAW;IAEX,IAAI,OAAO,CAAC,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,IAAI,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,kBAAkB,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,IAAI,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,UAAU,CAAC,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,oBAAoB,CAAC,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,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;AACvD,CAAC"}

package/bin/{shared-hooks → esm/shared-hooks}/useDynamicDDS.d.ts

@@ -3,20 +3,20 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 import { FluidObject, IFluidLoadable } from "@fluidframework/core-interfaces";
-import { LoadableObjectClass } from "fluid-framework";
+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 LoadableObjectClass type to load. Must conform to IFluidLoadable interface.
+ * @template T Type of Fluid SharedObjectKind type to load. Must conform to IFluidLoadable interface.
  * @param uniqueKey uniqueKey value for the data object
- * @param loadableObjectClass Fluid LoadableObjectClass<T> to create/load.
+ * @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, loadableObjectClass: LoadableObjectClass<T>, onFirstInitialize?: (dds: T) => void): {
+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;
 };

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