@microsoft/live-share-react 1.0.0-preview.11 → 1.0.0-preview.12

package/bin/live-hooks/useLiveAICompletion.js

@@ -0,0 +1,186 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LiveAICompletion, LiveAICompletionEvents, } from "@microsoft/live-share-turbo";
+import React from "react";
+import { useDynamicDDS } from "../shared-hooks";
+/**
+ * React hook for using a Live Share Turbo `LiveAICompletion`. Intended for use with OpenAI's Completion API.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveAICompletion` object, which is used for using AI completions collaboratively at minimal cost.
+ *
+ * @param uniqueKey the unique key for the `LiveAICompletion`. If one does not yet exist, a new one.
+ * @param onGetCompletion React useCallback function that returns a Promise<string> for the latest `promptValue`. Function is intended to
+ * communicate with a backend API that uses OpenAI's Completion API.
+ * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
+ * @param defaultPromptValue Optional. Text that sets the default prompt value. Default value is an empty string.
+ * @param autoCompletions Optional. Stateful boolean that when true, will automatically send completions when the `promptValue` changes. Default value is
+ * false.
+ * @param debounceDelayMilliseconds Optional. Stateful number that changes the debounce interval when `autoCompletions` is true. Default value is 2500.
+ * @param lockPrompt Optional. Stateful boolean that when true, will restrict prompt changes to only the user with `haveCompletionLock` set to true. Default
+ * value is false.
+ * @param lockCompletion Optional. Stateful boolean that when true, will restrict manual completion changes to only the user with `haveCompletionLock`
+ * set to true. This does not impact the `autoCompletions` setting, because `autoCompletions` already has this behavior. Default value is false.
+ *
+ * @returns IUseLiveAICompletionResults object that contains stateful responses and callback methods from `LiveAICompletion`.
+ */
+export const useLiveAICompletion = (uniqueKey, onGetCompletion, allowedRoles, defaultPromptValue, autoCompletions, debounceDelayMilliseconds, lockPrompt, lockCompletion) => {
+    /**
+     * Reference boolean for whether hook has registered "listening" events for `LiveAICompletion`.
+     */
+    const listeningRef = React.useRef(false);
+    /**
+     * @see IUseLiveAICompletionResults["promptValue"]
+     */
+    const [promptValue, setPromptValue] = React.useState("");
+    /**
+     * @see IUseLiveAICompletionResults["completionValue"]
+     */
+    const [completionValue, setCompletionValue] = React.useState();
+    /**
+     * @see IUseLiveAICompletionResults["haveCompletionLock"]
+     */
+    const [haveCompletionLock, setHaveCompletionLock] = React.useState(false);
+    /**
+     * User facing: dynamically load the DDS for the given unique key.
+     */
+    const { dds: liveAICompletion } = useDynamicDDS(uniqueKey, LiveAICompletion);
+    /**
+     * @see IUseLiveAICompletionResults["changePrompt"]
+     */
+    const changePrompt = React.useCallback((value) => {
+        if (liveAICompletion === undefined) {
+            console.error(new Error("Cannot call emitEvent when liveEvent is undefined"));
+            return;
+        }
+        if (!liveAICompletion.isInitialized) {
+            console.error(new Error("Cannot call emitEvent while liveEvent is not started"));
+            return;
+        }
+        return liveAICompletion.changePrompt(value);
+    }, [liveAICompletion]);
+    /**
+     * @see IUseLiveAICompletionResults["changePrompt"]
+     */
+    const sendCompletion = React.useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (liveAICompletion === undefined) {
+            throw new Error("Cannot call sendCompletion while `liveAICompletion` is undefined");
+        }
+        if (!liveAICompletion.isInitialized) {
+            throw new Error("Cannot call sendCompletion while `liveAICompletion` is not initialized");
+        }
+        return liveAICompletion.sendCompletion();
+    }), [liveAICompletion]);
+    /**
+     * Sets up the `LiveAICompletion` instance.
+     */
+    React.useEffect(() => {
+        if (listeningRef.current ||
+            (liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.isInitialized) === undefined)
+            return;
+        listeningRef.current = true;
+        // Register event listeners
+        const onPromptChanged = (promptValue, local, completionValuePromise) => __awaiter(void 0, void 0, void 0, function* () {
+            setPromptValue(promptValue);
+            if (!liveAICompletion.haveValidCompletionValue) {
+                setCompletionValue(undefined);
+            }
+            try {
+                const completionValue = yield completionValuePromise;
+                setCompletionValue(completionValue);
+            }
+            catch (_a) {
+                // We do nothing, since this typically fails as a result of a new prompt value replacing the old on, permissions changing, etc.
+            }
+        });
+        const onLockGranted = () => {
+            setHaveCompletionLock(true);
+        };
+        const onLockLost = () => {
+            setHaveCompletionLock(true);
+        };
+        liveAICompletion.on(LiveAICompletionEvents.promptChanged, onPromptChanged);
+        liveAICompletion.on(LiveAICompletionEvents.lockGranted, onLockGranted);
+        liveAICompletion.on(LiveAICompletionEvents.lockLost, onLockLost);
+        if (!liveAICompletion.isInitialized) {
+            // Initialize the LiveAICompletion instance
+            liveAICompletion.initialize(onGetCompletion, allowedRoles, defaultPromptValue);
+        }
+        return () => {
+            // on unmount, remove event listeners
+            listeningRef.current = false;
+            liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.off(LiveAICompletionEvents.promptChanged, onPromptChanged);
+            liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.off(LiveAICompletionEvents.lockGranted, onLockGranted);
+            liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.off(LiveAICompletionEvents.lockLost, onLockLost);
+        };
+    }, [liveAICompletion]);
+    /**
+     * Sets the onGetCompletion of the `liveAICompletion` based on the 'onGetCompletion' prop
+     */
+    React.useEffect(() => {
+        if ((liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.isInitialized) === true &&
+            onGetCompletion !== undefined) {
+            liveAICompletion.onGetCompletion = onGetCompletion;
+        }
+    }, [liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.isInitialized, onGetCompletion]);
+    /**
+     * Sets the autoCompletions of the `liveAICompletion` based on the 'autoCompletions' prop
+     */
+    React.useEffect(() => {
+        if (liveAICompletion !== undefined &&
+            autoCompletions !== undefined &&
+            liveAICompletion.autoCompletions !== autoCompletions) {
+            liveAICompletion.autoCompletions = autoCompletions;
+        }
+    }, [liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.autoCompletions, autoCompletions]);
+    /**
+     * Sets the debounceDelayMilliseconds of the `liveAICompletion` based on the 'debounceDelayMilliseconds' prop
+     */
+    React.useEffect(() => {
+        if (liveAICompletion !== undefined &&
+            debounceDelayMilliseconds !== undefined &&
+            liveAICompletion.debounceDelayMilliseconds !== debounceDelayMilliseconds) {
+            liveAICompletion.debounceDelayMilliseconds = debounceDelayMilliseconds;
+        }
+    }, [liveAICompletion, debounceDelayMilliseconds]);
+    /**
+     * Sets the lockPrompt of the `liveAICompletion` based on the 'lockPrompt' prop
+     */
+    React.useEffect(() => {
+        if (liveAICompletion !== undefined &&
+            lockPrompt !== undefined &&
+            liveAICompletion.lockPrompt !== lockPrompt) {
+            liveAICompletion.lockPrompt = lockPrompt;
+        }
+    }, [liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.lockPrompt, lockPrompt]);
+    /**
+     * Sets the lockCompletion of the `liveAICompletion` based on the 'lockCompletion' prop
+     */
+    React.useEffect(() => {
+        if (liveAICompletion !== undefined &&
+            lockCompletion !== undefined &&
+            liveAICompletion.lockCompletion !== lockCompletion) {
+            liveAICompletion.lockCompletion = lockCompletion;
+        }
+    }, [liveAICompletion === null || liveAICompletion === void 0 ? void 0 : liveAICompletion.lockCompletion, lockCompletion]);
+    return {
+        changePrompt,
+        completionValue,
+        haveCompletionLock,
+        liveAICompletion,
+        promptValue,
+        sendCompletion,
+    };
+};
+//# sourceMappingURL=useLiveAICompletion.js.map

package/bin/live-hooks/useLiveAICompletion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveAICompletion.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveAICompletion.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAGH,OAAO,EACH,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAC/B,SAAiB,EACjB,eAAyD,EACzD,YAAgC,EAChC,kBAA2B,EAC3B,eAAyB,EACzB,yBAAkC,EAClC,UAAoB,EACpB,cAAwB,EACG,EAAE;IAC7B;;OAEG;IACH,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAS,EAAE,CAAC,CAAC;IACjE;;OAEG;IACH,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAU,CAAC;IACvE;;OAEG;IACH,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC7C,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IACnC;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,GAAG,aAAa,CAC3C,SAAS,EACT,gBAAgB,CACnB,CAAC;IAEF;;OAEG;IACH,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAClC,CAAC,KAAa,EAAE,EAAE;QACd,IAAI,gBAAgB,KAAK,SAAS,EAAE;YAChC,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CACL,mDAAmD,CACtD,CACJ,CAAC;YACF,OAAO;SACV;QACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE;YACjC,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CACL,sDAAsD,CACzD,CACJ,CAAC;YACF,OAAO;SACV;QACD,OAAO,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC,EACD,CAAC,gBAAgB,CAAC,CACrB,CAAC;IAEF;;OAEG;IACH,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,GAGtC,EAAE;QACD,IAAI,gBAAgB,KAAK,SAAS,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;SACvF;QACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE;YACjC,MAAM,IAAI,KAAK,CACX,wEAAwE,CAC3E,CAAC;SACL;QACD,OAAO,gBAAgB,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC,CAAA,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,YAAY,CAAC,OAAO;YACpB,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,aAAa,MAAK,SAAS;YAE7C,OAAO;QACX,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAC5B,2BAA2B;QAC3B,MAAM,eAAe,GAAG,CACpB,WAAmB,EACnB,KAAc,EACd,sBAAuC,EACzC,EAAE;YACA,cAAc,CAAC,WAAW,CAAC,CAAC;YAC5B,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,EAAE;gBAC5C,kBAAkB,CAAC,SAAS,CAAC,CAAC;aACjC;YACD,IAAI;gBACA,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC;gBACrD,kBAAkB,CAAC,eAAe,CAAC,CAAC;aACvC;YAAC,WAAM;gBACJ,+HAA+H;aAClI;QACL,CAAC,CAAA,CAAC;QACF,MAAM,aAAa,GAAG,GAAG,EAAE;YACvB,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,GAAG,EAAE;YACpB,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,gBAAgB,CAAC,EAAE,CACf,sBAAsB,CAAC,aAAa,EACpC,eAAe,CAClB,CAAC;QACF,gBAAgB,CAAC,EAAE,CAAC,sBAAsB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACvE,gBAAgB,CAAC,EAAE,CAAC,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE;YACjC,2CAA2C;YAC3C,gBAAgB,CAAC,UAAU,CAAC,eAAe,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC;SAClF;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC;YAC7B,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CACjB,sBAAsB,CAAC,aAAa,EACpC,eAAe,CAClB,CAAC;YACF,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CACjB,sBAAsB,CAAC,WAAW,EAClC,aAAa,CAChB,CAAC;YACF,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACvE,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,aAAa,MAAK,IAAI;YACxC,eAAe,KAAK,SAAS,EAC/B;YACE,gBAAgB,CAAC,eAAe,GAAG,eAAe,CAAC;SACtD;IACL,CAAC,EAAE,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,gBAAgB,KAAK,SAAS;YAC9B,eAAe,KAAK,SAAS;YAC7B,gBAAgB,CAAC,eAAe,KAAK,eAAe,EACtD;YACE,gBAAgB,CAAC,eAAe,GAAG,eAAe,CAAC;SACtD;IACL,CAAC,EAAE,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC;IAEzD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,gBAAgB,KAAK,SAAS;YAC9B,yBAAyB,KAAK,SAAS;YACvC,gBAAgB,CAAC,yBAAyB,KAAK,yBAAyB,EAC1E;YACE,gBAAgB,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;SAC1E;IACL,CAAC,EAAE,CAAC,gBAAgB,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,gBAAgB,KAAK,SAAS;YAC9B,UAAU,KAAK,SAAS;YACxB,gBAAgB,CAAC,UAAU,KAAK,UAAU,EAC5C;YACE,gBAAgB,CAAC,UAAU,GAAG,UAAU,CAAC;SAC5C;IACL,CAAC,EAAE,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAE/C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,gBAAgB,KAAK,SAAS;YAC9B,cAAc,KAAK,SAAS;YAC5B,gBAAgB,CAAC,cAAc,KAAK,cAAc,EACpD;YACE,gBAAgB,CAAC,cAAc,GAAG,cAAc,CAAC;SACpD;IACL,CAAC,EAAE,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;IAEvD,OAAO;QACH,YAAY;QACZ,eAAe;QACf,kBAAkB;QAClB,gBAAgB;QAChB,WAAW;QACX,cAAc;KACjB,CAAC;AACN,CAAC,CAAC"}

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

@@ -0,0 +1,28 @@
+/*!
+ * 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

@@ -0,0 +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,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

@@ -0,0 +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 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

package/bin/live-hooks/useLiveCanvas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveCanvas.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,aAAa,EAGb,UAAU,GACb,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,aAAa,CACzB,SAAiB,EACjB,gBAA8D,EAC9D,MAAgB,EAChB,IAAiB,EACjB,SAAkB,EAClB,MAAe,EACf,KAAc,EACd,cAAqC,EACrC,cAAwB,EACxB,mBAA4B;IAE5B;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAiB,CAAC;IAE1E;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,aAAa,CACrC,SAAS,EACT,UAAU,CACb,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,qFAAqF;QACrF,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,kDAAkD;QAClD,IAAI,WAA+B,CAAC;QACpC,IAAI,WAAW,CAAC,gBAAgB,CAAC,EAAE;YAC/B,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC;SAC1C;aAAM;YACH,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,KAAK,IAAI;YAAE,OAAO;QACjC,iEAAiE;QACjE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;QACrD,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAChC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAErC,8DAA8D;QAC9D,OAAO,GAAG,EAAE;YACR,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,aAAa,CAAC,kBAAkB,EAAE,CAAC;QACvC,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,IAAI,MAAM,EAAE;gBACR,aAAa,CAAC,QAAQ,EAAE,CAAC;aAC5B;iBAAM;gBACH,aAAa,CAAC,UAAU,EAAE,CAAC;aAC9B;SACJ;IACL,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,IAAI,KAAK,SAAS,EAAE;YACrC,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;SAC7B;IACL,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,aAAa,CAAC,MAAM,GAAG;gBACnB,CAAC,EAAE,MAAM,CAAC,CAAC;gBACX,CAAC,EAAE,MAAM,CAAC,CAAC;aACd,CAAC;SACL;IACL,CAAC,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,KAAK,KAAK,SAAS,EAAE;YACtC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;SAC/B;IACL,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,cAAc,KAAK,SAAS,EAAE;YAC/C,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;SACjD;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,SAAS,EAAE;YAC5B,aAAa,CAAC,SAAS,GAAG;gBACtB,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC/B,CAAC;SACL;IACL,CAAC,EAAE;QACC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK;QAChB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG;QACd,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO;QAClB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI;QACf,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ;QACnB,aAAa;KAChB,CAAC,CAAC;IAEH;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,cAAc,KAAK,SAAS,EAAE;YAC5C,UAAU,CAAC,cAAc,GAAG,cAAc,CAAC;SAC9C;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,mBAAmB,EAAE;YACnC,UAAU,CAAC,wBAAwB,GAAG,GAAuB,EAAE;gBAC3D,OAAO,mBAAmB,CAAC;YAC/B,CAAC,CAAC;SACL;IACL,CAAC,EAAE,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO;QACH,aAAa;QACb,UAAU;KACb,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { UserMeetingRole } from "@microsoft/live-share";
+import { IUseLiveCoPilotResults } from "../types";
+/**
+ * React hook for using a Live Share Turbo `LiveCoPilot`. Intended for use with OpenAI's Completion API.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveCoPilot` object, which is used for using AI completions collaboratively at minimal cost.
+ *
+ * @param uniqueKey the unique key for the `LiveCoPilot`. If one does not yet exist, a new one.
+ * @param onGetCompletion React useCallback function that returns a Promise<string> for the latest `promptValue`. Function is intended to
+ * communicate with a backend API that uses OpenAI's Completion API.
+ * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
+ * @param defaultPromptValue Optional. Text that sets the default prompt value. Default value is an empty string.
+ * @param autoCompletions Optional. Stateful boolean that when true, will automatically send completions when the `promptValue` changes. Default value is true.
+ * @param debounceDelayMilliseconds Optional. Stateful number that changes the debounce interval when `autoCompletions` is true. Default value is 1000.
+ * @param lockPrompt Optional. Stateful boolean that when true, will restrict prompt changes to only the user with `haveCompletionLock` set to true. Default
+ * value is false.
+ * @param lockCompletion Optional. Stateful boolean that when true, will restrict manual completion changes to only the user with `haveCompletionLock`
+ * set to true. This does not impact the `autoCompletions` setting, because `autoCompletions` already has this behavior. Default value is false.
+ *
+ * @returns IUseLiveCoPilotResults object that contains stateful responses and callback methods from `LiveCoPilot`.
+ */
+export declare const useLiveCoPilot: (uniqueKey: string, onGetCompletion: (promptValue: string) => Promise<string>, allowedRoles?: UserMeetingRole[], defaultPromptValue?: string, autoCompletions?: boolean, debounceDelayMilliseconds?: number, lockPrompt?: boolean, lockCompletion?: boolean) => IUseLiveCoPilotResults;
+//# sourceMappingURL=useLiveCoPilot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveCoPilot.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveCoPilot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAIxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,cACZ,MAAM,iCACc,MAAM,KAAK,QAAQ,MAAM,CAAC,iBAC1C,eAAe,EAAE,uBACX,MAAM,oBACT,OAAO,8BACG,MAAM,eACrB,OAAO,mBACH,OAAO,KACzB,sBA4LF,CAAC"}

package/bin/live-hooks/useLiveCoPilot.js

@@ -0,0 +1,178 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LiveCoPilot, LiveCoPilotEvents } from "@microsoft/live-share-turbo";
+import React from "react";
+import { useDynamicDDS } from "../shared-hooks";
+/**
+ * React hook for using a Live Share Turbo `LiveCoPilot`. Intended for use with OpenAI's Completion API.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveCoPilot` object, which is used for using AI completions collaboratively at minimal cost.
+ *
+ * @param uniqueKey the unique key for the `LiveCoPilot`. If one does not yet exist, a new one.
+ * @param onGetCompletion React useCallback function that returns a Promise<string> for the latest `promptValue`. Function is intended to
+ * communicate with a backend API that uses OpenAI's Completion API.
+ * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
+ * @param defaultPromptValue Optional. Text that sets the default prompt value. Default value is an empty string.
+ * @param autoCompletions Optional. Stateful boolean that when true, will automatically send completions when the `promptValue` changes. Default value is true.
+ * @param debounceDelayMilliseconds Optional. Stateful number that changes the debounce interval when `autoCompletions` is true. Default value is 1000.
+ * @param lockPrompt Optional. Stateful boolean that when true, will restrict prompt changes to only the user with `haveCompletionLock` set to true. Default
+ * value is false.
+ * @param lockCompletion Optional. Stateful boolean that when true, will restrict manual completion changes to only the user with `haveCompletionLock`
+ * set to true. This does not impact the `autoCompletions` setting, because `autoCompletions` already has this behavior. Default value is false.
+ *
+ * @returns IUseLiveCoPilotResults object that contains stateful responses and callback methods from `LiveCoPilot`.
+ */
+export const useLiveCoPilot = (uniqueKey, onGetCompletion, allowedRoles, defaultPromptValue, autoCompletions, debounceDelayMilliseconds, lockPrompt, lockCompletion) => {
+    /**
+     * @see IUseLiveCoPilotResults["promptValue"]
+     */
+    const [promptValue, setPromptValue] = React.useState("");
+    /**
+     * @see IUseLiveCoPilotResults["completionValue"]
+     */
+    const [completionValue, setCompletionValue] = React.useState();
+    /**
+     * @see IUseLiveCoPilotResults["haveCompletionLock"]
+     */
+    const [haveCompletionLock, setHaveCompletionLock] = React.useState(false);
+    /**
+     * User facing: dynamically load the DDS for the given unique key.
+     */
+    const { dds: liveCoPilot } = useDynamicDDS(uniqueKey, LiveCoPilot);
+    /**
+     * @see IUseLiveCoPilotResults["changePrompt"]
+     */
+    const changePrompt = React.useCallback((value) => {
+        if (liveCoPilot === undefined) {
+            console.error(new Error("Cannot call emitEvent when liveEvent is undefined"));
+            return;
+        }
+        if (!liveCoPilot.isInitialized) {
+            console.error(new Error("Cannot call emitEvent while liveEvent is not started"));
+            return;
+        }
+        return liveCoPilot.changePrompt(value);
+    }, [liveCoPilot]);
+    /**
+     * @see IUseLiveCoPilotResults["changePrompt"]
+     */
+    const sendCompletion = React.useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (liveCoPilot === undefined) {
+            throw new Error("Cannot call sendCompletion while `liveCoPilot` is undefined");
+        }
+        if (!liveCoPilot.isInitialized) {
+            throw new Error("Cannot call sendCompletion while `liveCoPilot` is not initialized");
+        }
+        return liveCoPilot.sendCompletion();
+    }), [liveCoPilot]);
+    /**
+     * Sets up the `LiveCoPilot` instance.
+     */
+    React.useEffect(() => {
+        if (liveCoPilot === undefined)
+            return;
+        // Register event listeners
+        const onPromptChanged = (promptValue, local, completionValuePromise) => __awaiter(void 0, void 0, void 0, function* () {
+            setPromptValue(promptValue);
+            if (!liveCoPilot.haveValidCompletionValue) {
+                setCompletionValue(undefined);
+            }
+            try {
+                const completionValue = yield completionValuePromise;
+                setCompletionValue(completionValue);
+            }
+            catch (_a) {
+                // We do nothing, since this typically fails as a result of a new prompt value replacing the old on, permissions changing, etc.
+            }
+        });
+        const onLockGranted = () => {
+            setHaveCompletionLock(true);
+        };
+        const onLockLost = () => {
+            setHaveCompletionLock(true);
+        };
+        liveCoPilot.on(LiveCoPilotEvents.promptChanged, onPromptChanged);
+        liveCoPilot.on(LiveCoPilotEvents.lockGranted, onLockGranted);
+        liveCoPilot.on(LiveCoPilotEvents.lockLost, onLockLost);
+        if (!liveCoPilot.isInitialized) {
+            // Initialize the LiveCoPilot instance
+            liveCoPilot.initialize(onGetCompletion, allowedRoles, defaultPromptValue);
+        }
+        return () => {
+            // on unmount, remove event listeners
+            liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.off(LiveCoPilotEvents.promptChanged, onPromptChanged);
+            liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.off(LiveCoPilotEvents.lockGranted, onLockGranted);
+            liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.off(LiveCoPilotEvents.lockLost, onLockLost);
+        };
+    }, [liveCoPilot]);
+    /**
+     * Sets the onGetCompletion of the `liveCoPilot` based on the 'onGetCompletion' prop
+     */
+    React.useEffect(() => {
+        if ((liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.isInitialized) === true &&
+            onGetCompletion !== undefined) {
+            liveCoPilot.onGetCompletion = onGetCompletion;
+        }
+    }, [liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.isInitialized, onGetCompletion]);
+    /**
+     * Sets the autoCompletions of the `liveCoPilot` based on the 'autoCompletions' prop
+     */
+    React.useEffect(() => {
+        if (liveCoPilot !== undefined &&
+            autoCompletions !== undefined &&
+            liveCoPilot.autoCompletions !== autoCompletions) {
+            liveCoPilot.autoCompletions = autoCompletions;
+        }
+    }, [liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.autoCompletions, autoCompletions]);
+    /**
+     * Sets the debounceDelayMilliseconds of the `liveCoPilot` based on the 'debounceDelayMilliseconds' prop
+     */
+    React.useEffect(() => {
+        if (liveCoPilot !== undefined &&
+            debounceDelayMilliseconds !== undefined &&
+            liveCoPilot.debounceDelayMilliseconds !== debounceDelayMilliseconds) {
+            liveCoPilot.debounceDelayMilliseconds = debounceDelayMilliseconds;
+        }
+    }, [liveCoPilot, debounceDelayMilliseconds]);
+    /**
+     * Sets the lockPrompt of the `liveCoPilot` based on the 'lockPrompt' prop
+     */
+    React.useEffect(() => {
+        if (liveCoPilot !== undefined &&
+            lockPrompt !== undefined &&
+            liveCoPilot.lockPrompt !== lockPrompt) {
+            liveCoPilot.lockPrompt = lockPrompt;
+        }
+    }, [liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.lockPrompt, lockPrompt]);
+    /**
+     * Sets the lockCompletion of the `liveCoPilot` based on the 'lockCompletion' prop
+     */
+    React.useEffect(() => {
+        if (liveCoPilot !== undefined &&
+            lockCompletion !== undefined &&
+            liveCoPilot.lockCompletion !== lockCompletion) {
+            liveCoPilot.lockCompletion = lockCompletion;
+        }
+    }, [liveCoPilot === null || liveCoPilot === void 0 ? void 0 : liveCoPilot.lockCompletion, lockCompletion]);
+    return {
+        changePrompt,
+        completionValue,
+        haveCompletionLock,
+        liveCoPilot,
+        promptValue,
+        sendCompletion,
+    };
+};
+//# sourceMappingURL=useLiveCoPilot.js.map

package/bin/live-hooks/useLiveCoPilot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveCoPilot.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveCoPilot.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAGH,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC1B,SAAiB,EACjB,eAAyD,EACzD,YAAgC,EAChC,kBAA2B,EAC3B,eAAyB,EACzB,yBAAkC,EAClC,UAAoB,EACpB,cAAwB,EACF,EAAE;IACxB;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAS,EAAE,CAAC,CAAC;IACjE;;OAEG;IACH,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAU,CAAC;IACvE;;OAEG;IACH,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC7C,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IACnC;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,aAAa,CACtC,SAAS,EACT,WAAW,CACd,CAAC;IAEF;;OAEG;IACH,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAClC,CAAC,KAAa,EAAE,EAAE;QACd,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CACL,mDAAmD,CACtD,CACJ,CAAC;YACF,OAAO;SACV;QACD,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;YAC5B,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CACL,sDAAsD,CACzD,CACJ,CAAC;YACF,OAAO;SACV;QACD,OAAO,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,WAAW,CAAC,CAChB,CAAC;IAEF;;OAEG;IACH,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,GAGtC,EAAE;QACD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CACX,6DAA6D,CAChE,CAAC;SACL;QACD,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;YAC5B,MAAM,IAAI,KAAK,CACX,mEAAmE,CACtE,CAAC;SACL;QACD,OAAO,WAAW,CAAC,cAAc,EAAE,CAAC;IACxC,CAAC,CAAA,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,WAAW,KAAK,SAAS;YAAE,OAAO;QACtC,2BAA2B;QAC3B,MAAM,eAAe,GAAG,CACpB,WAAmB,EACnB,KAAc,EACd,sBAAuC,EACzC,EAAE;YACA,cAAc,CAAC,WAAW,CAAC,CAAC;YAC5B,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE;gBACvC,kBAAkB,CAAC,SAAS,CAAC,CAAC;aACjC;YACD,IAAI;gBACA,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC;gBACrD,kBAAkB,CAAC,eAAe,CAAC,CAAC;aACvC;YAAC,WAAM;gBACJ,+HAA+H;aAClI;QACL,CAAC,CAAA,CAAC;QACF,MAAM,aAAa,GAAG,GAAG,EAAE;YACvB,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,GAAG,EAAE;YACpB,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,WAAW,CAAC,EAAE,CAAC,iBAAiB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QACjE,WAAW,CAAC,EAAE,CAAC,iBAAiB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAC7D,WAAW,CAAC,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;YAC5B,sCAAsC;YACtC,WAAW,CAAC,UAAU,CAClB,eAAe,EACf,YAAY,EACZ,kBAAkB,CACrB,CAAC;SACL;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,iBAAiB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;YACnE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,iBAAiB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;YAC/D,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,iBAAiB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7D,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,MAAK,IAAI;YACnC,eAAe,KAAK,SAAS,EAC/B;YACE,WAAW,CAAC,eAAe,GAAG,eAAe,CAAC;SACjD;IACL,CAAC,EAAE,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,WAAW,KAAK,SAAS;YACzB,eAAe,KAAK,SAAS;YAC7B,WAAW,CAAC,eAAe,KAAK,eAAe,EACjD;YACE,WAAW,CAAC,eAAe,GAAG,eAAe,CAAC;SACjD;IACL,CAAC,EAAE,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC;IAEpD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,WAAW,KAAK,SAAS;YACzB,yBAAyB,KAAK,SAAS;YACvC,WAAW,CAAC,yBAAyB,KAAK,yBAAyB,EACrE;YACE,WAAW,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;SACrE;IACL,CAAC,EAAE,CAAC,WAAW,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,WAAW,KAAK,SAAS;YACzB,UAAU,KAAK,SAAS;YACxB,WAAW,CAAC,UAAU,KAAK,UAAU,EACvC;YACE,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC;SACvC;IACL,CAAC,EAAE,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,WAAW,KAAK,SAAS;YACzB,cAAc,KAAK,SAAS;YAC5B,WAAW,CAAC,cAAc,KAAK,cAAc,EAC/C;YACE,WAAW,CAAC,cAAc,GAAG,cAAc,CAAC;SAC/C;IACL,CAAC,EAAE,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;IAElD,OAAO;QACH,YAAY;QACZ,eAAe;QACf,kBAAkB;QAClB,WAAW;QACX,WAAW;QACX,cAAc;KACjB,CAAC;AACN,CAAC,CAAC"}

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

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { UserMeetingRole } from "@microsoft/live-share";
+import { IUseLiveEventResults, OnReceivedLiveEventAction } from "../types";
+/**
+ * React hook for using a Live Share `LiveEvent`.
+ *
+ * @remarks
+ * Use this hook if you want to send transient JSON objects to everyone connected to the Fluid container,
+ * such as when sending push notifications or reactions.
+ *
+ * @template TEvent Optional typing for events sent & received. Default is `object` type.
+ * @param uniqueKey the unique key for the `LiveEvent`. If one does not yet exist, a new one
+ * will be created, otherwise it will use the existing one.
+ * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
+ * @param onReceivedEvent Optional. Callback method to be called when a new notification is received.
+ * @returns stateful `latestEvent` & `allEvents` list, `sendEvent` callback, and the `liveEvent` object.
+ */
+export declare function useLiveEvent<TEvent extends object = object>(uniqueKey: string, allowedRoles?: UserMeetingRole[], onReceivedEvent?: OnReceivedLiveEventAction<TEvent>): IUseLiveEventResults<TEvent>;
+//# sourceMappingURL=useLiveEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveEvent.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAElB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAE5B,MAAM,UAAU,CAAC;AAIlB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,EACvD,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,eAAe,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,GACpD,oBAAoB,CAAC,MAAM,CAAC,CA+E9B"}