@microsoft/live-share-react 2.0.0-internal.17 → 2.0.0-internal.19

package/bin/cjs/live-hooks/useLiveState.d.ts

@@ -1,66 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { LiveState, UserMeetingRole } from "@microsoft/live-share";
-import { SetLiveStateAction } from "../types/index.js";
-/**
- * React hook for using a Live Share `LiveState`.
- *
- * @remarks
- * Use this hook if you want to synchronize app state that will reset when all users leave the session.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @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 initialState Optional. the initial state value of type TState
- * @param allowedRoles Optional. the user roles that are allowed to mutate the synchronized state
- * @returns ordered values: first value is the synchronized state value and the second is a setter to change the state value.
- * The setter returns a void promise, which will throw if the user does not have the required roles to set.
- *
- * @example
- ```jsx
-import { useLiveState } from "@microsoft/live-share-react";
-
-const planets = [
-  "Mercury",
-  "Venus",
-  "Earth",
-  "Mars",
-  "Jupiter",
-  "Saturn",
-  "Uranus",
-  "Neptune",
-];
-
-// Define a unique key that differentiates this usage of `useLiveState` from others in your app
-const MY_UNIQUE_KEY = "selected-planet-key";
-
-// Example component for using useLiveState
-export const MyCustomState = () => {
-  const [planet, setPlanet, liveState] = useLiveState(MY_UNIQUE_KEY, planets[0]);
-
-  // Render loading UI when creating LiveState instance for first time
-  if (!liveState) return <>Loading...</>;
-
-  // Render UI
-  return (
-    <div>
-      {`Current planet: ${planet}`}
-      {"Select a planet below:"}
-      {planets.map((planet) => (
-        <button
-          key={planet}
-          onClick={() => {
-            setPlanet(planet);
-          }}
-        >
-          {planet}
-        </button>
-      ))}
-    </div>
-  );
-};
- ```
- */
-export declare function useLiveState<TState = any>(uniqueKey: string, initialState: TState, allowedRoles?: UserMeetingRole[]): [TState, SetLiveStateAction<TState>, LiveState<TState> | undefined];
-//# sourceMappingURL=useLiveState.d.ts.map

package/bin/cjs/live-hooks/useLiveState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveState.d.ts","sourceRoot":"","sources":["../../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,SAAS,EACT,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAUvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAG,GAAG,EACrC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,eAAe,EAAE,GACjC,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAwErE"}

package/bin/cjs/live-hooks/useLiveState.js

@@ -1,134 +0,0 @@
-"use strict";
-/*!
- * 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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLiveState = useLiveState;
-const live_share_1 = require("@microsoft/live-share");
-const react_1 = __importDefault(require("react"));
-const index_js_1 = require("../shared-hooks/index.js");
-const index_js_2 = require("../providers/index.js");
-const index_js_3 = require("../internal/index.js");
-/**
- * React hook for using a Live Share `LiveState`.
- *
- * @remarks
- * Use this hook if you want to synchronize app state that will reset when all users leave the session.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @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 initialState Optional. the initial state value of type TState
- * @param allowedRoles Optional. the user roles that are allowed to mutate the synchronized state
- * @returns ordered values: first value is the synchronized state value and the second is a setter to change the state value.
- * The setter returns a void promise, which will throw if the user does not have the required roles to set.
- *
- * @example
- ```jsx
-import { useLiveState } from "@microsoft/live-share-react";
-
-const planets = [
-  "Mercury",
-  "Venus",
-  "Earth",
-  "Mars",
-  "Jupiter",
-  "Saturn",
-  "Uranus",
-  "Neptune",
-];
-
-// Define a unique key that differentiates this usage of `useLiveState` from others in your app
-const MY_UNIQUE_KEY = "selected-planet-key";
-
-// Example component for using useLiveState
-export const MyCustomState = () => {
-  const [planet, setPlanet, liveState] = useLiveState(MY_UNIQUE_KEY, planets[0]);
-
-  // Render loading UI when creating LiveState instance for first time
-  if (!liveState) return <>Loading...</>;
-
-  // Render UI
-  return (
-    <div>
-      {`Current planet: ${planet}`}
-      {"Select a planet below:"}
-      {planets.map((planet) => (
-        <button
-          key={planet}
-          onClick={() => {
-            setPlanet(planet);
-          }}
-        >
-          {planet}
-        </button>
-      ))}
-    </div>
-  );
-};
- ```
- */
-function useLiveState(uniqueKey, initialState, allowedRoles) {
-    const [currentState, setCurrentState] = react_1.default.useState(initialState);
-    /**
-     * User facing: dynamically load the DDS for the given unique key.
-     */
-    const { dds: liveState } = (0, index_js_1.useDynamicDDS)(uniqueKey, (live_share_1.LiveState));
-    const { container } = (0, index_js_2.useFluidObjectsContext)();
-    /**
-     * Change state callback that is user facing
-     * @param state TState to set
-     * @returns void promise, which will throw if the user does not have the required roles
-     */
-    const setState = react_1.default.useCallback((state) => __awaiter(this, void 0, void 0, function* () {
-        if (!container) {
-            throw new index_js_3.ActionContainerNotJoinedError("liveState", "setState");
-        }
-        if (liveState === undefined) {
-            throw new index_js_3.ActionLiveDataObjectUndefinedError("liveState", "setState");
-        }
-        if (!liveState.isInitialized) {
-            throw new index_js_3.ActionLiveDataObjectInitializedError("liveState", "setState");
-        }
-        const valueToSet = (0, index_js_3.isPrevStateCallback)(state)
-            ? state(liveState.state)
-            : state;
-        return yield liveState.set(valueToSet);
-    }), [container, liveState]);
-    /**
-     * Setup change listeners and start `LiveState` if needed
-     */
-    react_1.default.useEffect(() => {
-        if (liveState === undefined)
-            return;
-        const onStateChanged = (state) => {
-            setCurrentState(state);
-        };
-        liveState.on("stateChanged", onStateChanged);
-        if (liveState.initializeState === live_share_1.LiveDataObjectInitializeState.needed) {
-            liveState
-                .initialize(initialState, allowedRoles)
-                .then(() => onStateChanged(liveState.state));
-        }
-        else {
-            onStateChanged(liveState.state);
-        }
-        return () => {
-            liveState === null || liveState === void 0 ? void 0 : liveState.off("stateChanged", onStateChanged);
-        };
-    }, [liveState]);
-    return [currentState, setState, liveState];
-}
-//# sourceMappingURL=useLiveState.js.map

package/bin/cjs/live-hooks/useLiveState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveState.js","sourceRoot":"","sources":["../../../src/live-hooks/useLiveState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;AA4EH,oCA4EC;AAtJD,sDAI+B;AAC/B,kDAA0B;AAE1B,uDAAyD;AACzD,oDAA+D;AAC/D,mDAK8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,SAAgB,YAAY,CACxB,SAAiB,EACjB,YAAoB,EACpB,YAAgC;IAEhC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GACjC,eAAK,CAAC,QAAQ,CAAS,YAAY,CAAC,CAAC;IACzC;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAa,EACpC,SAAS,EACT,CAAA,sBAAiB,CAAA,CACpB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,iCAAsB,GAAE,CAAC;IAE/C;;;;OAIG;IACH,MAAM,QAAQ,GAAG,eAAK,CAAC,WAAW,CAC9B,CAAO,KAA+C,EAAE,EAAE;QACtD,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,wCAA6B,CACnC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,6CAAkC,CACxC,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,+CAAoC,CAC1C,WAAW,EACX,UAAU,CACb,CAAC;QACN,CAAC;QACD,MAAM,UAAU,GAAG,IAAA,8BAAmB,EAAS,KAAK,CAAC;YACjD,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC;YACxB,CAAC,CAAC,KAAK,CAAC;QACZ,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;OAEG;IACH,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO;QAEpC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,EAAE;YACrC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC7C,IACI,SAAS,CAAC,eAAe,KAAK,0CAA6B,CAAC,MAAM,EACpE,CAAC;YACC,SAAS;iBACJ,UAAU,CAAC,YAAY,EAAE,YAAY,CAAC;iBACtC,IAAI,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACJ,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,GAAG,EAAE;YACR,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,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC/C,CAAC"}

package/bin/cjs/live-hooks/useLiveTimer.d.ts

@@ -1,80 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { UserMeetingRole } from "@microsoft/live-share";
-import { IUseLiveTimerResults, OnTimerDidFinishAction, OnTimerDidPauseAction, OnTimerDidPlayAction, OnTimerDidStartAction, OnTimerTickAction } from "../types/index.js";
-/**
- * React hook for using Live Share's `LiveTimer` DDS.
- *
- * @remarks
- * Use this hook to create a synchronized countdown timer in your app or to schedule synchronized tasks.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @param uniqueKey the unique key for the `LiveTimer`. If one does not yet exist, a new one will be created, otherwise it will use the existing one.
- * @param allowedRoles Optional. the user roles that are allowed to start/stop/pause the timer.
- * @param tickRate Optional. the interval in which the `milliRemaining` state should be updated and the `onTick` callback will trigger.
- * @param onTick Optional. event handler callback for when an active timer ticks.
- * @param onStart Optional. event handler callback for when the timer is started.
- * @param onPause Optional. event handler callback for when the timer is paused.
- * @param onPlay Optional. event handler callback for when the timer is resumed.
- * @param onFinish Optional. event handler callback for when the timer finishes.
- * @returns results and callbacks exposed via the hook.
- *
- * @example
- ```jsx
-import { useLiveTimer } from "@microsoft/live-share-react";
-
-// Define a unique key that differentiates this usage of `useLiveTimer` from others in your app
-const MY_UNIQUE_KEY = "timer-key";
-
-// Example component for using useLiveTimer
-export function CountdownTimer() {
-    const {
-        milliRemaining,
-        timerConfig,
-        liveTimer,
-        start,
-        pause,
-        play,
-    } = useLiveTimer("TIMER-ID");
-
-    // Render loading UI when creating LiveTimer instance for first time
-    if (!liveTimer) return <>Loading...</>;
-
-    return (
-        <div>
-            <button
-                onClick={() => {
-                    start(60 * 1000);
-                }}
-            >
-                {timerConfig === undefined ? "Start" : "Reset"}
-            </button>
-            {timerConfig !== undefined && (
-                <button
-                    onClick={() => {
-                        if (timerConfig.running) {
-                            pause();
-                        } else {
-                            play();
-                        }
-                    }}
-                >
-                    {timerConfig.running ? "Pause" : "Play"}
-                </button>
-            )}
-            {milliRemaining !== undefined && (
-                <p>
-                {`${Math.round(milliRemaining / 1000)} / ${
-                    Math.round(timerConfig.duration) / 1000
-                }`}
-                </p>
-            )}
-        </div>
-    );
-}
- ```
- */
-export declare function useLiveTimer(uniqueKey: string, allowedRoles?: UserMeetingRole[], tickRate?: number, onTick?: OnTimerTickAction, onStart?: OnTimerDidStartAction, onPause?: OnTimerDidPauseAction, onPlay?: OnTimerDidPlayAction, onFinish?: OnTimerDidFinishAction): IUseLiveTimerResults;
-//# sourceMappingURL=useLiveTimer.d.ts.map

package/bin/cjs/live-hooks/useLiveTimer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveTimer.d.ts","sourceRoot":"","sources":["../../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,eAAe,EAGlB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EAIpB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,mBAAmB,CAAC;AAS3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,YAAY,CACxB,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,oBAAoB,EAC7B,QAAQ,CAAC,EAAE,sBAAsB,GAClC,oBAAoB,CA8JtB"}

package/bin/cjs/live-hooks/useLiveTimer.js

@@ -1,233 +0,0 @@
-"use strict";
-/*!
- * 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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLiveTimer = useLiveTimer;
-const live_share_1 = require("@microsoft/live-share");
-const react_1 = __importDefault(require("react"));
-const index_js_1 = require("../shared-hooks/index.js");
-const index_js_2 = require("../providers/index.js");
-const index_js_3 = require("../internal/index.js");
-/**
- * React hook for using Live Share's `LiveTimer` DDS.
- *
- * @remarks
- * Use this hook to create a synchronized countdown timer in your app or to schedule synchronized tasks.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @param uniqueKey the unique key for the `LiveTimer`. If one does not yet exist, a new one will be created, otherwise it will use the existing one.
- * @param allowedRoles Optional. the user roles that are allowed to start/stop/pause the timer.
- * @param tickRate Optional. the interval in which the `milliRemaining` state should be updated and the `onTick` callback will trigger.
- * @param onTick Optional. event handler callback for when an active timer ticks.
- * @param onStart Optional. event handler callback for when the timer is started.
- * @param onPause Optional. event handler callback for when the timer is paused.
- * @param onPlay Optional. event handler callback for when the timer is resumed.
- * @param onFinish Optional. event handler callback for when the timer finishes.
- * @returns results and callbacks exposed via the hook.
- *
- * @example
- ```jsx
-import { useLiveTimer } from "@microsoft/live-share-react";
-
-// Define a unique key that differentiates this usage of `useLiveTimer` from others in your app
-const MY_UNIQUE_KEY = "timer-key";
-
-// Example component for using useLiveTimer
-export function CountdownTimer() {
-    const {
-        milliRemaining,
-        timerConfig,
-        liveTimer,
-        start,
-        pause,
-        play,
-    } = useLiveTimer("TIMER-ID");
-
-    // Render loading UI when creating LiveTimer instance for first time
-    if (!liveTimer) return <>Loading...</>;
-
-    return (
-        <div>
-            <button
-                onClick={() => {
-                    start(60 * 1000);
-                }}
-            >
-                {timerConfig === undefined ? "Start" : "Reset"}
-            </button>
-            {timerConfig !== undefined && (
-                <button
-                    onClick={() => {
-                        if (timerConfig.running) {
-                            pause();
-                        } else {
-                            play();
-                        }
-                    }}
-                >
-                    {timerConfig.running ? "Pause" : "Play"}
-                </button>
-            )}
-            {milliRemaining !== undefined && (
-                <p>
-                {`${Math.round(milliRemaining / 1000)} / ${
-                    Math.round(timerConfig.duration) / 1000
-                }`}
-                </p>
-            )}
-        </div>
-    );
-}
- ```
- */
-function useLiveTimer(uniqueKey, allowedRoles, tickRate, onTick, onStart, onPause, onPlay, onFinish) {
-    /**
-     * User facing: Stateful timer config.
-     */
-    const [timerConfig, setTimerConfig] = react_1.default.useState();
-    /**
-     * User facing: Stateful time remaining.
-     */
-    const [milliRemaining, setMilliRemaining] = react_1.default.useState();
-    /**
-     * User facing: dynamically load the DDS for the given unique key.
-     */
-    const { dds: liveTimer } = (0, index_js_1.useDynamicDDS)(uniqueKey, live_share_1.LiveTimer);
-    const { container } = (0, index_js_2.useFluidObjectsContext)();
-    /**
-     * Callback to send event through `LiveTimer`
-     * @param duration the duration for the timer in milliseconds
-     * @returns void promise that will throw when user does not have required roles
-     */
-    const start = react_1.default.useCallback((duration) => __awaiter(this, void 0, void 0, function* () {
-        if (!container) {
-            throw new index_js_3.ActionContainerNotJoinedError("liveTimer", "start");
-        }
-        if (liveTimer === undefined) {
-            throw new index_js_3.ActionLiveDataObjectUndefinedError("liveTimer", "start");
-        }
-        if (!liveTimer.isInitialized) {
-            throw new index_js_3.ActionLiveDataObjectInitializedError("liveTimer", "start");
-        }
-        return yield liveTimer.start(duration);
-    }), [container, liveTimer]);
-    /**
-     * Callback to send event through `LiveTimer`
-     * @returns void promise that will throw when user does not have required roles
-     */
-    const play = react_1.default.useCallback(() => __awaiter(this, void 0, void 0, function* () {
-        if (!container) {
-            throw new index_js_3.ActionContainerNotJoinedError("liveTimer", "play");
-        }
-        if (liveTimer === undefined) {
-            throw new index_js_3.ActionLiveDataObjectUndefinedError("liveTimer", "play");
-        }
-        if (!liveTimer.isInitialized) {
-            throw new index_js_3.ActionLiveDataObjectInitializedError("liveTimer", "play");
-        }
-        return yield liveTimer.play();
-    }), [container, liveTimer]);
-    /**
-     * Callback to send event through `LiveTimer`
-     * @returns void promise that will throw when user does not have required roles
-     */
-    const pause = react_1.default.useCallback(() => __awaiter(this, void 0, void 0, function* () {
-        if (!container) {
-            throw new index_js_3.ActionContainerNotJoinedError("liveTimer", "pause");
-        }
-        if (liveTimer === undefined) {
-            throw new index_js_3.ActionLiveDataObjectUndefinedError("liveTimer", "pause");
-        }
-        if (!liveTimer.isInitialized) {
-            throw new index_js_3.ActionLiveDataObjectInitializedError("liveTimer", "pause");
-        }
-        return yield liveTimer.pause();
-    }), [container, liveTimer]);
-    /**
-     * Setup change listeners and start `LiveTimer` if needed
-     */
-    react_1.default.useEffect(() => {
-        if (liveTimer === undefined)
-            return;
-        // Reset default values, which is needed for when the `id` changes and a new DDS is loaded.
-        // React does not re-render if the values are already set to defaults (e.g., initial DDS).
-        setTimerConfig(undefined);
-        setMilliRemaining(undefined);
-        // Register event listeners
-        const onTimerConfigChange = (config) => {
-            setTimerConfig(config);
-        };
-        const onDidStart = (config) => {
-            onTimerConfigChange(config);
-            onStart === null || onStart === void 0 ? void 0 : onStart(config);
-            setMilliRemaining(config.duration);
-        };
-        const onDidFinish = (config) => {
-            onTimerConfigChange(config);
-            onFinish === null || onFinish === void 0 ? void 0 : onFinish(config);
-            setMilliRemaining(0);
-        };
-        const onDidPlay = (config) => {
-            onTimerConfigChange(config);
-            onPlay === null || onPlay === void 0 ? void 0 : onPlay(config);
-        };
-        const onDidPause = (config) => {
-            onTimerConfigChange(config);
-            onPause === null || onPause === void 0 ? void 0 : onPause(config);
-        };
-        const onDidTick = (milliseconds) => {
-            setMilliRemaining(milliseconds);
-            onTick === null || onTick === void 0 ? void 0 : onTick(milliseconds);
-        };
-        liveTimer.on(live_share_1.LiveTimerEvents.started, onDidStart);
-        liveTimer.on(live_share_1.LiveTimerEvents.finished, onDidFinish);
-        liveTimer.on(live_share_1.LiveTimerEvents.played, onDidPlay);
-        liveTimer.on(live_share_1.LiveTimerEvents.paused, onDidPause);
-        liveTimer.on(live_share_1.LiveTimerEvents.onTick, onDidTick);
-        if (liveTimer.initializeState === live_share_1.LiveDataObjectInitializeState.needed) {
-            // Start live event
-            liveTimer.initialize(allowedRoles);
-        }
-        return () => {
-            // on unmount, remove event listeners
-            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(live_share_1.LiveTimerEvents.started, onDidStart);
-            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(live_share_1.LiveTimerEvents.finished, onDidFinish);
-            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(live_share_1.LiveTimerEvents.played, onDidPlay);
-            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(live_share_1.LiveTimerEvents.paused, onDidPause);
-            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(live_share_1.LiveTimerEvents.onTick, onDidTick);
-        };
-    }, [liveTimer, onTick, onStart, onFinish, onPlay, onPause]);
-    /**
-     * Change tick rate if changes in props
-     */
-    react_1.default.useEffect(() => {
-        if (tickRate !== undefined &&
-            (liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate) !== undefined &&
-            tickRate !== (liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate)) {
-            liveTimer.tickRate = tickRate;
-        }
-    }, [tickRate, liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate]);
-    return {
-        liveTimer,
-        milliRemaining,
-        pause,
-        play,
-        start,
-        timerConfig,
-    };
-}
-//# sourceMappingURL=useLiveTimer.js.map

package/bin/cjs/live-hooks/useLiveTimer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveTimer.js","sourceRoot":"","sources":["../../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;AAqGH,oCAuKC;AA1QD,sDAM+B;AAC/B,kDAA0B;AAY1B,uDAAyD;AACzD,oDAA+D;AAC/D,mDAI8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,SAAgB,YAAY,CACxB,SAAiB,EACjB,YAAgC,EAChC,QAAiB,EACjB,MAA0B,EAC1B,OAA+B,EAC/B,OAA+B,EAC/B,MAA6B,EAC7B,QAAiC;IAEjC;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,eAAK,CAAC,QAAQ,EAAgB,CAAC;IACrE;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,eAAK,CAAC,QAAQ,EAAU,CAAC;IACrE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAa,EAAY,SAAS,EAAE,sBAAS,CAAC,CAAC;IAE1E,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,iCAAsB,GAAE,CAAC;IAE/C;;;;OAIG;IACH,MAAM,KAAK,GAAuB,eAAK,CAAC,WAAW,CAC/C,CAAO,QAAgB,EAAE,EAAE;QACvB,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,wCAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,6CAAkC,CACxC,WAAW,EACX,OAAO,CACV,CAAC;QACN,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,+CAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;QACN,CAAC;QACD,OAAO,MAAM,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;;OAGG;IACH,MAAM,IAAI,GAAsB,eAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACzD,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,wCAA6B,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,6CAAkC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,+CAAoC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAE3B;;;OAGG;IACH,MAAM,KAAK,GAAuB,eAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,wCAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,6CAAkC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,+CAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;QACN,CAAC;QACD,OAAO,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO;QACpC,2FAA2F;QAC3F,0FAA0F;QAC1F,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,2BAA2B;QAC3B,MAAM,mBAAmB,GAAG,CAAC,MAAoB,EAAE,EAAE;YACjD,cAAc,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,MAAoB,EAAE,EAAE;YACxC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,CAAC,CAAC;YAClB,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvC,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,CAAC,MAAoB,EAAE,EAAE;YACzC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,MAAM,CAAC,CAAC;YACnB,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,MAAoB,EAAE,EAAE;YACvC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,MAAM,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,MAAoB,EAAE,EAAE;YACxC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,CAAC,CAAC;QACtB,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,YAAoB,EAAE,EAAE;YACvC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,YAAY,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,4BAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAClD,SAAS,CAAC,EAAE,CAAC,4BAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACpD,SAAS,CAAC,EAAE,CAAC,4BAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,SAAS,CAAC,EAAE,CAAC,4BAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACjD,SAAS,CAAC,EAAE,CAAC,4BAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,IACI,SAAS,CAAC,eAAe,KAAK,0CAA6B,CAAC,MAAM,EACpE,CAAC;YACC,mBAAmB;YACnB,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,4BAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACpD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,4BAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACtD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,4BAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAClD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,4BAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACnD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,4BAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAE5D;;OAEG;IACH,eAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,QAAQ,KAAK,SAAS;YACtB,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,MAAK,SAAS;YACjC,QAAQ,MAAK,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,EAClC,CAAC;YACC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAClC,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,CAAC,CAAC;IAEpC,OAAO;QACH,SAAS;QACT,cAAc;QACd,KAAK;QACL,IAAI;QACJ,KAAK;QACL,WAAW;KACd,CAAC;AACN,CAAC"}

package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts

@@ -1,86 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { UserMeetingRole } from "@microsoft/live-share";
-import React from "react";
-import { ExtendedMediaMetadata, IMediaPlayer } from "@microsoft/live-share-media";
-import { IUseMediaSynchronizerResults } from "../types/index.js";
-/**
- * React hook for using a Live Share media `MediaPlayerSynchronizer`.
- *
- * @remarks
- * Use this hook if you want to synchronize the playback position of a video or audio element during a Live Share session.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @param uniqueKey uniqueKey value for the `LiveMediaSession` DDS object used by `MediaPlayerSynchronizer`.
- * @param mediaPlayerElement React RefObject containing object/element conforming to IMediaPlayer interface, `IMediaPlayer` object, or string id for <video> / <audio> element.
- * @param initialTrack initial track to load. Either ExtendedMediaMetadata, trackId string, or null.
- * @param allowedRoles Optional. Array of user roles that are eligible to modify group playback state.
- * @param viewOnly Optional. Flag for whether or not the media synchronizer should be in viewOnly mode.
- * @param canSendPositionUpdates Optional. Controls whether or not the local client is allowed to send position updates to the group.
- * @returns IUseMediaSynchronizerResults object.
- *
- * @example
- ```jsx
-import { useMediaSynchronizer } from "@microsoft/live-share-react";
-import { UserMeetingRole } from "@microsoft/live-share";
-import { MediaPlayerSynchronizerEvents } from "@microsoft/live-share-media";
-import { useRef, useEffect } from "react";
-
-const ALLOWED_ROLES = [UserMeetingRole.organizer, UserMeetingRole.presenter];
-
-const INITIAL_TRACK = "<YOUR_VIDEO_URL>";
-
-// Define a unique key that distinguishes this `useMediaSynchronizer` from others in your app
-const UNIQUE_KEY = "MEDIA-SESSION-ID";
-
-export function VideoPlayer() {
-  const videoRef = useRef(null);
-  const { play, pause, seekTo, mediaSynchronizer } = useMediaSynchronizer(
-    UNIQUE_KEY,
-    videoRef,
-    INITIAL_TRACK,
-    ALLOWED_ROLES
-  );
-
-  // Listen for groupaction events (optional)
-  useEffect(() => {
-    // Listen for player group actions for errors (e.g., play error)
-    const onGroupAction = (evt: IMediaPlayerSynchronizerEvent) => {
-      // See which user made the change (e.g., to display a notification)
-      const clientInfo = await synchronizer.mediaSession.getClientInfo(evt.details.clientId);
-    };
-    mediaSynchronizer?.addEventListener(
-      MediaPlayerSynchronizerEvents.groupaction,
-      onGroupAction
-    );
-    return () => {
-      mediaSynchronizer?.removeEventListener(
-        MediaPlayerSynchronizerEvents.groupaction,
-        onGroupAction
-      );
-    };
-  }, [mediaSynchronizer]);
-
-  return (
-    <div>
-      <video ref={videoRef} />
-      <button onClick={play}>
-        Play
-      </button>
-      <button onClick={pause}>
-        Pause
-      </button>
-      <button onClick={() => {
-        seekTo(0);
-      }}>
-        Start over
-      </button>
-    </div>
-  );
-}
- ```
- */
-export declare function useMediaSynchronizer(uniqueKey: string, mediaPlayerElement: React.RefObject<IMediaPlayer> | IMediaPlayer | string | null, initialTrack: Partial<ExtendedMediaMetadata> | string | null, allowedRoles?: UserMeetingRole[], viewOnly?: boolean, canSendPositionUpdates?: boolean): IUseMediaSynchronizerResults;
-//# sourceMappingURL=useMediaSynchronizer.d.ts.map

package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useMediaSynchronizer.d.ts","sourceRoot":"","sources":["../../../src/live-hooks/useMediaSynchronizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEH,qBAAqB,EACrB,YAAY,EAIf,MAAM,6BAA6B,CAAC;AAOrC,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AAOjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,wBAAgB,oBAAoB,CAChC,SAAS,EAAE,MAAM,EACjB,kBAAkB,EACZ,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,GAC7B,YAAY,GACZ,MAAM,GACN,IAAI,EACV,YAAY,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,GAAG,IAAI,EAC5D,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,QAAQ,CAAC,EAAE,OAAO,EAClB,sBAAsB,CAAC,EAAE,OAAO,GACjC,4BAA4B,CAiP9B"}