@microsoft/live-share-react 2.0.0-internal.1 → 2.0.0-internal.11

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

@@ -0,0 +1,74 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { useFluidObjectsContext } from "../providers/index.js";
+import { v4 as uuid } from "uuid";
+import { isPrevStateCallback } from "../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`.
+ */
+export function useSharedState(uniqueKey, initialState) {
+    /**
+     * User facing: stateful value and non-user facing setter.
+     */
+    const [localState, setLocalState] = React.useState(initialState);
+    /**
+     * Unique ID reference for the component.
+     */
+    const componentIdRef = React.useRef(uuid());
+    /**
+     * Register set state callbacks from AzureProvider and update/delete callbacks for initial object's `stateMap`.
+     */
+    const { registerSharedSetStateAction, unregisterSharedSetStateAction, updateSharedState, deleteSharedState, } = useFluidObjectsContext();
+    /**
+     * User facing: callback to change the shared state.
+     */
+    const setSharedState = React.useCallback((state) => {
+        setLocalState((prevState) => {
+            const valueToSet = 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.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.useEffect(() => {
+        registerSharedSetStateAction(uniqueKey, componentIdRef.current, setLocalState);
+        return () => {
+            unregisterSharedSetStateAction(uniqueKey, componentIdRef.current);
+        };
+    }, [
+        uniqueKey,
+        registerSharedSetStateAction,
+        unregisterSharedSetStateAction,
+    ]);
+    return [localState, setSharedState, disposeSharedState];
+}
+//# sourceMappingURL=useSharedState.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedState.js","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAK/D,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAC1B,SAAiB,EACjB,YAAe;IAEf;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAI,YAAY,CAAC,CAAC;IACpE;;OAEG;IACH,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5C;;OAEG;IACH,MAAM,EACF,4BAA4B,EAC5B,8BAA8B,EAC9B,iBAAiB,EACjB,iBAAiB,GACpB,GAAG,sBAAsB,EAAE,CAAC;IAE7B;;OAEG;IACH,MAAM,cAAc,GAA4B,KAAK,CAAC,WAAW,CAC7D,CAAC,KAAgC,EAAE,EAAE;QACjC,aAAa,CAAC,CAAC,SAAS,EAAE,EAAE;YACxB,MAAM,UAAU,GAAG,mBAAmB,CAAI,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,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACnB,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,KAAK,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/esm/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/esm/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"}

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

@@ -0,0 +1,113 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { getRootDataObject, getRootDirectory, TurboDirectory, TurboStateMap, } from "@microsoft/live-share/internal";
+/**
+ * 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 const useSharedStateRegistry = (results) => {
+    const registeredSharedSetStateActionMapRef = React.useRef(new Map());
+    const stateMap = useStateMap(results === null || results === void 0 ? void 0 : results.container);
+    /**
+     * @see ISharedStateRegistryResponse.registerSharedSetStateAction
+     */
+    const registerSharedSetStateAction = React.useCallback((uniqueKey, componentId, setLocalStateAction) => {
+        let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+        if (actionsMap) {
+            if (!actionsMap.has(componentId)) {
+                actionsMap.set(componentId, setLocalStateAction);
+            }
+        }
+        else {
+            actionsMap = new Map();
+            actionsMap.set(componentId, setLocalStateAction);
+            registeredSharedSetStateActionMapRef.current.set(uniqueKey, actionsMap);
+        }
+        // Set initial values, if known
+        const initialValue = stateMap === null || stateMap === void 0 ? void 0 : stateMap.get(uniqueKey);
+        if (initialValue) {
+            setLocalStateAction(initialValue);
+        }
+    }, [stateMap]);
+    /**
+     * @see ISharedStateRegistryResponse.unregisterSharedSetStateAction
+     */
+    const unregisterSharedSetStateAction = React.useCallback((uniqueKey, componentId) => {
+        let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+        if (actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.has(componentId)) {
+            actionsMap.delete(componentId);
+        }
+    }, []);
+    /**
+     * @see ISharedStateRegistryResponse.updateSharedState
+     */
+    const updateSharedState = React.useCallback((uniqueKey, value) => {
+        if (!stateMap)
+            return;
+        stateMap === null || stateMap === void 0 ? void 0 : stateMap.set(uniqueKey, value);
+    }, [stateMap]);
+    /**
+     * @see ISharedStateRegistryResponse.deleteSharedState
+     */
+    const deleteSharedState = React.useCallback((uniqueKey) => {
+        if (!stateMap)
+            return;
+        let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+        actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.clear();
+        stateMap.delete(uniqueKey);
+    }, [stateMap]);
+    React.useEffect(() => {
+        if (!stateMap)
+            return;
+        const valueChangedListener = (changed) => {
+            if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
+                const value = stateMap === null || stateMap === void 0 ? void 0 : stateMap.get(changed.key);
+                const actionMap = registeredSharedSetStateActionMapRef.current.get(changed.key);
+                actionMap === null || actionMap === void 0 ? void 0 : actionMap.forEach((setLocalStateHandler) => {
+                    setLocalStateHandler(value);
+                });
+            }
+        };
+        stateMap.on("valueChanged", valueChangedListener);
+        // Set initial values
+        stateMap.forEach((value, key) => {
+            const actionMap = registeredSharedSetStateActionMapRef.current.get(key);
+            actionMap === null || actionMap === void 0 ? void 0 : actionMap.forEach((setLocalStateHandler) => {
+                setLocalStateHandler(value);
+            });
+        });
+        return () => {
+            stateMap === null || stateMap === void 0 ? void 0 : stateMap.off("valueChanged", valueChangedListener);
+        };
+    }, [stateMap]);
+    return {
+        registerSharedSetStateAction,
+        unregisterSharedSetStateAction,
+        updateSharedState,
+        deleteSharedState,
+    };
+};
+const useStateMap = (container) => {
+    const [stateMap, setStateMap] = React.useState();
+    React.useEffect(() => {
+        if (!container) {
+            return;
+        }
+        const rootDataObject = getRootDataObject(container);
+        const rootDirectory = getRootDirectory(rootDataObject);
+        const turboDir = rootDirectory.getSubDirectory(TurboDirectory);
+        turboDir === null || turboDir === void 0 ? void 0 : turboDir.get(TurboStateMap).get().then((state) => {
+            setStateMap(state);
+        });
+    }, [container]);
+    return stateMap;
+};
+//# sourceMappingURL=useSharedStateRegistry.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedStateRegistry.js","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,KAAK,MAAM,OAAO,CAAC;AAS1B,OAAO,EACH,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,aAAa,GAChB,MAAM,gCAAgC,CAAC;AAwBxC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,OAA2C,EACf,EAAE;IAC9B,MAAM,oCAAoC,GAAG,KAAK,CAAC,MAAM,CAEvD,IAAI,GAAG,EAAE,CAAC,CAAC;IAEb,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,MAAM,4BAA4B,GAAG,KAAK,CAAC,WAAW,CAClD,CACI,SAAiB,EACjB,WAAmB,EACnB,mBAAwC,EAC1C,EAAE;QACA,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/B,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;YACpD,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YACjD,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAC5C,SAAS,EACT,UAAU,CACb,CAAC;QACN,CAAC;QACD,+BAA+B;QAC/B,MAAM,YAAY,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,YAAY,EAAE,CAAC;YACf,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;IACL,CAAC,EACD,CAAC,QAAQ,CAAC,CACb,CAAC;IAEF;;OAEG;IACH,MAAM,8BAA8B,GAAG,KAAK,CAAC,WAAW,CACpD,CAAC,SAAiB,EAAE,WAAmB,EAAE,EAAE;QACvC,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC;IACL,CAAC,EACD,EAAE,CACL,CAAC;IAEF;;OAEG;IACH,MAAM,iBAAiB,GAA4B,KAAK,CAAC,WAAW,CAChE,CAAC,SAAiB,EAAE,KAAU,EAAE,EAAE;QAC9B,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,EACD,CAAC,QAAQ,CAAC,CACb,CAAC;IAEF;;OAEG;IACH,MAAM,iBAAiB,GAA4B,KAAK,CAAC,WAAW,CAChE,CAAC,SAAiB,EAAE,EAAE;QAClB,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;QACpB,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC,EACD,CAAC,QAAQ,CAAC,CACb,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,MAAM,oBAAoB,GAAG,CAAC,OAAsB,EAAQ,EAAE;YAC1D,IAAI,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChE,MAAM,KAAK,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACzC,MAAM,SAAS,GACX,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAC5C,OAAO,CAAC,GAAG,CACd,CAAC;gBACN,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE;oBACxC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC;QACF,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QAClD,qBAAqB;QACrB,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAW,EAAE,EAAE;YACzC,MAAM,SAAS,GACX,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1D,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE;gBACxC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACR,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QACxD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,OAAO;QACH,4BAA4B;QAC5B,8BAA8B;QAC9B,iBAAiB;QACjB,iBAAiB;KACpB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAsC,EAAE,EAAE;IAC3D,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAyB,CAAC;IACxE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,OAAO;QACX,CAAC;QACD,MAAM,cAAc,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,aAAa,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,aAAa,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAC/D,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CACF,GAAG,CAAC,aAAa,EAClB,GAAG,GACH,IAAI,CAAC,CAAC,KAAgB,EAAE,EAAE;YACvB,WAAW,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACX,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC"}

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

@@ -0,0 +1,57 @@
+import { ImplicitFieldSchema, TreeViewConfiguration, InsertableTreeFieldFromImplicitField } from "fluid-framework";
+import { IUseSharedTreeResults } from "../types/index.js";
+/**
+ * Creates a new Fluid `SharedTree` instance if one doesn't already exist.
+ * @remarks
+ * Use the `root` variable from the {@link IUseSharedTreeResults} response from this hook with {@link useTreeNode}.
+ * This makes `root` stateful with React whenever a leaf of `root` changes.
+ *
+ * @param uniqueKey the unique key for the `SharedTree`. If one does not yet exist, a new `SharedTree` will be created.
+ * Otherwise it will use the existing one.
+ * @param treeViewConfiguration the tree view configuration that contains the `SharedTree` field schema.
+ * @param initialData the initial data to load into the `SharedTree` when it is first created.
+ * @returns the {@link IUseSharedTreeResults} with the `root` node.
+ *
+ * @example
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ * class YourObject extends sf.object("YourObject", {
+ *  listChangedCount: sf.number,
+ *  list: sf.array(sf.string),
+ * }) {
+ *  // You can add your own utility functions
+ *  insert() {
+ *      this.list.insertAtEnd("some text");
+ *      this.listChangedCount += 1;
+ *  }
+ * }
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  number: 0,
+ *  list: [],
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Makes root stateful / automatically update when the node changes (e.g., node.count)
+ *  const { node } = useTreeNode(root);
+ *  // node.list is its own TreeNode, so we make it stateful as well
+ *  const { node: list } = useTreeNode(node?.list);
+ *  if (!node || !list) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.listChangedCount}</div>
+ *          <button onClick={() => node.insert()}>Insert</button>
+ *          { list.map((item) => <div key={item}>{item}</div>) }
+ *      </div>
+ *  );
+ * }
+ * ```
+ */
+export declare function useSharedTree<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema>(uniqueKey: string, treeViewConfiguration: TreeViewConfiguration<TSchema>, initialData: InsertableTreeFieldFromImplicitField<TSchema>): IUseSharedTreeResults<TSchema>;
+//# sourceMappingURL=useSharedTree.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedTree.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedTree.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,mBAAmB,EACnB,qBAAqB,EAIrB,oCAAoC,EAEvC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAI1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,aAAa,CACzB,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EAEzD,SAAS,EAAE,MAAM,EACjB,qBAAqB,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACrD,WAAW,EAAE,oCAAoC,CAAC,OAAO,CAAC,GAC3D,qBAAqB,CAAC,OAAO,CAAC,CAuEhC"}

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

@@ -0,0 +1,117 @@
+import { SharedTree, } from "fluid-framework";
+import { useDynamicDDS } from "../shared-hooks/index.js";
+import React from "react";
+/**
+ * Creates a new Fluid `SharedTree` instance if one doesn't already exist.
+ * @remarks
+ * Use the `root` variable from the {@link IUseSharedTreeResults} response from this hook with {@link useTreeNode}.
+ * This makes `root` stateful with React whenever a leaf of `root` changes.
+ *
+ * @param uniqueKey the unique key for the `SharedTree`. If one does not yet exist, a new `SharedTree` will be created.
+ * Otherwise it will use the existing one.
+ * @param treeViewConfiguration the tree view configuration that contains the `SharedTree` field schema.
+ * @param initialData the initial data to load into the `SharedTree` when it is first created.
+ * @returns the {@link IUseSharedTreeResults} with the `root` node.
+ *
+ * @example
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ * class YourObject extends sf.object("YourObject", {
+ *  listChangedCount: sf.number,
+ *  list: sf.array(sf.string),
+ * }) {
+ *  // You can add your own utility functions
+ *  insert() {
+ *      this.list.insertAtEnd("some text");
+ *      this.listChangedCount += 1;
+ *  }
+ * }
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  number: 0,
+ *  list: [],
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Makes root stateful / automatically update when the node changes (e.g., node.count)
+ *  const { node } = useTreeNode(root);
+ *  // node.list is its own TreeNode, so we make it stateful as well
+ *  const { node: list } = useTreeNode(node?.list);
+ *  if (!node || !list) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.listChangedCount}</div>
+ *          <button onClick={() => node.insert()}>Insert</button>
+ *          { list.map((item) => <div key={item}>{item}</div>) }
+ *      </div>
+ *  );
+ * }
+ * ```
+ */
+export function useSharedTree(uniqueKey, treeViewConfiguration, initialData) {
+    const [treeView, setTreeView] = React.useState();
+    const [root, setRoot] = React.useState();
+    const onFirstInitialize = React.useCallback((newDDS) => {
+        try {
+            // Create a `treeView` with the provided `treeViewConfiguration`
+            const _treeView = newDDS.viewWith(treeViewConfiguration);
+            if (_treeView.compatibility.canInitialize) {
+                // Set initial data
+                _treeView.initialize(initialData);
+            }
+            // `onFirstInitialize` is only called for the user that created the tree, but we need this object for all clients.
+            // Dispose, since we will call `sharedTree.viewWith` in a `useEffect` down below and set it to state.
+            _treeView.dispose();
+        }
+        catch (err) {
+            console.error(err);
+        }
+    }, [treeViewConfiguration, initialData]);
+    /**
+     * User facing: dynamically load the `SharedTree` DDS for the given unique key.
+     */
+    const { dds: sharedTree } = useDynamicDDS(uniqueKey, SharedTree, onFirstInitialize);
+    /**
+     * Sets the tree view and root view
+     */
+    React.useEffect(() => {
+        if (!sharedTree)
+            return;
+        let _treeView = undefined;
+        try {
+            // Create a `treeView` with the provided `treeViewConfiguration`
+            _treeView = sharedTree.viewWith(treeViewConfiguration);
+            setTreeView(_treeView);
+        }
+        catch (err) {
+            console.error(err);
+        }
+        // Listen for changes to root view
+        const updateRoot = () => {
+            if (_treeView === null || _treeView === void 0 ? void 0 : _treeView.compatibility.canView) {
+                setRoot(_treeView.root);
+            }
+            else {
+                setRoot(undefined);
+            }
+        };
+        updateRoot();
+        const unsubscribeToRoot = _treeView === null || _treeView === void 0 ? void 0 : _treeView.events.on("rootChanged", updateRoot);
+        return () => {
+            _treeView === null || _treeView === void 0 ? void 0 : _treeView.dispose();
+            unsubscribeToRoot === null || unsubscribeToRoot === void 0 ? void 0 : unsubscribeToRoot();
+        };
+    }, [sharedTree, treeViewConfiguration]);
+    return {
+        treeView,
+        sharedTree,
+        root,
+    };
+}
+//# sourceMappingURL=useSharedTree.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedTree.js","sourceRoot":"","sources":["../../../src/shared-hooks/useSharedTree.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,UAAU,GAKb,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,aAAa,EAAe,MAAM,0BAA0B,CAAC;AACtE,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,UAAU,aAAa,CAGzB,SAAiB,EACjB,qBAAqD,EACrD,WAA0D;IAE1D,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAqB,CAAC;IACpE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GACjB,KAAK,CAAC,QAAQ,EAAuC,CAAC;IAE1D,MAAM,iBAAiB,GAAG,KAAK,CAAC,WAAW,CACvC,CAAC,MAAa,EAAQ,EAAE;QACpB,IAAI,CAAC;YACD,gEAAgE;YAChE,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YACzD,IAAI,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;gBACxC,mBAAmB;gBACnB,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;YACD,kHAAkH;YAClH,qGAAqG;YACrG,SAAS,CAAC,OAAO,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACL,CAAC,EACD,CAAC,qBAAqB,EAAE,WAAW,CAAC,CACvC,CAAC;IACF;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,aAAa,CACrC,SAAS,EACT,UAAU,EACV,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,IAAI,SAAS,GAAkC,SAAS,CAAC;QACzD,IAAI,CAAC;YACD,gEAAgE;YAChE,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YACvD,WAAW,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QAED,kCAAkC;QAClC,MAAM,UAAU,GAAG,GAAS,EAAE;YAC1B,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,aAAa,CAAC,OAAO,EAAE,CAAC;gBACnC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACJ,OAAO,CAAC,SAAS,CAAC,CAAC;YACvB,CAAC;QACL,CAAC,CAAC;QAEF,UAAU,EAAE,CAAC;QACb,MAAM,iBAAiB,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,CAAC,EAAE,CAC1C,aAAa,EACb,UAAU,CACb,CAAC;QACF,OAAO,GAAG,EAAE;YACR,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,EAAE,CAAC;YACrB,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,EAAI,CAAC;QAC1B,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAExC,OAAO;QACH,QAAQ;QACR,UAAU;QACV,IAAI;KACP,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,96 @@
+import { TreeChangeEvents, TreeNode } from "fluid-framework";
+import { IUseTreeNodeResults } from "../types/index.js";
+/**
+ * Makes a provided Fluid `TreeNode` stateful in React.
+ *
+ * @param node the Fluid `SharedTree` `TreeNode` instance to make stateful.
+ * @param stateChangeType listener type to apply changes for. Default value is "nodeChanged", which has the most optimal performance.
+ * Provide "treeChanged" to make all children nodes stateful as well when those child nodes change.
+ * When using the default, you must pass all child `TreeNode` values into `useTreeNode` for them to be stateful as well.
+ * @returns a stateful version `node`
+ *
+ * @example
+ * Example using default `"nodeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ * class YourObject extends sf.object("YourObject", {
+ *  listChangedCount: sf.number,
+ *  list: sf.array(sf.string),
+ * }) {
+ *  // You can add your own utility functions
+ *  insert() {
+ *      this.list.insertAtEnd("some text");
+ *      this.listChangedCount += 1;
+ *  }
+ * }
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  number: 0,
+ *  list: [],
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Makes root stateful / automatically update when the node changes (e.g., node.count)
+ *  const { node } = useTreeNode(root);
+ *  // node.list is its own TreeNode, so we make it stateful as well
+ *  const { node: list } = useTreeNode(node?.list);
+ *  if (!node || !list) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.listChangedCount}</div>
+ *          <button onClick={() => node.insert()}>Insert</button>
+ *          { list.map((item) => <div key={item}>{item}</div>) }
+ *      </div>
+ *  );
+ * }
+ * ```
+ *
+ * @example
+ * Example using `"treeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ *
+ * class ChildObject extends sf.object("ChildObject", {
+ *  count: sf.number,
+ * }) {
+ *  increment() {
+ *      this.count += 1;
+ *  }
+ * }
+ *
+ * class YourObject extends sf.object("YourObject", {
+ *  child: ChildObject,
+ * }) {}
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  child: new ChildObject({ count: 0 }),
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Using "treeChanged" prop makes all children nodes stateful as well.
+ *  // Use with caution / measure render performance with React dev tools.
+ *  const { node } = useTreeNode(root, "treeChanged");
+ *  if (!node) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.child.count}</div>
+ *          <button onClick={() => node.increment()}>Insert</button>
+ *      </div>
+ *  );
+ * }
+ * ```
+ */
+export declare function useTreeNode<TNode extends TreeNode | undefined = TreeNode>(node: TNode, stateChangeType?: keyof TreeChangeEvents): IUseTreeNodeResults<TNode>;
+//# sourceMappingURL=useTreeNode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useTreeNode.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useTreeNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,gBAAgB,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAQxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,QAAQ,GAAG,SAAS,GAAG,QAAQ,EACrE,IAAI,EAAE,KAAK,EACX,eAAe,GAAE,MAAM,gBAAgC,GACxD,mBAAmB,CAAC,KAAK,CAAC,CA0C5B"}

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

@@ -0,0 +1,132 @@
+import { Tree } from "fluid-framework";
+import { useEffect, useRef, useState } from "react";
+import { getRawNode, buildProxy, setUpListenersForNodeChildren, } from "./internals/tree-node-utils.js";
+/**
+ * Makes a provided Fluid `TreeNode` stateful in React.
+ *
+ * @param node the Fluid `SharedTree` `TreeNode` instance to make stateful.
+ * @param stateChangeType listener type to apply changes for. Default value is "nodeChanged", which has the most optimal performance.
+ * Provide "treeChanged" to make all children nodes stateful as well when those child nodes change.
+ * When using the default, you must pass all child `TreeNode` values into `useTreeNode` for them to be stateful as well.
+ * @returns a stateful version `node`
+ *
+ * @example
+ * Example using default `"nodeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ * class YourObject extends sf.object("YourObject", {
+ *  listChangedCount: sf.number,
+ *  list: sf.array(sf.string),
+ * }) {
+ *  // You can add your own utility functions
+ *  insert() {
+ *      this.list.insertAtEnd("some text");
+ *      this.listChangedCount += 1;
+ *  }
+ * }
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  number: 0,
+ *  list: [],
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Makes root stateful / automatically update when the node changes (e.g., node.count)
+ *  const { node } = useTreeNode(root);
+ *  // node.list is its own TreeNode, so we make it stateful as well
+ *  const { node: list } = useTreeNode(node?.list);
+ *  if (!node || !list) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.listChangedCount}</div>
+ *          <button onClick={() => node.insert()}>Insert</button>
+ *          { list.map((item) => <div key={item}>{item}</div>) }
+ *      </div>
+ *  );
+ * }
+ * ```
+ *
+ * @example
+ * Example using `"treeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ *
+ * class ChildObject extends sf.object("ChildObject", {
+ *  count: sf.number,
+ * }) {
+ *  increment() {
+ *      this.count += 1;
+ *  }
+ * }
+ *
+ * class YourObject extends sf.object("YourObject", {
+ *  child: ChildObject,
+ * }) {}
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  child: new ChildObject({ count: 0 }),
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Using "treeChanged" prop makes all children nodes stateful as well.
+ *  // Use with caution / measure render performance with React dev tools.
+ *  const { node } = useTreeNode(root, "treeChanged");
+ *  if (!node) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.child.count}</div>
+ *          <button onClick={() => node.increment()}>Insert</button>
+ *      </div>
+ *  );
+ * }
+ * ```
+ */
+export function useTreeNode(node, stateChangeType = "nodeChanged") {
+    // When we return a proxied node to a developer, it's possible they will pass it back to us in this hook.
+    // We can't listen using Tree.on using a proxy node though...
+    // Thus, if we are already listening to a node from another instance of this hook, we look for the unproxied node.
+    const rawNode = getRawNode(node);
+    const [proxyNode, setProxyNode] = useState(rawNode);
+    const treeProxyMapRef = useRef(new WeakMap());
+    useEffect(() => {
+        if (!rawNode)
+            return;
+        // Set default value
+        setProxyNode(rawNode);
+        function onNodeChanged() {
+            if (!rawNode)
+                return;
+            const proxyNode = buildProxy(rawNode, treeProxyMapRef.current);
+            setProxyNode(proxyNode);
+        }
+        // Listen to Fluid's base node from their TreeView so Fluid flex nodes continue to work
+        const unsubscribeListeners = [
+            Tree.on(rawNode, "nodeChanged", onNodeChanged),
+        ];
+        if (stateChangeType === "treeChanged") {
+            // Recursively for all child nodes of this node in the tree
+            setUpListenersForNodeChildren(rawNode, rawNode, treeProxyMapRef.current, unsubscribeListeners, 
+            // TODO: fix typing so casting isn't necessary
+            setProxyNode);
+        }
+        return () => {
+            unsubscribeListeners.forEach((unsubscribe) => unsubscribe());
+        };
+    }, [rawNode, stateChangeType]);
+    return {
+        node: proxyNode,
+    };
+}
+//# sourceMappingURL=useTreeNode.js.map