@microsoft/live-share-react 1.0.0-preview.9 → 1.0.2-preview.1

package/README.md

@@ -1,5 +1,7 @@
 # Live Share React
 
+**DISCLAIMER:** This package is in preview and experimental. We are not yet committed to maintaining this package and may make breaking changes at any time. Read this package's [license](./LICENSE) for more information.
+
 Live Share React is designed to make building collaborative apps in React simple and intuitive, all using familiar patterns from functional React.
 
 Here is a simple example of how to get started:
@@ -48,13 +50,13 @@ export function SharedCheckbox() {
 To add the latest version of the SDK to your application using NPM:
 
 ```bash
-npm install @microsoft/live-share-react --save
+npm install fluid-framework @fluidframework/azure-client @microsoft/live-share @microsoft/live-share-media @microsoft/live-share-canvas @microsoft/live-share-react --save
 ```
 
 or using [Yarn](https://yarnpkg.com/):
 
 ```bash
-yarn add @microsoft/live-share-react
+yarn add fluid-framework @fluidframework/azure-client @microsoft/live-share @microsoft/live-share-media @microsoft/live-share-canvas @microsoft/live-share-react
 ```
 
 ### Building package
@@ -66,7 +68,7 @@ npm install
 npm run build
 ```
 
-This will use lerna to hoist and build all dependencies.
+This will use npm workspaces to hoist and build all dependencies.
 
 ### Sample app
 
@@ -172,7 +174,7 @@ export function CardList() {
 
 ### useLivePresence
 
-Presence makes it easy to track which users are currently in the session and assign custom data to them. Unlike other hooks, `useLivePresence` has a default ID set for you, but you can override it with your own if you'd like.
+Presence makes it easy to track which users are currently in the session and assign custom data to them.
 
 ```javascript
 import { useLivePresence } from "@microsoft/live-share-react";
@@ -180,8 +182,8 @@ import { PresenceState } from "@microsoft/live-share";
 
 export function OnlineUsers() {
   const { localUser, allUsers, updatePresence } = useLivePresence(
-    "CUSTOM-USER-ID", // optional user id
-    { name: "First Last" } // optional custom data object
+    "UNIQUE-PRESENCE-KEY", // required unique key for presence
+    { favoriteColor: "red" } // optional custom data object
   );
   return (
     <div>
@@ -190,16 +192,18 @@ export function OnlineUsers() {
         {allUsers
           .filter((user) => user.state === PresenceState.online)
           .map((user) => (
-            <div key={user.userId}>{user.name}</div>
+            <div key={user.userId}>
+                {user.displayName + " " + user.data!.favoriteColor}
+            </div>
           ))}
       </div>
       <button
         onClick={() => {
           updatePresence(
+            localUser.data,
             localUser?.state === PresenceState.offline
               ? PresenceState.online
               : PresenceState.offline,
-            localUser.data
           );
         }}
       >
@@ -223,7 +227,7 @@ import { UserMeetingRole } from "@microsoft/live-share";
 const ALLOWED_ROLES = [UserMeetingRole.organizer, UserMeetingRole.presenter ];
 
 export function AppState() {
-  const [state, data, setState] = useLiveState("CUSTOM-STATE-ID", ALLOWED_ROLES, ExampleAppState.WAITING);
+  const [state, setState] = useLiveState("CUSTOM-STATE-ID", ExampleAppState.WAITING, ALLOWED_ROLES);
 
   if (state === ExampleAppState.WAITING) {
     return (
@@ -287,10 +291,10 @@ export function Reactions() {
       </button>
       {/* Show latest reaction */}
       {latestEvent?.local === false && (
-        <div>{`Received: ${latestEvent?.event.emoji}`}</div>
+        <div>{`Received: ${latestEvent?.value.emoji}`}</div>
       )}
       {latestEvent?.local === true && (
-        <div>{`Sent: ${latestEvent?.event.emoji}`}</div>
+        <div>{`Sent: ${latestEvent?.value.emoji}`}</div>
       )}
     </div>
   );
@@ -479,25 +483,89 @@ Implementations may vary for each dynamic object & hook. We will try and update
 
 Example:
 
-```javascript
-import { DynamicObjectRegistry } from "@microsoft/live-share";
+```typescript
+import React from "react";
 import { useDynamicDDS } from "@microsoft/live-share-react";
-import { SharedTree } from "@fluid-experimental/shared-tree";
-import { useCallback } from "react";
-
-// Register the experimental `SharedTree` DDS
-DynamicObjectRegistry.registerObjectClass(SharedTree, "SharedTree");
-
-// Custom useSharedTree hook
-export const useSharedTree = (uniqueKey) => {
-    const onFirstInitialize = useCallback((dds) => {
-        // Set initial values for the newly created SharedTree dds here
-    }. []);
-    const { dds: sharedTree } = useDynamicDDS(uniqueKey, SharedTree, onFirstInitialize);
+import { DynamicObjectRegistry } from "@microsoft/live-share";
+import { TaskManager  } from "@fluid-experimental/task-manager";
+
+// 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: string, taskId?: string): {
+    lockedTask: boolean;
+    taskManager: TaskManager | undefined;
+} => {
+    /**
+     * TaskId currently in queue for
+     */
+    const currentTaskIdRef = React.useRef<string | undefined>(undefined);
+    /**
+     * Stateful boolean that is true when the user is currently assigned the task
+     */
+    const [lockedTask, setLockedTask] = React.useState<boolean>(false);
+
+    /**
+     * User facing: dynamically load the TaskManager DDS for the given unique key.
+     */
+    const { dds: taskManager } = useDynamicDDS<TaskManager>(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 = async () => {
+                    try {
+                        await taskManager.lockTask(taskId);
+                        if (mounted) {
+                            setLockedTask(true);
+                        }
+                    } catch {
+                        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?.abandon(currentTaskIdRef.current);
+            }
+            currentTaskIdRef.current = undefined;
+        }
+    }, [taskManager, taskId]);
+
     return {
-        sharedTree,
+        lockedTask,
+        taskManager,
     };
-}
+};
 ```
 
 ## Code samples
@@ -518,11 +586,7 @@ The Live Share SDK contains dependencies for [@microsoft/teams-js](https://www.n
 
 | @microsoft/live-share | @microsoft/teams-js  | fluid-framework | @microsoft/live-share-\*   | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
 | --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
-| 1.0.0-preview.9       | ^2.10.1              | ~1.2.3          | 1.0.0-preview.9 (optional) | ~1.0.2 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
-| 1.0.0-preview.8       | ^2.5.0               | ~1.2.3          | 1.0.0-preview.9 (optional) | ~1.0.2 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
-| 1.0.0-preview.3       | 2.0.0-experimental.1 | ~1.2.3          | 1.0.0-preview.3 (optional) | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
-| ~0.5.1                | 2.0.0-experimental.1 | ~1.2.3          | ~0.5.1 (optional)          | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
-| ~0.3.1                | 2.0.0-experimental.0 | ~0.59.0         | ~0.3.1 (optional)          | ~0.59.0 (optional)           | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
+| ^1.0.0                  | ^2.11.0             | ^1.2.3          | ^1.0.0                      | ^1.0.0                       | ^2.5.0                        | ^2.5.0                          |
 
 ## Contributing
 
@@ -533,12 +597,12 @@ There are several ways you can [contribute](../../CONTRIBUTING.md) to this proje
 - Engage with other Live Share developers on [StackOverflow](https://stackoverflow.com/questions/tagged/live-share).
 - [Contribute bug fixes](../../CONTRIBUTING.md).
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact opencode@microsoft.com with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact <opencode@microsoft.com> with any additional questions or comments.
 
 ## Reporting Security Issues
 
-Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP](https://technet.microsoft.com/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/security/default).
+Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP](https://technet.microsoft.com/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/security/default).
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under a special [Microsoft](../../LICENSE) License.
+Licensed under a special [Microsoft](./LICENSE) License.

package/bin/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./providers";
-export * from "./shared-hooks";
-export * from "./live-hooks";
-export * from "./types";
-export * from "./providers";
-export * from "./interfaces";
+export * from "./providers";
+export * from "./shared-hooks";
+export * from "./live-hooks";
+export * from "./types";
+export * from "./providers";
+export * from "./interfaces";
 //# sourceMappingURL=index.d.ts.map

package/bin/index.js

@@ -1,7 +1,7 @@
-export * from "./providers";
-export * from "./shared-hooks";
-export * from "./live-hooks";
-export * from "./types";
-export * from "./providers";
-export * from "./interfaces";
+export * from "./providers";
+export * from "./shared-hooks";
+export * from "./live-hooks";
+export * from "./types";
+export * from "./providers";
+export * from "./interfaces";
 //# sourceMappingURL=index.js.map

package/bin/interfaces/LiveInterfaceExtensions.d.ts

@@ -1,9 +1,26 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-export interface IReceiveLiveEvent<TEvent extends object = object> {
-    event: TEvent;
-    local: boolean;
-}
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+/**
+ * Object response for a received event
+ */
+export interface IReceiveLiveEvent<TEvent = any> {
+    /**
+     * The value of the event that was sent
+     */
+    value: TEvent;
+    /**
+     * True if the local client was the one to send this event
+     */
+    local: boolean;
+    /**
+     * Client ID of the user that sent the event
+     */
+    clientId: string;
+    /**
+     * Server timestamp at which the event was sent
+     */
+    timestamp: number;
+}
 //# sourceMappingURL=LiveInterfaceExtensions.d.ts.map

package/bin/interfaces/LiveInterfaceExtensions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LiveInterfaceExtensions.d.ts","sourceRoot":"","sources":["../../src/interfaces/LiveInterfaceExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,iBAAiB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"LiveInterfaceExtensions.d.ts","sourceRoot":"","sources":["../../src/interfaces/LiveInterfaceExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,GAAG;IAC3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB"}

package/bin/interfaces/LiveInterfaceExtensions.js

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

package/bin/interfaces/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./LiveInterfaceExtensions";
+export * from "./LiveInterfaceExtensions";
 //# sourceMappingURL=index.d.ts.map

package/bin/interfaces/index.js

@@ -1,2 +1,2 @@
-export * from "./LiveInterfaceExtensions";
+export * from "./LiveInterfaceExtensions";
 //# sourceMappingURL=index.js.map

package/bin/internal/errors.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @hidden
+ */
+declare class UseLiveDataObjectActionError extends Error {
+    constructor(ddsName: string, functionName: string, message: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/bin/internal/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,4BAA6B,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAKrE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;gBAC/D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAGpD;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,4BAA4B;gBACpE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAOpD;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,4BAA4B;gBACtE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAGpD"}

package/bin/internal/errors.js

@@ -0,0 +1,39 @@
+/**
+ * @hidden
+ */
+class UseLiveDataObjectActionError extends Error {
+    constructor(ddsName, functionName, message) {
+        super(`use${toFirstLetterUppercase(ddsName)} ${functionName}: ${message}`);
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        super(ddsName, functionName, "container has not yet been joined");
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        super(ddsName, functionName, `${ddsName} is undefined, which means it is still being dynamically created`);
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        super(ddsName, functionName, `${ddsName} is not initialized`);
+    }
+}
+/**
+ * @hidden
+ */
+function toFirstLetterUppercase(word) {
+    return word[0].toUpperCase() + word.substring(1);
+}
+//# sourceMappingURL=errors.js.map

package/bin/internal/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,4BAA6B,SAAQ,KAAK;IAC5C,YAAY,OAAe,EAAE,YAAoB,EAAE,OAAe;QAC9D,KAAK,CACD,MAAM,sBAAsB,CAAC,OAAO,CAAC,IAAI,YAAY,KAAK,OAAO,EAAE,CACtE,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,4BAA4B;IAC3E,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,mCAAmC,CAAC,CAAC;IACtE,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,kCAAmC,SAAQ,4BAA4B;IAChF,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,kEAAkE,CAC/E,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,4BAA4B;IAClF,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,qBAAqB,CAAC,CAAC;IAClE,CAAC;CACJ;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,IAAY;IACxC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/bin/internal/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./useSharedStateRegistry";
+export * from "./errors";
+export * from "./type-guards";
+//# sourceMappingURL=index.d.ts.map

package/bin/internal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}

package/bin/internal/index.js

@@ -0,0 +1,4 @@
+export * from "./useSharedStateRegistry";
+export * from "./errors";
+export * from "./type-guards";
+//# sourceMappingURL=index.js.map

package/bin/internal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC"}

package/bin/internal/type-guards.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @hidden
+ * Used for useLiveState and useSharedState for checking if a value is a prevState callback
+ */
+export declare function isPrevStateCallback<TState>(value: any): value is (value: TState) => TState;
+//# sourceMappingURL=type-guards.d.ts.map

package/bin/internal/type-guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EACtC,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAEpC"}

package/bin/internal/type-guards.js

@@ -0,0 +1,8 @@
+/**
+ * @hidden
+ * Used for useLiveState and useSharedState for checking if a value is a prevState callback
+ */
+export function isPrevStateCallback(value) {
+    return typeof value === "function";
+}
+//# sourceMappingURL=type-guards.js.map

package/bin/internal/type-guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAC/B,KAAU;IAEV,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACvC,CAAC"}

package/bin/{internal-hooks → internal}/useSharedStateRegistry.d.ts

@@ -1,31 +1,31 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { DeleteSharedStateAction, IAzureContainerResults, RegisterSharedSetStateAction, UnregisterSharedSetStateAction, UpdateSharedStateAction } from "../types";
-export interface ISharedStateRegistryResponse {
-    /**
-     * Register a set state action callback
-     */
-    registerSharedSetStateAction: RegisterSharedSetStateAction;
-    /**
-     * Unregister a set state action callback
-     */
-    unregisterSharedSetStateAction: UnregisterSharedSetStateAction;
-    /**
-     * Setter callback to update the shared state
-     */
-    updateSharedState: UpdateSharedStateAction;
-    /**
-     * Delete a shared state value
-     */
-    deleteSharedState: DeleteSharedStateAction;
-}
-/**
- * Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
- *
- * @param results IAzureContainerResults response or undefined
- * @returns ISharedStateRegistryResponse object
- */
-export declare const useSharedStateRegistry: (results: IAzureContainerResults | undefined) => ISharedStateRegistryResponse;
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DeleteSharedStateAction, IAzureContainerResults, RegisterSharedSetStateAction, UnregisterSharedSetStateAction, UpdateSharedStateAction } from "../types";
+export interface ISharedStateRegistryResponse {
+    /**
+     * Register a set state action callback
+     */
+    registerSharedSetStateAction: RegisterSharedSetStateAction;
+    /**
+     * Unregister a set state action callback
+     */
+    unregisterSharedSetStateAction: UnregisterSharedSetStateAction;
+    /**
+     * Setter callback to update the shared state
+     */
+    updateSharedState: UpdateSharedStateAction;
+    /**
+     * Delete a shared state value
+     */
+    deleteSharedState: DeleteSharedStateAction;
+}
+/**
+ * Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
+ *
+ * @param results IAzureContainerResults response or undefined
+ * @returns ISharedStateRegistryResponse object
+ */
+export declare const useSharedStateRegistry: (results: IAzureContainerResults | undefined) => ISharedStateRegistryResponse;
 //# sourceMappingURL=useSharedStateRegistry.d.ts.map

package/bin/internal/useSharedStateRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSharedStateRegistry.d.ts","sourceRoot":"","sources":["../../src/internal/useSharedStateRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAE5B,8BAA8B,EAC9B,uBAAuB,EAC1B,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,4BAA4B,EAAE,4BAA4B,CAAC;IAC3D;;OAEG;IACH,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;CAC9C;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,YACtB,sBAAsB,GAAG,SAAS,KAC5C,4BAwHF,CAAC"}