@microsoft/live-share-react 1.0.0-preview.8 → 1.0.1-preview.1

package/bin/{internal-hooks → internal}/useSharedStateRegistry.js

@@ -1,100 +1,102 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import React from "react";
-/**
- * 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.
- *
- * @param results IAzureContainerResults response or undefined
- * @returns ISharedStateRegistryResponse object
- */
-export const useSharedStateRegistry = (results) => {
-    const registeredSharedSetStateActionMapRef = React.useRef(new Map());
-    /**
-     * @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 stateMap = results === null || results === void 0 ? void 0 : results.container.initialObjects.TURBO_STATE_MAP;
-        const initialValue = stateMap === null || stateMap === void 0 ? void 0 : stateMap.get(uniqueKey);
-        if (initialValue) {
-            setLocalStateAction(initialValue);
-        }
-    }, [results]);
-    /**
-     * @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 (!results)
-            return;
-        const { container } = results;
-        const stateMap = container.initialObjects.TURBO_STATE_MAP;
-        stateMap.set(uniqueKey, value);
-    }, [results]);
-    /**
-     * @see ISharedStateRegistryResponse.deleteSharedState
-     */
-    const deleteSharedState = React.useCallback((uniqueKey) => {
-        if (!results)
-            return;
-        const { container } = results;
-        let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
-        actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.clear();
-        const stateMap = container.initialObjects.TURBO_STATE_MAP;
-        stateMap.delete(uniqueKey);
-    }, [results]);
-    React.useEffect(() => {
-        if (!results)
-            return;
-        const { container } = results;
-        const stateMap = container.initialObjects.TURBO_STATE_MAP;
-        const valueChangedListener = (changed) => {
-            if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
-                const value = 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.off("valueChanged", valueChangedListener);
-        };
-    }, [results]);
-    return {
-        registerSharedSetStateAction,
-        unregisterSharedSetStateAction,
-        updateSharedState,
-        deleteSharedState,
-    };
-};
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+/**
+ * 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.
+ *
+ * @param results IAzureContainerResults response or undefined
+ * @returns ISharedStateRegistryResponse object
+ */
+export const useSharedStateRegistry = (results) => {
+    const registeredSharedSetStateActionMapRef = React.useRef(new Map());
+    /**
+     * @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 stateMap = results === null || results === void 0 ? void 0 : results.container.initialObjects.TURBO_STATE_MAP;
+        const initialValue = stateMap === null || stateMap === void 0 ? void 0 : stateMap.get(uniqueKey);
+        if (initialValue) {
+            setLocalStateAction(initialValue);
+        }
+    }, [results]);
+    /**
+     * @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 (!results)
+            return;
+        const { container } = results;
+        const stateMap = container.initialObjects
+            .TURBO_STATE_MAP;
+        stateMap.set(uniqueKey, value);
+    }, [results]);
+    /**
+     * @see ISharedStateRegistryResponse.deleteSharedState
+     */
+    const deleteSharedState = React.useCallback((uniqueKey) => {
+        if (!results)
+            return;
+        const { container } = results;
+        let actionsMap = registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+        actionsMap === null || actionsMap === void 0 ? void 0 : actionsMap.clear();
+        const stateMap = container.initialObjects
+            .TURBO_STATE_MAP;
+        stateMap.delete(uniqueKey);
+    }, [results]);
+    React.useEffect(() => {
+        if (!results)
+            return;
+        const { container } = results;
+        const stateMap = container.initialObjects.TURBO_STATE_MAP;
+        const valueChangedListener = (changed) => {
+            if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
+                const value = 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.off("valueChanged", valueChangedListener);
+        };
+    }, [results]);
+    return {
+        registerSharedSetStateAction,
+        unregisterSharedSetStateAction,
+        updateSharedState,
+        deleteSharedState,
+    };
+};
 //# sourceMappingURL=useSharedStateRegistry.js.map

package/bin/internal/useSharedStateRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedStateRegistry.js","sourceRoot":"","sources":["../../src/internal/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,MAAM,OAAO,CAAC;AA6B1B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,OAA2C,EACf,EAAE;IAC9B,MAAM,oCAAoC,GAAG,KAAK,CAAC,MAAM,CAEvD,IAAI,GAAG,EAAE,CAAC,CAAC;IAEb;;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;YACZ,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;gBAC9B,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;aACpD;SACJ;aAAM;YACH,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;SACL;QACD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC,cAAc,CAC7C,eAAwC,CAAC;QAC9C,MAAM,YAAY,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,YAAY,EAAE;YACd,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACrC;IACL,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,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;YAC9B,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAClC;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,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc;aACpC,eAA4B,CAAC;QAClC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,CAAC;IAEF;;OAEG;IACH,MAAM,iBAAiB,GAA4B,KAAK,CAAC,WAAW,CAChE,CAAC,SAAiB,EAAE,EAAE;QAClB,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,IAAI,UAAU,GACV,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc;aACpC,eAA4B,CAAC;QAClC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC,EACD,CAAC,OAAO,CAAC,CACZ,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,eAA4B,CAAC;QACvE,MAAM,oBAAoB,GAAG,CAAC,OAAsB,EAAQ,EAAE;YAC1D,IAAI,oCAAoC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxC,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;aACN;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,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QACvD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO;QACH,4BAA4B;QAC5B,8BAA8B;QAC9B,iBAAiB;QACjB,iBAAiB;KACpB,CAAC;AACN,CAAC,CAAC"}

package/bin/live-hooks/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./useLivePresence";
-export * from "./useLiveState";
-export * from "./useMediaSynchronizer";
-export * from "./useLiveEvent";
-export * from "./useLiveCanvas";
-export * from "./useLiveTimer";
+export * from "./useLivePresence";
+export * from "./useLiveState";
+export * from "./useMediaSynchronizer";
+export * from "./useLiveEvent";
+export * from "./useLiveCanvas";
+export * from "./useLiveTimer";
 //# sourceMappingURL=index.d.ts.map

package/bin/live-hooks/index.js

@@ -1,7 +1,7 @@
-export * from "./useLivePresence";
-export * from "./useLiveState";
-export * from "./useMediaSynchronizer";
-export * from "./useLiveEvent";
-export * from "./useLiveCanvas";
-export * from "./useLiveTimer";
+export * from "./useLivePresence";
+export * from "./useLiveState";
+export * from "./useMediaSynchronizer";
+export * from "./useLiveEvent";
+export * from "./useLiveCanvas";
+export * from "./useLiveTimer";
 //# sourceMappingURL=index.js.map

package/bin/live-hooks/useLiveCanvas.d.ts

@@ -1,28 +1,28 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { CanvasReferencePoint, IBrush, InkingTool, IPoint, IUserInfo } from "@microsoft/live-share-canvas";
-import React from "react";
-import { IUseLiveCanvasResults } from "../types";
-/**
- * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
- *
- * @remarks
- * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
- * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
- *
- * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
- * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
- * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
- * @param localUserCursor Optional. Stateful `IUserInfo` object for the local user's metadata to display alongside their cursor. Defaults to undefined.
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
- */
-export declare function useLiveCanvas(uniqueKey: string, canvasElementRef: React.RefObject<HTMLElement | null> | string, active?: boolean, tool?: InkingTool, lineBrush?: IBrush, offset?: IPoint, scale?: number, referencePoint?: CanvasReferencePoint, isCursorShared?: boolean, localUserCursor?: IUserInfo): IUseLiveCanvasResults;
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { CanvasReferencePoint, IBrush, InkingTool, IPoint } from "@microsoft/live-share-canvas";
+import React from "react";
+import { IUseLiveCanvasResults } from "../types";
+/**
+ * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
+ * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
+ *
+ * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
+ * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
+ * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
+ * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
+ * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
+ * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
+ * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
+ * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
+ * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
+ * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
+ * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
+ */
+export declare function useLiveCanvas(uniqueKey: string, canvasElementRef: React.RefObject<HTMLElement | null> | string, active?: boolean, tool?: InkingTool, lineBrush?: IBrush, offset?: IPoint, scale?: number, referencePoint?: CanvasReferencePoint, isCursorShared?: boolean, localUserPictureUrl?: string): IUseLiveCanvasResults;
 //# sourceMappingURL=useLiveCanvas.d.ts.map

package/bin/live-hooks/useLiveCanvas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLiveCanvas.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,MAAM,EAEN,UAAU,EACV,MAAM,EACN,SAAS,EAEZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,MAAM,EAC9D,MAAM,CAAC,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE,UAAU,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,oBAAoB,EACrC,cAAc,CAAC,EAAE,OAAO,EACxB,eAAe,CAAC,EAAE,SAAS,GAC5B,qBAAqB,CAoJvB"}
+{"version":3,"file":"useLiveCanvas.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,MAAM,EAEN,UAAU,EACV,MAAM,EAET,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,MAAM,EAC9D,MAAM,CAAC,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE,UAAU,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,oBAAoB,EACrC,cAAc,CAAC,EAAE,OAAO,EACxB,mBAAmB,CAAC,EAAE,MAAM,GAC7B,qBAAqB,CA6IvB"}

package/bin/live-hooks/useLiveCanvas.js

@@ -1,167 +1,159 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { InkingManager, LiveCanvas, } from "@microsoft/live-share-canvas";
-import React from "react";
-import { useDynamicDDS } from "../shared-hooks";
-import { isRefObject } from "../utils";
-/**
- * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
- *
- * @remarks
- * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
- * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
- *
- * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
- * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
- * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
- * @param localUserCursor Optional. Stateful `IUserInfo` object for the local user's metadata to display alongside their cursor. Defaults to undefined.
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
- */
-export function useLiveCanvas(uniqueKey, canvasElementRef, active, tool, lineBrush, offset, scale, referencePoint, isCursorShared, localUserCursor) {
-    /**
-     * User facing: inking manager instance
-     */
-    const [inkingManager, setInkingManager] = React.useState();
-    /**
-     * User facing: dynamically load the DDS for the given unique key.
-     */
-    const { dds: liveCanvas } = useDynamicDDS(uniqueKey, LiveCanvas);
-    /**
-     * Setup the InkingManager and LiveCanvas
-     */
-    React.useEffect(() => {
-        // if the component is already listening or liveCanvas is not yet initialized, return
-        if (!liveCanvas)
-            return;
-        // get the canvas element from the ref or document
-        let htmlElement;
-        if (isRefObject(canvasElementRef)) {
-            htmlElement = canvasElementRef.current;
-        }
-        else {
-            htmlElement = document.getElementById(canvasElementRef);
-        }
-        if (htmlElement === null)
-            return;
-        // Create the InkingManager and initialize the liveCanvas with it
-        const inkingManager = new InkingManager(htmlElement);
-        setInkingManager(inkingManager);
-        liveCanvas.initialize(inkingManager);
-        // cleanup function to be called when the component is unmount
-        return () => {
-            liveCanvas.dispose();
-            inkingManager.removeAllListeners();
-        };
-    }, [liveCanvas]);
-    /**
-     * Activate or deactivate the inkingManager based on the 'active' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && active !== undefined) {
-            if (active) {
-                inkingManager.activate();
-            }
-            else {
-                inkingManager.deactivate();
-            }
-        }
-    }, [active, inkingManager]);
-    /**
-     * Sets the tool of the inkingManager based on the 'tool' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && tool !== undefined) {
-            inkingManager.tool = tool;
-        }
-    }, [tool, inkingManager]);
-    /**
-     * Sets the offset of the inkingManager based on the 'offset' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && offset !== undefined) {
-            inkingManager.offset = {
-                x: offset.x,
-                y: offset.y,
-            };
-        }
-    }, [offset === null || offset === void 0 ? void 0 : offset.x, offset === null || offset === void 0 ? void 0 : offset.y, inkingManager]);
-    /**
-     * Sets the scale of the inkingManager based on the 'scale' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && scale !== undefined) {
-            inkingManager.scale = scale;
-        }
-    }, [scale, inkingManager]);
-    /**
-     * Sets the referencePoint of the inkingManager based on the 'referencePoint' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && referencePoint !== undefined) {
-            inkingManager.referencePoint = referencePoint;
-        }
-    }, [referencePoint, inkingManager]);
-    /**
-     * Sets the lineBrush of the inkingManager based on the 'lineBrush' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && lineBrush) {
-            inkingManager.lineBrush = {
-                color: lineBrush.color,
-                tip: lineBrush.tip,
-                tipSize: lineBrush.tipSize,
-                type: lineBrush.type,
-                endArrow: lineBrush.endArrow,
-            };
-        }
-    }, [
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.color,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tip,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tipSize,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.type,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.endArrow,
-        inkingManager,
-    ]);
-    /**
-     * Sets the isCursorShared of the liveCanvas based on the 'isCursorShared' prop
-     */
-    React.useEffect(() => {
-        if ((liveCanvas === null || liveCanvas === void 0 ? void 0 : liveCanvas.isCursorShared) !== undefined &&
-            isCursorShared !== undefined) {
-            liveCanvas.isCursorShared = isCursorShared;
-        }
-    }, [isCursorShared, liveCanvas === null || liveCanvas === void 0 ? void 0 : liveCanvas.isCursorShared]);
-    /**
-     * Sets the onGetLocalUserInfo method of the liveCanvas based on the 'localUserCursor' prop
-     */
-    React.useEffect(() => {
-        if ((liveCanvas === null || liveCanvas === void 0 ? void 0 : liveCanvas.onGetLocalUserInfo) !== undefined && localUserCursor) {
-            liveCanvas.onGetLocalUserInfo = () => {
-                return {
-                    displayName: localUserCursor.displayName,
-                    pictureUri: localUserCursor.pictureUri,
-                };
-            };
-        }
-    }, [
-        localUserCursor === null || localUserCursor === void 0 ? void 0 : localUserCursor.displayName,
-        localUserCursor === null || localUserCursor === void 0 ? void 0 : localUserCursor.pictureUri,
-        liveCanvas === null || liveCanvas === void 0 ? void 0 : liveCanvas.onGetLocalUserInfo,
-    ]);
-    /**
-     * Return hook response
-     */
-    return {
-        inkingManager,
-        liveCanvas,
-    };
-}
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { InkingManager, LiveCanvas, } from "@microsoft/live-share-canvas";
+import React from "react";
+import { useDynamicDDS } from "../shared-hooks";
+import { isRefObject } from "../utils";
+/**
+ * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
+ * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
+ *
+ * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
+ * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
+ * @param active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
+ * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
+ * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
+ * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
+ * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
+ * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
+ * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
+ * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
+ * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
+ */
+export function useLiveCanvas(uniqueKey, canvasElementRef, active, tool, lineBrush, offset, scale, referencePoint, isCursorShared, localUserPictureUrl) {
+    /**
+     * User facing: inking manager instance
+     */
+    const [inkingManager, setInkingManager] = React.useState();
+    /**
+     * User facing: dynamically load the DDS for the given unique key.
+     */
+    const { dds: liveCanvas } = useDynamicDDS(uniqueKey, LiveCanvas);
+    /**
+     * Setup the InkingManager and LiveCanvas
+     */
+    React.useEffect(() => {
+        // if the component is already listening or liveCanvas is not yet initialized, return
+        if (!liveCanvas)
+            return;
+        // get the canvas element from the ref or document
+        let htmlElement;
+        if (isRefObject(canvasElementRef)) {
+            htmlElement = canvasElementRef.current;
+        }
+        else {
+            htmlElement = document.getElementById(canvasElementRef);
+        }
+        if (htmlElement === null)
+            return;
+        // Create the InkingManager and initialize the liveCanvas with it
+        const inkingManager = new InkingManager(htmlElement);
+        setInkingManager(inkingManager);
+        liveCanvas.initialize(inkingManager);
+        // cleanup function to be called when the component is unmount
+        return () => {
+            liveCanvas.dispose();
+            inkingManager.removeAllListeners();
+        };
+    }, [liveCanvas]);
+    /**
+     * Activate or deactivate the inkingManager based on the 'active' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && active !== undefined) {
+            if (active) {
+                inkingManager.activate();
+            }
+            else {
+                inkingManager.deactivate();
+            }
+        }
+    }, [active, inkingManager]);
+    /**
+     * Sets the tool of the inkingManager based on the 'tool' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && tool !== undefined) {
+            inkingManager.tool = tool;
+        }
+    }, [tool, inkingManager]);
+    /**
+     * Sets the offset of the inkingManager based on the 'offset' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && offset !== undefined) {
+            inkingManager.offset = {
+                x: offset.x,
+                y: offset.y,
+            };
+        }
+    }, [offset === null || offset === void 0 ? void 0 : offset.x, offset === null || offset === void 0 ? void 0 : offset.y, inkingManager]);
+    /**
+     * Sets the scale of the inkingManager based on the 'scale' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && scale !== undefined) {
+            inkingManager.scale = scale;
+        }
+    }, [scale, inkingManager]);
+    /**
+     * Sets the referencePoint of the inkingManager based on the 'referencePoint' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && referencePoint !== undefined) {
+            inkingManager.referencePoint = referencePoint;
+        }
+    }, [referencePoint, inkingManager]);
+    /**
+     * Sets the lineBrush of the inkingManager based on the 'lineBrush' prop
+     */
+    React.useEffect(() => {
+        if (inkingManager && lineBrush) {
+            inkingManager.lineBrush = {
+                color: lineBrush.color,
+                tip: lineBrush.tip,
+                tipSize: lineBrush.tipSize,
+                type: lineBrush.type,
+                endArrow: lineBrush.endArrow,
+            };
+        }
+    }, [
+        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.color,
+        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tip,
+        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tipSize,
+        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.type,
+        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.endArrow,
+        inkingManager,
+    ]);
+    /**
+     * Sets the isCursorShared of the liveCanvas based on the 'isCursorShared' prop
+     */
+    React.useEffect(() => {
+        if (liveCanvas && isCursorShared !== undefined) {
+            liveCanvas.isCursorShared = isCursorShared;
+        }
+    }, [isCursorShared, liveCanvas]);
+    /**
+     * Sets the onGetLocalUserInfo method of the liveCanvas based on the 'localUserCursor' prop
+     */
+    React.useEffect(() => {
+        if (liveCanvas && localUserPictureUrl) {
+            liveCanvas.onGetLocalUserPictureUrl = () => {
+                return localUserPictureUrl;
+            };
+        }
+    }, [localUserPictureUrl, liveCanvas]);
+    /**
+     * Return hook response
+     */
+    return {
+        inkingManager,
+        liveCanvas,
+    };
+}
 //# sourceMappingURL=useLiveCanvas.js.map