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

package/bin/types/ResultTypes.d.ts

@@ -0,0 +1,163 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { AzureContainerServices } from "@fluidframework/azure-client";
+import { ITimerConfig, LivePresenceUser, LiveEvent, LivePresence, LiveTimer } from "@microsoft/live-share";
+import { InkingManager, LiveCanvas } from "@microsoft/live-share-canvas";
+import { CoordinationWaitPoint, ExtendedMediaMetadata, MediaPlayerSynchronizer } from "@microsoft/live-share-media";
+import { IFluidContainer, SharedMap } from "fluid-framework";
+import { IReceiveLiveEvent } from "../interfaces";
+import { OnPauseTimerAction, OnPlayTimerAction, OnStartTimerAction, OnUpdateLivePresenceAction, SendLiveEventAction } from "./ActionTypes";
+export interface IAzureContainerResults {
+    /**
+     * Fluid Container.
+     */
+    container: IFluidContainer;
+    /**
+     * Azure container services which has information such as current socket connections.
+     */
+    services: AzureContainerServices;
+}
+export interface ILiveShareContainerResults extends IAzureContainerResults {
+    /**
+     * Whether the local user/client initially created the container.
+     */
+    created: boolean;
+}
+export interface IUseSharedMapResults<TData> {
+    /**
+     * Stateful map of most recent values from `SharedMap`.
+     */
+    map: ReadonlyMap<string, TData>;
+    /**
+     * Callback method to set/replace new entries in the `SharedMap`.
+     */
+    setEntry: (key: string, value: TData) => void;
+    /**
+     * Callback method to delete an existing entry in the `SharedMap`.
+     */
+    deleteEntry: (key: string) => void;
+    /**
+     * The Fluid `SharedMap` object, should you want to use it directly.
+     */
+    sharedMap: SharedMap | undefined;
+}
+export interface IUseLiveEventResults<TEvent extends object = object> {
+    /**
+     * The most recent event that has been received in the session.
+     */
+    latestEvent: IReceiveLiveEvent<TEvent> | undefined;
+    /**
+     * All received events since initializing this component, sorted from oldest -> newest.
+     */
+    allEvents: IReceiveLiveEvent<TEvent>[];
+    /**
+     * Callback method to send a new event to users in the session.
+     */
+    sendEvent: SendLiveEventAction<TEvent>;
+    /**
+     * The `LiveEvent` object, should you want to use it directly.
+     */
+    liveEvent: LiveEvent | undefined;
+}
+export interface IUseLiveTimerResults {
+    /**
+     * The current timer configuration.
+     */
+    timerConfig: ITimerConfig | undefined;
+    /**
+     * The time remaining in milliseconds.
+     */
+    milliRemaining: number | undefined;
+    /**
+     * The `LiveTimer` object, should you want to use it directly.
+     */
+    liveTimer: LiveTimer | undefined;
+    /**
+     * Start timer callback.
+     */
+    start: OnStartTimerAction;
+    /**
+     * Play timer callback.
+     */
+    play: OnPlayTimerAction;
+    /**
+     * Pause timer callback.
+     */
+    pause: OnPauseTimerAction;
+}
+export interface IUseLivePresenceResults<TData extends object = object> {
+    /**
+     * The local user's presence object.
+     */
+    localUser: LivePresenceUser<TData> | undefined;
+    /**
+     * List of non-local user's presence objects.
+     */
+    otherUsers: LivePresenceUser<TData>[];
+    /**
+     * List of all user's presence objects.
+     */
+    allUsers: LivePresenceUser<TData>[];
+    /**
+     * Live Share `LivePresence` object, should you want to use it directly.
+     */
+    livePresence: LivePresence<TData> | undefined;
+    /**
+     * Callback method to update the local user's presence.
+     */
+    updatePresence: OnUpdateLivePresenceAction<TData>;
+}
+export interface IUseMediaSynchronizerResults {
+    /**
+     * Stateful boolean on whether the session has an active suspension.
+     */
+    suspended: boolean;
+    /**
+     * Callback to initiate a play action for the group media session.
+     */
+    play: () => void;
+    /**
+     * Callback to initiate a pause action for the group media session.
+     */
+    pause: () => void;
+    /**
+     * Callback to initiate a seek action for the group media session.
+     *
+     * @param time timestamp of the video in seconds to seek to
+     */
+    seekTo: (time: number) => void;
+    /**
+     * Callback to change the track for the group media session.
+     * @param track media metadata object, track src string, or null
+     */
+    setTrack: (track: Partial<ExtendedMediaMetadata> | string | null) => void;
+    /**
+     * Begin a new suspension. If a wait point is not set, the suspension will only impact the
+     * local user.
+     *
+     * @param waitPoint Optional. Point in track to set the suspension at.
+     * @see CoordinationWaitPoint
+     */
+    beginSuspension: (waitPoint?: CoordinationWaitPoint) => void;
+    /**
+     * End the currently active exception.
+     */
+    endSuspension: () => void;
+    /**
+     * Live Share `MediaPlayerSynchronizer` object, should you want to use it directly.
+     */
+    mediaSynchronizer: MediaPlayerSynchronizer | undefined;
+}
+export interface IUseLiveCanvasResults {
+    /**
+     * Inking manager for the canvas, which is synchronized by `liveCanvas`. It is set when loaded and undefined while loading.
+     */
+    inkingManager: InkingManager | undefined;
+    /**
+     * Live Canvas data object which synchronizes inking & cursors in the session. It is set when loaded and undefined while loading.
+     */
+    liveCanvas: LiveCanvas | undefined;
+}
+//# sourceMappingURL=ResultTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ResultTypes.d.ts","sourceRoot":"","sources":["../../src/types/ResultTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EACH,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,SAAS,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,mBAAmB,EACtB,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACtE;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB,CAAC,KAAK;IACvC;;OAEG;IACH,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC9C;;OAEG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IAChE;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;IACvC;;OAEG;IACH,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACvC;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM;IAClE;;OAEG;IACH,SAAS,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;IACtC;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;IACpC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,cAAc,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB;;;;OAIG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B;;;OAGG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAC1E;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,SAAS,CAAC,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAC7D;;OAEG;IACH,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B;;OAEG;IACH,iBAAiB,EAAE,uBAAuB,GAAG,SAAS,CAAC;CAC1D;AAED,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;CACtC"}

package/bin/types/ResultTypes.js

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

package/bin/types/ResultTypes.js.map

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

package/bin/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ActionTypes";
+export * from "./ResultTypes";
+export * from "./PropTypes";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/bin/types/index.js

@@ -0,0 +1,4 @@
+export * from "./ActionTypes";
+export * from "./ResultTypes";
+export * from "./PropTypes";
+//# sourceMappingURL=index.js.map

package/bin/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/bin/utils/getContainerSchema.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { ContainerSchema, LoadableObjectClass } from "fluid-framework";
+export declare function getContainerSchema(additionalDynamicObjectTypes: LoadableObjectClass<any>[] | undefined): ContainerSchema;
+export declare function getLiveShareContainerSchema(additionalDynamicObjectTypes: LoadableObjectClass<any>[] | undefined): ContainerSchema;
+//# sourceMappingURL=getContainerSchema.d.ts.map

package/bin/utils/getContainerSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getContainerSchema.d.ts","sourceRoot":"","sources":["../../src/utils/getContainerSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EACH,eAAe,EACf,mBAAmB,EAItB,MAAM,iBAAiB,CAAC;AAUzB,wBAAgB,kBAAkB,CAC9B,4BAA4B,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,GACrE,eAAe,CAUjB;AAED,wBAAgB,2BAA2B,CACvC,4BAA4B,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,mBAgBvE"}

package/bin/utils/getContainerSchema.js

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { LiveEvent, LivePresence, LiveState, LiveTimer, } from "@microsoft/live-share";
+import { LiveCanvas } from "@microsoft/live-share-canvas";
+import { LiveMediaSession } from "@microsoft/live-share-media";
+import { SharedDirectory, SharedMap, SharedString, } from "fluid-framework";
+const schema = {
+    initialObjects: {
+        stateMap: SharedMap,
+        dynamicObjects: SharedMap,
+    },
+    dynamicObjectTypes: [SharedMap, SharedString, SharedDirectory],
+};
+export function getContainerSchema(additionalDynamicObjectTypes) {
+    const _additionalDynamicObjectTypes = additionalDynamicObjectTypes !== null && additionalDynamicObjectTypes !== void 0 ? additionalDynamicObjectTypes : [];
+    return {
+        initialObjects: schema.initialObjects,
+        dynamicObjectTypes: [
+            ...schema.dynamicObjectTypes,
+            ..._additionalDynamicObjectTypes,
+        ],
+    };
+}
+export function getLiveShareContainerSchema(additionalDynamicObjectTypes) {
+    const liveShareDynamicObjects = [
+        LiveEvent,
+        LivePresence,
+        LiveState,
+        LiveMediaSession,
+        LiveTimer,
+        LiveCanvas,
+    ];
+    const _additionalDynamicObjectTypes = additionalDynamicObjectTypes !== null && additionalDynamicObjectTypes !== void 0 ? additionalDynamicObjectTypes : [];
+    return getContainerSchema([
+        ...liveShareDynamicObjects,
+        ..._additionalDynamicObjectTypes,
+    ]);
+}
+//# sourceMappingURL=getContainerSchema.js.map

package/bin/utils/getContainerSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getContainerSchema.js","sourceRoot":"","sources":["../../src/utils/getContainerSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,SAAS,EACT,YAAY,EACZ,SAAS,EACT,SAAS,GACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAGH,eAAe,EACf,SAAS,EACT,YAAY,GACf,MAAM,iBAAiB,CAAC;AAEzB,MAAM,MAAM,GAAoB;IAC5B,cAAc,EAAE;QACZ,QAAQ,EAAE,SAAS;QACnB,cAAc,EAAE,SAAS;KAC5B;IACD,kBAAkB,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,CAAC;CACjE,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAC9B,4BAAoE;IAEpE,MAAM,6BAA6B,GAC/B,4BAA4B,aAA5B,4BAA4B,cAA5B,4BAA4B,GAAI,EAAE,CAAC;IACvC,OAAO;QACH,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,kBAAkB,EAAE;YAChB,GAAG,MAAM,CAAC,kBAAmB;YAC7B,GAAG,6BAA6B;SACnC;KACJ,CAAC;AACN,CAAC;AAED,MAAM,UAAU,2BAA2B,CACvC,4BAAoE;IAEpE,MAAM,uBAAuB,GAA+B;QACxD,SAAS;QACT,YAAY;QACZ,SAAS;QACT,gBAAgB;QAChB,SAAS;QACT,UAAU;KACb,CAAC;IACF,MAAM,6BAA6B,GAC/B,4BAA4B,aAA5B,4BAA4B,cAA5B,4BAA4B,GAAI,EAAE,CAAC;IACvC,OAAO,kBAAkB,CAAC;QACtB,GAAG,uBAAuB;QAC1B,GAAG,6BAA6B;KACnC,CAAC,CAAC;AACP,CAAC"}

package/bin/utils/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/bin/utils/index.js

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

package/bin/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/bin/utils/type-check.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { ExtendedMediaMetadata, IMediaPlayer } from "@microsoft/live-share-media";
+import React from "react";
+export declare function isRefObject<T>(value: any): value is React.RefObject<T>;
+export declare function isMediaElement(value: any): value is IMediaPlayer;
+export declare function isExtendedMediaMetadata(value: any): value is ExtendedMediaMetadata;
+export declare function isMap(value: any): value is Map<string, any>;
+export declare function isEntries(value: any): value is readonly (readonly [string, any])[];
+export declare function isJSON(value: any): value is {
+    [key: string]: any;
+};
+//# sourceMappingURL=type-check.d.ts.map

package/bin/utils/type-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-check.d.ts","sourceRoot":"","sources":["../../src/utils/type-check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,qBAAqB,EACrB,YAAY,EACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAEtE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAoBhE;AAED,wBAAgB,uBAAuB,CACnC,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,qBAAqB,CAEhC;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAE3D;AAED,wBAAgB,SAAS,CACrB,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAU9C;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAOlE"}

package/bin/utils/type-check.js

@@ -0,0 +1,54 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export function isRefObject(value) {
+    return value.current === null || !!value.current;
+}
+export function isMediaElement(value) {
+    if (value) {
+        return (value.currentSrc !== undefined &&
+            value.currentTime !== undefined &&
+            value.duration !== undefined &&
+            value.ended !== undefined &&
+            value.muted !== undefined &&
+            value.paused !== undefined &&
+            value.playbackRate !== undefined &&
+            value.src !== undefined &&
+            value.volume !== undefined &&
+            value.load !== undefined &&
+            value.pause !== undefined &&
+            value.play !== undefined &&
+            value.addEventListener !== undefined &&
+            value.removeEventListener !== undefined);
+    }
+    return false;
+}
+export function isExtendedMediaMetadata(value) {
+    return value === null || !!(value === null || value === void 0 ? void 0 : value.trackIdentifier);
+}
+export function isMap(value) {
+    return value instanceof Map;
+}
+export function isEntries(value) {
+    try {
+        const tryValue = value;
+        if (typeof tryValue[0][0] === "string") {
+            return true;
+        }
+        return false;
+    }
+    catch (error) {
+        return false;
+    }
+}
+export function isJSON(value) {
+    try {
+        const tryValue = value;
+        return Object.keys(tryValue).length > 0;
+    }
+    catch (error) {
+        return false;
+    }
+}
+//# sourceMappingURL=type-check.js.map

package/bin/utils/type-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-check.js","sourceRoot":"","sources":["../../src/utils/type-check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,MAAM,UAAU,WAAW,CAAI,KAAU;IACrC,OAAO,KAAK,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAU;IACrC,IAAI,KAAK,EAAE;QACP,OAAO,CACH,KAAK,CAAC,UAAU,KAAK,SAAS;YAC9B,KAAK,CAAC,WAAW,KAAK,SAAS;YAC/B,KAAK,CAAC,QAAQ,KAAK,SAAS;YAC5B,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,MAAM,KAAK,SAAS;YAC1B,KAAK,CAAC,YAAY,KAAK,SAAS;YAChC,KAAK,CAAC,GAAG,KAAK,SAAS;YACvB,KAAK,CAAC,MAAM,KAAK,SAAS;YAC1B,KAAK,CAAC,IAAI,KAAK,SAAS;YACxB,KAAK,CAAC,KAAK,KAAK,SAAS;YACzB,KAAK,CAAC,IAAI,KAAK,SAAS;YACxB,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACpC,KAAK,CAAC,mBAAmB,KAAK,SAAS,CAC1C,CAAC;KACL;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,KAAU;IAEV,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,KAAU;IAC5B,OAAO,KAAK,YAAY,GAAG,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,SAAS,CACrB,KAAU;IAEV,IAAI;QACA,MAAM,QAAQ,GAAG,KAAyC,CAAC;QAC3D,IAAI,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;YACpC,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;KAChB;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,KAAK,CAAC;KAChB;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAU;IAC7B,IAAI;QACA,MAAM,QAAQ,GAAG,KAA+B,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;KAC3C;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,KAAK,CAAC;KAChB;AACL,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@microsoft/live-share-react",
+  "version": "1.0.0-preview.5",
+  "description": "Build collaborative React apps using Microsoft's Fluid & Live Share frameworks with ease.",
+  "author": "Microsoft",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "./bin/index.js",
+  "types": "./bin/index.d.ts",
+  "scripts": {
+    "clean": "npx shx rm -rf bin",
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@fluidframework/azure-client": "~1.0.2",
+    "@fluid-experimental/task-manager": "~1.2.3",
+    "@microsoft/live-share": "1.0.0-preview.4",
+    "@microsoft/live-share-canvas": "1.0.0-preview.4",
+    "@microsoft/live-share-media": "1.0.0-preview.4",
+    "@microsoft/live-share-turbo": "1.0.0-preview.4",
+    "fluid-framework": "~1.2.3",
+    "url": "^0.11.0",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.12.3",
+    "@fluidframework/test-client-utils": "~1.2.3",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@types/uuid": "^8.3.4",
+    "babel-loader": "^7.1.5",
+    "typescript": "^4.6.4"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17 || ^18",
+    "react-dom": "^16.8.0 || ^17 || ^18"
+  },
+  "repository": {
+      "directory": "packages/live-share-react",
+      "type": "git",
+      "url": "https://github.com/microsoft/live-share-sdk"
+  },
+  "homepage": "https://aka.ms/teamsliveshare",
+  "bugs": {
+      "url": "https://github.com/microsoft/live-share-sdk/issues"
+  }
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from "./providers";
+export * from "./shared-hooks";
+export * from "./live-hooks";
+export * from "./types";
+export * from "./providers";
+export * from "./interfaces";

package/src/interfaces/LiveInterfaceExtensions.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+
+export interface IReceiveLiveEvent<TEvent extends object = object> {
+    event: TEvent;
+    local: boolean;
+}

package/src/interfaces/index.ts

@@ -0,0 +1 @@
+export * from "./LiveInterfaceExtensions";

package/src/internal-hooks/index.ts

@@ -0,0 +1 @@
+export * from "./useSharedStateRegistry";

package/src/internal-hooks/useSharedStateRegistry.ts

@@ -0,0 +1,163 @@
+/*!
+ * 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,
+    };
+};

package/src/live-hooks/index.ts

@@ -0,0 +1,6 @@
+export * from "./useLivePresence";
+export * from "./useLiveState";
+export * from "./useMediaSynchronizer";
+export * from "./useLiveEvent";
+export * from "./useLiveCanvas";
+export * from "./useLiveTimer";