@microsoft/live-share-react 1.4.0-preview.0 → 1.4.1-preview.0

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

@@ -0,0 +1,62 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRefObject = isRefObject;
+exports.isMediaElement = isMediaElement;
+exports.isExtendedMediaMetadata = isExtendedMediaMetadata;
+exports.isMap = isMap;
+exports.isEntries = isEntries;
+exports.isJSON = isJSON;
+function isRefObject(value) {
+    return value.current === null || !!value.current;
+}
+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;
+}
+function isExtendedMediaMetadata(value) {
+    return value === null || !!(value === null || value === void 0 ? void 0 : value.trackIdentifier);
+}
+function isMap(value) {
+    return value instanceof Map;
+}
+function isEntries(value) {
+    try {
+        const tryValue = value;
+        if (typeof tryValue[0][0] === "string") {
+            return true;
+        }
+        return false;
+    }
+    catch (error) {
+        return false;
+    }
+}
+function isJSON(value) {
+    try {
+        const tryValue = value;
+        return Object.keys(tryValue).length > 0;
+    }
+    catch (error) {
+        return false;
+    }
+}
+//# sourceMappingURL=type-check.js.map

package/bin/cjs/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,kCAEC;AAED,wCAoBC;AAED,0DAIC;AAED,sBAEC;AAED,8BAYC;AAED,wBAOC;AAzDD,SAAgB,WAAW,CAAI,KAAU;IACrC,OAAO,KAAK,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;AACrD,CAAC;AAED,SAAgB,cAAc,CAAC,KAAU;IACrC,IAAI,KAAK,EAAE,CAAC;QACR,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;IACN,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAgB,uBAAuB,CACnC,KAAU;IAEV,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,CAAA,CAAC;AACtD,CAAC;AAED,SAAgB,KAAK,CAAC,KAAU;IAC5B,OAAO,KAAK,YAAY,GAAG,CAAC;AAChC,CAAC;AAED,SAAgB,SAAS,CACrB,KAAU;IAEV,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,KAAyC,CAAC;QAC3D,IAAI,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,SAAgB,MAAM,CAAC,KAAU;IAC7B,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,KAA+B,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC"}

package/bin/esm/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./providers/index.js";
+export * from "./shared-hooks/index.js";
+export * from "./live-hooks/index.js";
+export * from "./types/index.js";
+export * from "./providers/index.js";
+export * from "./interfaces/index.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC"}

package/bin/esm/index.js

@@ -0,0 +1,7 @@
+export * from "./providers/index.js";
+export * from "./shared-hooks/index.js";
+export * from "./live-hooks/index.js";
+export * from "./types/index.js";
+export * from "./providers/index.js";
+export * from "./interfaces/index.js";
+//# sourceMappingURL=index.js.map

package/bin/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC"}

package/bin/esm/interfaces/LiveInterfaceExtensions.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+/**
+ * Object response for a received event
+ */
+export interface IReceiveLiveEvent<TEvent = any> {
+    /**
+     * The value of the event that was sent
+     */
+    value: TEvent;
+    /**
+     * True if the local client was the one to send this event
+     */
+    local: boolean;
+    /**
+     * Client ID of the user that sent the event
+     */
+    clientId: string;
+    /**
+     * Server timestamp at which the event was sent
+     */
+    timestamp: number;
+}
+//# sourceMappingURL=LiveInterfaceExtensions.d.ts.map

package/bin/esm/interfaces/LiveInterfaceExtensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveInterfaceExtensions.d.ts","sourceRoot":"","sources":["../../../src/interfaces/LiveInterfaceExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,GAAG;IAC3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB"}

package/bin/esm/interfaces/LiveInterfaceExtensions.js

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

package/bin/esm/interfaces/LiveInterfaceExtensions.js.map

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

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

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

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

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

package/bin/esm/interfaces/index.js

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

package/bin/esm/interfaces/index.js.map

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

package/bin/esm/internal/errors.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @hidden
+ */
+declare class UseLiveDataObjectActionError extends Error {
+    constructor(ddsName: string, functionName: string, message: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+/**
+ * @hidden
+ */
+export declare class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
+    constructor(ddsName: string, functionName: string);
+}
+/**
+ * @hidden
+ */
+export interface ITeamsJsSdkError {
+    /**
+     * error code
+     */
+    errorCode: number;
+    /**
+     * Optional description for the error. This may contain useful information for web-app developers.
+     * This string will not be localized and is not for end-user consumption.
+     * App should not depend on the string content. The exact value may change. This is only for debugging purposes.
+     */
+    message?: string;
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/bin/esm/internal/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,4BAA6B,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAIrE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,4BAA4B;gBAC/D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAOpD;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,4BAA4B;gBACpE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAQpD;AAED;;GAEG;AACH,qBAAa,oCAAqC,SAAQ,4BAA4B;gBACtE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAQpD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/bin/esm/internal/errors.js

@@ -0,0 +1,42 @@
+/**
+ * @hidden
+ */
+class UseLiveDataObjectActionError extends Error {
+    constructor(ddsName, functionName, message) {
+        const hookName = `use${toFirstLetterUppercase(ddsName)}`;
+        super(`${hookName} ${functionName}: ${message}`);
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionContainerNotJoinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        super(ddsName, functionName, "container has not yet been joined.\nTo fix this error, ensure `container` from `useFluidObjectsContext()` is defined before calling this function.\nIf using `<LiveShareProvider>`, you can instead check the `joined` response is true from `useLiveShareContext()` before calling this function.");
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionLiveDataObjectUndefinedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        const hookName = `use${toFirstLetterUppercase(ddsName)}`;
+        super(ddsName, functionName, `${ddsName} is undefined, which means it is still being dynamically created.\nTo fix this error, ensure that \`${ddsName}\` (found in the response of \`${hookName}\`) is defined before calling this function.`);
+    }
+}
+/**
+ * @hidden
+ */
+export class ActionLiveDataObjectInitializedError extends UseLiveDataObjectActionError {
+    constructor(ddsName, functionName) {
+        const hookName = `use${toFirstLetterUppercase(ddsName)}`;
+        super(ddsName, functionName, `${ddsName} is not yet initialized.\nTo fix this error, ensure that \`${ddsName}?.isInitialized\` is true (found in the response of \`${hookName}\`) before calling this function.`);
+    }
+}
+/**
+ * @hidden
+ */
+function toFirstLetterUppercase(word) {
+    return word[0].toUpperCase() + word.substring(1);
+}
+//# sourceMappingURL=errors.js.map

package/bin/esm/internal/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/internal/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,4BAA6B,SAAQ,KAAK;IAC5C,YAAY,OAAe,EAAE,YAAoB,EAAE,OAAe;QAC9D,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CAAC,GAAG,QAAQ,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,4BAA4B;IAC3E,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CACD,OAAO,EACP,YAAY,EACZ,oSAAoS,CACvS,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,kCAAmC,SAAQ,4BAA4B;IAChF,YAAY,OAAe,EAAE,YAAoB;QAC7C,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,uGAAuG,OAAO,kCAAkC,QAAQ,8CAA8C,CACnN,CAAC;IACN,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,4BAA4B;IAClF,YAAY,OAAe,EAAE,YAAoB;QAC7C,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,KAAK,CACD,OAAO,EACP,YAAY,EACZ,GAAG,OAAO,8DAA8D,OAAO,yDAAyD,QAAQ,mCAAmC,CACtL,CAAC;IACN,CAAC;CACJ;AAkBD;;GAEG;AACH,SAAS,sBAAsB,CAAC,IAAY;IACxC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC"}

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

@@ -0,0 +1,3 @@
+export * from "./errors.js";
+export * from "./type-guards.js";
+//# sourceMappingURL=index.d.ts.map

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

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

package/bin/esm/internal/index.js

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

package/bin/esm/internal/index.js.map

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

package/bin/esm/internal/type-guards.d.ts

@@ -0,0 +1,11 @@
+import { ITeamsJsSdkError } from "./errors.js";
+/**
+ * @hidden
+ * Used for useLiveState and useSharedState for checking if a value is a prevState callback
+ */
+export declare function isPrevStateCallback<TState>(value: any): value is (value: TState) => TState;
+/**
+ * @hidden
+ */
+export declare function isITeamsJsSdkError(value: any): value is ITeamsJsSdkError;
+//# sourceMappingURL=type-guards.d.ts.map

package/bin/esm/internal/type-guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EACtC,KAAK,EAAE,GAAG,GACX,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAEpC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,gBAAgB,CAKxE"}

package/bin/esm/internal/type-guards.js

@@ -0,0 +1,20 @@
+/**
+ * @hidden
+ * Used for useLiveState and useSharedState for checking if a value is a prevState callback
+ */
+export function isPrevStateCallback(value) {
+    return typeof value === "function";
+}
+/**
+ * @hidden
+ */
+export function isITeamsJsSdkError(value) {
+    if (!value)
+        return false;
+    if (typeof value.errorCode !== "number")
+        return false;
+    if (value.message === undefined)
+        return true;
+    return typeof value.message === "string";
+}
+//# sourceMappingURL=type-guards.js.map

package/bin/esm/internal/type-guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../../src/internal/type-guards.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAC/B,KAAU;IAEV,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAU;IACzC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC7C,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC;AAC7C,CAAC"}

package/bin/esm/live-hooks/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./useLivePresence.js";
+export * from "./useLiveFollowMode.js";
+export * from "./useLiveState.js";
+export * from "./useMediaSynchronizer.js";
+export * from "./useLiveEvent.js";
+export * from "./useLiveCanvas.js";
+export * from "./useLiveTimer.js";
+//# sourceMappingURL=index.d.ts.map

package/bin/esm/live-hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}

package/bin/esm/live-hooks/index.js

@@ -0,0 +1,8 @@
+export * from "./useLivePresence.js";
+export * from "./useLiveFollowMode.js";
+export * from "./useLiveState.js";
+export * from "./useMediaSynchronizer.js";
+export * from "./useLiveEvent.js";
+export * from "./useLiveCanvas.js";
+export * from "./useLiveTimer.js";
+//# sourceMappingURL=index.js.map

package/bin/esm/live-hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}

package/bin/esm/live-hooks/useLiveCanvas.d.ts

@@ -0,0 +1,80 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import React from "react";
+import { IUseLiveCanvasOptionalProps, IUseLiveCanvasResults } from "../types/index.js";
+/**
+ * React hook for using a Live Share Canvas `LiveCanvas` and `InkingManager`.
+ *
+ * @remarks
+ * Use this hook to set up an `LiveCanvas` object, which is used for collaborative inking. It takes several input parameters, including a unique key,
+ * a reference to a canvas element, and various settings for the inking tool, brush, and canvas offset and scale.
+ * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
+ *
+ * @param uniqueKey the unique key for the `LiveCanvas`. If one does not yet exist, a new one.
+ * @param canvasElementRef the HTML div element ref or document ID that `InkingManager` will use for canvas-based collaboration.
+ * @param props Optional. Other optional props.
+ * @param props.active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
+ * @param props.tool Optional. Stateful enum for what tool to use in the `InkingManager`.
+ * @param props.lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
+ * @param props.offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
+ * @param props.scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
+ * @param props.referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
+ * @param props.isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
+ * @param props.localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
+ * @param props.node 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.
+ * @param allowedRoles Optional. The user roles that are allowed to start/stop/pause the timer.
+ *
+ * @returns `IUseLiveCanvasResults` object that contains the `liveCanvas` data object and `inkingManager`.
+ *
+ * @example
+ ```jsx
+import { useLiveCanvas } from "@microsoft/live-share-react";
+import { InkingTool } from "@microsoft/live-share-canvas";
+import { useRef } from "react";
+
+// Unique identifier that distinguishes this useLiveCanvas from others in your app
+const UNIQUE_KEY = "CUSTOM-LIVE-CANVAS";
+
+// Example component
+export function ExampleLiveCanvas() {
+    const liveCanvasRef = useRef(null);
+    const { liveCanvas, inkingManager } = useLiveCanvas(
+        "CUSTOM-LIVE-CANVAS",
+        liveCanvasRef,
+    );
+
+    return (
+        <div style={{ position: "absolute"}}>
+            <div
+                ref={liveCanvasRef}
+                // Best practice is to not define inline styles
+                style={{ width: "556px", height: "224px" }}
+            />
+            {!!liveCanvas && (
+                <div>
+                    <button
+                        onClick={() => {
+                            inkingManager.tool = InkingTool.pen;
+                        }}
+                    >
+                        {"Pen"}
+                    </button>
+                    <button
+                        onClick={() => {
+                            inkingManager.tool = InkingTool.laserPointer;
+                        }}
+                    >
+                        {"Laser pointer"}
+                    </button>
+                </div>
+            )}
+        </div>
+    );
+};
+ ```
+ */
+export declare function useLiveCanvas(uniqueKey: string, canvasElementRef: React.RefObject<HTMLElement | null> | string, props?: IUseLiveCanvasOptionalProps): IUseLiveCanvasResults;
+//# sourceMappingURL=useLiveCanvas.d.ts.map

package/bin/esm/live-hooks/useLiveCanvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLiveCanvas.d.ts","sourceRoot":"","sources":["../../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EACH,2BAA2B,EAC3B,qBAAqB,EACxB,MAAM,mBAAmB,CAAC;AAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,MAAM,EAC9D,KAAK,CAAC,EAAE,2BAA2B,GACpC,qBAAqB,CA0KvB"}