@microsoft/live-share-react 2.0.0-internal.14 → 2.0.0-internal.16

package/bin/live-hooks/useLiveTimer.js

@@ -0,0 +1,172 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LiveTimerEvents, LiveTimer, LiveDataObjectInitializeState, } from "@microsoft/live-share";
+import React from "react";
+import { useDynamicDDS } from "../shared-hooks";
+import { useFluidObjectsContext } from "../providers";
+import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
+/**
+ * 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.
+ */
+export function useLiveTimer(uniqueKey, allowedRoles, tickRate, onTick, onStart, onPause, onPlay, onFinish) {
+    /**
+     * User facing: Stateful timer config.
+     */
+    const [timerConfig, setTimerConfig] = React.useState();
+    /**
+     * User facing: Stateful time remaining.
+     */
+    const [milliRemaining, setMilliRemaining] = React.useState();
+    /**
+     * User facing: dynamically load the DDS for the given unique key.
+     */
+    const { dds: liveTimer } = useDynamicDDS(uniqueKey, LiveTimer);
+    const { container } = 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.useCallback((duration) => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("liveTimer", "start");
+        }
+        if (liveTimer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("liveTimer", "start");
+        }
+        if (!liveTimer.isInitialized) {
+            throw new 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.useCallback(() => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("liveTimer", "play");
+        }
+        if (liveTimer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("liveTimer", "play");
+        }
+        if (!liveTimer.isInitialized) {
+            throw new 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.useCallback(() => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("liveTimer", "pause");
+        }
+        if (liveTimer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("liveTimer", "pause");
+        }
+        if (!liveTimer.isInitialized) {
+            throw new ActionLiveDataObjectInitializedError("liveTimer", "pause");
+        }
+        return yield liveTimer.pause();
+    }), [container, liveTimer]);
+    /**
+     * Setup change listeners and start `LiveTimer` if needed
+     */
+    React.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(LiveTimerEvents.started, onDidStart);
+        liveTimer.on(LiveTimerEvents.finished, onDidFinish);
+        liveTimer.on(LiveTimerEvents.played, onDidPlay);
+        liveTimer.on(LiveTimerEvents.paused, onDidPause);
+        liveTimer.on(LiveTimerEvents.onTick, onDidTick);
+        if (liveTimer.initializeState === LiveDataObjectInitializeState.needed) {
+            // Start live event
+            liveTimer.initialize(allowedRoles);
+        }
+        return () => {
+            // on unmount, remove event listeners
+            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.started, onDidStart);
+            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.finished, onDidFinish);
+            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.played, onDidPlay);
+            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.paused, onDidPause);
+            liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.onTick, onDidTick);
+        };
+    }, [liveTimer, onTick, onStart, onFinish, onPlay, onPause]);
+    /**
+     * Change tick rate if changes in props
+     */
+    React.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/live-hooks/useLiveTimer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveTimer.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAEH,eAAe,EAEf,SAAS,EACT,6BAA6B,GAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAY1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,oCAAoC,EACpC,kCAAkC,GACrC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,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,KAAK,CAAC,QAAQ,EAAgB,CAAC;IACrE;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAU,CAAC;IACrE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,aAAa,CAAY,SAAS,EAAE,SAAS,CAAC,CAAC;IAE1E,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;;;OAIG;IACH,MAAM,KAAK,GAAuB,KAAK,CAAC,WAAW,CAC/C,CAAO,QAAgB,EAAE,EAAE;QACvB,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACjE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CACxC,WAAW,EACX,OAAO,CACV,CAAC;SACL;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;SACL;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,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACzD,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SAChE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACvE;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,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QAC3D,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACjE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACtE;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;SACL;QACD,OAAO,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,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,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAClD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACpD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACjD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,IACI,SAAS,CAAC,eAAe,KAAK,6BAA6B,CAAC,MAAM,EACpE;YACE,mBAAmB;YACnB,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SACtC;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACpD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACtD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAClD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACnD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,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,KAAK,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;YACE,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACjC;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/live-hooks/useMediaSynchronizer.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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";
+/**
+ * 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.
+ */
+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/live-hooks/useMediaSynchronizer.d.ts.map

@@ -0,0 +1 @@
+{"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;AAGrC,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAOxD;;;;;;;;;;;;;;GAcG;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"}

package/bin/live-hooks/useMediaSynchronizer.js

@@ -0,0 +1,234 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LiveDataObjectInitializeState, } from "@microsoft/live-share";
+import React from "react";
+import { LiveMediaSession, } from "@microsoft/live-share-media";
+import { isExtendedMediaMetadata, isMediaElement, isRefObject } from "../utils";
+import { useDynamicDDS } from "../shared-hooks";
+import { useFluidObjectsContext } from "../providers";
+import { ActionContainerNotJoinedError, ActionLiveDataObjectUndefinedError, } from "../internal";
+/**
+ * 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.
+ */
+export function useMediaSynchronizer(uniqueKey, mediaPlayerElement, initialTrack, allowedRoles, viewOnly, canSendPositionUpdates) {
+    /**
+     * User facing media synchronizer and non-user facing setter
+     */
+    const [mediaSynchronizer, setMediaSynchronizer] = React.useState();
+    /**
+     * Suspension object and setter
+     */
+    const [suspension, setSuspension] = React.useState();
+    /**
+     * User facing: dynamically load the LiveMediaSession DDS for the given unique key.
+     */
+    const { dds: mediaSession } = useDynamicDDS(uniqueKey, LiveMediaSession);
+    const { container } = useFluidObjectsContext();
+    /**
+     * Play callback
+     */
+    const play = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("mediaSynchronizer", "play");
+        }
+        if (mediaSynchronizer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "play");
+        }
+        return yield mediaSynchronizer.play();
+    }), [container, mediaSynchronizer]);
+    /**
+     * Pause callback
+     */
+    const pause = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("mediaSynchronizer", "pause");
+        }
+        if (mediaSynchronizer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "pause");
+        }
+        return yield mediaSynchronizer.pause();
+    }), [container, mediaSynchronizer]);
+    /**
+     * User facing: seek callback
+     */
+    const seekTo = React.useCallback((time) => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("mediaSynchronizer", "seekTo");
+        }
+        if (mediaSynchronizer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "seekTo");
+        }
+        return yield mediaSynchronizer.seekTo(time);
+    }), [container, mediaSynchronizer]);
+    /**
+     * User facing: set track callback
+     */
+    const setTrack = React.useCallback((track) => __awaiter(this, void 0, void 0, function* () {
+        if (!container) {
+            throw new ActionContainerNotJoinedError("mediaSynchronizer", "setTrack");
+        }
+        if (mediaSynchronizer === undefined) {
+            throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "setTrack");
+        }
+        if (isExtendedMediaMetadata(track)) {
+            return yield mediaSynchronizer.setTrack(track);
+        }
+        else if (typeof track === "string") {
+            return yield mediaSynchronizer.setTrack({
+                trackIdentifier: track,
+            });
+        }
+    }), [container, mediaSynchronizer]);
+    /**
+     * User facing: create a new suspension and set it locally to state
+     */
+    const beginSuspension = React.useCallback((waitPoint) => {
+        const suspension = mediaSession === null || mediaSession === void 0 ? void 0 : mediaSession.coordinator.beginSuspension(waitPoint);
+        setSuspension(suspension);
+    }, [mediaSession]);
+    /**
+     * User facing: if a suspension is active, end it. Called when "Follow presenter" button is clicked.
+     */
+    const endSuspension = React.useCallback(() => {
+        suspension === null || suspension === void 0 ? void 0 : suspension.end();
+        setSuspension(undefined);
+    }, [suspension]);
+    /**
+     * Setup change listeners and start `LiveMediaSession` if needed
+     */
+    React.useEffect(() => {
+        if (mediaSession === undefined || !mediaPlayerElement)
+            return;
+        let mounted = true;
+        // Query the HTML5 media element from the document and set reference
+        let mediaPlayer;
+        if (isRefObject(mediaPlayerElement)) {
+            if (!mediaPlayerElement.current)
+                return;
+            mediaPlayer = mediaPlayerElement.current;
+        }
+        else if (typeof mediaPlayerElement === "string") {
+            const mediaElement = document.getElementById(mediaPlayerElement);
+            if (!isMediaElement(mediaElement))
+                return;
+            mediaPlayer = mediaElement;
+        }
+        else {
+            mediaPlayer = mediaPlayerElement;
+        }
+        if (initialTrack) {
+            // If supported type and not null, set the initial src
+            if (isExtendedMediaMetadata(initialTrack)) {
+                mediaPlayer.src = initialTrack.trackIdentifier;
+            }
+            else if (typeof initialTrack === "string") {
+                mediaPlayer.src = initialTrack;
+            }
+        }
+        // Begin synchronizing a MediaSynchronizer for the player
+        const synchronizer = mediaSession.synchronize(mediaPlayer);
+        if (viewOnly !== undefined) {
+            // Set synchronizer to view only mode provided by developer
+            synchronizer.viewOnly = viewOnly;
+        }
+        if (canSendPositionUpdates !== undefined) {
+            synchronizer.mediaSession.coordinator.canSendPositionUpdates =
+                canSendPositionUpdates;
+        }
+        if (mediaSession.initializeState ===
+            LiveDataObjectInitializeState.needed) {
+            // Start synchronizing the media session
+            mediaSession.initialize(allowedRoles !== null && allowedRoles !== void 0 ? allowedRoles : []);
+        }
+        else if (initialTrack) {
+            mediaSession.onLocalUserAllowed(() => __awaiter(this, void 0, void 0, function* () {
+                if (!mounted)
+                    return;
+                try {
+                    if (isExtendedMediaMetadata(initialTrack)) {
+                        yield synchronizer.setTrack(initialTrack);
+                    }
+                    else if (typeof initialTrack === "string") {
+                        yield synchronizer.setTrack({
+                            trackIdentifier: initialTrack,
+                        });
+                    }
+                }
+                catch (err) {
+                    console.error(err);
+                }
+            }));
+        }
+        setMediaSynchronizer(synchronizer);
+        return () => {
+            mounted = false;
+            synchronizer.removeAllListeners();
+            mediaSession.removeAllListeners();
+            synchronizer === null || synchronizer === void 0 ? void 0 : synchronizer.end();
+            mediaSession === null || mediaSession === void 0 ? void 0 : mediaSession.dispose();
+        };
+    }, [mediaSession, mediaPlayerElement]);
+    /**
+     * Change view in media synchronizer only if prop changes
+     */
+    React.useEffect(() => {
+        if (!mediaSynchronizer)
+            return;
+        if (viewOnly === undefined)
+            return;
+        if (mediaSynchronizer.viewOnly === viewOnly)
+            return;
+        mediaSynchronizer.viewOnly = viewOnly;
+    }, [viewOnly, mediaSynchronizer === null || mediaSynchronizer === void 0 ? void 0 : mediaSynchronizer.viewOnly]);
+    /**
+     * Change canSendPositionUpdates when prop changes
+     */
+    React.useEffect(() => {
+        if (!mediaSynchronizer)
+            return;
+        if (canSendPositionUpdates === undefined)
+            return;
+        if (mediaSynchronizer.mediaSession.coordinator
+            .canSendPositionUpdates === canSendPositionUpdates)
+            return;
+        mediaSynchronizer.mediaSession.coordinator.canSendPositionUpdates =
+            canSendPositionUpdates;
+    }, [
+        canSendPositionUpdates,
+        mediaSynchronizer === null || mediaSynchronizer === void 0 ? void 0 : mediaSynchronizer.mediaSession.coordinator.canSendPositionUpdates,
+    ]);
+    return {
+        suspended: !!suspension,
+        mediaSynchronizer,
+        play,
+        pause,
+        seekTo,
+        setTrack,
+        beginSuspension,
+        endSuspension,
+    };
+}
+//# sourceMappingURL=useMediaSynchronizer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useMediaSynchronizer.js","sourceRoot":"","sources":["../../src/live-hooks/useMediaSynchronizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EACH,6BAA6B,GAEhC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAIH,gBAAgB,GAGnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,kCAAkC,GACrC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,oBAAoB,CAChC,SAAiB,EACjB,kBAIU,EACV,YAA4D,EAC5D,YAAgC,EAChC,QAAkB,EAClB,sBAAgC;IAEhC;;OAEG;IACH,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAE7D,CAAC;IACJ;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,EAE/C,CAAC;IACJ;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,aAAa,CACvC,SAAS,EACT,gBAAgB,CACnB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACtC,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,MAAM,CACT,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,MAAM,CACT,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACvC,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,OAAO,CACV,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,OAAO,CACV,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,KAAK,EAAE,CAAC;IAC3C,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC5B,CAAO,IAAY,EAAE,EAAE;QACnB,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,QAAQ,CACX,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,QAAQ,CACX,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,iBAAiB,CAAC,CACjC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAO,KAAqD,EAAE,EAAE;QAC5D,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,UAAU,CACb,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,UAAU,CACb,CAAC;SACL;QACD,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE;YAChC,OAAO,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAClD;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAClC,OAAO,MAAM,iBAAiB,CAAC,QAAQ,CAAC;gBACpC,eAAe,EAAE,KAAK;aACA,CAAC,CAAC;SAC/B;IACL,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,iBAAiB,CAAC,CACjC,CAAC;IAEF;;OAEG;IACH,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CACrC,CAAC,SAAiC,EAAE,EAAE;QAClC,MAAM,UAAU,GACZ,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACzD,aAAa,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF;;OAEG;IACH,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,EAAE,CAAC;QAClB,aAAa,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,kBAAkB;YAAE,OAAO;QAC9D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,oEAAoE;QACpE,IAAI,WAAqC,CAAC;QAC1C,IAAI,WAAW,CAAe,kBAAkB,CAAC,EAAE;YAC/C,IAAI,CAAC,kBAAkB,CAAC,OAAO;gBAAE,OAAO;YACxC,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC;SAC5C;aAAM,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;YAC/C,MAAM,YAAY,GAAG,QAAQ,CAAC,cAAc,CACxC,kBAAkB,CACd,CAAC;YACT,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;gBAAE,OAAO;YAC1C,WAAW,GAAG,YAAY,CAAC;SAC9B;aAAM;YACH,WAAW,GAAG,kBAAkB,CAAC;SACpC;QACD,IAAI,YAAY,EAAE;YACd,sDAAsD;YACtD,IAAI,uBAAuB,CAAC,YAAY,CAAC,EAAE;gBACvC,WAAW,CAAC,GAAG,GAAG,YAAY,CAAC,eAAe,CAAC;aAClD;iBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;gBACzC,WAAW,CAAC,GAAG,GAAG,YAAY,CAAC;aAClC;SACJ;QACD,yDAAyD;QACzD,MAAM,YAAY,GAAG,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,2DAA2D;YAC3D,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACpC;QACD,IAAI,sBAAsB,KAAK,SAAS,EAAE;YACtC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB;gBACxD,sBAAsB,CAAC;SAC9B;QAED,IACI,YAAY,CAAC,eAAe;YAC5B,6BAA6B,CAAC,MAAM,EACtC;YACE,wCAAwC;YACxC,YAAY,CAAC,UAAU,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,EAAE,CAAC,CAAC;SAC/C;aAAM,IAAI,YAAY,EAAE;YACrB,YAAY,CAAC,kBAAkB,CAAC,GAAS,EAAE;gBACvC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,IAAI;oBACA,IAAI,uBAAuB,CAAC,YAAY,CAAC,EAAE;wBACvC,MAAM,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;qBAC7C;yBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;wBACzC,MAAM,YAAY,CAAC,QAAQ,CAAC;4BACxB,eAAe,EAAE,YAAY;yBACP,CAAC,CAAC;qBAC/B;iBACJ;gBAAC,OAAO,GAAG,EAAE;oBACV,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACtB;YACL,CAAC,CAAA,CAAC,CAAC;SACN;QACD,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAEnC,OAAO,GAAG,EAAE;YACR,OAAO,GAAG,KAAK,CAAC;YAChB,YAAY,CAAC,kBAAkB,EAAE,CAAC;YAClC,YAAY,CAAC,kBAAkB,EAAE,CAAC;YAClC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,GAAG,EAAE,CAAC;YACpB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,EAAE,CAAC;QAC5B,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAC/B,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO;QACnC,IAAI,iBAAiB,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO;QACpD,iBAAiB,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1C,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,QAAQ,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAC/B,IAAI,sBAAsB,KAAK,SAAS;YAAE,OAAO;QACjD,IACI,iBAAiB,CAAC,YAAY,CAAC,WAAW;aACrC,sBAAsB,KAAK,sBAAsB;YAEtD,OAAO;QACX,iBAAiB,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB;YAC7D,sBAAsB,CAAC;IAC/B,CAAC,EAAE;QACC,sBAAsB;QACtB,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,YAAY,CAAC,WAAW,CAAC,sBAAsB;KACrE,CAAC,CAAC;IAEH,OAAO;QACH,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,iBAAiB;QACjB,IAAI;QACJ,KAAK;QACL,MAAM;QACN,QAAQ;QACR,eAAe;QACf,aAAa;KAChB,CAAC;AACN,CAAC"}

package/bin/providers/AzureProvider.d.ts

@@ -0,0 +1,113 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { IFluidContainer, LoadableObjectClassRecord } from "fluid-framework";
+import React from "react";
+import { AzureClientProps, AzureContainerServices } from "@fluidframework/azure-client";
+import { IAzureContainerResults } from "../types";
+import { ISharedStateRegistryResponse } from "../shared-hooks";
+import { IFluidTurboClient } from "@microsoft/live-share-turbo";
+/**
+ * React Context provider values for `<AzureProvider>` and `<LiveShareProvider>`.
+ *
+ * @remarks
+ * To get the latest values, use the {@link useFluidObjectsContext} hook.
+ */
+export interface IFluidContext extends ISharedStateRegistryResponse {
+    /**
+     * The Fluid Turbo client used for connecting to the Fluid container.
+     */
+    clientRef: React.MutableRefObject<IFluidTurboClient>;
+    /**
+     * Stateful Fluid container.
+     */
+    container: IFluidContainer | undefined;
+    /**
+     * The Azure container services (e.g., audience).
+     */
+    services: AzureContainerServices | undefined;
+    /**
+     * A stateful error object that is set if there was an error connecting to the Fluid container.
+     */
+    joinError: Error | undefined;
+    /**
+     * React callback function to connect to an existing Fluid container.
+     *
+     * @remarks
+     * The results will also be set to their stateful counterparts for `container` and `services`.
+     *
+     * @param containerId the containerId to connect to.
+     * @param initialObjects Optional. initial object schema, which should match that passed to `createContainer()`.
+     * @returns promise that returns a results object once complete (e.g., container, services, etc.)
+     */
+    getContainer: (containerId: string, initialObjects?: LoadableObjectClassRecord) => Promise<IAzureContainerResults>;
+    /**
+     * React callback function to create and connect to a new Fluid container.
+     *
+     * @remarks
+     * The results will also be set to their stateful counterparts for `container` and `services`.
+     *
+     * @param initialObjects Optional. The initial object schema to apply to the container.
+     * @param onInitializeContainer Optional. A callback for when the container is first initialized, which is useful for setting default values to objects in `initialObjects`.
+     * @returns promise that returns a results object once complete (e.g., container, services, etc.)
+     */
+    createContainer: (initialObjects?: LoadableObjectClassRecord, onInitializeContainer?: (container: IFluidContainer) => void) => Promise<IAzureContainerResults>;
+}
+/**
+ * @hidden
+ */
+export declare const FluidContext: React.Context<IFluidContext>;
+/**
+ * Hook to get the latest React context state for `FluidContext`.
+ *
+ * @remarks
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @returns current state of `LiveShareContext`
+ */
+export declare const useFluidObjectsContext: () => IFluidContext;
+/**
+ * Prop types for {@link AzureProvider} component.
+ */
+export interface IAzureProviderProps {
+    /**
+     * Optional. React children node for the React Context Provider.
+     */
+    children?: React.ReactNode;
+    /**
+     * Props for initializing a new `AzureClient` instance.
+     */
+    clientOptions: AzureClientProps;
+    /**
+     * The `containerId` to connect to when {@link joinOnLoad} is true.
+     *
+     * @remarks
+     * If you pass in an `undefined` value when {@link createOnLoad} is true, a new container will be created.
+     */
+    containerId?: string;
+    /**
+     * Flag to control whether or not a new container should be created on first mount.
+     *
+     * @remarks
+     * If no {@link containerId} is set when the component first mounts, setting this to `true` will automatically create a new container.
+     * This prop does not do anything if you are using `<LiveShareProvider>` instead of `<AzureProvider>`.
+     */
+    createOnLoad?: boolean;
+    /**
+     * The initial object schema to use when {@link joinOnLoad} or {@link createOnLoad} is true.
+     */
+    initialObjects?: LoadableObjectClassRecord;
+    /**
+     * Flag to control whether or not to connect to an existing container on first mount.
+     *
+     * @remarks
+     * Setting this to true will connect to the container if {@link containerId} is provided as a prop.
+     */
+    joinOnLoad?: boolean;
+}
+/**
+ * React Context provider component for using Fluid data objects & joining/creating a Fluid document `AzureClient`.
+ */
+export declare const AzureProvider: React.FC<IAzureProviderProps>;
+//# sourceMappingURL=AzureProvider.d.ts.map

package/bin/providers/AzureProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureProvider.d.ts","sourceRoot":"","sources":["../../src/providers/AzureProvider.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACH,gBAAgB,EAChB,sBAAsB,EACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,EACH,4BAA4B,EAE/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAEH,iBAAiB,EACpB,MAAM,6BAA6B,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,4BAA4B;IAC/D;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IACrD;;OAEG;IACH,SAAS,EAAE,eAAe,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,QAAQ,EAAE,sBAAsB,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC;IAC7B;;;;;;;;;OASG;IACH,YAAY,EAAE,CACV,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,yBAAyB,KACzC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACrC;;;;;;;;;OASG;IACH,eAAe,EAAE,CACb,cAAc,CAAC,EAAE,yBAAyB,EAC1C,qBAAqB,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,IAAI,KAC3D,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,8BAExB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,QAAO,aAQzC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;OAEG;IACH,aAAa,EAAE,gBAAgB,CAAC;IAChC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAkHvD,CAAC"}