@limrun/api 0.59.0 → 0.61.0

package/src/tunnel.ts

@@ -1281,13 +1281,15 @@ async function startMultiplexedTcpTunnel(
   });
 }
 
-export const isNonRetryableError = (errMessage: string): boolean => {
+/** HTTP status of a refused WebSocket upgrade, as ws reports it in the error message. */
+export function upgradeStatus(errMessage: string): number | undefined {
   const match = errMessage.match(/Unexpected server response: (\d+)/);
-  if (match && match[1]) {
-    const statusCode = parseInt(match[1], 10);
-    return statusCode >= 400 && statusCode < 500;
-  }
-  return false;
+  return match?.[1] ? parseInt(match[1], 10) : undefined;
+}
+
+export const isNonRetryableError = (errMessage: string): boolean => {
+  const status = upgradeStatus(errMessage);
+  return status !== undefined && status >= 400 && status < 500;
 };
 
 export function assertPort(port: number, name: string, min: number, max: number): void {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.59.0'; // x-release-please-version
+export const VERSION = '0.61.0'; // x-release-please-version

package/tunnel-connector.d.mts

@@ -0,0 +1,88 @@
+import { type DestinationTunnelInspectionConfig } from "./destination-tunnel.mjs";
+import { type LogLevel } from "./tunnel.mjs";
+export interface TunnelConnectorOptions {
+    /** The tunnel's own key, or an admin's credential. */
+    apiKey: string;
+    /** Limrun API base URL, such as https://api.limrun.com. */
+    baseURL: string;
+    organizationId: string;
+    /**
+     * The ID of a tunnel created in the console or the API. Its name, which
+     * instances set in `spec.tunnel`, and its selectors come from the platform.
+     */
+    tunnelId: string;
+    /** Inspection for every instance tunnel. Defaults to enabled without bodies. */
+    inspection?: Partial<DestinationTunnelInspectionConfig>;
+    /** Take the name over from the connector that holds it now. */
+    replace?: boolean;
+    /** Identifies this connector to the platform. Defaults to the OS hostname. */
+    hostname?: string;
+    /** Reported to the platform. Defaults to the SDK version. */
+    clientVersion?: string;
+    /** Log level of the per-instance tunnels. Defaults to 'warn'. */
+    logLevel?: LogLevel;
+    onEvent?: (event: TunnelConnectorEvent) => void;
+}
+export type TunnelConnectorEvent = 
+/** This connector holds the tunnel; emitted once per session and control connection. */
+{
+    type: 'active';
+    sessionId: string;
+    name: string;
+}
+/** The connector's key expires within two weeks; emitted once a day until it does. */
+ | {
+    type: 'keyExpiring';
+    expiresAt: string;
+}
+/** Another connector holds the name; emitted once per holder. */
+ | {
+    type: 'standby';
+    holder: {
+        hostname: string;
+        since?: string;
+    };
+} | {
+    type: 'attached';
+    instanceId: string;
+    tunnelId: string;
+}
+/** The connector gave up on the instance. */
+ | {
+    type: 'attachFailed';
+    instanceId: string;
+    code: string;
+    message: string;
+} | {
+    type: 'detached';
+    instanceId: string;
+    reason: string;
+} | {
+    type: 'notice';
+    code: string;
+    message: string;
+    instanceId?: string;
+}
+/** The control channel, or the tunnel of `instanceId`, retries after `delayMs`. */
+ | {
+    type: 'reconnecting';
+    instanceId?: string;
+    delayMs: number;
+    reason: string;
+};
+export interface TunnelConnector {
+    /** Resolves after close() and rejects with the terminal error that ended the connector. */
+    closed: Promise<void>;
+    /** Releases the name at once, closes every instance tunnel, and resolves when done. */
+    close: () => Promise<void>;
+}
+/**
+ * Serve a persistent tunnel: hold it through one control WebSocket to the
+ * Limrun API and open a destination tunnel to every instance created with
+ * `spec.tunnel` set to its name, with a short-lived token the API hands out
+ * for each. Instance tunnels stay up while the control channel reconnects,
+ * so an API outage never becomes a tunnel outage; one that drops re-dials
+ * once the API sends a fresh token.
+ */
+export declare function runTunnel(options: TunnelConnectorOptions): TunnelConnector;
+//# sourceMappingURL=tunnel-connector.d.mts.map

package/tunnel-connector.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnel-connector.d.mts","sourceRoot":"","sources":["src/tunnel-connector.ts"],"names":[],"mappings":"AA0BA,OAAO,EAGL,KAAK,iCAAiC,EAEvC,iCAA6B;AAC9B,OAAO,EAAiB,KAAK,QAAQ,EAAE,qBAAiB;AAyBxD,MAAM,WAAW,sBAAsB;IACrC,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;IACxD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;CACjD;AAED,MAAM,MAAM,oBAAoB;AAC9B,wFAAwF;AACtF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AACrD,sFAAsF;GACpF;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AAC5C,iEAAiE;GAC/D;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjE;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;AAC5D,6CAA6C;GAC3C;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE;AACxE,mFAAmF;GACjF;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,uFAAuF;IACvF,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAoDD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CA+gB1E"}

package/tunnel-connector.d.ts

@@ -0,0 +1,88 @@
+import { type DestinationTunnelInspectionConfig } from "./destination-tunnel.js";
+import { type LogLevel } from "./tunnel.js";
+export interface TunnelConnectorOptions {
+    /** The tunnel's own key, or an admin's credential. */
+    apiKey: string;
+    /** Limrun API base URL, such as https://api.limrun.com. */
+    baseURL: string;
+    organizationId: string;
+    /**
+     * The ID of a tunnel created in the console or the API. Its name, which
+     * instances set in `spec.tunnel`, and its selectors come from the platform.
+     */
+    tunnelId: string;
+    /** Inspection for every instance tunnel. Defaults to enabled without bodies. */
+    inspection?: Partial<DestinationTunnelInspectionConfig>;
+    /** Take the name over from the connector that holds it now. */
+    replace?: boolean;
+    /** Identifies this connector to the platform. Defaults to the OS hostname. */
+    hostname?: string;
+    /** Reported to the platform. Defaults to the SDK version. */
+    clientVersion?: string;
+    /** Log level of the per-instance tunnels. Defaults to 'warn'. */
+    logLevel?: LogLevel;
+    onEvent?: (event: TunnelConnectorEvent) => void;
+}
+export type TunnelConnectorEvent = 
+/** This connector holds the tunnel; emitted once per session and control connection. */
+{
+    type: 'active';
+    sessionId: string;
+    name: string;
+}
+/** The connector's key expires within two weeks; emitted once a day until it does. */
+ | {
+    type: 'keyExpiring';
+    expiresAt: string;
+}
+/** Another connector holds the name; emitted once per holder. */
+ | {
+    type: 'standby';
+    holder: {
+        hostname: string;
+        since?: string;
+    };
+} | {
+    type: 'attached';
+    instanceId: string;
+    tunnelId: string;
+}
+/** The connector gave up on the instance. */
+ | {
+    type: 'attachFailed';
+    instanceId: string;
+    code: string;
+    message: string;
+} | {
+    type: 'detached';
+    instanceId: string;
+    reason: string;
+} | {
+    type: 'notice';
+    code: string;
+    message: string;
+    instanceId?: string;
+}
+/** The control channel, or the tunnel of `instanceId`, retries after `delayMs`. */
+ | {
+    type: 'reconnecting';
+    instanceId?: string;
+    delayMs: number;
+    reason: string;
+};
+export interface TunnelConnector {
+    /** Resolves after close() and rejects with the terminal error that ended the connector. */
+    closed: Promise<void>;
+    /** Releases the name at once, closes every instance tunnel, and resolves when done. */
+    close: () => Promise<void>;
+}
+/**
+ * Serve a persistent tunnel: hold it through one control WebSocket to the
+ * Limrun API and open a destination tunnel to every instance created with
+ * `spec.tunnel` set to its name, with a short-lived token the API hands out
+ * for each. Instance tunnels stay up while the control channel reconnects,
+ * so an API outage never becomes a tunnel outage; one that drops re-dials
+ * once the API sends a fresh token.
+ */
+export declare function runTunnel(options: TunnelConnectorOptions): TunnelConnector;
+//# sourceMappingURL=tunnel-connector.d.ts.map

package/tunnel-connector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnel-connector.d.ts","sourceRoot":"","sources":["src/tunnel-connector.ts"],"names":[],"mappings":"AA0BA,OAAO,EAGL,KAAK,iCAAiC,EAEvC,gCAA6B;AAC9B,OAAO,EAAiB,KAAK,QAAQ,EAAE,oBAAiB;AAyBxD,MAAM,WAAW,sBAAsB;IACrC,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;IACxD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;CACjD;AAED,MAAM,MAAM,oBAAoB;AAC9B,wFAAwF;AACtF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AACrD,sFAAsF;GACpF;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AAC5C,iEAAiE;GAC/D;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjE;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;AAC5D,6CAA6C;GAC3C;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE;AACxE,mFAAmF;GACjF;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,uFAAuF;IACvF,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAoDD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CA+gB1E"}