@wandelbots/nova-js 3.9.0-pr.280.641b7e2 → 3.9.0-pr.280.74e07a8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wandelbots/nova-js",
   "type": "module",
-  "version": "3.9.0-pr.280.641b7e2",
+  "version": "3.9.0-pr.280.74e07a8",
   "description": "Official JS client for the Wandelbots API",
   "sideEffects": false,
   "packageManager": "pnpm@11.1.3+sha512.c85357fe17ca12dd23dd7071822666dfd7e3cb76fe214e3370b5ea2fb34f2a231185509b63e717f3cd0acb38dd3f8d82bcd5e8172400ae678b70ea4fbed0896d",
@@ -74,6 +74,7 @@
     "mobx": "^6.15.0",
     "path-to-regexp": "^8.4.0",
     "reconnecting-websocket": "^4.4.0",
-    "three": "^0.183.2"
+    "three": "^0.183.2",
+    "url-join": "^5.0.0"
   }
 }

package/src/lib/deprecated/v1/NovaClient.ts

@@ -6,11 +6,11 @@
 import type { Configuration as BaseConfiguration } from "@wandelbots/nova-api/v1"
 import type { AxiosRequestConfig } from "axios"
 import axios, { isAxiosError } from "axios"
+import urlJoin from "url-join"
 import { loginWithAuth0 } from "../../../LoginWithAuth0.js"
 import { AutoReconnectingWebsocket } from "../../AutoReconnectingWebsocket.js"
 import { availableStorage } from "../../availableStorage.js"
 import { parseNovaInstanceUrl } from "../../converters.js"
-
 import { ConnectedMotionGroup } from "./ConnectedMotionGroup.js"
 import { JoggerConnection } from "./JoggerConnection.js"
 import { MotionStreamConnection } from "./MotionStreamConnection.js"
@@ -45,6 +45,7 @@ export type NovaClientConfig = {
 
   /**
    * Access token for Bearer authentication.
+   * @deprecated use accessToken instead
    */
   accessToken?: string
 } & Omit<BaseConfiguration, "isJsonMime" | "basePath">
@@ -81,7 +82,7 @@ export class NovaClient {
 
     // Set up Axios instance with interceptor for token fetching
     const axiosInstance = axios.create({
-      baseURL: new URL("/api/v1", this.config.instanceUrl).href,
+      baseURL: urlJoin(this.config.instanceUrl, "/api/v1"),
       // TODO - backend needs to set proper CORS headers for this
       headers:
         typeof window !== "undefined" &&
@@ -143,7 +144,7 @@ export class NovaClient {
 
     this.api = new NovaCellAPIClient(cellId, {
       ...config,
-      basePath: new URL("/api/v1", this.instanceUrl).href,
+      basePath: urlJoin(this.instanceUrl.href, "/api/v1"),
       isJsonMime: (mime: string) => {
         return mime === "application/json"
       },
@@ -192,10 +193,11 @@ export class NovaClient {
 
   makeWebsocketURL(path: string): string {
     const url = new URL(
-      new URL(
-        `/api/v1/cells/${this.config.cellId}/${path.replace(/^\/+/, "")}`,
-        this.instanceUrl,
-      ).href,
+      urlJoin(
+        this.instanceUrl.href,
+        `/api/v1/cells/${this.config.cellId}`,
+        path,
+      ),
     )
     url.protocol = url.protocol.replace("http", "ws")
     url.protocol = url.protocol.replace("https", "wss")

package/src/lib/deprecated/v2/NovaClient.ts

@@ -2,11 +2,11 @@
 import type { Configuration as BaseConfiguration } from "@wandelbots/nova-api/v2"
 import type { AxiosRequestConfig } from "axios"
 import axios, { isAxiosError } from "axios"
+import urlJoin from "url-join"
 import { loginWithAuth0 } from "../../../LoginWithAuth0"
 import { AutoReconnectingWebsocket } from "../../AutoReconnectingWebsocket"
 import { availableStorage } from "../../availableStorage"
 import { parseNovaInstanceUrl } from "../../converters"
-
 import { MockNovaInstance } from "../../v2/mock/MockNovaInstance"
 import { NovaCellAPIClient } from "./NovaCellAPIClient"
 
@@ -74,7 +74,7 @@ export class NovaClient {
 
     // Set up Axios instance with interceptor for token fetching
     const axiosInstance = axios.create({
-      baseURL: new URL("/api/v2", this.instanceUrl).href,
+      baseURL: urlJoin(this.instanceUrl.href, "/api/v2"),
       // TODO - backend needs to set proper CORS headers for this
       headers:
         typeof window !== "undefined" &&
@@ -136,7 +136,7 @@ export class NovaClient {
 
     this.api = new NovaCellAPIClient(cellId, {
       ...config,
-      basePath: new URL("/api/v2", this.instanceUrl).href,
+      basePath: urlJoin(this.instanceUrl.href, "/api/v2"),
       isJsonMime: (mime: string) => {
         return mime === "application/json"
       },
@@ -184,10 +184,11 @@ export class NovaClient {
 
   makeWebsocketURL(path: string): string {
     const url = new URL(
-      new URL(
-        `/api/v2/cells/${this.config.cellId}/${path.replace(/^\/+/, "")}`,
-        this.instanceUrl,
-      ).href,
+      urlJoin(
+        this.instanceUrl.href,
+        `/api/v2/cells/${this.config.cellId}`,
+        path,
+      ),
     )
     url.protocol = url.protocol.replace("http", "ws")
     url.protocol = url.protocol.replace("https", "wss")

package/src/lib/v2/Nova.ts

@@ -1,6 +1,7 @@
 import type { Configuration as BaseConfiguration } from "@wandelbots/nova-api/v2"
 import type { AxiosRequestConfig } from "axios"
 import axios, { isAxiosError } from "axios"
+import urlJoin from "url-join"
 import { loginWithAuth0 } from "../../LoginWithAuth0"
 import { AutoReconnectingWebsocket } from "../AutoReconnectingWebsocket"
 import { availableStorage } from "../availableStorage"
@@ -49,7 +50,7 @@ export class Nova {
 
     // Set up Axios instance with interceptor for token fetching
     const axiosInstance = axios.create({
-      baseURL: new URL("/api/v2", this.instanceUrl).href,
+      baseURL: urlJoin(this.instanceUrl.href, "/api/v2"),
       // TODO - backend needs to set proper CORS headers for this
       headers:
         typeof window !== "undefined" &&
@@ -111,7 +112,7 @@ export class Nova {
 
     this.api = new NovaAPIClient({
       ...config,
-      basePath: new URL("/api/v2", this.instanceUrl).href,
+      basePath: urlJoin(this.instanceUrl.href, "/api/v2"),
       isJsonMime: (mime: string) => {
         return mime === "application/json"
       },
@@ -161,7 +162,7 @@ export class Nova {
   }
 
   makeWebsocketURL(path: string): string {
-    const url = new URL(`/api/v2/${path.replace(/^\/+/, "")}`, this.instanceUrl)
+    const url = new URL(urlJoin(this.instanceUrl.href, `/api/v2`, path))
     url.protocol = url.protocol.replace("http", "ws")
     url.protocol = url.protocol.replace("https", "wss")
 

package/src/lib/v2/NovaAPIClient.ts

@@ -2,33 +2,7 @@ import type {
   BaseAPI,
   Configuration as BaseConfiguration,
 } from "@wandelbots/nova-api/v2"
-import {
-  ApplicationApi,
-  BUSInputsOutputsApi,
-  CellApi,
-  ControllerApi,
-  ControllerInputsOutputsApi,
-  JoggingApi,
-  KinematicsApi,
-  LicenseApi,
-  MotionGroupApi,
-  MotionGroupModelsApi,
-  NOVACloudApi,
-  ProgramApi,
-  RobotConfigurationsApi,
-  SessionApi,
-  StoreCollisionComponentsApi,
-  StoreCollisionSetupsApi,
-  StoreObjectApi,
-  SystemApi,
-  TrajectoryCachingApi,
-  TrajectoryExecutionApi,
-  TrajectoryPlanningApi,
-  VersionApi,
-  VirtualControllerApi,
-  VirtualControllerBehaviorApi,
-  VirtualControllerInputsOutputsApi,
-} from "@wandelbots/nova-api/v2"
+import * as novaApiV2 from "@wandelbots/nova-api/v2"
 import type { AxiosInstance } from "axios"
 import axios from "axios"
 
@@ -43,12 +17,71 @@ type WithUnwrappedAxiosResponse<T> = {
   [P in keyof T]: UnwrapAxiosResponseReturn<T[P]>
 }
 
+/**
+ * Filters nova-api/v2 exports to just the API class constructors,
+ * excluding helper factories and param creators.
+ */
+type ApiConstructors = {
+  [K in keyof typeof novaApiV2 as K extends `${string}Api`
+    ? K extends
+        | `${string}Factory${string}`
+        | `${string}Fp${string}`
+        | `${string}ParamCreator${string}`
+      ? never
+      : K
+    : never]: (typeof novaApiV2)[K]
+}
+
+/**
+ * Lowercases leading uppercase characters to produce a camelCase property name.
+ * e.g. "BUSInputsOutputs" -> "busInputsOutputs", "NOVACloud" -> "novaCloud",
+ *      "Application" -> "application"
+ */
+type CamelCase<S extends string> =
+  S extends `${Uppercase<infer A>}${Uppercase<infer B>}${infer Rest}`
+    ? Rest extends `${Lowercase<string>}${string}`
+      ? `${Lowercase<A>}${CamelCase<`${Uppercase<B>}${Rest}`>}`
+      : `${Lowercase<A>}${CamelCase<`${Uppercase<B>}${Rest}`>}`
+    : Uncapitalize<S>
+
+/**
+ * Maps API class names to property names by stripping "Api" and converting
+ * the leading acronym to lowercase camelCase.
+ */
+type ApiProperties = {
+  readonly [K in keyof ApiConstructors as K extends `${infer P}Api`
+    ? CamelCase<P>
+    : never]: ApiConstructors[K] extends new (
+    // biome-ignore lint/suspicious/noExplicitAny: needed for contravariant parameter matching
+    ...args: any[]
+  ) => infer I
+    ? WithUnwrappedAxiosResponse<I>
+    : never
+}
+
 type NovaAPIClientOpts = BaseConfiguration & {
   axiosInstance?: AxiosInstance
   mock?: boolean
 }
 
-function unwrap<T extends BaseAPI>(
+function isApiClass(
+  name: string,
+  value: unknown,
+): value is new (
+  config: BaseConfiguration,
+  basePath: string,
+  axios: AxiosInstance,
+) => BaseAPI {
+  return (
+    name.endsWith("Api") &&
+    typeof value === "function" &&
+    !name.includes("Factory") &&
+    !name.includes("Fp") &&
+    !name.includes("ParamCreator")
+  )
+}
+
+function wrapApi<T extends BaseAPI>(
   ApiConstructor: new (
     config: BaseConfiguration,
     basePath: string,
@@ -82,64 +115,43 @@ function unwrap<T extends BaseAPI>(
 
 /**
  * API client providing type-safe access to all the endpoints of a NOVA
- * instance.
+ * instance. API sections are auto-discovered from @wandelbots/nova-api/v2
+ * at runtime, so new sections added upstream are exposed automatically.
  */
-export class NovaAPIClient {
+export const NovaAPIClient = class NovaAPIClient {
   readonly opts: NovaAPIClientOpts
 
-  readonly application: WithUnwrappedAxiosResponse<ApplicationApi>
-  readonly busIOs: WithUnwrappedAxiosResponse<BUSInputsOutputsApi>
-  readonly cell: WithUnwrappedAxiosResponse<CellApi>
-  readonly controller: WithUnwrappedAxiosResponse<ControllerApi>
-  readonly controllerIOs: WithUnwrappedAxiosResponse<ControllerInputsOutputsApi>
-  readonly jogging: WithUnwrappedAxiosResponse<JoggingApi>
-  readonly kinematics: WithUnwrappedAxiosResponse<KinematicsApi>
-  readonly license: WithUnwrappedAxiosResponse<LicenseApi>
-  readonly motionGroup: WithUnwrappedAxiosResponse<MotionGroupApi>
-  readonly motionGroupModels: WithUnwrappedAxiosResponse<MotionGroupModelsApi>
-  readonly novaCloud: WithUnwrappedAxiosResponse<NOVACloudApi>
-  readonly program: WithUnwrappedAxiosResponse<ProgramApi>
-  readonly robotConfigurations: WithUnwrappedAxiosResponse<RobotConfigurationsApi>
-  readonly session: WithUnwrappedAxiosResponse<SessionApi>
-  readonly storeCollisionComponents: WithUnwrappedAxiosResponse<StoreCollisionComponentsApi>
-  readonly storeCollisionSetups: WithUnwrappedAxiosResponse<StoreCollisionSetupsApi>
-  readonly storeObject: WithUnwrappedAxiosResponse<StoreObjectApi>
-  readonly system: WithUnwrappedAxiosResponse<SystemApi>
-  readonly trajectoryCaching: WithUnwrappedAxiosResponse<TrajectoryCachingApi>
-  readonly trajectoryExecution: WithUnwrappedAxiosResponse<TrajectoryExecutionApi>
-  readonly trajectoryPlanning: WithUnwrappedAxiosResponse<TrajectoryPlanningApi>
-  readonly version: WithUnwrappedAxiosResponse<VersionApi>
-  readonly virtualController: WithUnwrappedAxiosResponse<VirtualControllerApi>
-  readonly virtualControllerBehavior: WithUnwrappedAxiosResponse<VirtualControllerBehaviorApi>
-  readonly virtualControllerIOs: WithUnwrappedAxiosResponse<VirtualControllerInputsOutputsApi>
-
   constructor(opts: NovaAPIClientOpts) {
     this.opts = opts
 
-    this.application = unwrap(ApplicationApi, opts)
-    this.busIOs = unwrap(BUSInputsOutputsApi, opts)
-    this.cell = unwrap(CellApi, opts)
-    this.controller = unwrap(ControllerApi, opts)
-    this.controllerIOs = unwrap(ControllerInputsOutputsApi, opts)
-    this.jogging = unwrap(JoggingApi, opts)
-    this.kinematics = unwrap(KinematicsApi, opts)
-    this.license = unwrap(LicenseApi, opts)
-    this.motionGroup = unwrap(MotionGroupApi, opts)
-    this.motionGroupModels = unwrap(MotionGroupModelsApi, opts)
-    this.novaCloud = unwrap(NOVACloudApi, opts)
-    this.program = unwrap(ProgramApi, opts)
-    this.robotConfigurations = unwrap(RobotConfigurationsApi, opts)
-    this.session = unwrap(SessionApi, opts)
-    this.storeCollisionComponents = unwrap(StoreCollisionComponentsApi, opts)
-    this.storeCollisionSetups = unwrap(StoreCollisionSetupsApi, opts)
-    this.storeObject = unwrap(StoreObjectApi, opts)
-    this.system = unwrap(SystemApi, opts)
-    this.trajectoryCaching = unwrap(TrajectoryCachingApi, opts)
-    this.trajectoryExecution = unwrap(TrajectoryExecutionApi, opts)
-    this.trajectoryPlanning = unwrap(TrajectoryPlanningApi, opts)
-    this.version = unwrap(VersionApi, opts)
-    this.virtualController = unwrap(VirtualControllerApi, opts)
-    this.virtualControllerBehavior = unwrap(VirtualControllerBehaviorApi, opts)
-    this.virtualControllerIOs = unwrap(VirtualControllerInputsOutputsApi, opts)
+    for (const [name, value] of Object.entries(novaApiV2)) {
+      if (isApiClass(name, value)) {
+        const stripped = name.slice(0, -3)
+        // Lowercase leading acronym run: "BUSInputsOutputs" -> "busInputsOutputs"
+        let i = 0
+        while (
+          i < stripped.length &&
+          stripped[i] === stripped[i].toUpperCase() &&
+          stripped[i] !== stripped[i].toLowerCase()
+        ) {
+          i++
+        }
+        // If multiple uppercase chars, keep the last one uppercase (it starts the next word)
+        const boundary = i > 1 ? i - 1 : i
+        const propName =
+          stripped.slice(0, boundary).toLowerCase() + stripped.slice(boundary)
+        // biome-ignore lint/suspicious/noExplicitAny: dynamically assigning discovered API properties
+        ;(this as any)[propName] = wrapApi(value, opts)
+      }
+    }
+  }
+} as {
+  new (
+    opts: NovaAPIClientOpts,
+  ): ApiProperties & {
+    readonly cellId: string
+    readonly opts: NovaAPIClientOpts
   }
 }
+
+export type NovaAPIClient = InstanceType<typeof NovaAPIClient>