@microsoft/live-share-react 1.4.0-preview.0 → 2.0.0-internal.10

package/README.md

@@ -14,32 +14,29 @@ import { LiveShareHost } from "@microsoft/teams-js";
 const host = LiveShareHost.create();
 
 export function LiveShareApp() {
-  // Call app.initialize() from teams-js before rendering LiveShareProvider
+    // Call app.initialize() from teams-js before rendering LiveShareProvider
 
-  return (
-    <LiveShareProvider
-      joinOnLoad={true}
-      host={host}
-    >
-      <SharedCheckbox />
-    </LiveShareProvider>
-  );
+    return (
+        <LiveShareProvider joinOnLoad={true} host={host}>
+            <SharedCheckbox />
+        </LiveShareProvider>
+    );
 }
 
 // SharedCheckbox.jsx
 import { useSharedState } from "@microsoft/live-share-react";
 
 export function SharedCheckbox() {
-  const [checked, setChecked] = useSharedState("MY-UNIQUE-ID", false);
-  return (
-    <input
-      type="checkbox"
-      checked={checked}
-      onChange={() => {
-        setChecked(!checked);
-      }}
-    />
-  );
+    const [checked, setChecked] = useSharedState("MY-UNIQUE-ID", false);
+    return (
+        <input
+            type="checkbox"
+            checked={checked}
+            onChange={() => {
+                setChecked(!checked);
+            }}
+        />
+    );
 }
 ```
 
@@ -102,31 +99,31 @@ The following example shows how `useSharedState` can be used to dynamically crea
 import { useSharedState } from "@microsoft/live-share-react";
 
 export function CounterCard({ card, onDelete }) {
-  const [count, setCount, disposeCount] = useSharedState(
-    `card-count:${card.id}`,
-    0
-  );
-  return (
-    <div className="card">
-      <h3>{card.title}</h3>
-      <button
-        onClick={() => {
-          setCount(count + 1);
-        }}
-      >
-        {"+1"}
-      </button>
-      <span>{`${count} `}</span>
-      <button
-        onClick={() => {
-          onDelete(card.id);
-          disposeCount();
-        }}
-      >
-        {"Delete"}
-      </button>
-    </div>
-  );
+    const [count, setCount, disposeCount] = useSharedState(
+        `card-count:${card.id}`,
+        0
+    );
+    return (
+        <div className="card">
+            <h3>{card.title}</h3>
+            <button
+                onClick={() => {
+                    setCount(count + 1);
+                }}
+            >
+                {"+1"}
+            </button>
+            <span>{`${count} `}</span>
+            <button
+                onClick={() => {
+                    onDelete(card.id);
+                    disposeCount();
+                }}
+            >
+                {"Delete"}
+            </button>
+        </div>
+    );
 }
 ```
 
@@ -143,32 +140,32 @@ import { useSharedMap } from "@microsoft/live-share-react";
 import { v4 as uuid } from "uuid";
 
 export function CardList() {
-  const { map, setEntry, deleteEntry } = useSharedMap("CUSTOM-MAP-ID");
-  return (
-    <div>
-      <h2>{"Cards"}</h2>
-      <button
-        onClick={() => {
-          const id = uuid();
-          setEntry(id, {
-            id,
-            title: "Custom Card",
-          });
-        }}
-      >
-        {"+ Add card"}
-      </button>
-      <div className="flex wrap row hAlign">
-        {[...map.values()].map((cardValue) => (
-          <CounterCard
-            key={cardValue.id}
-            card={cardValue}
-            onDelete={deleteEntry}
-          />
-        ))}
-      </div>
-    </div>
-  );
+    const { map, setEntry, deleteEntry } = useSharedMap("CUSTOM-MAP-ID");
+    return (
+        <div>
+            <h2>{"Cards"}</h2>
+            <button
+                onClick={() => {
+                    const id = uuid();
+                    setEntry(id, {
+                        id,
+                        title: "Custom Card",
+                    });
+                }}
+            >
+                {"+ Add card"}
+            </button>
+            <div className="flex wrap row hAlign">
+                {[...map.values()].map((cardValue) => (
+                    <CounterCard
+                        key={cardValue.id}
+                        card={cardValue}
+                        onDelete={deleteEntry}
+                    />
+                ))}
+            </div>
+        </div>
+    );
 }
 ```
 
@@ -270,34 +267,34 @@ Here is a simple example:
 import { useLiveEvent } from "@microsoft/live-share-react";
 
 export function Reactions() {
-  const { latestEvent, sendEvent } = useLiveEvent("EVENT-ID");
+    const { latestEvent, sendEvent } = useLiveEvent("EVENT-ID");
 
-  return (
-    <div>
-      {/* Buttons for sending reactions */}
-      <button
-        onClick={() => {
-          sendEvent({ emoji: "❤️" });
-        }}
-      >
-        {"❤️"}
-      </button>
-      <button
-        onClick={() => {
-          sendEvent({ emoji: "😂" });
-        }}
-      >
-        {"😂"}
-      </button>
-      {/* Show latest reaction */}
-      {latestEvent?.local === false && (
-        <div>{`Received: ${latestEvent?.value.emoji}`}</div>
-      )}
-      {latestEvent?.local === true && (
-        <div>{`Sent: ${latestEvent?.value.emoji}`}</div>
-      )}
-    </div>
-  );
+    return (
+        <div>
+            {/* Buttons for sending reactions */}
+            <button
+                onClick={() => {
+                    sendEvent({ emoji: "❤️" });
+                }}
+            >
+                {"❤️"}
+            </button>
+            <button
+                onClick={() => {
+                    sendEvent({ emoji: "😂" });
+                }}
+            >
+                {"😂"}
+            </button>
+            {/* Show latest reaction */}
+            {latestEvent?.local === false && (
+                <div>{`Received: ${latestEvent?.value.emoji}`}</div>
+            )}
+            {latestEvent?.local === true && (
+                <div>{`Sent: ${latestEvent?.value.emoji}`}</div>
+            )}
+        </div>
+    );
 }
 ```
 
@@ -311,37 +308,38 @@ Here is a simple example:
 import { useLiveTimer } from "@microsoft/live-share-react";
 
 export function CountdownTimer() {
-  const { milliRemaining, timerConfig, start, pause, play } = useLiveTimer("TIMER-ID");
+    const { milliRemaining, timerConfig, start, pause, play } =
+        useLiveTimer("TIMER-ID");
 
-  return (
-    <div>
-      <button
-        onClick={() => {
-          start(60 * 1000);
-        }}
-      >
-        { timerConfig === undefined ? "Start" : "Reset" }
-      </button>
-      { timerConfig !== undefined && (
-        <button
-          onClick={() => {
-            if (timerConfig.running) {
-              pause();
-            } else {
-              play();
-            }
-          }}
-        >
-          {timerConfig.running ? "Pause" : "Play" }
-        </button>
-      )}
-      { milliRemaining !== undefined && (
-        <p>
-          { `${Math.round(milliRemaining / 1000)} / ${Math.round(timerConfig.duration) / 1000}` }
-        </p>
-      )}
-    </div>
-  );
+    return (
+        <div>
+            <button
+                onClick={() => {
+                    start(60 * 1000);
+                }}
+            >
+                {timerConfig === undefined ? "Start" : "Reset"}
+            </button>
+            {timerConfig !== undefined && (
+                <button
+                    onClick={() => {
+                        if (timerConfig.running) {
+                            pause();
+                        } else {
+                            play();
+                        }
+                    }}
+                >
+                    {timerConfig.running ? "Pause" : "Play"}
+                </button>
+            )}
+            {milliRemaining !== undefined && (
+                <p>
+                    {`${Math.round(milliRemaining / 1000)} / ${Math.round(timerConfig.duration) / 1000}`}
+                </p>
+            )}
+        </div>
+    );
 }
 ```
 
@@ -359,24 +357,24 @@ import { useRef } from "react";
 const ALLOWED_ROLES = [UserMeetingRole.organizer, UserMeetingRole.presenter];
 
 const INITIAL_TRACK =
-  "https://storage.googleapis.com/media-session/big-buck-bunny/trailer.mov";
+    "https://storage.googleapis.com/media-session/big-buck-bunny/trailer.mov";
 
 export function VideoPlayer() {
-  const videoRef = useRef(null);
-  const { play, pause } = useMediaSynchronizer(
-    "MEDIA-SESSION-ID",
-    videoRef,
-    INITIAL_TRACK,
-    ALLOWED_ROLES
-  );
+    const videoRef = useRef(null);
+    const { play, pause } = useMediaSynchronizer(
+        "MEDIA-SESSION-ID",
+        videoRef,
+        INITIAL_TRACK,
+        ALLOWED_ROLES
+    );
 
-  return (
-    <div>
-      <video ref={videoRef} />
-      <button onClick={play}>{"Play"}</button>
-      <button onClick={pause}>{"Pause"}</button>
-    </div>
-  );
+    return (
+        <div>
+            <video ref={videoRef} />
+            <button onClick={play}>{"Play"}</button>
+            <button onClick={pause}>{"Pause"}</button>
+        </div>
+    );
 }
 ```
 
@@ -440,10 +438,7 @@ import { useTaskManager } from "@microsoft/live-share-react";
 
 export const ExampleTaskManager = () => {
     const [taskId, setTaskId] = useState(undefined);
-    const { lockedTask } = useTaskManager(
-        "CUSTOM-TASK-MANAGER",
-        taskId,
-    );
+    const { lockedTask } = useTaskManager("CUSTOM-TASK-MANAGER", taskId);
 
     const displayText = lockedTask
         ? "You are assigned the task"
@@ -454,19 +449,19 @@ export const ExampleTaskManager = () => {
             {!taskId && (
                 <button
                     onClick={() => {
-                        setTaskId("task-id")
+                        setTaskId("task-id");
                     }}
                 >
-                    {'Join task queue'}
+                    {"Join task queue"}
                 </button>
             )}
             {taskId && (
                 <button
                     onClick={() => {
-                        setTaskId(undefined)
+                        setTaskId(undefined);
                     }}
                 >
-                    {'Leave task queue'}
+                    {"Leave task queue"}
                 </button>
             )}
             <p>{displayText}</p>
@@ -477,7 +472,7 @@ export const ExampleTaskManager = () => {
 
 ### Custom Fluid object hooks
 
-If you want to dynamically load a custom Fluid object in your app, use the `useDynamicDDS` to create a custom hook. This is the same hook that Live Share React uses internally within our custom hooks, such as `useLiveEvent`. If you made a custom data object or are using one of Fluid's experimental data structures, you also must register your Fluid `LoadableObjectClass` with `DynamicObjectRegistry.registerObjectClass` to `@microsoft/live-share`, if it is not already.
+If you want to dynamically load a custom Fluid object in your app, use the `useDynamicDDS` to create a custom hook. This is the same hook that Live Share React uses internally within our custom hooks, such as `useLiveEvent`. If you made a custom data object or are using one of Fluid's experimental data structures, you also must register your Fluid `SharedObjectKind` with `DynamicObjectRegistry.registerObjectClass` to `@microsoft/live-share`, if it is not already.
 
 Implementations may vary for each dynamic object & hook. We will try and update this package periodically with new packages released by Fluid Framework and Live Share, as they are published.
 
@@ -487,19 +482,25 @@ Example:
 import React from "react";
 import { useDynamicDDS } from "@microsoft/live-share-react";
 import { DynamicObjectRegistry } from "@microsoft/live-share";
-import { TaskManager  } from "@fluid-experimental/task-manager";
+import { TaskManager } from "@fluid-experimental/task-manager";
 
 // Register TaskManager as dynamic object
-DynamicObjectRegistry.registerObjectClass(TaskManager, TaskManager.getFactory().type);
+DynamicObjectRegistry.registerObjectClass(
+    TaskManager,
+    TaskManager.getFactory().type
+);
 
 /**
  * A hook for joining a queue to lock tasks for a given id. Guaranteed to have only one user assigned to a task at a time.
- * 
+ *
  * @param uniqueKey the unique key for the TaskManager DDS
  * @param taskId the task id to lock
  * @returns stateful data about the status of the task lock
  */
-export const useTaskManager = (uniqueKey: string, taskId?: string): {
+export const useTaskManager = (
+    uniqueKey: string,
+    taskId?: string
+): {
     lockedTask: boolean;
     taskManager: TaskManager | undefined;
 } => {
@@ -515,7 +516,10 @@ export const useTaskManager = (uniqueKey: string, taskId?: string): {
     /**
      * User facing: dynamically load the TaskManager DDS for the given unique key.
      */
-    const { dds: taskManager } = useDynamicDDS<TaskManager>(uniqueKey, TaskManager);
+    const { dds: taskManager } = useDynamicDDS<TaskManager>(
+        uniqueKey,
+        TaskManager
+    );
 
     /**
      * When the task id changes, lock the task. When the task id is undefined, abandon the task.
@@ -541,7 +545,7 @@ export const useTaskManager = (uniqueKey: string, taskId?: string): {
                             currentTaskIdRef.current = undefined;
                         }
                     }
-                }
+                };
                 onLockTask();
             } else if (!taskId && currentTaskIdRef.current) {
                 taskManager.abandon(currentTaskIdRef.current);
@@ -558,7 +562,7 @@ export const useTaskManager = (uniqueKey: string, taskId?: string): {
                 taskManager?.abandon(currentTaskIdRef.current);
             }
             currentTaskIdRef.current = undefined;
-        }
+        };
     }, [taskManager, taskId]);
 
     return {
@@ -570,9 +574,9 @@ export const useTaskManager = (uniqueKey: string, taskId?: string): {
 
 ## Code samples
 
-| Sample name       | Description                                                             | Javascript                                            |
-| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------------------- |
-| Live Share React  | Simple example with each of our custom Live Share React hooks.          | [View](../../samples/javascript/04.live-share-react)  |
+| Sample name      | Description                                                    | Javascript                                           |
+| ---------------- | -------------------------------------------------------------- | ---------------------------------------------------- |
+| Live Share React | Simple example with each of our custom Live Share React hooks. | [View](../../samples/javascript/04.live-share-react) |
 
 ## React version compatibility
 
@@ -584,18 +588,19 @@ The Live Share SDK contains dependencies for [@microsoft/teams-js](https://www.n
 
 **It is critical that your app use the package dependencies listed in the table below.** Lookup the version of the `@microsoft/live-share` you're using and set any other dependencies in your package.json file to match:
 
-| @microsoft/live-share | @microsoft/teams-js  | fluid-framework | @microsoft/live-share-\*   | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
-| --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
-| ^1.0.0                  | ^2.11.0             | ^1.2.3          | ^1.0.0                      | ^1.0.0                       | ^2.5.0                        | ^2.5.0                          |
+| @microsoft/live-share | @microsoft/teams-js | fluid-framework | @microsoft/live-share-\* | @fluidframework/azure-client | @microsoft/TeamsFx | @microsoft/TeamsFx-react |
+| --------------------- | ------------------- | --------------- | ------------------------ | ---------------------------- | ------------------ | ------------------------ |
+| ^2.0.0                | ^2.11.0             | ^2.0.0          | ^2.0.0                   | ^2.0.0                       | ^2.5.0             | ^2.5.0                   |
+| ^1.0.0                | ^2.11.0             | ^1.2.3          | ^1.0.0                   | ^1.0.0                       | ^2.5.0             | ^2.5.0                   |
 
 ## Contributing
 
 There are several ways you can [contribute](../../CONTRIBUTING.md) to this project:
 
-- [Submit bugs](https://github.com/microsoft/live-share-sdk/issues) and help us verify fixes as they are checked in.
-- Review the source code changes.
-- Engage with other Live Share developers on [StackOverflow](https://stackoverflow.com/questions/tagged/live-share).
-- [Contribute bug fixes](../../CONTRIBUTING.md).
+-   [Submit bugs](https://github.com/microsoft/live-share-sdk/issues) and help us verify fixes as they are checked in.
+-   Review the source code changes.
+-   Engage with other Live Share developers on [StackOverflow](https://stackoverflow.com/questions/tagged/live-share).
+-   [Contribute bug fixes](../../CONTRIBUTING.md).
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact <opencode@microsoft.com> with any additional questions or comments.
 

package/bin/cjs/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/cjs/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/cjs/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./providers/index.js"), exports);
+__exportStar(require("./shared-hooks/index.js"), exports);
+__exportStar(require("./live-hooks/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./providers/index.js"), exports);
+__exportStar(require("./interfaces/index.js"), exports);
+//# sourceMappingURL=index.js.map

package/bin/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,0DAAwC;AACxC,wDAAsC;AACtC,mDAAiC;AACjC,uDAAqC;AACrC,wDAAsC"}

package/bin/cjs/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/cjs/interfaces/LiveInterfaceExtensions.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LiveInterfaceExtensions.js.map

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

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

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

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

package/bin/cjs/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/cjs/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./LiveInterfaceExtensions.js"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/bin/{internal → cjs/internal}/errors.d.ts

@@ -22,5 +22,20 @@ export declare class ActionLiveDataObjectUndefinedError extends UseLiveDataObjec
 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/cjs/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/cjs/internal/errors.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionLiveDataObjectInitializedError = exports.ActionLiveDataObjectUndefinedError = exports.ActionContainerNotJoinedError = void 0;
+/**
+ * @hidden
+ */
+class UseLiveDataObjectActionError extends Error {
+    constructor(ddsName, functionName, message) {
+        const hookName = `use${toFirstLetterUppercase(ddsName)}`;
+        super(`${hookName} ${functionName}: ${message}`);
+    }
+}
+/**
+ * @hidden
+ */
+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.");
+    }
+}
+exports.ActionContainerNotJoinedError = ActionContainerNotJoinedError;
+/**
+ * @hidden
+ */
+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.`);
+    }
+}
+exports.ActionLiveDataObjectUndefinedError = ActionLiveDataObjectUndefinedError;
+/**
+ * @hidden
+ */
+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.`);
+    }
+}
+exports.ActionLiveDataObjectInitializedError = ActionLiveDataObjectInitializedError;
+/**
+ * @hidden
+ */
+function toFirstLetterUppercase(word) {
+    return word[0].toUpperCase() + word.substring(1);
+}
+//# sourceMappingURL=errors.js.map

package/bin/cjs/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,MAAa,6BAA8B,SAAQ,4BAA4B;IAC3E,YAAY,OAAe,EAAE,YAAoB;QAC7C,KAAK,CACD,OAAO,EACP,YAAY,EACZ,oSAAoS,CACvS,CAAC;IACN,CAAC;CACJ;AARD,sEAQC;AAED;;GAEG;AACH,MAAa,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;AATD,gFASC;AAED;;GAEG;AACH,MAAa,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;AATD,oFASC;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/cjs/internal/index.d.ts

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