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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/live-share-react",
-    "version": "2.0.0-internal.12",
+    "version": "2.0.0-internal.14",
     "description": "Build collaborative React apps using Microsoft's Fluid & Live Share frameworks with ease.",
     "author": "Microsoft",
     "license": "SEE LICENSE IN LICENSE",
@@ -32,21 +32,21 @@
     },
     "devDependencies": {
         "@babel/core": "^7.21.8",
-        "@microsoft/live-share": "2.0.0-internal.12",
-        "@microsoft/live-share-canvas": "2.0.0-internal.12",
-        "@microsoft/live-share-media": "2.0.0-internal.12",
+        "@microsoft/live-share": "2.0.0-internal.14",
+        "@microsoft/live-share-canvas": "2.0.0-internal.14",
+        "@microsoft/live-share-media": "2.0.0-internal.14",
         "@types/react": "^18.0.0",
         "@types/react-dom": "^18.0.0",
         "@types/uuid": "^9.0.1",
         "babel-loader": "^9.1.2",
-        "fluid-framework": ">=2.40 <2.70",
+        "fluid-framework": ">=2.40 <2.90",
         "typescript": "~5.5.3"
     },
     "peerDependencies": {
-        "@microsoft/live-share": "2.0.0-internal.12",
-        "@microsoft/live-share-canvas": "2.0.0-internal.12",
-        "@microsoft/live-share-media": "2.0.0-internal.12",
-        "fluid-framework": ">=2.40 <2.70",
+        "@microsoft/live-share": "2.0.0-internal.14",
+        "@microsoft/live-share-canvas": "2.0.0-internal.14",
+        "@microsoft/live-share-media": "2.0.0-internal.14",
+        "fluid-framework": ">=2.40 <2.90",
         "react": "^16.8.0 || ^17 || ^18",
         "react-dom": "^16.8.0 || ^17 || ^18"
     },

package/bin/index.d.ts

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

package/bin/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/bin/index.js

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

package/bin/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/bin/interfaces/LiveInterfaceExtensions.d.ts

@@ -1,26 +0,0 @@
-/*!
- * 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/interfaces/LiveInterfaceExtensions.d.ts.map

@@ -1 +0,0 @@
-{"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/interfaces/LiveInterfaceExtensions.js

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

package/bin/interfaces/LiveInterfaceExtensions.js.map

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

package/bin/interfaces/index.d.ts

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

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

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

package/bin/interfaces/index.js

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

package/bin/interfaces/index.js.map

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

package/bin/internal/errors.d.ts

@@ -1,41 +0,0 @@
-/**
- * @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/internal/errors.d.ts.map

@@ -1 +0,0 @@
-{"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/internal/errors.js

@@ -1,42 +0,0 @@
-/**
- * @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/internal/errors.js.map

@@ -1 +0,0 @@
-{"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/internal/index.d.ts

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

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

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

package/bin/internal/index.js

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

package/bin/internal/index.js.map

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

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

@@ -1,11 +0,0 @@
-import { ITeamsJsSdkError } from "./errors";
-/**
- * @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/internal/type-guards.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../src/internal/type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;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/internal/type-guards.js

@@ -1,20 +0,0 @@
-/**
- * @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/internal/type-guards.js.map

@@ -1 +0,0 @@
-{"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/live-hooks/index.d.ts

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/bin/live-hooks/index.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/live-hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

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

@@ -1,29 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { CanvasReferencePoint, IBrush, InkingTool, IPoint } from "@microsoft/live-share-canvas";
-import React from "react";
-import { IUseLiveCanvasResults } from "../types";
-/**
- * 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 active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
- * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
- */
-export declare function useLiveCanvas(uniqueKey: string, canvasElementRef: React.RefObject<HTMLElement | null> | string, active?: boolean, tool?: InkingTool, lineBrush?: IBrush, offset?: IPoint, scale?: number, referencePoint?: CanvasReferencePoint, isCursorShared?: boolean, localUserPictureUrl?: string): IUseLiveCanvasResults;
-//# sourceMappingURL=useLiveCanvas.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveCanvas.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,MAAM,EAEN,UAAU,EACV,MAAM,EAET,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,MAAM,EAC9D,MAAM,CAAC,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE,UAAU,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,oBAAoB,EACrC,cAAc,CAAC,EAAE,OAAO,EACxB,mBAAmB,CAAC,EAAE,MAAM,GAC7B,qBAAqB,CA6IvB"}

package/bin/live-hooks/useLiveCanvas.js

@@ -1,160 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { InkingManager, LiveCanvas, } from "@microsoft/live-share-canvas";
-import React from "react";
-import { useDynamicDDS } from "../shared-hooks";
-import { isRefObject } from "../utils";
-/**
- * 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 active Optional. Stateful boolean that will activate/de-activate `InkingManager` accordingly.
- * @param tool Optional. Stateful enum for what tool to use in the `InkingManager`.
- * @param lineBrush Optional. Stateful lineBrush object for the selected lineBrush options to use in `InkingManager`.
- * @param offset Optional. Stateful offset point to use in the `InkingManager`. Gets the viewport offset. Defaults to 0,0.
- * @param scale Optional. Stateful scale number to use in the `InkingManager`. Defaults to 1 and must be greater than 0.
- * @param referencePoint Optional. Stateful reference point enum to use in the `InkingManger`. Defaults to "center".
- * @param isCursorShared Optional. Stateful boolean flag for whether cursor should be shared in `LiveCanvas`. Defaults to false.
- * @param localUserPictureUrl Optional. url string for the local user to display alongside their cursor. Defaults to undefined.
- * @returns IUseLiveCanvasResults object that contains the `liveCanvas` data object and `inkingManager`.
- */
-export function useLiveCanvas(uniqueKey, canvasElementRef, active, tool, lineBrush, offset, scale, referencePoint, isCursorShared, localUserPictureUrl) {
-    /**
-     * User facing: inking manager instance
-     */
-    const [inkingManager, setInkingManager] = React.useState();
-    /**
-     * User facing: dynamically load the DDS for the given unique key.
-     */
-    const { dds: liveCanvas } = useDynamicDDS(uniqueKey, LiveCanvas);
-    /**
-     * Setup the InkingManager and LiveCanvas
-     */
-    React.useEffect(() => {
-        // if the component is already listening or liveCanvas is not yet initialized, return
-        if (!liveCanvas)
-            return;
-        // get the canvas element from the ref or document
-        let htmlElement;
-        if (isRefObject(canvasElementRef)) {
-            htmlElement = canvasElementRef.current;
-        }
-        else {
-            htmlElement = document.getElementById(canvasElementRef);
-        }
-        if (htmlElement === null)
-            return;
-        // Create the InkingManager and initialize the liveCanvas with it
-        const inkingManager = new InkingManager(htmlElement);
-        setInkingManager(inkingManager);
-        liveCanvas.initialize(inkingManager);
-        // cleanup function to be called when the component is unmount
-        return () => {
-            liveCanvas.dispose();
-            inkingManager.removeAllListeners();
-        };
-    }, [liveCanvas]);
-    /**
-     * Activate or deactivate the inkingManager based on the 'active' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && active !== undefined) {
-            if (active) {
-                inkingManager.activate();
-            }
-            else {
-                inkingManager.deactivate();
-            }
-        }
-    }, [active, inkingManager]);
-    /**
-     * Sets the tool of the inkingManager based on the 'tool' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && tool !== undefined) {
-            inkingManager.tool = tool;
-        }
-    }, [tool, inkingManager]);
-    /**
-     * Sets the offset of the inkingManager based on the 'offset' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && offset !== undefined) {
-            inkingManager.offset = {
-                x: offset.x,
-                y: offset.y,
-            };
-        }
-    }, [offset === null || offset === void 0 ? void 0 : offset.x, offset === null || offset === void 0 ? void 0 : offset.y, inkingManager]);
-    /**
-     * Sets the scale of the inkingManager based on the 'scale' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && scale !== undefined) {
-            inkingManager.scale = scale;
-        }
-    }, [scale, inkingManager]);
-    /**
-     * Sets the referencePoint of the inkingManager based on the 'referencePoint' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && referencePoint !== undefined) {
-            inkingManager.referencePoint = referencePoint;
-        }
-    }, [referencePoint, inkingManager]);
-    /**
-     * Sets the lineBrush of the inkingManager based on the 'lineBrush' prop
-     */
-    React.useEffect(() => {
-        if (inkingManager && lineBrush) {
-            inkingManager.lineBrush = {
-                color: lineBrush.color,
-                tip: lineBrush.tip,
-                tipSize: lineBrush.tipSize,
-                type: lineBrush.type,
-                endArrow: lineBrush.endArrow,
-            };
-        }
-    }, [
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.color,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tip,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.tipSize,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.type,
-        lineBrush === null || lineBrush === void 0 ? void 0 : lineBrush.endArrow,
-        inkingManager,
-    ]);
-    /**
-     * Sets the isCursorShared of the liveCanvas based on the 'isCursorShared' prop
-     */
-    React.useEffect(() => {
-        if (liveCanvas && isCursorShared !== undefined) {
-            liveCanvas.isCursorShared = isCursorShared;
-        }
-    }, [isCursorShared, liveCanvas]);
-    /**
-     * Sets the onGetLocalUserInfo method of the liveCanvas based on the 'localUserCursor' prop
-     */
-    React.useEffect(() => {
-        if (liveCanvas && localUserPictureUrl) {
-            liveCanvas.onGetLocalUserPictureUrl = () => {
-                return localUserPictureUrl;
-            };
-        }
-    }, [localUserPictureUrl, liveCanvas]);
-    /**
-     * Return hook response
-     */
-    return {
-        inkingManager,
-        liveCanvas,
-    };
-}
-//# sourceMappingURL=useLiveCanvas.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveCanvas.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveCanvas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,aAAa,EAGb,UAAU,GACb,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,aAAa,CACzB,SAAiB,EACjB,gBAA8D,EAC9D,MAAgB,EAChB,IAAiB,EACjB,SAAkB,EAClB,MAAe,EACf,KAAc,EACd,cAAqC,EACrC,cAAwB,EACxB,mBAA4B;IAE5B;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAiB,CAAC;IAE1E;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,aAAa,CACrC,SAAS,EACT,UAAU,CACb,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,qFAAqF;QACrF,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,kDAAkD;QAClD,IAAI,WAA+B,CAAC;QACpC,IAAI,WAAW,CAAC,gBAAgB,CAAC,EAAE;YAC/B,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC;SAC1C;aAAM;YACH,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,KAAK,IAAI;YAAE,OAAO;QACjC,iEAAiE;QACjE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;QACrD,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAChC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAErC,8DAA8D;QAC9D,OAAO,GAAG,EAAE;YACR,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,aAAa,CAAC,kBAAkB,EAAE,CAAC;QACvC,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,IAAI,MAAM,EAAE;gBACR,aAAa,CAAC,QAAQ,EAAE,CAAC;aAC5B;iBAAM;gBACH,aAAa,CAAC,UAAU,EAAE,CAAC;aAC9B;SACJ;IACL,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,IAAI,KAAK,SAAS,EAAE;YACrC,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;SAC7B;IACL,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,MAAM,KAAK,SAAS,EAAE;YACvC,aAAa,CAAC,MAAM,GAAG;gBACnB,CAAC,EAAE,MAAM,CAAC,CAAC;gBACX,CAAC,EAAE,MAAM,CAAC,CAAC;aACd,CAAC;SACL;IACL,CAAC,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,KAAK,KAAK,SAAS,EAAE;YACtC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;SAC/B;IACL,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,cAAc,KAAK,SAAS,EAAE;YAC/C,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;SACjD;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,aAAa,IAAI,SAAS,EAAE;YAC5B,aAAa,CAAC,SAAS,GAAG;gBACtB,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC/B,CAAC;SACL;IACL,CAAC,EAAE;QACC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK;QAChB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG;QACd,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO;QAClB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI;QACf,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ;QACnB,aAAa;KAChB,CAAC,CAAC;IAEH;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,cAAc,KAAK,SAAS,EAAE;YAC5C,UAAU,CAAC,cAAc,GAAG,cAAc,CAAC;SAC9C;IACL,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,UAAU,IAAI,mBAAmB,EAAE;YACnC,UAAU,CAAC,wBAAwB,GAAG,GAAuB,EAAE;gBAC3D,OAAO,mBAAmB,CAAC;YAC/B,CAAC,CAAC;SACL;IACL,CAAC,EAAE,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO;QACH,aAAa;QACb,UAAU;KACb,CAAC;AACN,CAAC"}

package/bin/live-hooks/useLiveEvent.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { UserMeetingRole } from "@microsoft/live-share";
-import { IUseLiveEventResults, OnReceivedLiveEventAction } from "../types";
-/**
- * React hook for using a Live Share `LiveEvent`.
- *
- * @remarks
- * Use this hook if you want to send transient JSON objects to everyone connected to the Fluid container,
- * such as when sending push notifications or reactions.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @template TEvent Optional typing for events sent & received. Default is `object` type.
- * @param uniqueKey the unique key for the `LiveEvent`. If one does not yet exist, a new one
- * will be created, otherwise it will use the existing one.
- * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
- * @param onReceivedEvent Optional. Callback method to be called when a new notification is received.
- * @returns stateful `latestEvent` & `allEvents` list, `sendEvent` callback, and the `liveEvent` object.
- */
-export declare function useLiveEvent<TEvent = any>(uniqueKey: string, allowedRoles?: UserMeetingRole[], onReceivedEvent?: OnReceivedLiveEventAction<TEvent>): IUseLiveEventResults<TEvent>;
-//# sourceMappingURL=useLiveEvent.d.ts.map

package/bin/live-hooks/useLiveEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useLiveEvent.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAGlB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAE5B,MAAM,UAAU,CAAC;AAUlB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAG,GAAG,EACrC,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,eAAe,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,GACpD,oBAAoB,CAAC,MAAM,CAAC,CAoG9B"}

package/bin/live-hooks/useLiveEvent.js

@@ -1,108 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { LiveEventEvents, LiveEvent, LiveDataObjectInitializeState, } from "@microsoft/live-share";
-import React from "react";
-import { useDynamicDDS } from "../shared-hooks";
-import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
-import { useFluidObjectsContext } from "../providers";
-/**
- * React hook for using a Live Share `LiveEvent`.
- *
- * @remarks
- * Use this hook if you want to send transient JSON objects to everyone connected to the Fluid container,
- * such as when sending push notifications or reactions.
- * This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
- *
- * @template TEvent Optional typing for events sent & received. Default is `object` type.
- * @param uniqueKey the unique key for the `LiveEvent`. If one does not yet exist, a new one
- * will be created, otherwise it will use the existing one.
- * @param allowedRoles Optional. The meeting roles eligible to send events through this object.
- * @param onReceivedEvent Optional. Callback method to be called when a new notification is received.
- * @returns stateful `latestEvent` & `allEvents` list, `sendEvent` callback, and the `liveEvent` object.
- */
-export function useLiveEvent(uniqueKey, allowedRoles, onReceivedEvent) {
-    /**
-     * Stateful latest event (user facing) and its non-user-facing setter method.
-     */
-    const [latestEvent, setLatestReceived] = React.useState();
-    /**
-     * Reference for all received/sent events. The current value of this is user-facing. Because
-     * this is always set at the same time as latestEvent, it is effectively a stateful value.
-     */
-    const allEventsRef = React.useRef([]);
-    /**
-     * User facing: dynamically load the DDS for the given unique key.
-     */
-    const { dds: liveEvent } = useDynamicDDS(uniqueKey, (LiveEvent));
-    const { container } = useFluidObjectsContext();
-    /**
-     * User facing: callback to send event through `LiveEvent`
-     */
-    const sendEvent = React.useCallback((event) => __awaiter(this, void 0, void 0, function* () {
-        if (!container) {
-            throw new ActionContainerNotJoinedError("liveEvent", "sendEvent");
-        }
-        if (liveEvent === undefined) {
-            throw new ActionLiveDataObjectUndefinedError("liveEvent", "sendEvent");
-        }
-        if (!liveEvent.isInitialized) {
-            throw new ActionLiveDataObjectInitializedError("liveEvent", "sendEvent");
-        }
-        return yield liveEvent.send(event);
-    }), [container, liveEvent]);
-    /**
-     * Setup change listeners and start `LiveEvent` if needed
-     */
-    React.useEffect(() => {
-        if ((liveEvent === null || liveEvent === void 0 ? void 0 : liveEvent.isInitialized) === undefined)
-            return;
-        // Register event listener
-        const onEventReceived = (event, local, clientId, timestamp) => {
-            // If developer passed the optional onReceivedEvent callback, we
-            // call it.
-            onReceivedEvent === null || onReceivedEvent === void 0 ? void 0 : onReceivedEvent(event, local);
-            // Set the received event to our local state
-            const received = {
-                value: event,
-                local,
-                clientId,
-                timestamp,
-            };
-            allEventsRef.current = [...allEventsRef.current, received];
-            setLatestReceived(received);
-        };
-        // Reset the events list if it allEventRef.current is non-empty.
-        // This happens when the `id` a developer provides changes on the fly.
-        if (allEventsRef.current.length > 0) {
-            allEventsRef.current = [];
-            setLatestReceived(undefined);
-        }
-        liveEvent.on(LiveEventEvents.received, onEventReceived);
-        if (liveEvent.initializeState === LiveDataObjectInitializeState.needed) {
-            // Start live event
-            liveEvent.initialize(allowedRoles);
-        }
-        return () => {
-            // on unmount, remove event listeners
-            liveEvent === null || liveEvent === void 0 ? void 0 : liveEvent.off(LiveEventEvents.received, onEventReceived);
-        };
-    }, [liveEvent]);
-    return {
-        latestEvent,
-        allEvents: allEventsRef.current,
-        sendEvent,
-        liveEvent,
-    };
-}
-//# sourceMappingURL=useLiveEvent.js.map