Maintenance/workers compat

[luke-owen-crowdhandler]

No description provided.

[Copilot]

Pull request overview

Adds Cloudflare Workers (workerd) runtime compatibility to the SDK, including request-context handling and HTTP transport changes, while also centralizing CrowdHandler query parameter keys and improving redirect URL construction.

Changes:

• Add Cloudflare Workers request context support via a new CloudflareWorkersHandler and init() config option.
• Route API HTTP calls through native fetch when running in Workers, keeping axios-like error/response shapes.
• Centralize ch-* query-string keys (CH_PARAM_KEYS) and update redirect/query processing to better handle hash fragments.

Reviewed changes

Copilot reviewed 9 out of 29 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/request/requestContext.ts	Adds Workers request context switching to return a Workers-specific handler.
src/request/cloudflareWorkersHandler.ts	Introduces a Workers-native request/response handler (Request in, Response out).
src/init.ts	Adds cloudflareWorkersRequest to config and overloads; wires it into context creation and error message.
src/gatekeeper/gatekeeper.ts	Centralizes ch-param stripping via CH_PARAM_KEYS and ensures ch-params are placed before URL hash fragments.
src/common/types.ts	Adds shared CH_PARAM_KEYS constant for ch-param detection/stripping.
src/common/processURL.ts	Uses CH_PARAM_KEYS to strip ch-params from query strings.
src/client/base_client.ts	Adds Workers detection and a fetch-based HTTP path intended to avoid axios usage in Workers.
package.json	Bumps version and adds conditional exports entries (including workerd/worker).
dist/types/request/requestContext.d.ts	Updates type declarations for Workers request context.
dist/types/request/cloudflareWorkersHandler.d.ts	Adds type declarations for the new Workers handler.
dist/types/init.d.ts	Updates type declarations for cloudflareWorkersRequest config overload.
dist/types/common/types.d.ts	Exposes CH_PARAM_KEYS in generated type declarations.
dist/types/client/base_client.d.ts	Adds httpRequest to generated type declarations.
dist/request/requestContext.js	Compiled output reflecting Workers request context support.
dist/request/cloudflareWorkersHandler.js	Compiled output for the new Workers handler.
dist/init.js	Compiled output reflecting cloudflareWorkersRequest initialization support.
dist/gatekeeper/gatekeeper.js	Compiled output reflecting updated redirect URL building and param stripping.
dist/crowdhandler.umd.js	Bundled UMD output updated for v2.4.0 and Workers support logic.
dist/crowdhandler.esm.js	Bundled ESM output updated for v2.4.0 and Workers support logic.
dist/crowdhandler.cjs.js	Bundled CJS output updated for v2.4.0 and Workers support logic.
dist/common/types.js	Compiled output exporting CH_PARAM_KEYS.
dist/common/processURL.js	Compiled output using CH_PARAM_KEYS for stripping.
dist/client/base_client.js	Compiled output for fetch-based Workers HTTP routing.
README.md	Documents Workers usage and updates versioned CDN snippet and feature list.

Comments suppressed due to low confidence (1)

src/client/base_client.ts:273

• httpDELETE(path, body) ignores its body argument and does not send it in the request. This is a functional regression for callers like Resource.delete() that pass a payload (and the previous axios.delete implementation typically sent it as data). Pass body through to httpRequest() and ensure the Workers fetch path also supports a DELETE request body when body is provided.

  async httpDELETE(path: string, body: object) {
    try {
      const response = await this.httpRequest("DELETE", this.apiUrl + path, {
        headers: {
          "x-api-key": this.key,
        },
      });

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The new conditional exports for workerd/worker point to ./dist/crowdhandler.esm.js, but that bundle still has a top-level import axios from 'axios'. In Workers environments this often breaks bundling/runtime unless Node compatibility/polyfills are enabled, which contradicts the goal of “no Node polyfills required”. Consider providing a dedicated Workers ESM build that does not import axios (or lazy-loads axios only in non-Workers runtimes) and update these export conditions to reference that file.

Suggested change

	"workerd": "./dist/crowdhandler.esm.js",
	"worker": "./dist/crowdhandler.esm.js",
	"browser": "./dist/crowdhandler.umd.js",
	"import": "./dist/crowdhandler.esm.js",
	"require": "./dist/crowdhandler.cjs.js",
	"default": "./dist/crowdhandler.esm.js"
	"workerd": "./dist/crowdhandler.umd.js",
	"worker": "./dist/crowdhandler.umd.js",
	"browser": "./dist/crowdhandler.umd.js",
	"import": "./dist/crowdhandler.esm.js",
	"require": "./dist/crowdhandler.cjs.js",
	"default": "./dist/crowdhandler.umd.js"

[Copilot]

CloudflareWorkersHandler.setCookie() returns a header value string but does not actually apply it anywhere. Because Gatekeeper.setCookie() calls this.REQUEST.setCookie(...) for side effects and ignores the return value, gatekeeper.setCookie() will report success in a Workers context while not setting any cookie. Consider either making Workers setCookie() throw (to prevent silent no-ops) or updating the Gatekeeper/handler contract so Workers can surface the Set-Cookie value to the caller in a supported way.

[Copilot]

In the Workers fetch path, a timeout-triggered abort will throw (typically a DOMException with name "AbortError"), but the wrapped error you rethrow does not set an axios-like code (e.g. ECONNABORTED). As a result, createError.apiConnection() will classify SDK timeouts as generic connection failures instead of API_TIMEOUT. Consider detecting aborts (via err.name === 'AbortError' / controller.signal.aborted) and setting wrapped.code accordingly to preserve existing timeout semantics.

Suggested change

	const wrapped: any = new Error(err?.message || "Network request failed");
	const wrapped: any = new Error(err?.message || "Network request failed");
	if (controller.signal.aborted || err?.name === "AbortError") {
	wrapped.code = "ECONNABORTED";
	}

[luke-owen-crowdhandler]

@copilot

[Copilot]

@copilot

Addressed all three review comments in commit d856796:

1. workerd/worker exports — changed both conditions to ./dist/crowdhandler.umd.js. The UMD bundle already inlines the browser-compatible axios build, so no Node-only modules are pulled in when deploying to Workers.

2. base_client.ts abort handling — added controller.signal.aborted || err?.name === "AbortError" check to set wrapped.code = "ECONNABORTED" on the thrown error, so createError.apiConnection() correctly classifies Workers-path timeouts as API_TIMEOUT.

3. Gatekeeper.setCookie() silent no-op — updated the return type to boolean | string. The method now captures the return value from this.REQUEST.setCookie(): CloudflareWorkersHandler returns the Set-Cookie header string (which the caller must apply to the outgoing Response), while all other handlers return void (cookie applied as a side-effect, true returned as before). Updated JSDoc with a Workers-specific usage example.