@wandelbots/nova-js 3.2.0 → 3.3.0

package/README.md

@@ -11,51 +11,61 @@ This library provides an idiomatic TypeScript client for working with the Wandel
 npm install @wandelbots/nova-js
 ```
 
-If you develop an React application we also provide a set of [React components](https://github.com/wandelbotsgmbh/wandelbots-js-react-components) which you can use together with this library.
+If you develop a React application we also provide a set of [React components](https://github.com/wandelbotsgmbh/wandelbots-js-react-components). It includes a [Robot Jogging Panel](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/jogging-joggingpanel--docs), a [Robot Visualization](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/3d-view-robot--docs) and other useful UI widgets.
 
 ## Table of contents
 
 - [Basic usage](#basic-usage)
-- [API Version Support](#api-version-support)
 - [API calls](#api-calls)
+- [API version support](#api-version-support)
 - [Opening websockets](#opening-websockets)
-- [Connect to a motion group](#connect-to-a-motion-group)
-- [Execute Wandelscript](#execute-wandelscript)
-- [Jogging](#jogging)
-  - [Stopping the jogger](#stopping-the-jogger)
-  - [Rotating a joint](#rotating-a-joint)
-  - [Moving a TCP](#moving-the-tcp)
-  - [Rotating a TCP](#rotating-the-tcp)
-  - [Post-jogging cleanup](#post-jogging-cleanup)
-  - [Jogging UI Panel](#jogging-ui-panel)
+- [Execute Wandelscript (V1)](#execute-wandelscript-v1)
 
 ## Basic usage
 
 The core of this package is the `NovaClient`, which represents a connection to a configured robot cell on a given Nova instance:
 
 ```ts
-import { NovaClient } from "@wandelbots/nova-js"
+// Please make sure you import NovaClient from "@wandelbots/nova-js/v2"
+//
+// The NovaClient from "@wandelbots/nova-js" is still API v1,
+// but it will be removed in the future, use "@wandelbots/nova-js/v1" if
+// you need the API v1 client
+import { NovaClient } from "@wandelbots/nova-js/v2"
 
 const nova = new NovaClient({
   instanceUrl: "https://example.instance.wandelbots.io",
   cellId: "cell",
-
   // Access token is given in the developer portal UI when you create an instance
   accessToken: "...",
 })
 ```
 
-## API Version Support
+### API calls
+
+You can make calls to the REST API via `nova.api`, which contains a bunch of namespaced methods for each endpoint generated from the OpenAPI spec and documentation.
+
+For example, to list the controllers configured in your cell:
+
+```ts
+const controllerIds = await nova.api.controller.listRobotControllers()
+// -> e.g. ["ur5e", ...]
+```
+
+Documentation for the various API endpoints is available on your Nova instance at `/api/v2/ui` or on [portal.wandelbots.io](https://portal.wandelbots.io/docs/api/v2/ui/)
 
-This library primarily supports **Nova API v1**, which provides full functionality including motion group connections, jogging, program execution, and all the features documented below.
 
-**Nova API v2** support is currently **experimental and limited**. While v2 API endpoints are accessible through the NovaCellAPIClient, many of the higher-level abstractions (like `connectMotionGroup`, `connectJogger`, and `ProgramStateConnection`) are not yet available for v2.
+## API version support
 
-For v2 usage:
+This library supports **Nova API v1** and **v2**. Please note that except for Wandelscript execution, usage of **API v1** is deprecated and not recommended.
+
+V1 usage:
 
 ```ts
-// Note: v2 support is experimental
-import { NovaClient } from "@wandelbots/nova-js/v2"
+// The NovaClient from "@wandelbots/nova-js" is still API v1,
+// but it will be removed in the future, use "@wandelbots/nova-js/v1" if
+// you need the API v1 client
+import { NovaClient } from "@wandelbots/nova-js/v1"
 
 const nova = new NovaClient({
   instanceUrl: "https://example.instance.wandelbots.io",
@@ -63,24 +73,11 @@ const nova = new NovaClient({
   accessToken: "...",
 })
 
-// Direct API access is available
-const { controllers } = await nova.api.controller.listRobotControllers()
-```
-
-We recommend using **v1** for production applications until v2 support is fully implemented.
-
-## API calls
-
-You can make calls to the REST API via `nova.api`, which contains a bunch of namespaced methods for each endpoint generated from the OpenAPI spec and documentation.
-
-For example, to list the controllers configured in your cell:
-
-```ts
+// Deprecated API version is still callable
 const { instances } = await nova.api.controller.listControllers()
-// -> e.g. [{ controller: "ur5e", model_name: "UniversalRobots::Controller", ... }, ...]
 ```
 
-Documentation for the various API endpoints is available on your Nova instance at `/api/v1/ui` (public documentation site is in the works)
+*Please note*: When using the v1 client, please make sure to add `"three"` to your package.json, since it will be moved to peer dependency in *v4.0* of this library.
 
 ## Opening websockets
 
@@ -102,24 +99,7 @@ programStateSocket.dispose()
 
 The reconnecting websocket interface is fairly low-level and you won't get type safety on the messages. So when available, you'll likely want to use one of the following endpoint-specific abstractions instead which are built on top!
 
-## Connect to a motion group
-
-The library provides an easy to use way to access properties of a motion group.
-
-```ts
-activeRobot = await this.nova.connectMotionGroup(`some-motion-group-id`)
-```
-
-This connected motion group opens a websocket and listens to changes of the current joints and the TCP pose. You can read out those values by using the `rapidlyChangingMotionState` of the object. Along other properties it also provides the current `safetySetup` and `tcps`.
-
-```ts
-const newJoints =
-  activeRobot.rapidlyChangingMotionState.state.joint_position.joints
-```
-
-To render a visual representation, you can use the `robot` component of the [react components](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/3d-view-robot--docs).
-
-## Execute Wandelscript
+## Execute Wandelscript (V1)
 
 The `ProgramStateConnection` provides an object which allows to execute and stop a given Wandelscript.
 
@@ -131,90 +111,6 @@ programRunner.executeProgram(script)
 
 You can `stop` the current execution or listen to state updates of your wandelscript code by observing the `programRunner.executionState`.
 
-## Jogging
-
-Jogging in a robotics context generally refers to the manual movement of the robot via direct human input. The Wandelbots platform provides websocket-based jogging methods which can be used to build similar jogging interfaces to those found on teach pendants.
-
-```ts
-const jogger = await nova.connectJogger(`some-motion-group-id`)
-```
-
-The jogger has two mutually exclusive modes. You must set the appropriate jogging mode before starting a jogging motion; this ensures that the motion is ready to start immediately when called with minimal delay.
-
-```ts
-// Set the jogger to "joint" mode, enabling continuous joint rotations.
-await jogger.setJoggingMode("joint")
-
-// Set the jogger to "tcp" mode, enabling continuous translation
-// and rotation movements of the tool center point.
-await jogger.setJoggingMode("tcp", {
-  tcpId: "flange",
-  coordSystemId: "world",
-})
-```
-
-### Stopping the jogger
-
-For safety purposes, let's first consider how to stop the jogger. Calling stop will stop all motion types regardless of mode:
-
-```ts
-await jogger.stop()
-```
-
-As a failsafe, the server will also stop any jogging motions when it detects the relevant websocket has been closed. This means that if e.g. the network connection drops out or the browser tab is closed in the middle of a motion, it will stop automatically.
-
-However, you should never totally rely on any software being able to stop the robot: always have the hardware emergency stop button within reach just in case!
-
-### Rotating a joint
-
-Requires `joint` mode. This example starts joint 0 of the robot rotating in a positive direction at 1 radian per second:
-
-```ts
-await jogger.startJointRotation({
-  joint: 0,
-  direction: "+",
-  velocityRadsPerSec: 1,
-})
-```
-
-### Moving a TCP
-
-Requires `tcp` mode. This example starts moving a TCP in a positive direction along the X axis of the specified coordinate system, at a velocity of 10 millimeters per second:
-
-```ts
-await jogger.startTCPTranslation({
-  axis: "x",
-  direction: "+",
-  velocityMmPerSec: 10,
-})
-```
-
-### Rotating a TCP
-
-Requires `tcp` mode. This example starts rotating the TCP in a positive direction around the X axis of the specified coordinate system, at a velocity of 1 radians per second:
-
-```ts
-await jogger.startTCPRotation({
-  axis: "x",
-  direction: "+",
-  velocityRadsPerSec: 1,
-})
-```
-
-### Post-jogging cleanup
-
-When you are done with a jogger, make sure to call dispose:
-
-```ts
-await jogger.dispose()
-```
-
-This will close any open websockets and ensure things are left in a good state.
-
-### Jogging UI Panel
-
-You can use the [Jogging Panel](https://wandelbotsgmbh.github.io/wandelbots-js-react-components/?path=/docs/jogging-joggingpanel--docs) from the [react components](https://github.com/wandelbotsgmbh/wandelbots-js-react-components) library to get a easy to use visualization component.
-
 ## Contributing
 
 If you would like to contribute a change to this repository, see [CONTRIBUTING.md](CONTRIBUTING.md).

package/dist/AutoReconnectingWebsocket-Qcrbm3Kb.d.cts

@@ -0,0 +1,69 @@
+import ReconnectingWebSocket from "reconnecting-websocket";
+import { AxiosResponse, InternalAxiosRequestConfig } from "axios";
+
+//#region src/lib/v1/mock/MockNovaInstance.d.ts
+
+/**
+ * Ultra-simplified mock Nova server for testing stuff
+ */
+declare class MockNovaInstance$1 {
+  readonly connections: AutoReconnectingWebsocket[];
+  handleAPIRequest(config: InternalAxiosRequestConfig): Promise<AxiosResponse>;
+  handleWebsocketConnection(socket: AutoReconnectingWebsocket): void;
+  handleWebsocketMessage(socket: AutoReconnectingWebsocket, message: string): void;
+}
+//#endregion
+//#region src/lib/v2/mock/MockNovaInstance.d.ts
+/**
+ * Ultra-simplified mock Nova server for testing stuff
+ */
+declare class MockNovaInstance {
+  readonly connections: AutoReconnectingWebsocket[];
+  handleAPIRequest(config: InternalAxiosRequestConfig): Promise<AxiosResponse>;
+  handleWebsocketConnection(socket: AutoReconnectingWebsocket): void;
+  handleWebsocketMessage(socket: AutoReconnectingWebsocket, message: string): void;
+}
+//#endregion
+//#region src/lib/AutoReconnectingWebsocket.d.ts
+declare class AutoReconnectingWebsocket extends ReconnectingWebSocket {
+  readonly opts: {
+    mock?: MockNovaInstance$1 | MockNovaInstance;
+    onDispose?: () => void;
+  };
+  receivedFirstMessage?: MessageEvent;
+  targetUrl: string;
+  disposed: boolean;
+  constructor(targetUrl: string, opts?: {
+    mock?: MockNovaInstance$1 | MockNovaInstance;
+    onDispose?: () => void;
+  });
+  changeUrl(targetUrl: string): void;
+  sendJson(data: unknown): void;
+  /**
+   * Permanently close this websocket and indicate that
+   * this object should not be used again.
+   **/
+  dispose(): void;
+  /**
+   * Returns a promise that resolves once the websocket
+   * is in the OPEN state. */
+  opened(): Promise<void>;
+  /**
+   * Returns a promise that resolves once the websocket
+   * is in the CLOSED state. */
+  closed(): Promise<void>;
+  /**
+   * Returns a promise that resolves when the first message
+   * is received from the websocket. Resolves immediately if
+   * the first message has already been received.
+   */
+  firstMessage(): Promise<MessageEvent<any>>;
+  /**
+   * Returns a promise that resolves when the next message
+   * is received from the websocket.
+   */
+  nextMessage(): Promise<MessageEvent<any>>;
+}
+//#endregion
+export { MockNovaInstance as n, MockNovaInstance$1 as r, AutoReconnectingWebsocket as t };
+//# sourceMappingURL=AutoReconnectingWebsocket-Qcrbm3Kb.d.cts.map

package/dist/AutoReconnectingWebsocket-Qcrbm3Kb.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoReconnectingWebsocket-Qcrbm3Kb.d.cts","names":[],"sources":["../src/lib/v1/mock/MockNovaInstance.ts","../src/lib/v2/mock/MockNovaInstance.ts","../src/lib/AutoReconnectingWebsocket.ts"],"sourcesContent":[],"mappings":";;;;;;;AAeA;AACwB,cADX,kBAAA,CACW;EAGZ,SAAA,WAAA,EAHY,yBAGZ,EAAA;EACC,gBAAA,CAAA,MAAA,EADD,0BACC,CAAA,EAAR,OAAQ,CAAA,aAAA,CAAA;EAAR,yBAAA,CAAA,MAAA,EAg8B+B,yBAh8B/B,CAAA,EAAA,IAAA;EAg8B+B,sBAAA,CAAA,MAAA,EAkOH,yBAlOG,EAAA,OAAA,EAAA,MAAA,CAAA,EAAA,IAAA;;;;;;AAr8BpC;AACwB,cCPX,gBAAA,CDOW;EAGZ,SAAA,WAAA,ECTY,yBDSZ,EAAA;EACC,gBAAA,CAAA,MAAA,ECPD,0BDOC,CAAA,ECNR,ODMQ,CCNA,aDMA,CAAA;EAAR,yBAAA,CAAA,MAAA,EC4iC+B,yBD5iC/B,CAAA,EAAA,IAAA;EAg8B+B,sBAAA,CAAA,MAAA,ECwUH,yBDxUG,EAAA,OAAA,EAAA,MAAA,CAAA,EAAA,IAAA;;;;cEh9BvB,yBAAA,SAAkC,qBAAA;EFWlC,SAAA,IAAA,EAAA;IACW,IAAA,CAAA,EEJX,kBFIW,GEJW,gBFIX;IAGZ,SAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EACC,CAAA;EAAR,oBAAA,CAAA,EEfoB,YFepB;EAg8B+B,SAAA,EAAA,MAAA;EAkOH,QAAA,EAAA,OAAA;EAAyB,WAAA,CAAA,SAAA,EAAA,MAAA,EAAA,KAAA,EAAA;WE1qC7C,qBAAsB;;;EDHtB,SAAA,CAAA,SAAgB,EAAA,MAAA,CAAA,EAAA,IAAA;EACL,QAAA,CAAA,IAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAGZ;;;;EA+wCqB,OAAA,CAAA,CAAA,EAAA,IAAA;EAAyB;;;YCtsC5C;EAlFD;;;EACY,MAAA,CAAA,CAAA,EA+FX,OA/FW,CAAA,IAAA,CAAA;EAOZ;;;;;EAwGO,YAAA,CAAA,CAAA,EAAA,OAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA;EA4BD;;;;iBAAA,QAAA"}

package/dist/AutoReconnectingWebsocket-dHe-kceU.d.mts

@@ -0,0 +1,69 @@
+import ReconnectingWebSocket from "reconnecting-websocket";
+import { AxiosResponse, InternalAxiosRequestConfig } from "axios";
+
+//#region src/lib/v1/mock/MockNovaInstance.d.ts
+
+/**
+ * Ultra-simplified mock Nova server for testing stuff
+ */
+declare class MockNovaInstance$1 {
+  readonly connections: AutoReconnectingWebsocket[];
+  handleAPIRequest(config: InternalAxiosRequestConfig): Promise<AxiosResponse>;
+  handleWebsocketConnection(socket: AutoReconnectingWebsocket): void;
+  handleWebsocketMessage(socket: AutoReconnectingWebsocket, message: string): void;
+}
+//#endregion
+//#region src/lib/v2/mock/MockNovaInstance.d.ts
+/**
+ * Ultra-simplified mock Nova server for testing stuff
+ */
+declare class MockNovaInstance {
+  readonly connections: AutoReconnectingWebsocket[];
+  handleAPIRequest(config: InternalAxiosRequestConfig): Promise<AxiosResponse>;
+  handleWebsocketConnection(socket: AutoReconnectingWebsocket): void;
+  handleWebsocketMessage(socket: AutoReconnectingWebsocket, message: string): void;
+}
+//#endregion
+//#region src/lib/AutoReconnectingWebsocket.d.ts
+declare class AutoReconnectingWebsocket extends ReconnectingWebSocket {
+  readonly opts: {
+    mock?: MockNovaInstance$1 | MockNovaInstance;
+    onDispose?: () => void;
+  };
+  receivedFirstMessage?: MessageEvent;
+  targetUrl: string;
+  disposed: boolean;
+  constructor(targetUrl: string, opts?: {
+    mock?: MockNovaInstance$1 | MockNovaInstance;
+    onDispose?: () => void;
+  });
+  changeUrl(targetUrl: string): void;
+  sendJson(data: unknown): void;
+  /**
+   * Permanently close this websocket and indicate that
+   * this object should not be used again.
+   **/
+  dispose(): void;
+  /**
+   * Returns a promise that resolves once the websocket
+   * is in the OPEN state. */
+  opened(): Promise<void>;
+  /**
+   * Returns a promise that resolves once the websocket
+   * is in the CLOSED state. */
+  closed(): Promise<void>;
+  /**
+   * Returns a promise that resolves when the first message
+   * is received from the websocket. Resolves immediately if
+   * the first message has already been received.
+   */
+  firstMessage(): Promise<MessageEvent<any>>;
+  /**
+   * Returns a promise that resolves when the next message
+   * is received from the websocket.
+   */
+  nextMessage(): Promise<MessageEvent<any>>;
+}
+//#endregion
+export { MockNovaInstance as n, MockNovaInstance$1 as r, AutoReconnectingWebsocket as t };
+//# sourceMappingURL=AutoReconnectingWebsocket-dHe-kceU.d.mts.map

package/dist/AutoReconnectingWebsocket-dHe-kceU.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoReconnectingWebsocket-dHe-kceU.d.mts","names":[],"sources":["../src/lib/v1/mock/MockNovaInstance.ts","../src/lib/v2/mock/MockNovaInstance.ts","../src/lib/AutoReconnectingWebsocket.ts"],"sourcesContent":[],"mappings":";;;;;;;AAeA;AACwB,cADX,kBAAA,CACW;EAGZ,SAAA,WAAA,EAHY,yBAGZ,EAAA;EACC,gBAAA,CAAA,MAAA,EADD,0BACC,CAAA,EAAR,OAAQ,CAAA,aAAA,CAAA;EAAR,yBAAA,CAAA,MAAA,EAg8B+B,yBAh8B/B,CAAA,EAAA,IAAA;EAg8B+B,sBAAA,CAAA,MAAA,EAkOH,yBAlOG,EAAA,OAAA,EAAA,MAAA,CAAA,EAAA,IAAA;;;;;;AAr8BpC;AACwB,cCPX,gBAAA,CDOW;EAGZ,SAAA,WAAA,ECTY,yBDSZ,EAAA;EACC,gBAAA,CAAA,MAAA,ECPD,0BDOC,CAAA,ECNR,ODMQ,CCNA,aDMA,CAAA;EAAR,yBAAA,CAAA,MAAA,EC4iC+B,yBD5iC/B,CAAA,EAAA,IAAA;EAg8B+B,sBAAA,CAAA,MAAA,ECwUH,yBDxUG,EAAA,OAAA,EAAA,MAAA,CAAA,EAAA,IAAA;;;;cEh9BvB,yBAAA,SAAkC,qBAAA;EFWlC,SAAA,IAAA,EAAA;IACW,IAAA,CAAA,EEJX,kBFIW,GEJW,gBFIX;IAGZ,SAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EACC,CAAA;EAAR,oBAAA,CAAA,EEfoB,YFepB;EAg8B+B,SAAA,EAAA,MAAA;EAkOH,QAAA,EAAA,OAAA;EAAyB,WAAA,CAAA,SAAA,EAAA,MAAA,EAAA,KAAA,EAAA;WE1qC7C,qBAAsB;;;EDHtB,SAAA,CAAA,SAAgB,EAAA,MAAA,CAAA,EAAA,IAAA;EACL,QAAA,CAAA,IAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAGZ;;;;EA+wCqB,OAAA,CAAA,CAAA,EAAA,IAAA;EAAyB;;;YCtsC5C;EAlFD;;;EACY,MAAA,CAAA,CAAA,EA+FX,OA/FW,CAAA,IAAA,CAAA;EAOZ;;;;;EAwGO,YAAA,CAAA,CAAA,EAAA,OAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA;EA4BD;;;;iBAAA,QAAA"}

package/dist/LoginWithAuth0-CBD9BXXz.cjs

@@ -0,0 +1,264 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let reconnecting_websocket = require("reconnecting-websocket");
+reconnecting_websocket = __toESM(reconnecting_websocket);
+
+//#region src/lib/AutoReconnectingWebsocket.ts
+var AutoReconnectingWebsocket = class extends reconnecting_websocket.default {
+	constructor(targetUrl, opts = {}) {
+		console.log("Opening websocket to", targetUrl);
+		super(() => this.targetUrl || targetUrl, void 0, { startClosed: true });
+		this.opts = opts;
+		this.disposed = false;
+		Object.defineProperty(this, "url", { get() {
+			return this.targetUrl;
+		} });
+		this.targetUrl = targetUrl;
+		this.addEventListener("open", () => {
+			console.log(`Websocket to ${this.url} opened`);
+		});
+		this.addEventListener("message", (ev) => {
+			if (!this.receivedFirstMessage) this.receivedFirstMessage = ev;
+		});
+		this.addEventListener("close", () => {
+			console.log(`Websocket to ${this.url} closed`);
+		});
+		const origReconnect = this.reconnect;
+		this.reconnect = () => {
+			if (this.opts.mock) this.opts.mock.handleWebsocketConnection(this);
+			else origReconnect.apply(this);
+		};
+		this.reconnect();
+	}
+	changeUrl(targetUrl) {
+		this.receivedFirstMessage = void 0;
+		this.targetUrl = targetUrl;
+		this.reconnect();
+	}
+	sendJson(data) {
+		if (this.opts.mock) this.opts.mock.handleWebsocketMessage(this, JSON.stringify(data));
+		else this.send(JSON.stringify(data));
+	}
+	/**
+	* Permanently close this websocket and indicate that
+	* this object should not be used again.
+	**/
+	dispose() {
+		this.close();
+		this.disposed = true;
+		if (this.opts.onDispose) this.opts.onDispose();
+	}
+	/**
+	* Returns a promise that resolves once the websocket
+	* is in the OPEN state. */
+	async opened() {
+		return new Promise((resolve, reject) => {
+			if (this.readyState === WebSocket.OPEN) resolve();
+			else {
+				this.addEventListener("open", () => resolve());
+				this.addEventListener("error", reject);
+			}
+		});
+	}
+	/**
+	* Returns a promise that resolves once the websocket
+	* is in the CLOSED state. */
+	async closed() {
+		return new Promise((resolve, reject) => {
+			if (this.readyState === WebSocket.CLOSED) resolve();
+			else {
+				this.addEventListener("close", () => resolve());
+				this.addEventListener("error", reject);
+			}
+		});
+	}
+	/**
+	* Returns a promise that resolves when the first message
+	* is received from the websocket. Resolves immediately if
+	* the first message has already been received.
+	*/
+	async firstMessage() {
+		if (this.receivedFirstMessage) return this.receivedFirstMessage;
+		return new Promise((resolve, reject) => {
+			const onMessage = (ev) => {
+				this.receivedFirstMessage = ev;
+				this.removeEventListener("message", onMessage);
+				this.removeEventListener("error", onError);
+				resolve(ev);
+			};
+			const onError = (ev) => {
+				this.removeEventListener("message", onMessage);
+				this.removeEventListener("error", onError);
+				reject(ev);
+			};
+			this.addEventListener("message", onMessage);
+			this.addEventListener("error", onError);
+		});
+	}
+	/**
+	* Returns a promise that resolves when the next message
+	* is received from the websocket.
+	*/
+	async nextMessage() {
+		return new Promise((resolve, reject) => {
+			const onMessage = (ev) => {
+				this.removeEventListener("message", onMessage);
+				this.removeEventListener("error", onError);
+				resolve(ev);
+			};
+			const onError = (ev) => {
+				this.removeEventListener("message", onMessage);
+				this.removeEventListener("error", onError);
+				reject(ev);
+			};
+			this.addEventListener("message", onMessage);
+			this.addEventListener("error", onError);
+		});
+	}
+};
+
+//#endregion
+//#region src/lib/availableStorage.ts
+/**
+* Safety wrapper around browser localStorage providing context availability
+* checks and JSON parsing
+*/
+var AvailableStorage = class {
+	constructor() {
+		this.available = typeof window !== "undefined" && !!window.localStorage;
+	}
+	getJSON(key) {
+		if (!this.available) return null;
+		const result = window.localStorage.getItem(key);
+		if (result === null) return null;
+		try {
+			return JSON.parse(result);
+		} catch (err) {
+			return null;
+		}
+	}
+	setJSON(key, obj) {
+		if (!this.available) return null;
+		window.localStorage.setItem(key, JSON.stringify(obj));
+	}
+	delete(key) {
+		if (!this.available) return null;
+		window.localStorage.removeItem(key);
+	}
+	setString(key, value) {
+		if (!this.available) return null;
+		window.localStorage.setItem(key, value);
+	}
+	getString(key) {
+		if (!this.available) return null;
+		return window.localStorage.getItem(key);
+	}
+};
+const availableStorage = new AvailableStorage();
+
+//#endregion
+//#region src/LoginWithAuth0.ts
+const DOMAIN_SUFFIX = "wandelbots.io";
+/**
+* Mapping of stages to Auth0 configurations.
+* The client ids are public identifiers for a specific auth0 application
+* and are safe to include in client-side code.
+* https://auth0.com/docs/get-started/applications/application-settings
+*/
+const auth0ConfigMap = {
+	dev: {
+		domain: `https://auth.portal.dev.${DOMAIN_SUFFIX}`,
+		clientId: "fLbJD0RLp5r2Dpucm5j8BjwMR6Hunfha"
+	},
+	stg: {
+		domain: `https://auth.portal.stg.${DOMAIN_SUFFIX}`,
+		clientId: "joVDeD9e786WzFNSGCqoVq7HNkWt5j6s"
+	},
+	prod: {
+		domain: `https://auth.portal.${DOMAIN_SUFFIX}`,
+		clientId: "J7WJUi38xVQdJAEBNRT9Xw1b0fXDb4J2"
+	}
+};
+/** Determine which Auth0 configuration to use based on instance URL  */
+const getAuth0Config = (instanceUrl) => {
+	if (instanceUrl.endsWith(`dev.${DOMAIN_SUFFIX}`)) return auth0ConfigMap.dev;
+	if (instanceUrl.endsWith(`stg.${DOMAIN_SUFFIX}`)) return auth0ConfigMap.stg;
+	if (instanceUrl.endsWith(DOMAIN_SUFFIX)) return auth0ConfigMap.prod;
+	throw new Error("Unsupported instance URL. Cannot determine Auth0 configuration.");
+};
+/**
+* Initializes Auth0 login process using redirect if necessary and retrieves an access token.
+* Returns null when an access token should not be needed to authenticate (i.e. cookie auth
+* when deployed on the instance domain)
+*/
+const loginWithAuth0 = async (instanceUrl) => {
+	if (typeof window === "undefined") throw new Error(`Access token must be set to use NovaClient when not in a browser environment.`);
+	const auth0Config = getAuth0Config(instanceUrl);
+	if (new URL(instanceUrl).origin === window.location.origin) {
+		window.location.reload();
+		throw new Error("Failed to reload page to get auth details, please refresh manually");
+	}
+	const { Auth0Client } = await import("@auth0/auth0-spa-js");
+	const auth0Client = new Auth0Client({
+		domain: auth0Config.domain,
+		clientId: auth0Config.clientId ?? "",
+		useRefreshTokens: false,
+		authorizationParams: {
+			audience: "nova-api",
+			redirect_uri: window.location.origin
+		}
+	});
+	if (window.location.search.includes("code=") && window.location.search.includes("state=")) {
+		const { appState } = await auth0Client.handleRedirectCallback();
+		window.history.replaceState({}, document.title, appState?.returnTo || window.location.pathname);
+	} else await auth0Client.loginWithRedirect();
+	return await auth0Client.getTokenSilently();
+};
+
+//#endregion
+Object.defineProperty(exports, 'AutoReconnectingWebsocket', {
+  enumerable: true,
+  get: function () {
+    return AutoReconnectingWebsocket;
+  }
+});
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});
+Object.defineProperty(exports, 'availableStorage', {
+  enumerable: true,
+  get: function () {
+    return availableStorage;
+  }
+});
+Object.defineProperty(exports, 'loginWithAuth0', {
+  enumerable: true,
+  get: function () {
+    return loginWithAuth0;
+  }
+});
+//# sourceMappingURL=LoginWithAuth0-CBD9BXXz.cjs.map

package/dist/LoginWithAuth0-CBD9BXXz.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoginWithAuth0-CBD9BXXz.cjs","names":["ReconnectingWebSocket","opts: {\n      mock?: v1.MockNovaInstance | v2.MockNovaInstance\n      onDispose?: () => void\n    }"],"sources":["../src/lib/AutoReconnectingWebsocket.ts","../src/lib/availableStorage.ts","../src/LoginWithAuth0.ts"],"sourcesContent":["import ReconnectingWebSocket, { type ErrorEvent } from \"reconnecting-websocket\"\nimport type * as v1 from \"./v1/mock/MockNovaInstance\"\nimport type * as v2 from \"./v2/mock/MockNovaInstance\"\n\nexport class AutoReconnectingWebsocket extends ReconnectingWebSocket {\n  receivedFirstMessage?: MessageEvent\n  targetUrl: string\n  disposed = false\n\n  constructor(\n    targetUrl: string,\n    readonly opts: {\n      mock?: v1.MockNovaInstance | v2.MockNovaInstance\n      onDispose?: () => void\n    } = {},\n  ) {\n    console.log(\"Opening websocket to\", targetUrl)\n\n    super(() => this.targetUrl || targetUrl, undefined, {\n      startClosed: true,\n    })\n\n    // Reconnecting websocket doesn't set this properly with startClosed\n    Object.defineProperty(this, \"url\", {\n      get() {\n        return this.targetUrl\n      },\n    })\n\n    this.targetUrl = targetUrl\n\n    this.addEventListener(\"open\", () => {\n      console.log(`Websocket to ${this.url} opened`)\n    })\n\n    this.addEventListener(\"message\", (ev) => {\n      if (!this.receivedFirstMessage) {\n        this.receivedFirstMessage = ev\n      }\n    })\n\n    this.addEventListener(\"close\", () => {\n      console.log(`Websocket to ${this.url} closed`)\n    })\n\n    const origReconnect = this.reconnect\n    this.reconnect = () => {\n      if (this.opts.mock) {\n        this.opts.mock.handleWebsocketConnection(this)\n      } else {\n        origReconnect.apply(this)\n      }\n    }\n\n    this.reconnect()\n  }\n\n  changeUrl(targetUrl: string) {\n    this.receivedFirstMessage = undefined\n    this.targetUrl = targetUrl\n    this.reconnect()\n  }\n\n  sendJson(data: unknown) {\n    if (this.opts.mock) {\n      this.opts.mock.handleWebsocketMessage(this, JSON.stringify(data))\n    } else {\n      this.send(JSON.stringify(data))\n    }\n  }\n\n  /**\n   * Permanently close this websocket and indicate that\n   * this object should not be used again.\n   **/\n  dispose() {\n    this.close()\n    this.disposed = true\n    if (this.opts.onDispose) {\n      this.opts.onDispose()\n    }\n  }\n\n  /**\n   * Returns a promise that resolves once the websocket\n   * is in the OPEN state. */\n  async opened() {\n    return new Promise<void>((resolve, reject) => {\n      if (this.readyState === WebSocket.OPEN) {\n        resolve()\n      } else {\n        this.addEventListener(\"open\", () => resolve())\n        this.addEventListener(\"error\", reject)\n      }\n    })\n  }\n\n  /**\n   * Returns a promise that resolves once the websocket\n   * is in the CLOSED state. */\n  async closed() {\n    return new Promise<void>((resolve, reject) => {\n      if (this.readyState === WebSocket.CLOSED) {\n        resolve()\n      } else {\n        this.addEventListener(\"close\", () => resolve())\n        this.addEventListener(\"error\", reject)\n      }\n    })\n  }\n\n  /**\n   * Returns a promise that resolves when the first message\n   * is received from the websocket. Resolves immediately if\n   * the first message has already been received.\n   */\n  async firstMessage() {\n    if (this.receivedFirstMessage) {\n      return this.receivedFirstMessage\n    }\n\n    return new Promise<MessageEvent>((resolve, reject) => {\n      const onMessage = (ev: MessageEvent) => {\n        this.receivedFirstMessage = ev\n        this.removeEventListener(\"message\", onMessage)\n        this.removeEventListener(\"error\", onError)\n        resolve(ev)\n      }\n\n      const onError = (ev: ErrorEvent) => {\n        this.removeEventListener(\"message\", onMessage)\n        this.removeEventListener(\"error\", onError)\n        reject(ev)\n      }\n\n      this.addEventListener(\"message\", onMessage)\n      this.addEventListener(\"error\", onError)\n    })\n  }\n\n  /**\n   * Returns a promise that resolves when the next message\n   * is received from the websocket.\n   */\n  async nextMessage() {\n    return new Promise<MessageEvent>((resolve, reject) => {\n      const onMessage = (ev: MessageEvent) => {\n        this.removeEventListener(\"message\", onMessage)\n        this.removeEventListener(\"error\", onError)\n        resolve(ev)\n      }\n\n      const onError = (ev: ErrorEvent) => {\n        this.removeEventListener(\"message\", onMessage)\n        this.removeEventListener(\"error\", onError)\n        reject(ev)\n      }\n\n      this.addEventListener(\"message\", onMessage)\n      this.addEventListener(\"error\", onError)\n    })\n  }\n}\n","/**\n * Safety wrapper around browser localStorage providing context availability\n * checks and JSON parsing\n */\nclass AvailableStorage {\n  available = typeof window !== \"undefined\" && !!window.localStorage\n\n  getJSON<T>(key: string): Partial<T> | null {\n    if (!this.available) return null\n\n    const result = window.localStorage.getItem(key)\n    if (result === null) return null\n\n    try {\n      return JSON.parse(result)\n    } catch (err) {\n      return null\n    }\n  }\n\n  setJSON(key: string, obj: unknown) {\n    if (!this.available) return null\n\n    window.localStorage.setItem(key, JSON.stringify(obj))\n  }\n\n  delete(key: string) {\n    if (!this.available) return null\n\n    window.localStorage.removeItem(key)\n  }\n\n  setString(key: string, value: string) {\n    if (!this.available) return null\n\n    window.localStorage.setItem(key, value)\n  }\n\n  getString(key: string): string | null {\n    if (!this.available) return null\n\n    return window.localStorage.getItem(key)\n  }\n}\n\nexport const availableStorage = new AvailableStorage()\n","const DOMAIN_SUFFIX = \"wandelbots.io\"\n\n/**\n * Mapping of stages to Auth0 configurations.\n * The client ids are public identifiers for a specific auth0 application\n * and are safe to include in client-side code.\n * https://auth0.com/docs/get-started/applications/application-settings\n */\nconst auth0ConfigMap = {\n  dev: {\n    domain: `https://auth.portal.dev.${DOMAIN_SUFFIX}`,\n    clientId: \"fLbJD0RLp5r2Dpucm5j8BjwMR6Hunfha\",\n  },\n  stg: {\n    domain: `https://auth.portal.stg.${DOMAIN_SUFFIX}`,\n    clientId: \"joVDeD9e786WzFNSGCqoVq7HNkWt5j6s\",\n  },\n  prod: {\n    domain: `https://auth.portal.${DOMAIN_SUFFIX}`,\n    clientId: \"J7WJUi38xVQdJAEBNRT9Xw1b0fXDb4J2\",\n  },\n}\n\n/** Determine which Auth0 configuration to use based on instance URL  */\nconst getAuth0Config = (instanceUrl: string) => {\n  if (instanceUrl.endsWith(`dev.${DOMAIN_SUFFIX}`)) return auth0ConfigMap.dev\n  if (instanceUrl.endsWith(`stg.${DOMAIN_SUFFIX}`)) return auth0ConfigMap.stg\n  if (instanceUrl.endsWith(DOMAIN_SUFFIX)) return auth0ConfigMap.prod\n  throw new Error(\n    \"Unsupported instance URL. Cannot determine Auth0 configuration.\",\n  )\n}\n\n/**\n * Initializes Auth0 login process using redirect if necessary and retrieves an access token.\n * Returns null when an access token should not be needed to authenticate (i.e. cookie auth\n * when deployed on the instance domain)\n */\nexport const loginWithAuth0 = async (\n  instanceUrl: string,\n): Promise<string | null> => {\n  if (typeof window === \"undefined\") {\n    throw new Error(\n      `Access token must be set to use NovaClient when not in a browser environment.`,\n    )\n  }\n\n  const auth0Config = getAuth0Config(instanceUrl)\n\n  if (new URL(instanceUrl).origin === window.location.origin) {\n    // When deployed on the instance itself, our auth is handled by cookies\n    // and no access token is needed-- just need to reload the page and it'll\n    // login again / set cookie as needed\n    window.location.reload()\n    throw new Error(\n      \"Failed to reload page to get auth details, please refresh manually\",\n    )\n  }\n\n  // If we're on localhost or another domain, we need to do the full oauth flow\n  // Note this will ONLY work for origins which are whitelisted as a redirect_uri\n  // in the auth0 config, currently\n  const { Auth0Client } = await import(\"@auth0/auth0-spa-js\")\n\n  const auth0Client = new Auth0Client({\n    domain: auth0Config.domain,\n    clientId: auth0Config.clientId ?? \"\",\n    useRefreshTokens: false,\n    authorizationParams: {\n      audience: \"nova-api\",\n      redirect_uri: window.location.origin,\n    },\n  })\n\n  // If the URL includes a redirect result, handle it\n  if (\n    window.location.search.includes(\"code=\") &&\n    window.location.search.includes(\"state=\")\n  ) {\n    const { appState } = await auth0Client.handleRedirectCallback()\n    // Return to the URL the user was originally on before the redirect\n    window.history.replaceState(\n      {},\n      document.title,\n      appState?.returnTo || window.location.pathname,\n    )\n  } else {\n    // Initiate login with redirect\n    await auth0Client.loginWithRedirect()\n  }\n\n  // Once logged in, retrieve the access token silently\n  const accessToken = await auth0Client.getTokenSilently()\n  return accessToken\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAa,4BAAb,cAA+CA,+BAAsB;CAKnE,YACE,WACA,AAASC,OAGL,EAAE,EACN;AACA,UAAQ,IAAI,wBAAwB,UAAU;AAE9C,cAAY,KAAK,aAAa,WAAW,QAAW,EAClD,aAAa,MACd,CAAC;EATO;kBAJA;AAgBT,SAAO,eAAe,MAAM,OAAO,EACjC,MAAM;AACJ,UAAO,KAAK;KAEf,CAAC;AAEF,OAAK,YAAY;AAEjB,OAAK,iBAAiB,cAAc;AAClC,WAAQ,IAAI,gBAAgB,KAAK,IAAI,SAAS;IAC9C;AAEF,OAAK,iBAAiB,YAAY,OAAO;AACvC,OAAI,CAAC,KAAK,qBACR,MAAK,uBAAuB;IAE9B;AAEF,OAAK,iBAAiB,eAAe;AACnC,WAAQ,IAAI,gBAAgB,KAAK,IAAI,SAAS;IAC9C;EAEF,MAAM,gBAAgB,KAAK;AAC3B,OAAK,kBAAkB;AACrB,OAAI,KAAK,KAAK,KACZ,MAAK,KAAK,KAAK,0BAA0B,KAAK;OAE9C,eAAc,MAAM,KAAK;;AAI7B,OAAK,WAAW;;CAGlB,UAAU,WAAmB;AAC3B,OAAK,uBAAuB;AAC5B,OAAK,YAAY;AACjB,OAAK,WAAW;;CAGlB,SAAS,MAAe;AACtB,MAAI,KAAK,KAAK,KACZ,MAAK,KAAK,KAAK,uBAAuB,MAAM,KAAK,UAAU,KAAK,CAAC;MAEjE,MAAK,KAAK,KAAK,UAAU,KAAK,CAAC;;;;;;CAQnC,UAAU;AACR,OAAK,OAAO;AACZ,OAAK,WAAW;AAChB,MAAI,KAAK,KAAK,UACZ,MAAK,KAAK,WAAW;;;;;CAOzB,MAAM,SAAS;AACb,SAAO,IAAI,SAAe,SAAS,WAAW;AAC5C,OAAI,KAAK,eAAe,UAAU,KAChC,UAAS;QACJ;AACL,SAAK,iBAAiB,cAAc,SAAS,CAAC;AAC9C,SAAK,iBAAiB,SAAS,OAAO;;IAExC;;;;;CAMJ,MAAM,SAAS;AACb,SAAO,IAAI,SAAe,SAAS,WAAW;AAC5C,OAAI,KAAK,eAAe,UAAU,OAChC,UAAS;QACJ;AACL,SAAK,iBAAiB,eAAe,SAAS,CAAC;AAC/C,SAAK,iBAAiB,SAAS,OAAO;;IAExC;;;;;;;CAQJ,MAAM,eAAe;AACnB,MAAI,KAAK,qBACP,QAAO,KAAK;AAGd,SAAO,IAAI,SAAuB,SAAS,WAAW;GACpD,MAAM,aAAa,OAAqB;AACtC,SAAK,uBAAuB;AAC5B,SAAK,oBAAoB,WAAW,UAAU;AAC9C,SAAK,oBAAoB,SAAS,QAAQ;AAC1C,YAAQ,GAAG;;GAGb,MAAM,WAAW,OAAmB;AAClC,SAAK,oBAAoB,WAAW,UAAU;AAC9C,SAAK,oBAAoB,SAAS,QAAQ;AAC1C,WAAO,GAAG;;AAGZ,QAAK,iBAAiB,WAAW,UAAU;AAC3C,QAAK,iBAAiB,SAAS,QAAQ;IACvC;;;;;;CAOJ,MAAM,cAAc;AAClB,SAAO,IAAI,SAAuB,SAAS,WAAW;GACpD,MAAM,aAAa,OAAqB;AACtC,SAAK,oBAAoB,WAAW,UAAU;AAC9C,SAAK,oBAAoB,SAAS,QAAQ;AAC1C,YAAQ,GAAG;;GAGb,MAAM,WAAW,OAAmB;AAClC,SAAK,oBAAoB,WAAW,UAAU;AAC9C,SAAK,oBAAoB,SAAS,QAAQ;AAC1C,WAAO,GAAG;;AAGZ,QAAK,iBAAiB,WAAW,UAAU;AAC3C,QAAK,iBAAiB,SAAS,QAAQ;IACvC;;;;;;;;;;AC5JN,IAAM,mBAAN,MAAuB;;mBACT,OAAO,WAAW,eAAe,CAAC,CAAC,OAAO;;CAEtD,QAAW,KAAgC;AACzC,MAAI,CAAC,KAAK,UAAW,QAAO;EAE5B,MAAM,SAAS,OAAO,aAAa,QAAQ,IAAI;AAC/C,MAAI,WAAW,KAAM,QAAO;AAE5B,MAAI;AACF,UAAO,KAAK,MAAM,OAAO;WAClB,KAAK;AACZ,UAAO;;;CAIX,QAAQ,KAAa,KAAc;AACjC,MAAI,CAAC,KAAK,UAAW,QAAO;AAE5B,SAAO,aAAa,QAAQ,KAAK,KAAK,UAAU,IAAI,CAAC;;CAGvD,OAAO,KAAa;AAClB,MAAI,CAAC,KAAK,UAAW,QAAO;AAE5B,SAAO,aAAa,WAAW,IAAI;;CAGrC,UAAU,KAAa,OAAe;AACpC,MAAI,CAAC,KAAK,UAAW,QAAO;AAE5B,SAAO,aAAa,QAAQ,KAAK,MAAM;;CAGzC,UAAU,KAA4B;AACpC,MAAI,CAAC,KAAK,UAAW,QAAO;AAE5B,SAAO,OAAO,aAAa,QAAQ,IAAI;;;AAI3C,MAAa,mBAAmB,IAAI,kBAAkB;;;;AC7CtD,MAAM,gBAAgB;;;;;;;AAQtB,MAAM,iBAAiB;CACrB,KAAK;EACH,QAAQ,2BAA2B;EACnC,UAAU;EACX;CACD,KAAK;EACH,QAAQ,2BAA2B;EACnC,UAAU;EACX;CACD,MAAM;EACJ,QAAQ,uBAAuB;EAC/B,UAAU;EACX;CACF;;AAGD,MAAM,kBAAkB,gBAAwB;AAC9C,KAAI,YAAY,SAAS,OAAO,gBAAgB,CAAE,QAAO,eAAe;AACxE,KAAI,YAAY,SAAS,OAAO,gBAAgB,CAAE,QAAO,eAAe;AACxE,KAAI,YAAY,SAAS,cAAc,CAAE,QAAO,eAAe;AAC/D,OAAM,IAAI,MACR,kEACD;;;;;;;AAQH,MAAa,iBAAiB,OAC5B,gBAC2B;AAC3B,KAAI,OAAO,WAAW,YACpB,OAAM,IAAI,MACR,gFACD;CAGH,MAAM,cAAc,eAAe,YAAY;AAE/C,KAAI,IAAI,IAAI,YAAY,CAAC,WAAW,OAAO,SAAS,QAAQ;AAI1D,SAAO,SAAS,QAAQ;AACxB,QAAM,IAAI,MACR,qEACD;;CAMH,MAAM,EAAE,gBAAgB,MAAM,OAAO;CAErC,MAAM,cAAc,IAAI,YAAY;EAClC,QAAQ,YAAY;EACpB,UAAU,YAAY,YAAY;EAClC,kBAAkB;EAClB,qBAAqB;GACnB,UAAU;GACV,cAAc,OAAO,SAAS;GAC/B;EACF,CAAC;AAGF,KACE,OAAO,SAAS,OAAO,SAAS,QAAQ,IACxC,OAAO,SAAS,OAAO,SAAS,SAAS,EACzC;EACA,MAAM,EAAE,aAAa,MAAM,YAAY,wBAAwB;AAE/D,SAAO,QAAQ,aACb,EAAE,EACF,SAAS,OACT,UAAU,YAAY,OAAO,SAAS,SACvC;OAGD,OAAM,YAAY,mBAAmB;AAKvC,QADoB,MAAM,YAAY,kBAAkB"}