@revenexx/integrations-node-sdk 1.11.0 → 1.14.0

package/dist/types.d.ts

@@ -3,7 +3,31 @@ export type LocalizedString = string | Record<string, string>;
 export type DataType = 'any' | 'object' | 'array' | 'string' | 'number' | 'boolean';
 export type OutputKind = 'default' | 'branch' | 'error';
 export type NodeCategory = 'trigger' | 'action' | 'transform' | 'control' | 'io';
-export type ConfigType = 'string' | 'number' | 'boolean' | 'select' | 'multiselect' | 'object' | 'array' | 'expression' | 'secret-ref' | 'credentials-ref' | 'state-ref' | 'dynamic-schema';
+export type ConfigType = 'string' | 'number' | 'boolean' | 'select' | 'multiselect' | 'object' | 'array' | 'expression' | 'secret-ref' | 'credentials-ref' | 'state-ref' | 'dynamic-schema' | 'vpn-route';
+/**
+ * What a node receives at run time for a `vpn-route` setting (PO-831).
+ *
+ * The editor stores `{ connection: string; route: string }`, or `null` (or no
+ * value) for the public internet. Before `execute`, the worker replaces a stored
+ * reference with the route as it stands now, so the node never resolves it
+ * itself; a connection that is not active fails the step as `VPN_UNAVAILABLE`,
+ * one that is gone as `VPN_ROUTE_MISSING` (see `VPN_ERROR_CODES`). A setting left
+ * on the public internet stays `null` or absent.
+ */
+export interface ResolvedVpnRoute {
+    /** The VPN connection's name. */
+    connection: string;
+    /** The route's name within that connection. */
+    route: string;
+    kind: 'http' | 'tcp';
+    /**
+     * Where the run reaches the route: for `http` a base URL
+     * (`http://10.31.0.7:8080/sap-odata/`), for `tcp` a `host:port`
+     * (`10.31.0.7:20001`). The address is on the run's allow-list, so
+     * `safeFetch` reaches it although it is private.
+     */
+    endpoint: string;
+}
 /**
  * Semantic category of an image, driving how the registry/CDN organises and
  * displays it.
@@ -48,6 +72,12 @@ export interface IOutputField {
 export interface IOutputPort {
     kind: OutputKind;
     dataType: DataType;
+    /**
+     * The port's name, as a branch and an edge refer to it. Lowercase kebab-case —
+     * `not-found`, never `notFound` — because the registry refuses anything else
+     * on upload and `rvnxx-nodes manifest` stops on it (`SLUG_PATTERN`). A setting's
+     * `key` may be camelCase; a port name may not.
+     */
     name?: string;
     label?: LocalizedString;
     description?: LocalizedString;
@@ -71,6 +101,7 @@ export interface IOutputPort {
      */
     resolveOutputs?: boolean;
     fallback?: {
+        /** Lowercase kebab-case, as {@link IOutputPort.name}. */
         name: string;
         label?: LocalizedString;
         description?: LocalizedString;
@@ -186,6 +217,15 @@ export interface IConfigFieldBase {
      * the node whose config names it.
      */
     stateRole?: 'mapping' | 'cursor' | 'dedupe' | 'digest';
+    /**
+     * Only meaningful when `type === 'vpn-route'`: which kind of route the picker
+     * offers (PO-831) — `http` for a node that sends HTTP requests through the
+     * relay's proxy, `tcp` for one that opens a socket. Defaults to `'http'`.
+     *
+     * **Accepted by the registry only once integrations#406 is deployed** — until
+     * then a package declaring it is refused on upload.
+     */
+    routeKind?: 'http' | 'tcp';
 }
 export interface IConfigField extends IConfigFieldBase {
     /**
@@ -504,6 +544,29 @@ export interface ICredentialDescription {
     images?: IImage[];
     authKind: CredentialAuthKind;
     fields: ICredentialField[];
+    /**
+     * Which of this type's fields a VPN route replaces (PO-829). A type without it
+     * cannot be routed through a VPN, and the studio offers no choice.
+     *
+     * - `tcp` — the route's relay address and port replace the `hostField` and
+     *   `portField` values (both keys of `fields`).
+     * - `http` — the route's endpoint replaces the base of the `urlField` value,
+     *   keeping any path the author typed after it.
+     *
+     * The stored configuration is never rewritten; the platform substitutes the
+     * route's current endpoint each time the credential is tested or resolved.
+     *
+     * **Accepted by the registry only once integrations#406 is deployed** — until
+     * then a package declaring it is refused on upload.
+     */
+    network?: {
+        kind: 'tcp';
+        hostField: string;
+        portField: string;
+    } | {
+        kind: 'http';
+        urlField: string;
+    };
 }
 /**
  * Runtime context handed to a credential's `test`/`resolve`. Runs in the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenexx/integrations-node-sdk",
-  "version": "1.11.0",
+  "version": "1.14.0",
   "description": "TypeScript interfaces and utilities for Revenexx integration nodes",
   "license": "MIT",
   "author": "revenexx GmbH",
@@ -63,6 +63,7 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "ipaddr.js": "2.5.0"
+    "ipaddr.js": "2.5.0",
+    "undici": "6.29.1"
   }
 }