@limrun/api 0.58.1 → 0.60.0

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.58.1'; // x-release-please-version
+export const VERSION = '0.60.0'; // x-release-please-version

package/tunnel-connector.d.mts

@@ -0,0 +1,77 @@
+import { type DestinationTunnelInspectionConfig, type DestinationTunnelSelectors } from "./destination-tunnel.mjs";
+import { type LogLevel } from "./tunnel.mjs";
+export interface TunnelConnectorOptions {
+    apiKey: string;
+    /** Limrun API base URL, such as https://api.limrun.com. */
+    baseURL: string;
+    organizationId: string;
+    /** The name instances set in `spec.tunnel` to attach to this connector. */
+    name: string;
+    selectors: DestinationTunnelSelectors;
+    /** 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 name; emitted once per session and control connection. */
+{
+    type: 'active';
+    sessionId: 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 the name through one control WebSocket to
+ * the Limrun API and open a destination tunnel to every instance created
+ * with `spec.tunnel` set to it. Instance tunnels stay up while the control
+ * channel reconnects, so an API outage never becomes a tunnel outage.
+ */
+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":"AAwBA,OAAO,EAGL,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAChC,iCAA6B;AAC9B,OAAO,EAAiB,KAAK,QAAQ,EAAE,qBAAiB;AAoBxD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,0BAA0B,CAAC;IACtC,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,sFAAsF;AACpF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AACvC,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;AAyCD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CAyd1E"}

package/tunnel-connector.d.ts

@@ -0,0 +1,77 @@
+import { type DestinationTunnelInspectionConfig, type DestinationTunnelSelectors } from "./destination-tunnel.js";
+import { type LogLevel } from "./tunnel.js";
+export interface TunnelConnectorOptions {
+    apiKey: string;
+    /** Limrun API base URL, such as https://api.limrun.com. */
+    baseURL: string;
+    organizationId: string;
+    /** The name instances set in `spec.tunnel` to attach to this connector. */
+    name: string;
+    selectors: DestinationTunnelSelectors;
+    /** 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 name; emitted once per session and control connection. */
+{
+    type: 'active';
+    sessionId: 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 the name through one control WebSocket to
+ * the Limrun API and open a destination tunnel to every instance created
+ * with `spec.tunnel` set to it. Instance tunnels stay up while the control
+ * channel reconnects, so an API outage never becomes a tunnel outage.
+ */
+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":"AAwBA,OAAO,EAGL,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAChC,gCAA6B;AAC9B,OAAO,EAAiB,KAAK,QAAQ,EAAE,oBAAiB;AAoBxD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,0BAA0B,CAAC;IACtC,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,sFAAsF;AACpF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AACvC,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;AAyCD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CAyd1E"}