@microsoft/live-share-react 2.0.0-internal.4 → 2.0.0-internal.6

package/bin/esm/shared-hooks/useTreeNode.js

@@ -0,0 +1,132 @@
+import { Tree } from "fluid-framework";
+import { useEffect, useRef, useState } from "react";
+import { getRawNode, buildProxy, setUpListenersForNodeChildren, } from "./internals/tree-node-utils.js";
+/**
+ * Makes a provided Fluid `TreeNode` stateful in React.
+ *
+ * @param node the Fluid `SharedTree` `TreeNode` instance to make stateful.
+ * @param stateChangeType listener type to apply changes for. Default value is "nodeChanged", which has the most optimal performance.
+ * Provide "treeChanged" to make all children nodes stateful as well when those child nodes change.
+ * When using the default, you must pass all child `TreeNode` values into `useTreeNode` for them to be stateful as well.
+ * @returns a stateful version `node`
+ *
+ * @example
+ * Example using default `"nodeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ * class YourObject extends sf.object("YourObject", {
+ *  listChangedCount: sf.number,
+ *  list: sf.array(sf.string),
+ * }) {
+ *  // You can add your own utility functions
+ *  insert() {
+ *      this.list.insertAtEnd("some text");
+ *      this.listChangedCount += 1;
+ *  }
+ * }
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  number: 0,
+ *  list: [],
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Makes root stateful / automatically update when the node changes (e.g., node.count)
+ *  const { node } = useTreeNode(root);
+ *  // node.list is its own TreeNode, so we make it stateful as well
+ *  const { node: list } = useTreeNode(node?.list);
+ *  if (!node || !list) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.listChangedCount}</div>
+ *          <button onClick={() => node.insert()}>Insert</button>
+ *          { list.map((item) => <div key={item}>{item}</div>) }
+ *      </div>
+ *  );
+ * }
+ * ```
+ *
+ * @example
+ * Example using `"treeChanged"` `stateChangeType`
+ * ```tsx
+ * import { SchemaFactory, TreeViewConfiguration } from "fluid-framework";
+ * import { useSharedTree, useTreeNode } from "@microsoft/live-share-react";
+ * // Declare a schema factory with your unique uuid
+ * const sf = new SchemaFactory("fc1db2e8-0000-11ee-be57-0242ac120002");
+ *
+ * class ChildObject extends sf.object("ChildObject", {
+ *  count: sf.number,
+ * }) {
+ *  increment() {
+ *      this.count += 1;
+ *  }
+ * }
+ *
+ * class YourObject extends sf.object("YourObject", {
+ *  child: ChildObject,
+ * }) {}
+ * const config = new TreeViewConfiguration({ schema: YourObject });
+ * const initialData = new YourObject({
+ *  child: new ChildObject({ count: 0 }),
+ * });
+ *
+ * // Must be child component of <LiveShareProvider> or <AzureProvider>
+ * export const YourComponent = () => {
+ *  // Get the root node of the `SharedTree` mapped to "some-unique-key"
+ *  const { root } = useSharedTree("some-unique-key", config, initialData);
+ *  // Using "treeChanged" prop makes all children nodes stateful as well.
+ *  // Use with caution / measure render performance with React dev tools.
+ *  const { node } = useTreeNode(root, "treeChanged");
+ *  if (!node) return (<>"Loading"</>);
+ *  return (
+ *      <div>
+ *          <div>Changed: {node.child.count}</div>
+ *          <button onClick={() => node.increment()}>Insert</button>
+ *      </div>
+ *  );
+ * }
+ * ```
+ */
+export function useTreeNode(node, stateChangeType = "nodeChanged") {
+    // When we return a proxied node to a developer, it's possible they will pass it back to us in this hook.
+    // We can't listen using Tree.on using a proxy node though...
+    // Thus, if we are already listening to a node from another instance of this hook, we look for the unproxied node.
+    const rawNode = getRawNode(node);
+    const [proxyNode, setProxyNode] = useState(rawNode);
+    const treeProxyMapRef = useRef(new WeakMap());
+    useEffect(() => {
+        if (!rawNode)
+            return;
+        // Set default value
+        setProxyNode(rawNode);
+        function onNodeChanged() {
+            if (!rawNode)
+                return;
+            const proxyNode = buildProxy(rawNode, treeProxyMapRef.current);
+            setProxyNode(proxyNode);
+        }
+        // Listen to Fluid's base node from their TreeView so Fluid flex nodes continue to work
+        const unsubscribeListeners = [
+            Tree.on(rawNode, "nodeChanged", onNodeChanged),
+        ];
+        if (stateChangeType === "treeChanged") {
+            // Recursively for all child nodes of this node in the tree
+            setUpListenersForNodeChildren(rawNode, rawNode, treeProxyMapRef.current, unsubscribeListeners, 
+            // TODO: fix typing so casting isn't necessary
+            setProxyNode);
+        }
+        return () => {
+            unsubscribeListeners.forEach((unsubscribe) => unsubscribe());
+        };
+    }, [rawNode, stateChangeType]);
+    return {
+        node: proxyNode,
+    };
+}
+//# sourceMappingURL=useTreeNode.js.map

package/bin/esm/shared-hooks/useTreeNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTreeNode.js","sourceRoot":"","sources":["../../../src/shared-hooks/useTreeNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAA8B,MAAM,iBAAiB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,EACH,UAAU,EACV,UAAU,EACV,6BAA6B,GAChC,MAAM,gCAAgC,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,MAAM,UAAU,WAAW,CACvB,IAAW,EACX,kBAA0C,aAAa;IAEvD,yGAAyG;IACzG,6DAA6D;IAC7D,kHAAkH;IAClH,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAQ,OAAO,CAAC,CAAC;IAC3D,MAAM,eAAe,GAAG,MAAM,CAA8B,IAAI,OAAO,EAAE,CAAC,CAAC;IAE3E,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,oBAAoB;QACpB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,SAAS,aAAa;YAClB,IAAI,CAAC,OAAO;gBAAE,OAAO;YAErB,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;YAC/D,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,uFAAuF;QACvF,MAAM,oBAAoB,GAAmB;YACzC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC;SACjD,CAAC;QACF,IAAI,eAAe,KAAK,aAAa,EAAE,CAAC;YACpC,2DAA2D;YAC3D,6BAA6B,CACzB,OAAO,EACP,OAAO,EACP,eAAe,CAAC,OAAO,EACvB,oBAAoB;YACpB,8CAA8C;YAC9C,YAAmB,CACtB,CAAC;QACN,CAAC;QACD,OAAO,GAAG,EAAE;YACR,oBAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QACjE,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;IAE/B,OAAO;QACH,IAAI,EAAE,SAAS;KAClB,CAAC;AACN,CAAC"}

package/bin/esm/types/ActionTypes.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { IFluidLoadable } from "@fluidframework/core-interfaces";
+import { ITimerConfig, ILiveEvent, LivePresenceData } from "@microsoft/live-share";
+import { SharedObjectKind } from "fluid-framework";
+/**
+ * Callback to set shared state
+ */
+export type SetSharedStateAction<TState> = (state: TState | ((prevState: TState) => TState)) => void;
+/**
+ * Callback to set local state
+ */
+export type SetLocalStateAction = React.Dispatch<React.SetStateAction<any>>;
+/**
+ * Callback for UnregisterDDSSetStateAction.
+ * <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: SharedObjectKind<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void
+ */
+export type RegisterDDSSetStateAction = <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: SharedObjectKind<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void;
+/**
+ * Callback for UnregisterDDSSetStateAction.
+ * (uniqueKey: string, componentId: string) => void
+ */
+export type UnregisterDDSSetStateAction = (uniqueKey: string, componentId: string) => void;
+/**
+ * Callback for RegisterSharedSetStateAction.
+ * (uniqueKey: string, componentId: string, setLocalStateAction: SetLocalStateAction) => void
+ */
+export type RegisterSharedSetStateAction = (uniqueKey: string, componentId: string, setLocalStateAction: SetLocalStateAction) => void;
+/**
+ * Callback for UnregisterSharedSetStateAction.
+ * (uniqueKey: string, componentId: string) => void
+ */
+export type UnregisterSharedSetStateAction = (uniqueKey: string, componentId: string) => void;
+/**
+ * Callback for UpdateSharedStateAction.
+ * (uniqueKey: string, value: any) => void
+ */
+export type UpdateSharedStateAction = (uniqueKey: string, value: any) => void;
+/**
+ * Callback for DeleteSharedStateAction.
+ * (uniqueKey: string) => void
+ */
+export type DeleteSharedStateAction = (uniqueKey: string) => void;
+/**
+ * Callback for DisposeSharedStateAction.
+ * () => void
+ */
+export type DisposeSharedStateAction = () => void;
+/**
+ * Callback for SetLiveStateAction<TState = undefined>.
+ * (state: TState) => Promise<void>
+ */
+export type SetLiveStateAction<TState = undefined> = (state: TState | ((prevState: TState) => TState)) => Promise<void>;
+/**
+ * Callback for SendLiveEventAction<TEvent>.
+ * (event: TEvent, targetClientId?: string) => Promise<void>
+ */
+export type SendLiveEventAction<TEvent> = (event: TEvent, targetClientId?: string) => Promise<ILiveEvent<TEvent>>;
+/**
+ * Callback for OnReceivedLiveEventAction<TEvent>.
+ * (event: TEvent, local: boolean) => void
+ */
+export type OnReceivedLiveEventAction<TEvent> = (event: TEvent, local: boolean) => void;
+/**
+ * Callback for OnUpdateLivePresenceAction<TData extends object = object>.
+ * (data?: TData | undefined, state?: PresenceState | undefined) => Promise<void>
+ */
+export type OnUpdateLivePresenceAction<TData extends LivePresenceData = any> = (data: TData) => Promise<void>;
+/**
+ * Callback for OnStartTimerAction.
+ * (duration: number) => Promise<void>
+ */
+export type OnStartTimerAction = (duration: number) => Promise<void>;
+/**
+ * Callback for OnPlayTimerAction.
+ * () => Promise<void>
+ */
+export type OnPlayTimerAction = () => Promise<void>;
+/**
+ * Callback for OnPauseTimerAction.
+ * () => Promise<void>
+ */
+export type OnPauseTimerAction = () => Promise<void>;
+/**
+ * Callback for OnTimerTickAction.
+ * (milliRemaining: number) => void
+ */
+export type OnTimerTickAction = (milliRemaining: number) => void;
+/**
+ * Callback for OnTimerDidStartAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidStartAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidPauseAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidPauseAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidPlayAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidPlayAction = (timerConfig: ITimerConfig) => void;
+/**
+ * Callback for OnTimerDidFinishAction.
+ * (timerConfig: ITimerConfig) => void
+ */
+export type OnTimerDidFinishAction = (timerConfig: ITimerConfig) => void;
+//# sourceMappingURL=ActionTypes.d.ts.map

package/bin/esm/types/ActionTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionTypes.d.ts","sourceRoot":"","sources":["../../../src/types/ActionTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EACH,YAAY,EACZ,UAAU,EACV,gBAAgB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAInD;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,MAAM,IAAI,CACvC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC,KAC9C,IAAI,CAAC;AACV;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AAI5E;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,SAAS,cAAc,EAC7D,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAChC,mBAAmB,EAAE,mBAAmB,EACxC,oBAAoB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,KACtC,IAAI,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,KAClB,IAAI,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,CACvC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,mBAAmB,KACvC,IAAI,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,CACzC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,KAClB,IAAI,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;AAClE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC;AAIlD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,MAAM,GAAG,SAAS,IAAI,CACjD,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC,KAC9C,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,IAAI,CACtC,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,KACtB,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,yBAAyB,CAAC,MAAM,IAAI,CAC5C,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,OAAO,KACb,IAAI,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CAAC,KAAK,SAAS,gBAAgB,GAAG,GAAG,IAAI,CAC3E,IAAI,EAAE,KAAK,KACV,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;AACjE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACxE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACxE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC;AACvE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI,CAAC"}

package/bin/esm/types/ActionTypes.js.map

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

package/bin/esm/types/PropTypes.d.ts

@@ -0,0 +1,56 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { UserMeetingRole } from "@microsoft/live-share";
+import { CanvasReferencePoint, IBrush, IPoint, InkingTool, LiveCanvasTreeNode } from "@microsoft/live-share-canvas";
+export type SharedMapInitialData<T> = Map<string, T> | readonly (readonly [string, T])[] | {
+    [key: string]: T;
+} | undefined;
+/**
+ * Optional props for {@link useLiveCanvas}
+ */
+export interface IUseLiveCanvasOptionalProps {
+    /**
+     * Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
+     */
+    active?: boolean;
+    /**
+     * Optional. Stateful enum for what tool to use in the `InkingManager`.
+     */
+    tool?: InkingTool;
+    /**
+     * Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
+     */
+    lineBrush?: IBrush;
+    /**
+     * Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
+     */
+    offset?: IPoint;
+    /**
+     * Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
+     */
+    scale?: number;
+    /**
+     * Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
+     */
+    referencePoint?: CanvasReferencePoint;
+    /**
+     * Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
+     */
+    isCursorShared?: boolean;
+    /**
+     * Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
+     */
+    localUserPictureUrl?: string;
+    /**
+     * Optional. A Fluid `LiveCanvasTree` `TreeNode` instance to swap out the underlying storage solution for strokes.
+     * To learn more, look at Fluid's [SharedTree](https://fluidframework.com/docs/data-structures/tree/) documentation.
+     */
+    node?: LiveCanvasTreeNode;
+    /**
+     * Optional. The user roles that are allowed to start/stop/pause the timer.
+     */
+    allowedRoles?: UserMeetingRole[];
+}
+//# sourceMappingURL=PropTypes.d.ts.map

package/bin/esm/types/PropTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropTypes.d.ts","sourceRoot":"","sources":["../../../src/types/PropTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EACH,oBAAoB,EACpB,MAAM,EACN,MAAM,EACN,UAAU,EACV,kBAAkB,EACrB,MAAM,8BAA8B,CAAC;AAGtC,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAC5B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,GACd,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,GACjC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,GACpB,SAAS,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;CACpC"}

package/bin/esm/types/PropTypes.js.map

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

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

@@ -0,0 +1,330 @@
+/*!
+ * 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, IFollowModeState, FollowModePresenceUser, LiveFollowMode, LivePresenceData } from "@microsoft/live-share";
+import { InkingManager, LiveCanvas } from "@microsoft/live-share-canvas";
+import { CoordinationWaitPoint, ExtendedMediaMetadata, MediaPlayerSynchronizer } from "@microsoft/live-share-media";
+import { IFluidContainer, ITree, ImplicitFieldSchema, TreeFieldFromImplicitField, TreeView } from "fluid-framework";
+import { SharedMap } from "fluid-framework/legacy";
+import { IReceiveLiveEvent } from "../interfaces/index.js";
+import { OnPauseTimerAction, OnPlayTimerAction, OnStartTimerAction, OnUpdateLivePresenceAction, SendLiveEventAction } from "./ActionTypes.js";
+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;
+}
+/**
+ * @deprecated use {@link useSharedTree} instead.
+ *
+ * Return type of {@link useSharedMap} hook.
+ */
+export interface IUseSharedMapResults<TData> {
+    /**
+     * The Fluid `SharedMap` object.
+     */
+    sharedMap: (Map<string, TData> & SharedMap) | undefined;
+    /**
+     * Callback method to get entries in the `SharedMap`.
+     */
+    getEntry: (key: string) => TData | undefined;
+    /**
+     * 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;
+}
+/**
+ * Return type of {@link useSharedTree} hook.
+ */
+export interface IUseSharedTreeResults<TSchema extends ImplicitFieldSchema> {
+    /**
+     * The Fluid `TreeView`.
+     */
+    treeView: TreeView<TSchema> | undefined;
+    /**
+     * The Fluid `SharedTree` object, should you want to use it directly.
+     */
+    sharedTree: ITree | undefined;
+    /**
+     * Root node
+     */
+    root: TreeFieldFromImplicitField<TSchema> | undefined;
+}
+/**
+ * Return type of {@link useTreeNode} hook.
+ */
+export interface IUseTreeNodeResults<TNode = any> {
+    /**
+     * The Fluid `TreeNode`
+     */
+    node: TNode;
+}
+/**
+ * Return type of {@link useLiveEvent} hook.
+ */
+export interface IUseLiveEventResults<TEvent = any> {
+    /**
+     * 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.
+     * @param TEvent to send.
+     * @returns void promise that will throw when user does not have required roles
+     */
+    sendEvent: SendLiveEventAction<TEvent>;
+    /**
+     * The `LiveEvent` object, should you want to use it directly.
+     */
+    liveEvent: LiveEvent | undefined;
+}
+/**
+ * Return type of {@link useLiveTimer} hook.
+ */
+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;
+    /**
+     * 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
+     */
+    start: OnStartTimerAction;
+    /**
+     * Callback to send event through `LiveTimer`
+     * @returns void promise that will throw when user does not have required roles
+     */
+    play: OnPlayTimerAction;
+    /**
+     * Callback to send event through `LiveTimer`
+     * @returns void promise that will throw when user does not have required roles
+     */
+    pause: OnPauseTimerAction;
+}
+/**
+ * Return type of {@link useLivePresence} hook.
+ */
+export interface IUseLivePresenceResults<TData extends LivePresenceData = any> {
+    /**
+     * 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.
+     * @param data TData to set for user.
+     * @returns void promise that will throw when user does not have required roles
+     */
+    updatePresence: OnUpdateLivePresenceAction<TData>;
+}
+/**
+ * Return type of {@link useMediaSynchronizer} hook.
+ */
+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.
+     * @returns void promise that will throw when user does not have required roles
+     */
+    play: () => Promise<void>;
+    /**
+     * Callback to initiate a pause action for the group media session.
+     * @returns void promise that will throw when user does not have required roles
+     */
+    pause: () => Promise<void>;
+    /**
+     * Callback to initiate a seek action for the group media session.
+     * @param time timestamp of the video in seconds to seek to
+     * @returns void promise that will throw when user does not have required roles
+     */
+    seekTo: (time: number) => Promise<void>;
+    /**
+     * Callback to change the track for the group media session.
+     * @param track media metadata object, track src string, or null
+     * @returns void promise that will throw when user does not have required roles
+     */
+    setTrack: (track: Partial<ExtendedMediaMetadata> | string | null) => Promise<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;
+}
+/**
+ * Return type of {@link useLiveCanvas} hook.
+ */
+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;
+}
+/**
+ * Return type of {@link useLiveFollowMode} hook.
+ */
+export interface IUseLiveFollowModeResults<TData = any> {
+    /**
+     * Gets the current follow mode state.
+     */
+    state: IFollowModeState<TData> | undefined;
+    /**
+     * Local LivePresenceUser.
+     */
+    localUser: FollowModePresenceUser<TData> | undefined;
+    /**
+     * List of non-local user's presence objects.
+     */
+    otherUsers: FollowModePresenceUser<TData>[];
+    /**
+     * List of all user's presence objects.
+     */
+    allUsers: FollowModePresenceUser<TData>[];
+    /**
+     * LiveFollowMode DDS
+     */
+    liveFollowMode: LiveFollowMode<TData> | undefined;
+    /**
+     * Broadcast a new custom data value for the local user's current state.
+     *
+     * @remarks
+     * Each user has their own state value, though it will differ from what is shown in {@link state} depending on the value of {@link FollowModeType}.
+     * Will cause the user to become out of sync if another user is presenting or the local user is following another user.
+     * To see each user's state, use the {@link getUsers} API, or listen to "presenceChanged" updates.
+     *
+     * @param newValue the state value for the local user's presence record.
+     *
+     * @returns a void promise that resolves once the update event has been sent to the server.
+     *
+     * @throws error if initialization has not yet succeeded.
+     */
+    update: (stateValue: TData) => Promise<void>;
+    /**
+     * Start presenting the local user's state.
+     *
+     * @remarks
+     * If another user is already presenting, the local user will take control of presenting from the previous presenter.
+     * To update the local user's state that both the local and remote users will reference, use the {@link update} function.
+     * This API will override any `followingUserId` value that was set through {@link followUser} until presenting has stopped.
+     * To stop presenting, use the {@link stopPresenting} API.
+     *
+     * @returns a void promise that resolves once the event has been sent to the server.
+     *
+     * @throws error if initialization has not yet succeeded.
+     * @throws error if the local user is already the presenter.
+     * @throws error if the local user does not have the required roles to present.
+     */
+    startPresenting: () => Promise<void>;
+    /**
+     * Stop presenting the presenting user's current state.
+     *
+     * @remarks
+     * This API allows any user with valid roles to cancel presenting, though we generally recommend only allowing the active presenter to do so.
+     * To start presenting, use the {@link startPresenting} API.
+     *
+     * @returns a void promise that resolves once the event has been sent to the server.
+     *
+     * @throws error if initialization has not yet succeeded.
+     * @throws error if the local user does not have the required roles to stop presenting.
+     */
+    stopPresenting: () => Promise<void>;
+    /**
+     * Temporarily stop following presenter/follower.
+     *
+     * @returns a void promise once the operation succeeds.
+     *
+     * @throws error if initialization has not yet succeeded.
+     */
+    beginSuspension: () => Promise<void>;
+    /**
+     * Resume following presenter/follower.
+     *
+     * @returns a void promise once the operation succeeds.
+     *
+     * @throws error if initialization has not yet succeeded.
+     */
+    endSuspension: () => Promise<void>;
+    /**
+     * Follows another user in the session.
+     *
+     * @remarks
+     * If another user is presenting, {@link state} will not reflect following this user until there is no longer a presenter.
+     *
+     * @param userId the userId for the user to follow.
+     *
+     * @returns a void promise that resolves once the event has been sent to the server.
+     *
+     * @throws error if initialization has not yet succeeded.
+     * @throws error if attempting to follow a user that is not recognized by this object's `LivePresence` instance.
+     * @throws error if the `userId` provided is equal to the local user's `userId`.
+     */
+    followUser: (userId: string) => Promise<void>;
+    /**
+     * Stop following the currently following user.
+     *
+     * @returns a void promise that resolves once the event has been sent to the server.
+     *
+     * @throws error if initialization has not yet succeeded.
+     * @throws error if the user is not already following another user.
+     */
+    stopFollowing: () => Promise<void>;
+}
+//# sourceMappingURL=ResultTypes.d.ts.map

package/bin/esm/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,EACT,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EACnB,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,EACH,eAAe,EACf,KAAK,EACL,mBAAmB,EACnB,0BAA0B,EAC1B,QAAQ,EACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAcnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACH,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,mBAAmB,EACtB,MAAM,kBAAkB,CAAC;AAE1B,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;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,KAAK;IACvC;;OAEG;IACH,SAAS,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,GAAG,SAAS,CAAC;IAC7C;;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;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,OAAO,SAAS,mBAAmB;IACtE;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,UAAU,EAAE,KAAK,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,GAAG,GAAG;IAC5C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,MAAM,GAAG,GAAG;IAC9C;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;IACvC;;;;OAIG;IACH,SAAS,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACvC;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,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;;;;OAIG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,KAAK,SAAS,gBAAgB,GAAG,GAAG;IACzE;;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;;;;OAIG;IACH,cAAc,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B;;;;OAIG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC;;;;OAIG;IACH,QAAQ,EAAE,CACN,KAAK,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,GAAG,IAAI,KACpD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB;;;;;;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;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,KAAK,GAAG,GAAG;IAClD;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,SAAS,EAAE,sBAAsB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACrD;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;IAC5C;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;IAC1C;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAClD;;;;;;;;;;;;;OAaG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;;;;;;;;OAcG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC;;;;;;;;;;;OAWG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC;;;;;;OAMG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C;;;;;;;OAOG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC"}

package/bin/esm/types/ResultTypes.js.map

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

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

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

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

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