@microsoft/live-share-react 2.0.0-internal.2 → 2.0.0-internal.20

package/bin/esm/shared-hooks/useTreeNode.d.ts

@@ -0,0 +1,96 @@
+import { TreeChangeEvents, TreeNode } from "fluid-framework";
+import { IUseTreeNodeResults } from "../types/index.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 declare function useTreeNode<TNode extends TreeNode | undefined = TreeNode>(node: TNode, stateChangeType?: keyof TreeChangeEvents): IUseTreeNodeResults<TNode>;
+//# sourceMappingURL=useTreeNode.d.ts.map

package/bin/esm/shared-hooks/useTreeNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTreeNode.d.ts","sourceRoot":"","sources":["../../../src/shared-hooks/useTreeNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,gBAAgB,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAQxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,QAAQ,GAAG,SAAS,GAAG,QAAQ,EACrE,IAAI,EAAE,KAAK,EACX,eAAe,GAAE,MAAM,gBAAgC,GACxD,mBAAmB,CAAC,KAAK,CAAC,CA0C5B"}

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/{types → esm/types}/ActionTypes.d.ts

@@ -4,8 +4,8 @@
  */
 import React from "react";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
-import { LoadableObjectClass } from "fluid-framework";
-import { ITimerConfig, ILiveEvent, PresenceState } from "@microsoft/live-share";
+import { ITimerConfig, ILiveEvent, LivePresenceData } from "@microsoft/live-share";
+import { SharedObjectKind } from "fluid-framework";
 /**
  * Callback to set shared state
  */
@@ -16,9 +16,9 @@ export type SetSharedStateAction<TState> = (state: TState | ((prevState: TState)
 export type SetLocalStateAction = React.Dispatch<React.SetStateAction<any>>;
 /**
  * Callback for UnregisterDDSSetStateAction.
- * <T extends IFluidLoadable>(uniqueKey: string, componentId: string, objectClass: LoadableObjectClass<T>, setLocalStateAction: SetLocalStateAction, onDidFirstInitialize?: (dds: T) => void) => void
+ * <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: LoadableObjectClass<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
@@ -56,9 +56,9 @@ export type DisposeSharedStateAction = () => void;
 export type SetLiveStateAction<TState = undefined> = (state: TState | ((prevState: TState) => TState)) => Promise<void>;
 /**
  * Callback for SendLiveEventAction<TEvent>.
- * (event: TEvent) => Promise<void>
+ * (event: TEvent, targetClientId?: string) => Promise<void>
  */
-export type SendLiveEventAction<TEvent> = (event: TEvent) => Promise<ILiveEvent<TEvent>>;
+export type SendLiveEventAction<TEvent> = (event: TEvent, targetClientId?: string) => Promise<ILiveEvent<TEvent>>;
 /**
  * Callback for OnReceivedLiveEventAction<TEvent>.
  * (event: TEvent, local: boolean) => void
@@ -68,7 +68,7 @@ export type OnReceivedLiveEventAction<TEvent> = (event: TEvent, local: boolean)
  * Callback for OnUpdateLivePresenceAction<TData extends object = object>.
  * (data?: TData | undefined, state?: PresenceState | undefined) => Promise<void>
  */
-export type OnUpdateLivePresenceAction<TData extends object = object> = (data?: TData | undefined, state?: PresenceState | undefined) => Promise<void>;
+export type OnUpdateLivePresenceAction<TData extends LivePresenceData = any> = (data: TData) => Promise<void>;
 /**
  * Callback for OnStartTimerAction.
  * (duration: number) => Promise<void>

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/FluidMap.d.ts

@@ -0,0 +1,151 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Like TypeScript's built-in `Iterable` type.
+ *
+ * @privateRemarks
+ * This exists to be unaffected by TypeScript's version and configuration options.
+ *
+ * @sealed @public
+ */
+export interface FluidIterable<T> {
+    /**
+     * Returns an iterator over the elements in this iterable.
+     *
+     * @remarks Works like the built-in {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator | \[Symbol.iterator\]} protocol.
+     */
+    [Symbol.iterator](): FluidIterableIterator<T>;
+}
+/**
+ * Like TypeScript's built-in iterable iterator type.
+ *
+ * @privateRemarks
+ * The done branch uses `any` rather than `undefined` to match TypeScript's built-in IteratorReturnResult, which defaults to any for the same reason.
+ * Using `undefined` causes TypeScript to include it in type inference at call sites like `Array.from` which would infer `T | undefined` instead of `T`.
+ * The done value is rarely meaningful to callers since values are mainly consumed when done is false.
+ * Thus `any` is not particularly harmful here, and the unsafety is worth it as
+ * it interacts better with the existing TypeScript `IteratorResult` interfaces where `TReturn` defaults to any.
+ *
+ * @sealed @public
+ */
+export interface FluidIterableIterator<T> extends FluidIterable<T> {
+    /**
+     * Returns the next element in the iteration sequence.
+     *
+     * @remarks Works like the built-in {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterator_protocol | Iterator.next} method.
+     * When there are remaining elements, returns `\{ value: T; done?: false \}`.
+     * When the iteration is complete, returns `\{ value: any; done: true \}`.
+     */
+    next(): {
+        value: T;
+        done?: false;
+    } | {
+        value: any;
+        done: true;
+    };
+}
+/**
+ * Like TypeScript's built in `ReadonlyMap` type.
+ * Unlike the built in `ReadonlyMap`, this interface includes Symbol.toStringTag.
+ *
+ * @privateRemarks
+ * This exists so that Fluid has a `ReadonlyMap` type which is unaffected by TypeScript's version and configuration options,
+ * and safe to implement without being broken by changes to TypeScript's default ReadonlyMap type.
+ * All behavior exposed through this interface should be compatible with the corresponding behavior of built in ReadonlyMaps,
+ * but it may lack some of the newer APIs,
+ * and might express the type slightly different from how TypeScript does in its `ReadonlyMap` type.
+ *
+ * @sealed @public
+ */
+export interface FluidReadonlyMap<K, V> {
+    /**
+     * Returns an iterable of entries in the map.
+     */
+    [Symbol.iterator](): FluidIterableIterator<[K, V]>;
+    /**
+     * The number of entries in the map.
+     */
+    readonly size: number;
+    /**
+     * Returns an iterable of key, value pairs for every entry in the map.
+     */
+    entries(): FluidIterableIterator<[K, V]>;
+    /**
+     * Executes the provided function once per each key/value pair in the map.
+     */
+    forEach(callbackfn: (value: V, key: K, map: FluidReadonlyMap<K, V>) => void, thisArg?: any): void;
+    /**
+     * Returns the value associated to the specified key, or undefined if there is none.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Returns a boolean indicating whether an element with the specified key exists or not.
+     */
+    has(key: K): boolean;
+    /**
+     * Returns an iterable of keys in the map.
+     */
+    keys(): FluidIterableIterator<K>;
+    /**
+     * Returns an iterable of values in the map.
+     */
+    values(): FluidIterableIterator<V>;
+    /**
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag | Symbol.toStringTag}
+     */
+    readonly [Symbol.toStringTag]: string;
+}
+/**
+ * Like TypeScript's built in `Map` type.
+ *
+ * @privateRemarks
+ * This exists so that Fluid has a `Map` type which is unaffected by TypeScript's version and configuration options,
+ * and safe to implement without being broken by changes to TypeScript's default Map type.
+ * All behavior exposed through this interface should be compatible with the corresponding behavior of JavaScript Maps,
+ * but it may lack some of the newer APIs,
+ * and might express the type slightly different from how TypeScript does in its `Map` type.
+ *
+ * @sealed @public
+ */
+export interface FluidMap<K, V> extends FluidReadonlyMap<K, V> {
+    /**
+     * Removes the specified element from the map by its key.
+     *
+     * @remarks
+     * Unlike the built-in `Map.delete`, this returns `void` instead of a boolean.
+     * This is intentional: in a distributed system, the caller often cannot reliably know
+     * whether the element existed at the time of deletion.
+     * Subtypes may override this to return a boolean if appropriate.
+     */
+    delete(key: K): void;
+    /**
+     * Executes the provided function once per each key/value pair in the map.
+     */
+    forEach(callbackfn: (value: V, key: K, map: FluidMap<K, V>) => void, thisArg?: any): void;
+    /**
+     * Adds a new element with a specified key and value to the map.
+     * If an element with the same key already exists, the element will be updated.
+     */
+    set(key: K, value: V): void;
+}
+//# sourceMappingURL=FluidMap.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FluidMap.d.ts","sourceRoot":"","sources":["../../../src/types/FluidMap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;CACjD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAC9D;;;;;;OAMG;IACH,IAAI,IAAI;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,IAAI,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC;CACnE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,EAAE,CAAC;IAClC;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CACH,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EAEnE,OAAO,CAAC,EAAE,GAAG,GACd,IAAI,CAAC;IAER;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3B;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1D;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CACH,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EAE3D,OAAO,CAAC,EAAE,GAAG,GACd,IAAI,CAAC;IAER;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAC/B"}

package/bin/esm/types/FluidMap.js

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export {};
+//# sourceMappingURL=FluidMap.js.map

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

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

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"}