@microsoft/live-share-react 1.0.0-preview.10

package/bin/shared-hooks/useLockedTask.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A hook for joining a queue to lock tasks for a given id. Guaranteed to have only one user assigned to a task at a time.
+ *
+ * @param uniqueKey the unique key for the TaskManager DDS
+ * @param taskId the task id to lock
+ * @returns stateful data about the status of the task lock
+ */
+export declare const useLockedTask: (uniqueKey: string, taskId?: string) => {
+    lockedTask: boolean;
+};
+//# sourceMappingURL=useLockedTask.d.ts.map

package/bin/shared-hooks/useLockedTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLockedTask.d.ts","sourceRoot":"","sources":["../../src/shared-hooks/useLockedTask.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,cAAe,MAAM,WAAW,MAAM;gBAChD,OAAO;CA+DtB,CAAC"}

package/bin/shared-hooks/useLockedTask.js

@@ -0,0 +1,82 @@
+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 React, { useEffect } from "react";
+import { TaskManager } from "@fluid-experimental/task-manager";
+import { useDynamicDDS } from "./useDynamicDDS";
+/**
+ * A hook for joining a queue to lock tasks for a given id. Guaranteed to have only one user assigned to a task at a time.
+ *
+ * @param uniqueKey the unique key for the TaskManager DDS
+ * @param taskId the task id to lock
+ * @returns stateful data about the status of the task lock
+ */
+export const useLockedTask = (uniqueKey, taskId) => {
+    /**
+     * TaskId currently in queue for
+     */
+    const currentTaskIdRef = React.useRef(undefined);
+    /**
+     * Stateful boolean that is true when the user is currently assigned the task
+     */
+    const [lockedTask, setLockedTask] = React.useState(false);
+    /**
+     * User facing: dynamically load the TaskManager DDS for the given unique key.
+     */
+    const { dds: taskManager } = useDynamicDDS(uniqueKey, TaskManager);
+    /**
+     * When the task id changes, lock the task. When the task id is undefined, abandon the task.
+     */
+    useEffect(() => {
+        let mounted = true;
+        if (taskManager) {
+            if (taskId && currentTaskIdRef.current !== taskId) {
+                if (currentTaskIdRef.current) {
+                    taskManager.abandon(currentTaskIdRef.current);
+                    setLockedTask(false);
+                }
+                currentTaskIdRef.current = taskId;
+                const onLockTask = () => __awaiter(void 0, void 0, void 0, function* () {
+                    try {
+                        yield taskManager.lockTask(taskId);
+                        if (mounted) {
+                            setLockedTask(true);
+                        }
+                    }
+                    catch (_a) {
+                        if (mounted) {
+                            setLockedTask(false);
+                            currentTaskIdRef.current = undefined;
+                        }
+                    }
+                });
+                onLockTask();
+            }
+            else if (!taskId && currentTaskIdRef.current) {
+                taskManager.abandon(currentTaskIdRef.current);
+                setLockedTask(false);
+                currentTaskIdRef.current = undefined;
+            }
+        }
+        /**
+         * When the component unmounts, abandon the task if it is still locked
+         */
+        return () => {
+            mounted = false;
+            if (currentTaskIdRef.current) {
+                taskManager === null || taskManager === void 0 ? void 0 : taskManager.abandon(currentTaskIdRef.current);
+            }
+            currentTaskIdRef.current = undefined;
+        };
+    }, [taskManager, taskId]);
+    return {
+        lockedTask,
+    };
+};
+//# sourceMappingURL=useLockedTask.js.map

package/bin/shared-hooks/useLockedTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLockedTask.js","sourceRoot":"","sources":["../../src/shared-hooks/useLockedTask.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,MAAe,EAE9D,EAAE;IACA;;OAEG;IACH,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAqB,SAAS,CAAC,CAAC;IACrE;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IAEnE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,aAAa,CAAc,SAAS,EAAE,WAAW,CAAC,CAAC;IAEhF;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,WAAW,EAAE;YACb,IAAI,MAAM,IAAI,gBAAgB,CAAC,OAAO,KAAK,MAAM,EAAE;gBAC/C,IAAI,gBAAgB,CAAC,OAAO,EAAE;oBAC1B,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;oBAC9C,aAAa,CAAC,KAAK,CAAC,CAAC;iBACxB;gBACD,gBAAgB,CAAC,OAAO,GAAG,MAAM,CAAC;gBAClC,MAAM,UAAU,GAAG,GAAS,EAAE;oBAC1B,IAAI;wBACA,MAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;wBACnC,IAAI,OAAO,EAAE;4BACT,aAAa,CAAC,IAAI,CAAC,CAAC;yBACvB;qBACJ;oBAAC,WAAM;wBACJ,IAAI,OAAO,EAAE;4BACT,aAAa,CAAC,KAAK,CAAC,CAAC;4BACrB,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;yBACxC;qBACJ;gBACL,CAAC,CAAA,CAAA;gBACD,UAAU,EAAE,CAAC;aAChB;iBAAM,IAAI,CAAC,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE;gBAC5C,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBAC9C,aAAa,CAAC,KAAK,CAAC,CAAC;gBACrB,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;aACxC;SACJ;QACD;;WAEG;QACH,OAAO,GAAG,EAAE;YACR,OAAO,GAAG,KAAK,CAAC;YAChB,IAAI,gBAAgB,CAAC,OAAO,EAAE;gBAC1B,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;aAClD;YACD,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;QACzC,CAAC,CAAA;IACL,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IAE1B,OAAO;QACH,UAAU;KACb,CAAC;AACN,CAAC,CAAC"}

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

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

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

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

package/bin/shared-hooks/useSharedMap.js

@@ -0,0 +1,106 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { isEntries, isJSON, isMap } from "../utils";
+import { useDynamicDDS } from "./useDynamicDDS";
+import { SharedMap } from "fluid-framework";
+/**
+ * React hook for using a Fluid `SharedMap`.
+ *
+ * @remarks
+ * The primary benefit of using the `useSharedMap` hook rather than the Fluid `SharedMap`
+ * directly is that it integrates nicely with React state and automates repetitive tasks.
+ * If you want to use `SharedMap` this hook creates directly, you can do that as well.
+ *
+ * @template TData Optional typing for objects stored in the SharedMap. Default is `object` type.
+ * @param uniqueKey the unique key for the `SharedMap`. If one does not yet exist, a new `SharedMap`
+ * will be created, otherwise it will use the existing one.
+ * @param initialData a JS Map, entries array, or JSON object to insert into the `SharedMap` when creating
+ * the DDS for the first time.
+ * @returns stateful `map` entries, `setEntry` callback, `deleteEntry` callback, and the Fluid `sharedMap`.
+ */
+export function useSharedMap(uniqueKey, initialData) {
+    /**
+     * Stateful readonly map (user facing) with most recent values from `SharedMap` and its setter method.
+     */
+    const [map, setMap] = React.useState(getInitialData(initialData));
+    const onFirstInitialize = React.useCallback((newDDS) => {
+        /**
+         * Callback method to set the `initialData` into the map when the `SharedMap` is first created.
+         * Only should be used as a prop to useDynamicDDS.
+         */
+        getInitialData(initialData).forEach((value, key) => {
+            newDDS.set(key, value);
+        });
+    }, [initialData]);
+    /**
+     * User facing: dynamically load the SharedMap DDS for the given unique key.
+     */
+    const { dds: sharedMap } = useDynamicDDS(uniqueKey, SharedMap, onFirstInitialize);
+    /**
+     * User facing: set a value to the Fluid `SharedMap`.
+     */
+    const setEntry = React.useCallback((key, value) => {
+        if (!sharedMap) {
+            console.error(new Error("Cannot call set when sharedMap is undefined"));
+            return;
+        }
+        sharedMap.set(key, value);
+    }, [sharedMap]);
+    /**
+     * User facing: delete a value from the Fluid `SharedMap`.
+     */
+    const deleteEntry = React.useCallback((key) => {
+        if (!sharedMap) {
+            console.error(new Error("Cannot call remove when sharedMap is undefined"));
+            return;
+        }
+        sharedMap.delete(key);
+    }, [sharedMap]);
+    // Setup change listeners, initial values, etc.
+    React.useEffect(() => {
+        if (!sharedMap)
+            return;
+        // Register valueChanged listener for `SharedMap`.
+        const onValueChanged = () => {
+            setMap(new Map(sharedMap.entries()));
+        };
+        sharedMap.on("valueChanged", onValueChanged);
+        // Get initial values from `SharedMap`.
+        onValueChanged();
+        return () => {
+            // Cleanup on component unmount.
+            sharedMap === null || sharedMap === void 0 ? void 0 : sharedMap.off("valueChanged", onValueChanged);
+        };
+    }, [sharedMap]);
+    return {
+        map,
+        setEntry,
+        deleteEntry,
+        sharedMap,
+    };
+}
+/**
+ * Helper method for converting different initial data props into a Map<string, TData> to insert into the Fluid SharedMap
+ * @template TData Optional typing for objects stored in the SharedMap. Default is `object` type.
+ * @param initialData a JS Map, entries array, or JSON object.
+ * @returns A Map<string, TData> with the entries provided.
+ */
+function getInitialData(initialData) {
+    if (isMap(initialData)) {
+        return initialData;
+    }
+    else if (isEntries(initialData)) {
+        return new Map(initialData);
+    }
+    else if (isJSON(initialData)) {
+        const values = Object.keys(initialData).map((key) => {
+            return [key, initialData[key]];
+        });
+        return new Map(values);
+    }
+    return new Map();
+}
+//# sourceMappingURL=useSharedMap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedMap.js","sourceRoot":"","sources":["../../src/shared-hooks/useSharedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,YAAY,CACxB,SAAiB,EACjB,WAAyC;IAEzC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAChC,cAAc,CAAQ,WAAW,CAAC,CACrC,CAAC;IAEF,MAAM,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,MAAiB,EAAQ,EAAE;QACpE;;;WAGG;QACH,cAAc,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,aAAa,CAAY,SAAS,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;IAE7F;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAC,GAAW,EAAE,KAAY,EAAE,EAAE;QAC1B,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAC3D,CAAC;YACF,OAAO;SACV;QACD,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,SAAS,CAAC,CACd,CAAC;IAEF;;OAEG;IACH,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CACjC,CAAC,GAAW,EAAE,EAAE;QACZ,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,CAAC,KAAK,CACT,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAC9D,CAAC;YACF,OAAO;SACV;QACD,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,EACD,CAAC,SAAS,CAAC,CACd,CAAC;IAEF,+CAA+C;IAC/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,kDAAkD;QAClD,MAAM,cAAc,GAAG,GAAG,EAAE;YACxB,MAAM,CAAC,IAAI,GAAG,CAAgB,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC7C,uCAAuC;QACvC,cAAc,EAAE,CAAC;QAEjB,OAAO,GAAG,EAAE;YACR,gCAAgC;YAChC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO;QACH,GAAG;QACH,QAAQ;QACR,WAAW;QACX,SAAS;KACZ,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CACnB,WAAwC;IAExC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE;QACpB,OAAO,WAAW,CAAC;KACtB;SAAM,IAAI,SAAS,CAAC,WAAW,CAAC,EAAE;QAC/B,OAAO,IAAI,GAAG,CAAgB,WAAW,CAAC,CAAC;KAC9C;SAAM,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE;QAC5B,MAAM,MAAM,GAAiC,MAAM,CAAC,IAAI,CACpD,WAAW,CACd,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACV,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,GAAG,CAAgB,MAAM,CAAC,CAAC;KACzC;IACD,OAAO,IAAI,GAAG,EAAiB,CAAC;AACpC,CAAC"}

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

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DisposeSharedStateAction, SetSharedStateAction } from "../types";
+/**
+ * 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.).
+ *
+ * @template S Typing for objects stored associated with the `uniqueKey`.
+ * @param uniqueKey the unique key for a `SharedMap`. If you use the same key for multiple components, those components will reference the same state.
+ * @param initialState a default state for the `SharedMap`.
+ *
+ * @returns a stateful value, the function to update it, and an optional dispose method to delete it from the `SharedMap`.
+ */
+export declare function useSharedState<S>(uniqueKey: string, initialState: S): [S, SetSharedStateAction<S>, DisposeSharedStateAction];
+//# sourceMappingURL=useSharedState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedState.d.ts","sourceRoot":"","sources":["../../src/shared-hooks/useSharedState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAG1E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC5B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,CAAC,GAChB,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAyDxD"}

package/bin/shared-hooks/useSharedState.js

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { useFluidObjectsContext } from "../providers";
+import { v4 as uuid } from "uuid";
+/**
+ * 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.).
+ *
+ * @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((updatedState) => {
+        setLocalState(updatedState);
+        updateSharedState(uniqueKey, updatedState);
+    }, [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/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,cAAc,CAAC;AAEtD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;;;;;;;;GAaG;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,YAAe,EAAE,EAAE;QAChB,aAAa,CAAC,YAAY,CAAC,CAAC;QAC5B,iBAAiB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC/C,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,CAAC,SAAS,EAAE,4BAA4B,EAAE,8BAA8B,CAAC,CAAC,CAAC;IAE9E,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC;AAC5D,CAAC"}

package/bin/shared-hooks/useTaskManager.d.ts

@@ -0,0 +1,13 @@
+import { TaskManager } from "@fluid-experimental/task-manager";
+/**
+ * A hook for joining a queue to lock tasks for a given id. Guaranteed to have only one user assigned to a task at a time.
+ *
+ * @param uniqueKey the unique key for the TaskManager DDS
+ * @param taskId the task id to lock
+ * @returns stateful data about the status of the task lock
+ */
+export declare const useTaskManager: (uniqueKey: string, taskId?: string) => {
+    lockedTask: boolean;
+    taskManager: TaskManager | undefined;
+};
+//# sourceMappingURL=useTaskManager.d.ts.map

package/bin/shared-hooks/useTaskManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTaskManager.d.ts","sourceRoot":"","sources":["../../src/shared-hooks/useTaskManager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAG,MAAM,kCAAkC,CAAC;AAMhE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,cAAe,MAAM,WAAW,MAAM;gBACjD,OAAO;iBACN,WAAW,GAAG,SAAS;CAgEvC,CAAC"}

package/bin/shared-hooks/useTaskManager.js

@@ -0,0 +1,86 @@
+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 React from "react";
+import { useDynamicDDS } from "./useDynamicDDS";
+import { TaskManager } from "@fluid-experimental/task-manager";
+import { DynamicObjectRegistry } from "@microsoft/live-share";
+// Register TaskManager as dynamic object
+DynamicObjectRegistry.registerObjectClass(TaskManager, TaskManager.getFactory().type);
+/**
+ * A hook for joining a queue to lock tasks for a given id. Guaranteed to have only one user assigned to a task at a time.
+ *
+ * @param uniqueKey the unique key for the TaskManager DDS
+ * @param taskId the task id to lock
+ * @returns stateful data about the status of the task lock
+ */
+export const useTaskManager = (uniqueKey, taskId) => {
+    /**
+     * TaskId currently in queue for
+     */
+    const currentTaskIdRef = React.useRef(undefined);
+    /**
+     * Stateful boolean that is true when the user is currently assigned the task
+     */
+    const [lockedTask, setLockedTask] = React.useState(false);
+    /**
+     * User facing: dynamically load the TaskManager DDS for the given unique key.
+     */
+    const { dds: taskManager } = useDynamicDDS(uniqueKey, TaskManager);
+    /**
+     * When the task id changes, lock the task. When the task id is undefined, abandon the task.
+     */
+    React.useEffect(() => {
+        let mounted = true;
+        if (taskManager) {
+            if (taskId && currentTaskIdRef.current !== taskId) {
+                if (currentTaskIdRef.current) {
+                    taskManager.abandon(currentTaskIdRef.current);
+                    setLockedTask(false);
+                }
+                currentTaskIdRef.current = taskId;
+                const onLockTask = () => __awaiter(void 0, void 0, void 0, function* () {
+                    try {
+                        yield taskManager.lockTask(taskId);
+                        if (mounted) {
+                            setLockedTask(true);
+                        }
+                    }
+                    catch (_a) {
+                        if (mounted) {
+                            setLockedTask(false);
+                            currentTaskIdRef.current = undefined;
+                        }
+                    }
+                });
+                onLockTask();
+            }
+            else if (!taskId && currentTaskIdRef.current) {
+                taskManager.abandon(currentTaskIdRef.current);
+                setLockedTask(false);
+                currentTaskIdRef.current = undefined;
+            }
+        }
+        /**
+         * When the component unmounts, abandon the task if it is still locked
+         */
+        return () => {
+            mounted = false;
+            if (currentTaskIdRef.current) {
+                taskManager === null || taskManager === void 0 ? void 0 : taskManager.abandon(currentTaskIdRef.current);
+            }
+            currentTaskIdRef.current = undefined;
+        };
+    }, [taskManager, taskId]);
+    return {
+        lockedTask,
+        taskManager,
+    };
+};
+//# sourceMappingURL=useTaskManager.js.map

package/bin/shared-hooks/useTaskManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTaskManager.js","sourceRoot":"","sources":["../../src/shared-hooks/useTaskManager.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAG,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,yCAAyC;AACzC,qBAAqB,CAAC,mBAAmB,CAAC,WAAW,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC;AAEtF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,MAAe,EAG/D,EAAE;IACA;;OAEG;IACH,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAqB,SAAS,CAAC,CAAC;IACrE;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IAEnE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,aAAa,CAAc,SAAS,EAAE,WAAW,CAAC,CAAC;IAEhF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,WAAW,EAAE;YACb,IAAI,MAAM,IAAI,gBAAgB,CAAC,OAAO,KAAK,MAAM,EAAE;gBAC/C,IAAI,gBAAgB,CAAC,OAAO,EAAE;oBAC1B,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;oBAC9C,aAAa,CAAC,KAAK,CAAC,CAAC;iBACxB;gBACD,gBAAgB,CAAC,OAAO,GAAG,MAAM,CAAC;gBAClC,MAAM,UAAU,GAAG,GAAS,EAAE;oBAC1B,IAAI;wBACA,MAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;wBACnC,IAAI,OAAO,EAAE;4BACT,aAAa,CAAC,IAAI,CAAC,CAAC;yBACvB;qBACJ;oBAAC,WAAM;wBACJ,IAAI,OAAO,EAAE;4BACT,aAAa,CAAC,KAAK,CAAC,CAAC;4BACrB,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;yBACxC;qBACJ;gBACL,CAAC,CAAA,CAAA;gBACD,UAAU,EAAE,CAAC;aAChB;iBAAM,IAAI,CAAC,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE;gBAC5C,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBAC9C,aAAa,CAAC,KAAK,CAAC,CAAC;gBACrB,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;aACxC;SACJ;QACD;;WAEG;QACH,OAAO,GAAG,EAAE;YACR,OAAO,GAAG,KAAK,CAAC;YAChB,IAAI,gBAAgB,CAAC,OAAO,EAAE;gBAC1B,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;aAClD;YACD,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;QACzC,CAAC,CAAA;IACL,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IAE1B,OAAO;QACH,UAAU;QACV,WAAW;KACd,CAAC;AACN,CAAC,CAAC"}

package/bin/types/ActionTypes.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { IFluidLoadable } from "@fluidframework/core-interfaces";
+import { LoadableObjectClass } from "fluid-framework";
+import { ITimerConfig, PresenceState } from "@microsoft/live-share";
+export declare type SetSharedStateAction<T> = (state: T) => void;
+export declare type SetLocalStateAction = React.Dispatch<React.SetStateAction<any>>;
+export declare type RegisterDDSSetStateAction = <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: LoadableObjectClass<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void;
+export declare type UnregisterDDSSetStateAction = (uniqueKey: string, componentId: string) => void;
+export declare type RegisterSharedSetStateAction = (uniqueKey: string, componentId: string, setLocalStateAction: SetLocalStateAction) => void;
+export declare type UnregisterSharedSetStateAction = (uniqueKey: string, componentId: string) => void;
+export declare type UpdateSharedStateAction = (uniqueKey: string, value: any) => void;
+export declare type DeleteSharedStateAction = (uniqueKey: string) => void;
+export declare type DisposeSharedStateAction = () => void;
+export declare type SetLiveStateAction<TState = undefined> = (state: TState) => void;
+export declare type SendLiveEventAction<TEvent> = (event: TEvent) => void;
+export declare type OnReceivedLiveEventAction<TEvent> = (event: TEvent, local: boolean) => void;
+export declare type OnUpdateLivePresenceAction<TData extends object = object> = (state?: PresenceState | undefined, data?: TData | undefined) => void;
+export declare type OnStartTimerAction = (duration: number) => void;
+export declare type OnPlayTimerAction = () => void;
+export declare type OnPauseTimerAction = () => void;
+export declare type OnTimerTickAction = (milliRemaining: number) => void;
+export declare type OnTimerDidStartAction = (timerConfig: ITimerConfig) => void;
+export declare type OnTimerDidPauseAction = (timerConfig: ITimerConfig) => void;
+export declare type OnTimerDidPlayAction = (timerConfig: ITimerConfig) => void;
+export declare type OnTimerDidFinishAction = (timerConfig: ITimerConfig) => void;
+//# sourceMappingURL=ActionTypes.d.ts.map

package/bin/types/ActionTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionTypes.d.ts","sourceRoot":"","sources":["../../src/types/ActionTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGpE,oBAAY,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AACzD,oBAAY,mBAAmB,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AAG5E,oBAAY,yBAAyB,GAAG,CAAC,CAAC,SAAS,cAAc,EAC7D,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,EACnC,mBAAmB,EAAE,mBAAmB,EACxC,oBAAoB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,KACtC,IAAI,CAAC;AAEV,oBAAY,2BAA2B,GAAG,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,KAClB,IAAI,CAAC;AAEV,oBAAY,4BAA4B,GAAG,CACvC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,mBAAmB,KACvC,IAAI,CAAC;AAEV,oBAAY,8BAA8B,GAAG,CACzC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,KAClB,IAAI,CAAC;AAEV,oBAAY,uBAAuB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;AAE9E,oBAAY,uBAAuB,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;AAClE,oBAAY,wBAAwB,GAAG,MAAM,IAAI,CAAC;AAIlD,oBAAY,kBAAkB,CAAC,MAAM,GAAG,SAAS,IAAI,CACjD,KAAK,EAAE,MAAM,KACZ,IAAI,CAAC;AAEV,oBAAY,mBAAmB,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AAElE,oBAAY,yBAAyB,CAAC,MAAM,IAAI,CAC5C,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,OAAO,KACb,IAAI,CAAC;AAEV,oBAAY,0BAA0B,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI,CACpE,KAAK,CAAC,EAAE,aAAa,GAAG,SAAS,EACjC,IAAI,CAAC,EAAE,KAAK,GAAG,SAAS,KACvB,IAAI,CAAC;AAEV,oBAAY,kBAAkB,GAAG,CAC7B,QAAQ,EAAE,MAAM,KACf,IAAI,CAAC;AAEV,oBAAY,iBAAiB,GAAG,MAAM,IAAI,CAAC;AAE3C,oBAAY,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAE5C,oBAAY,iBAAiB,GAAG,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;AACjE,oBAAY,qBAAqB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACxE,oBAAY,qBAAqB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACxE,oBAAY,oBAAoB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACvE,oBAAY,sBAAsB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC"}

package/bin/types/ActionTypes.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export {};
+//# sourceMappingURL=ActionTypes.js.map

package/bin/types/ActionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionTypes.js","sourceRoot":"","sources":["../../src/types/ActionTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/bin/types/PropTypes.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export declare type SharedMapInitialData<T> = Map<string, T> | readonly (readonly [string, T])[] | {
+    [key: string]: T;
+} | undefined;
+//# sourceMappingURL=PropTypes.d.ts.map

package/bin/types/PropTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropTypes.d.ts","sourceRoot":"","sources":["../../src/types/PropTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,oBAAY,oBAAoB,CAAC,CAAC,IAC5B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,GACd,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,GACjC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,GACpB,SAAS,CAAC"}

package/bin/types/PropTypes.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export {};
+//# sourceMappingURL=PropTypes.js.map

package/bin/types/PropTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropTypes.js","sourceRoot":"","sources":["../../src/types/PropTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG"}