@openclaw/gateway-client 0.0.0 → 2026.7.2-beta.4

package/dist/timeouts.d.mts

@@ -0,0 +1,39 @@
+//#region packages/gateway-client/src/timeouts.d.ts
+/** Maximum delay Node timers can represent without overflow warnings. */
+declare const MAX_SAFE_TIMEOUT_DELAY_MS = 2147483647;
+/** Default server-side window for gateway preauth handshakes. */
+declare const DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS = 15000;
+/** Default deadline for a single non-streaming Gateway request. */
+declare const DEFAULT_GATEWAY_REQUEST_TIMEOUT_MS = 30000;
+/** Minimum client watchdog delay for connect challenge setup. */
+declare const MIN_CONNECT_CHALLENGE_TIMEOUT_MS = 250;
+/** Default maximum client watchdog delay, aligned with the preauth server timeout. */
+declare const MAX_CONNECT_CHALLENGE_TIMEOUT_MS = 15000;
+/** Clamps arbitrary timer delays to Node's safe range and an optional floor. */
+declare function resolveSafeTimeoutDelayMs(delayMs: number, opts?: {
+  minMs?: number;
+}): number;
+/** Adds grace time while preserving safe timer bounds if inputs overflow or are invalid. */
+declare function addSafeTimeoutDelayGraceMs(delayMs: number, graceMs: number, opts?: {
+  minMs?: number;
+}): number;
+/** Resolves optional timeout values through a fallback and safe timer clamp. */
+declare function resolveFiniteTimeoutDelayMs(delayMs: number | null | undefined, fallbackMs: number, opts?: {
+  minMs?: number;
+}): number;
+/** Clamps connect challenge watchdog timeouts to the gateway-supported range. */
+declare function clampConnectChallengeTimeoutMs(timeoutMs: number, maxTimeoutMs?: number): number;
+/** Reads the connect challenge watchdog override from the process environment. */
+declare function getConnectChallengeTimeoutMsFromEnv(env?: NodeJS.ProcessEnv): number | undefined;
+/** Resolves the client watchdog timeout using explicit, env, then preauth defaults. */
+declare function resolveConnectChallengeTimeoutMs(timeoutMs?: number | null, params?: {
+  env?: NodeJS.ProcessEnv;
+  configuredTimeoutMs?: number | null;
+}): number;
+/** Resolves the server preauth timeout from env, explicit config, or default. */
+declare function resolvePreauthHandshakeTimeoutMs(params?: {
+  env?: NodeJS.ProcessEnv;
+  configuredTimeoutMs?: number | null;
+}): number;
+//#endregion
+export { DEFAULT_GATEWAY_REQUEST_TIMEOUT_MS, DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS, MAX_CONNECT_CHALLENGE_TIMEOUT_MS, MAX_SAFE_TIMEOUT_DELAY_MS, MIN_CONNECT_CHALLENGE_TIMEOUT_MS, addSafeTimeoutDelayGraceMs, clampConnectChallengeTimeoutMs, getConnectChallengeTimeoutMsFromEnv, resolveConnectChallengeTimeoutMs, resolveFiniteTimeoutDelayMs, resolvePreauthHandshakeTimeoutMs, resolveSafeTimeoutDelayMs };

package/dist/timeouts.mjs

@@ -0,0 +1,77 @@
+//#region packages/gateway-client/src/timeouts.ts
+function parseStrictPositiveInteger(value) {
+	const trimmed = value.trim();
+	if (!/^\+?\d+$/u.test(trimmed)) return;
+	const parsed = Number(trimmed);
+	return Number.isSafeInteger(parsed) && parsed > 0 ? parsed : void 0;
+}
+function isTestRuntimeEnv(env) {
+	return env.VITEST === "true" || env.VITEST === "1" || env.VITEST_POOL_ID !== void 0 || env.VITEST_WORKER_ID !== void 0 || env.NODE_ENV === "test" || env !== process.env && (process.env.VITEST === "true" || process.env.VITEST === "1" || process.env.VITEST_POOL_ID !== void 0 || process.env.VITEST_WORKER_ID !== void 0 || false);
+}
+/** Maximum delay Node timers can represent without overflow warnings. */
+const MAX_SAFE_TIMEOUT_DELAY_MS = 2147483647;
+/** Default server-side window for gateway preauth handshakes. */
+const DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS = 15e3;
+/** Default deadline for a single non-streaming Gateway request. */
+const DEFAULT_GATEWAY_REQUEST_TIMEOUT_MS = 3e4;
+/** Minimum client watchdog delay for connect challenge setup. */
+const MIN_CONNECT_CHALLENGE_TIMEOUT_MS = 250;
+/** Default maximum client watchdog delay, aligned with the preauth server timeout. */
+const MAX_CONNECT_CHALLENGE_TIMEOUT_MS = DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS;
+/** Clamps arbitrary timer delays to Node's safe range and an optional floor. */
+function resolveSafeTimeoutDelayMs(delayMs, opts) {
+	const rawMinMs = opts?.minMs ?? 1;
+	const minMs = Math.min(MAX_SAFE_TIMEOUT_DELAY_MS, Math.max(0, Number.isFinite(rawMinMs) ? Math.floor(rawMinMs) : 1));
+	return Math.min(MAX_SAFE_TIMEOUT_DELAY_MS, Math.max(minMs, Number.isFinite(delayMs) ? Math.floor(delayMs) : minMs));
+}
+/** Adds grace time while preserving safe timer bounds if inputs overflow or are invalid. */
+function addSafeTimeoutDelayGraceMs(delayMs, graceMs, opts) {
+	if (!Number.isFinite(delayMs) || !Number.isFinite(graceMs)) return resolveSafeTimeoutDelayMs(MAX_SAFE_TIMEOUT_DELAY_MS, opts);
+	const withGrace = delayMs + graceMs;
+	return resolveSafeTimeoutDelayMs(Number.isFinite(withGrace) ? withGrace : MAX_SAFE_TIMEOUT_DELAY_MS, opts);
+}
+/** Resolves optional timeout values through a fallback and safe timer clamp. */
+function resolveFiniteTimeoutDelayMs(delayMs, fallbackMs, opts) {
+	return resolveSafeTimeoutDelayMs(typeof delayMs === "number" && Number.isFinite(delayMs) ? delayMs : fallbackMs, opts);
+}
+/** Clamps connect challenge watchdog timeouts to the gateway-supported range. */
+function clampConnectChallengeTimeoutMs(timeoutMs, maxTimeoutMs = MAX_CONNECT_CHALLENGE_TIMEOUT_MS) {
+	return Math.max(250, Math.min(Math.max(250, maxTimeoutMs), timeoutMs));
+}
+/** Reads the connect challenge watchdog override from the process environment. */
+function getConnectChallengeTimeoutMsFromEnv(env = process.env) {
+	const raw = env.OPENCLAW_CONNECT_CHALLENGE_TIMEOUT_MS;
+	if (raw) {
+		const parsed = parseStrictPositiveInteger(raw);
+		if (parsed !== void 0) return resolveSafeTimeoutDelayMs(parsed);
+	}
+}
+function normalizePositiveTimeoutMs(timeoutMs) {
+	return typeof timeoutMs === "number" && Number.isFinite(timeoutMs) && timeoutMs > 0 ? resolveSafeTimeoutDelayMs(timeoutMs) : void 0;
+}
+/** Resolves the client watchdog timeout using explicit, env, then preauth defaults. */
+function resolveConnectChallengeTimeoutMs(timeoutMs, params) {
+	const configuredPreauthTimeoutMs = resolvePreauthHandshakeTimeoutMs({
+		env: params?.env,
+		configuredTimeoutMs: params?.configuredTimeoutMs
+	});
+	const maxTimeoutMs = Math.max(DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS, configuredPreauthTimeoutMs);
+	if (typeof timeoutMs === "number" && Number.isFinite(timeoutMs)) return clampConnectChallengeTimeoutMs(timeoutMs, maxTimeoutMs);
+	const envOverride = getConnectChallengeTimeoutMsFromEnv(params?.env);
+	if (envOverride !== void 0) return clampConnectChallengeTimeoutMs(envOverride, Math.max(maxTimeoutMs, envOverride));
+	return clampConnectChallengeTimeoutMs(configuredPreauthTimeoutMs, maxTimeoutMs);
+}
+/** Resolves the server preauth timeout from env, explicit config, or default. */
+function resolvePreauthHandshakeTimeoutMs(params) {
+	const env = params?.env ?? process.env;
+	const configuredTimeout = env.OPENCLAW_HANDSHAKE_TIMEOUT_MS || (isTestRuntimeEnv(env) ? env.OPENCLAW_TEST_HANDSHAKE_TIMEOUT_MS : void 0);
+	if (configuredTimeout) {
+		const parsed = parseStrictPositiveInteger(configuredTimeout);
+		if (parsed !== void 0) return resolveSafeTimeoutDelayMs(parsed);
+	}
+	const configured = normalizePositiveTimeoutMs(params?.configuredTimeoutMs);
+	if (configured !== void 0) return configured;
+	return DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS;
+}
+//#endregion
+export { DEFAULT_GATEWAY_REQUEST_TIMEOUT_MS, DEFAULT_PREAUTH_HANDSHAKE_TIMEOUT_MS, MAX_CONNECT_CHALLENGE_TIMEOUT_MS, MAX_SAFE_TIMEOUT_DELAY_MS, MIN_CONNECT_CHALLENGE_TIMEOUT_MS, addSafeTimeoutDelayGraceMs, clampConnectChallengeTimeoutMs, getConnectChallengeTimeoutMsFromEnv, resolveConnectChallengeTimeoutMs, resolveFiniteTimeoutDelayMs, resolvePreauthHandshakeTimeoutMs, resolveSafeTimeoutDelayMs };

package/npm-shrinkwrap.json

@@ -0,0 +1,50 @@
+{
+  "name": "@openclaw/gateway-client",
+  "version": "2026.7.2-beta.4",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@openclaw/gateway-client",
+      "version": "2026.7.2-beta.4",
+      "license": "MIT",
+      "dependencies": {
+        "ipaddr.js": "2.4.0",
+        "ws": "8.21.1"
+      },
+      "engines": {
+        "node": ">=22.19.0"
+      }
+    },
+    "node_modules/ipaddr.js": {
+      "version": "2.4.0",
+      "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.4.0.tgz",
+      "integrity": "sha512-9VGk3HGanVE6JoZXHiCpnGy5X0jYDnN4EA4lntFPj+1vIWlFhIylq2CrrCOJH9EAhc5CYhq18F2Av2tgoAPsYQ==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/ws": {
+      "version": "8.21.1",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.21.1.tgz",
+      "integrity": "sha512-+0NTnW77fFN/DjQi6k/Sq/Yvk4Sgajw7urW8V+asjXnRgDs9gyGkdb7EzgfhA4goXsRIZKE28fzIXBHEzhuiWw==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": ">=5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,11 +1,74 @@
 {
   "name": "@openclaw/gateway-client",
-  "version": "0.0.0",
-  "description": "Reserved package name for the OpenClaw Gateway client.",
+  "version": "2026.7.2-beta.4",
+  "description": "Reference WebSocket client for the OpenClaw Gateway protocol",
+  "keywords": [
+    "client",
+    "gateway",
+    "openclaw",
+    "websocket"
+  ],
+  "homepage": "https://github.com/openclaw/openclaw#readme",
+  "bugs": {
+    "url": "https://github.com/openclaw/openclaw/issues"
+  },
+  "license": "MIT",
+  "author": "OpenClaw Foundation (https://openclaw.org)",
   "repository": {
     "type": "git",
-    "url": "https://github.com/openclaw/openclaw"
+    "url": "git+https://github.com/openclaw/openclaw.git",
+    "directory": "packages/gateway-client"
   },
-  "license": "MIT",
-  "private": false
-}
+  "files": [
+    "dist",
+    "npm-shrinkwrap.json",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.mts",
+      "import": "./dist/browser.mjs",
+      "default": "./dist/browser.mjs"
+    },
+    "./readiness": {
+      "types": "./dist/readiness.d.mts",
+      "import": "./dist/readiness.mjs",
+      "default": "./dist/readiness.mjs"
+    },
+    "./timeouts": {
+      "types": "./dist/timeouts.d.mts",
+      "import": "./dist/timeouts.mjs",
+      "default": "./dist/timeouts.mjs"
+    }
+  },
+  "dependencies": {
+    "ipaddr.js": "2.4.0",
+    "ws": "8.21.1",
+    "@openclaw/gateway-protocol": "2026.7.2-beta.4"
+  },
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "openclaw": {
+    "release": {
+      "publishToNpm": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts src/browser.ts src/readiness.ts src/timeouts.ts --no-config --platform node --format esm --dts --out-dir dist --clean"
+  }
+}