@microsoft/live-share-react 1.2.2-preview.0 → 1.3.1-preview.0

package/src/{internal → shared-hooks}/useSharedStateRegistry.ts

@@ -1,164 +1,170 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-
-import { IValueChanged, SharedMap } from "fluid-framework";
-import React from "react";
-import {
-    DeleteSharedStateAction,
-    IAzureContainerResults,
-    RegisterSharedSetStateAction,
-    SetLocalStateAction,
-    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 const useSharedStateRegistry = (
-    results: IAzureContainerResults | undefined
-): ISharedStateRegistryResponse => {
-    const registeredSharedSetStateActionMapRef = React.useRef<
-        Map<string, Map<string, SetLocalStateAction>>
-    >(new Map());
-
-    /**
-     * @see ISharedStateRegistryResponse.registerSharedSetStateAction
-     */
-    const registerSharedSetStateAction = React.useCallback(
-        (
-            uniqueKey: string,
-            componentId: string,
-            setLocalStateAction: SetLocalStateAction
-        ) => {
-            let actionsMap =
-                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
-            if (actionsMap) {
-                if (!actionsMap.has(componentId)) {
-                    actionsMap.set(componentId, setLocalStateAction);
-                }
-            } else {
-                actionsMap = new Map<string, SetLocalStateAction>();
-                actionsMap.set(componentId, setLocalStateAction);
-                registeredSharedSetStateActionMapRef.current.set(
-                    uniqueKey,
-                    actionsMap
-                );
-            }
-            // Set initial values, if known
-            const stateMap = results?.container.initialObjects
-                .TURBO_STATE_MAP as SharedMap | undefined;
-            const initialValue = stateMap?.get(uniqueKey);
-            if (initialValue) {
-                setLocalStateAction(initialValue);
-            }
-        },
-        [results]
-    );
-
-    /**
-     * @see ISharedStateRegistryResponse.unregisterSharedSetStateAction
-     */
-    const unregisterSharedSetStateAction = React.useCallback(
-        (uniqueKey: string, componentId: string) => {
-            let actionsMap =
-                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
-            if (actionsMap?.has(componentId)) {
-                actionsMap.delete(componentId);
-            }
-        },
-        []
-    );
-
-    /**
-     * @see ISharedStateRegistryResponse.updateSharedState
-     */
-    const updateSharedState: UpdateSharedStateAction = React.useCallback(
-        (uniqueKey: string, value: any) => {
-            if (!results) return;
-            const { container } = results;
-            const stateMap = container.initialObjects
-                .TURBO_STATE_MAP as SharedMap;
-            stateMap.set(uniqueKey, value);
-        },
-        [results]
-    );
-
-    /**
-     * @see ISharedStateRegistryResponse.deleteSharedState
-     */
-    const deleteSharedState: DeleteSharedStateAction = React.useCallback(
-        (uniqueKey: string) => {
-            if (!results) return;
-            const { container } = results;
-            let actionsMap =
-                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
-            actionsMap?.clear();
-            const stateMap = container.initialObjects
-                .TURBO_STATE_MAP as SharedMap;
-            stateMap.delete(uniqueKey);
-        },
-        [results]
-    );
-
-    React.useEffect(() => {
-        if (!results) return;
-        const { container } = results;
-        const stateMap = container.initialObjects.TURBO_STATE_MAP as SharedMap;
-        const valueChangedListener = (changed: IValueChanged): void => {
-            if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
-                const value = stateMap.get(changed.key);
-                const actionMap =
-                    registeredSharedSetStateActionMapRef.current.get(
-                        changed.key
-                    );
-                actionMap?.forEach((setLocalStateHandler) => {
-                    setLocalStateHandler(value);
-                });
-            }
-        };
-        stateMap.on("valueChanged", valueChangedListener);
-        // Set initial values
-        stateMap.forEach((value: any, key: string) => {
-            const actionMap =
-                registeredSharedSetStateActionMapRef.current.get(key);
-            actionMap?.forEach((setLocalStateHandler) => {
-                setLocalStateHandler(value);
-            });
-        });
-        return () => {
-            stateMap.off("valueChanged", valueChangedListener);
-        };
-    }, [results]);
-
-    return {
-        registerSharedSetStateAction,
-        unregisterSharedSetStateAction,
-        updateSharedState,
-        deleteSharedState,
-    };
-};
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+
+import { IValueChanged, SharedMap } from "fluid-framework";
+import React from "react";
+import {
+    DeleteSharedStateAction,
+    IAzureContainerResults,
+    RegisterSharedSetStateAction,
+    SetLocalStateAction,
+    UnregisterSharedSetStateAction,
+    UpdateSharedStateAction,
+} from "../types";
+
+/**
+ * Response for the {@link useSharedStateRegistry} hook.
+ */
+export interface ISharedStateRegistryResponse {
+    /**
+     * Register a set state action callback
+     */
+    registerSharedSetStateAction: RegisterSharedSetStateAction;
+    /**
+     * Unregister a set state action callback
+     */
+    unregisterSharedSetStateAction: UnregisterSharedSetStateAction;
+    /**
+     * Setter callback to update the shared state
+     */
+    updateSharedState: UpdateSharedStateAction;
+    /**
+     * Delete a shared state value
+     */
+    deleteSharedState: DeleteSharedStateAction;
+}
+
+/**
+ * Hook used internally to keep track of the SharedSetStateActionMap for each unique key. It sets state values for provided keys and updates components listening to the values.
+ *
+ * @remarks
+ * Use this if you are building a custom `LiveShareProvider` or `AzureProvider` implementation in your app.
+ *
+ * @param results IAzureContainerResults response or undefined
+ * @returns ISharedStateRegistryResponse object
+ */
+export const useSharedStateRegistry = (
+    results: IAzureContainerResults | undefined
+): ISharedStateRegistryResponse => {
+    const registeredSharedSetStateActionMapRef = React.useRef<
+        Map<string, Map<string, SetLocalStateAction>>
+    >(new Map());
+
+    /**
+     * @see ISharedStateRegistryResponse.registerSharedSetStateAction
+     */
+    const registerSharedSetStateAction = React.useCallback(
+        (
+            uniqueKey: string,
+            componentId: string,
+            setLocalStateAction: SetLocalStateAction
+        ) => {
+            let actionsMap =
+                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+            if (actionsMap) {
+                if (!actionsMap.has(componentId)) {
+                    actionsMap.set(componentId, setLocalStateAction);
+                }
+            } else {
+                actionsMap = new Map<string, SetLocalStateAction>();
+                actionsMap.set(componentId, setLocalStateAction);
+                registeredSharedSetStateActionMapRef.current.set(
+                    uniqueKey,
+                    actionsMap
+                );
+            }
+            // Set initial values, if known
+            const stateMap = results?.container.initialObjects
+                .TURBO_STATE_MAP as SharedMap | undefined;
+            const initialValue = stateMap?.get(uniqueKey);
+            if (initialValue) {
+                setLocalStateAction(initialValue);
+            }
+        },
+        [results]
+    );
+
+    /**
+     * @see ISharedStateRegistryResponse.unregisterSharedSetStateAction
+     */
+    const unregisterSharedSetStateAction = React.useCallback(
+        (uniqueKey: string, componentId: string) => {
+            let actionsMap =
+                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+            if (actionsMap?.has(componentId)) {
+                actionsMap.delete(componentId);
+            }
+        },
+        []
+    );
+
+    /**
+     * @see ISharedStateRegistryResponse.updateSharedState
+     */
+    const updateSharedState: UpdateSharedStateAction = React.useCallback(
+        (uniqueKey: string, value: any) => {
+            if (!results) return;
+            const { container } = results;
+            const stateMap = container.initialObjects
+                .TURBO_STATE_MAP as SharedMap;
+            stateMap.set(uniqueKey, value);
+        },
+        [results]
+    );
+
+    /**
+     * @see ISharedStateRegistryResponse.deleteSharedState
+     */
+    const deleteSharedState: DeleteSharedStateAction = React.useCallback(
+        (uniqueKey: string) => {
+            if (!results) return;
+            const { container } = results;
+            let actionsMap =
+                registeredSharedSetStateActionMapRef.current.get(uniqueKey);
+            actionsMap?.clear();
+            const stateMap = container.initialObjects
+                .TURBO_STATE_MAP as SharedMap;
+            stateMap.delete(uniqueKey);
+        },
+        [results]
+    );
+
+    React.useEffect(() => {
+        if (!results) return;
+        const { container } = results;
+        const stateMap = container.initialObjects.TURBO_STATE_MAP as SharedMap;
+        const valueChangedListener = (changed: IValueChanged): void => {
+            if (registeredSharedSetStateActionMapRef.current.has(changed.key)) {
+                const value = stateMap.get(changed.key);
+                const actionMap =
+                    registeredSharedSetStateActionMapRef.current.get(
+                        changed.key
+                    );
+                actionMap?.forEach((setLocalStateHandler) => {
+                    setLocalStateHandler(value);
+                });
+            }
+        };
+        stateMap.on("valueChanged", valueChangedListener);
+        // Set initial values
+        stateMap.forEach((value: any, key: string) => {
+            const actionMap =
+                registeredSharedSetStateActionMapRef.current.get(key);
+            actionMap?.forEach((setLocalStateHandler) => {
+                setLocalStateHandler(value);
+            });
+        });
+        return () => {
+            stateMap.off("valueChanged", valueChangedListener);
+        };
+    }, [results]);
+
+    return {
+        registerSharedSetStateAction,
+        unregisterSharedSetStateAction,
+        updateSharedState,
+        deleteSharedState,
+    };
+};

package/src/types/ActionTypes.ts

@@ -1,161 +1,161 @@
-/*!
- * 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, ILiveEvent, PresenceState } from "@microsoft/live-share";
-
-// React actions
-
-/**
- * Callback to set shared state
- */
-export type SetSharedStateAction<TState> = (
-    state: TState | ((prevState: TState) => TState)
-) => void;
-/**
- * Callback to set local state
- */
-export type SetLocalStateAction = React.Dispatch<React.SetStateAction<any>>;
-
-// Fluid actions
-
-/**
- * Callback for UnregisterDDSSetStateAction.
- * <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: LoadableObjectClass<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void
- */
-export type RegisterDDSSetStateAction = <T extends IFluidLoadable>(
-    uniqueKey: string,
-    componentId: string,
-    objectClass: LoadableObjectClass<T>,
-    setLocalStateAction: SetLocalStateAction,
-    onDidFirstInitialize?: (dds: T) => void
-) => void;
-
-/**
- * Callback for UnregisterDDSSetStateAction.
- * (uniqueKey: string, componentId: string) => void
- */
-export type UnregisterDDSSetStateAction = (
-    uniqueKey: string,
-    componentId: string
-) => void;
-
-/**
- * Callback for RegisterSharedSetStateAction.
- * (uniqueKey: string, componentId: string, setLocalStateAction: SetLocalStateAction) => void
- */
-export type RegisterSharedSetStateAction = (
-    uniqueKey: string,
-    componentId: string,
-    setLocalStateAction: SetLocalStateAction
-) => void;
-
-/**
- * Callback for UnregisterSharedSetStateAction.
- * (uniqueKey: string, componentId: string) => void
- */
-export type UnregisterSharedSetStateAction = (
-    uniqueKey: string,
-    componentId: string
-) => void;
-
-/**
- * Callback for UpdateSharedStateAction.
- * (uniqueKey: string, value: any) => void
- */
-export type UpdateSharedStateAction = (uniqueKey: string, value: any) => void;
-
-/**
- * Callback for DeleteSharedStateAction.
- * (uniqueKey: string) => void
- */
-export type DeleteSharedStateAction = (uniqueKey: string) => void;
-/**
- * Callback for DisposeSharedStateAction.
- * () => void
- */
-export type DisposeSharedStateAction = () => void;
-
-// Live Share actions
-
-/**
- * Callback for SetLiveStateAction<TState = undefined>.
- * (state: TState) => Promise<void>
- */
-export type SetLiveStateAction<TState = undefined> = (
-    state: TState | ((prevState: TState) => TState)
-) => Promise<void>;
-
-/**
- * Callback for SendLiveEventAction<TEvent>.
- * (event: TEvent) => Promise<void>
- */
-export type SendLiveEventAction<TEvent> = (
-    event: TEvent
-) => Promise<ILiveEvent<TEvent>>;
-
-/**
- * Callback for OnReceivedLiveEventAction<TEvent>.
- * (event: TEvent, local: boolean) => void
- */
-export type OnReceivedLiveEventAction<TEvent> = (
-    event: TEvent,
-    local: boolean
-) => void;
-
-/**
- * Callback for OnUpdateLivePresenceAction<TData extends object = object>.
- * (data?: TData | undefined, state?: PresenceState | undefined) => Promise<void>
- */
-export type OnUpdateLivePresenceAction<TData extends object = object> = (
-    data?: TData | undefined,
-    state?: PresenceState | undefined
-) => Promise<void>;
-
-/**
- * Callback for OnStartTimerAction.
- * (duration: number) => Promise<void>
- */
-export type OnStartTimerAction = (duration: number) => Promise<void>;
-
-/**
- * Callback for OnPlayTimerAction.
- * () => Promise<void>
- */
-export type OnPlayTimerAction = () => Promise<void>;
-
-/**
- * Callback for OnPauseTimerAction.
- * () => Promise<void>
- */
-export type OnPauseTimerAction = () => Promise<void>;
-
-/**
- * Callback for OnTimerTickAction.
- * (milliRemaining: number) => void
- */
-export type OnTimerTickAction = (milliRemaining: number) => void;
-/**
- * Callback for OnTimerDidStartAction.
- * (timerConfig: ITimerConfig) => void
- */
-export type OnTimerDidStartAction = (timerConfig: ITimerConfig) => void;
-/**
- * Callback for OnTimerDidPauseAction.
- * (timerConfig: ITimerConfig) => void
- */
-export type OnTimerDidPauseAction = (timerConfig: ITimerConfig) => void;
-/**
- * Callback for OnTimerDidPlayAction.
- * (timerConfig: ITimerConfig) => void
- */
-export type OnTimerDidPlayAction = (timerConfig: ITimerConfig) => void;
-/**
- * Callback for OnTimerDidFinishAction.
- * (timerConfig: ITimerConfig) => void
- */
-export type OnTimerDidFinishAction = (timerConfig: ITimerConfig) => void;
+/*!
+ * 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, ILiveEvent, PresenceState } from "@microsoft/live-share";
+
+// React actions
+
+/**
+ * Callback to set shared state
+ */
+export type SetSharedStateAction<TState> = (
+    state: TState | ((prevState: TState) => TState)
+) => void;
+/**
+ * Callback to set local state
+ */
+export type SetLocalStateAction = React.Dispatch<React.SetStateAction<any>>;
+
+// Fluid actions
+
+/**
+ * Callback for UnregisterDDSSetStateAction.
+ * <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: LoadableObjectClass<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void
+ */
+export type RegisterDDSSetStateAction = <T extends IFluidLoadable>(
+    uniqueKey: string,
+    componentId: string,
+    objectClass: LoadableObjectClass<T>,
+    setLocalStateAction: SetLocalStateAction,
+    onDidFirstInitialize?: (dds: T) => void
+) => void;
+
+/**
+ * Callback for UnregisterDDSSetStateAction.
+ * (uniqueKey: string, componentId: string) => void
+ */
+export type UnregisterDDSSetStateAction = (
+    uniqueKey: string,
+    componentId: string
+) => void;
+
+/**
+ * Callback for RegisterSharedSetStateAction.
+ * (uniqueKey: string, componentId: string, setLocalStateAction: SetLocalStateAction) => void
+ */
+export type RegisterSharedSetStateAction = (
+    uniqueKey: string,
+    componentId: string,
+    setLocalStateAction: SetLocalStateAction
+) => void;
+
+/**
+ * Callback for UnregisterSharedSetStateAction.
+ * (uniqueKey: string, componentId: string) => void
+ */
+export type UnregisterSharedSetStateAction = (
+    uniqueKey: string,
+    componentId: string
+) => void;
+
+/**
+ * Callback for UpdateSharedStateAction.
+ * (uniqueKey: string, value: any) => void
+ */
+export type UpdateSharedStateAction = (uniqueKey: string, value: any) => void;
+
+/**
+ * Callback for DeleteSharedStateAction.
+ * (uniqueKey: string) => void
+ */
+export type DeleteSharedStateAction = (uniqueKey: string) => void;
+/**
+ * Callback for DisposeSharedStateAction.
+ * () => void
+ */
+export type DisposeSharedStateAction = () => void;
+
+// Live Share actions
+
+/**
+ * Callback for SetLiveStateAction<TState = undefined>.
+ * (state: TState) => Promise<void>
+ */
+export type SetLiveStateAction<TState = undefined> = (
+    state: TState | ((prevState: TState) => TState)
+) => Promise<void>;
+
+/**
+ * Callback for SendLiveEventAction<TEvent>.
+ * (event: TEvent) => Promise<void>
+ */
+export type SendLiveEventAction<TEvent> = (
+    event: TEvent
+) => Promise<ILiveEvent<TEvent>>;
+
+/**
+ * Callback for OnReceivedLiveEventAction<TEvent>.
+ * (event: TEvent, local: boolean) => void
+ */
+export type OnReceivedLiveEventAction<TEvent> = (
+    event: TEvent,
+    local: boolean
+) => void;
+
+/**
+ * Callback for OnUpdateLivePresenceAction<TData extends object = object>.
+ * (data?: TData | undefined, state?: PresenceState | undefined) => Promise<void>
+ */
+export type OnUpdateLivePresenceAction<TData extends object = object> = (
+    data?: TData | undefined,
+    state?: PresenceState | undefined
+) => Promise<void>;
+
+/**
+ * Callback for OnStartTimerAction.
+ * (duration: number) => Promise<void>
+ */
+export type OnStartTimerAction = (duration: number) => Promise<void>;
+
+/**
+ * Callback for OnPlayTimerAction.
+ * () => Promise<void>
+ */
+export type OnPlayTimerAction = () => Promise<void>;
+
+/**
+ * Callback for OnPauseTimerAction.
+ * () => Promise<void>
+ */
+export type OnPauseTimerAction = () => Promise<void>;
+
+/**
+ * Callback for OnTimerTickAction.
+ * (milliRemaining: number) => void
+ */
+export type OnTimerTickAction = (milliRemaining: number) => void;
+/**
+ * Callback for OnTimerDidStartAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidStartAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidPauseAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidPauseAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidPlayAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidPlayAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidFinishAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidFinishAction = (timerConfig: ITimerConfig) => void;