@redirhub/cloudflare-redirects 0.1.1 → 0.2.0

package/README.md

@@ -99,10 +99,12 @@ add your own logic, pass `origin: (request, env, ctx) => …`.
 | Option | |
 | --- | --- |
 | `settings(env)` | The rules address and the key from the Worker's bindings. Empty address: off, every request goes to the origin. |
+| `report` | `false`, or `(request) => boolean`: whether to report, over the key. Default: whenever there is a key. |
 | `origin(request, env, ctx)` | Where requests no rule answers go; default `fetch(request)`. |
 | `report404` | `rules` (default): 404s of hostnames with **Report 404 pages** on; `all`: every hostname the Worker serves. |
 | `hostname(request)` | The hostname to look up in the rules; `null` leaves the request alone (straight to the origin, nothing reported). Default the `Host` header. |
-| `path(request)` | The path the visitor asked for, percent-encoded; `null` leaves the request alone. Default the request URL's path. |
+| `path(request)` | The path to look up in the rules, percent-encoded; `null` leaves the request alone. Default the request URL's path. |
+| `location(location, request)` | The `Location` to send, from the one the rule gives; also the reported destination. |
 | `clientIp(request)` | The visitor's address in reports; default `CF-Connecting-IP`. `null` writes `-`. |
 | `userAgent(request)` | The User-Agent in reports; default the `User-Agent` header. `null` writes `-`. |
 | `anonymizeIp` | Report IPv4 with the last byte zeroed, IPv6 cut to /48. |
@@ -127,7 +129,8 @@ export default createWorker<Env>({
     const { pathname } = new URL(request.url)
     return pathname.startsWith('/api/') ? null : pathname
   },
-  userAgent: (request) => request.headers.get('user-agent'),
+  // Testing on workers.dev redirects, but is not reported.
+  report: (request) => !new URL(request.url).hostname.endsWith('.workers.dev'),
   anonymizeIp: true,
 })
 ```

package/dist/core/redirects.d.ts

@@ -13,6 +13,11 @@ export interface RedirectsOptions {
     rulesUrl: string | null | undefined;
     /** The integration key. Without it redirects work and nothing is reported. */
     key?: string | null;
+    /**
+     * Whether to report, over the key: `false` reports nothing, a function decides per request
+     * (e.g. not for preview deployments). Default: report whenever there is a key.
+     */
+    report?: boolean | ((request: Request) => boolean);
     /**
      * Which 404 answers of the site are reported (where the site's answer is seen, `afterSite`):
      * `rules` (default) for hostnames whose `@host` line has `report404`, `all` for every hostname.
@@ -32,6 +37,11 @@ export interface RedirectsOptions {
      * your code sees it, e.g. a proxy that strips a prefix.
      */
     path?: (request: Request) => string | null;
+    /**
+     * The `Location` to send, from the one the rule gives (e.g. a same-site target in the visitor's
+     * language). It is also what the report names as the destination. Default: as the rule gives it.
+     */
+    location?: (location: string, request: Request) => string;
     /**
      * The visitor's address in reports: only a value the platform sets, never a header a client can
      * forge. Null writes `-`.

package/dist/core/redirects.js

@@ -43,7 +43,7 @@ export function createRedirects(options) {
     };
     const keepAliveOf = (context) => (context ? (work) => context.waitUntil(work) : undefined);
     const report = (request, url, host, status, size, keepAlive, redirect) => {
-        if (!reporter) {
+        if (!reporter || options.report === false || (typeof options.report === 'function' && !options.report(request))) {
             return;
         }
         const ip = options.clientIp?.(request) ?? null;
@@ -61,7 +61,8 @@ export function createRedirects(options) {
         }, now()), keepAlive);
     };
     const redirect = (request, url, rules, host, rule, keepAlive) => {
-        const location = buildLocation(rule, url);
+        const target = buildLocation(rule, url);
+        const location = options.location ? options.location(target, request) : target;
         const headers = new Headers({ Location: byteString(location) });
         if (rules.poweredBy) {
             headers.set('X-Powered-By', rules.poweredBy);

package/dist/version.d.ts

@@ -1,5 +1,5 @@
 /** This package: names its log lines and the User-Agent of rules downloads and reports. */
 export declare const PACKAGE = "cloudflare-redirects";
 /** Equal to package.json's version (a test checks it). */
-export declare const VERSION = "0.1.1";
-export declare const USER_AGENT = "cloudflare-redirects/0.1.1";
+export declare const VERSION = "0.2.0";
+export declare const USER_AGENT = "cloudflare-redirects/0.2.0";

package/dist/version.js

@@ -1,5 +1,5 @@
 /** This package: names its log lines and the User-Agent of rules downloads and reports. */
 export const PACKAGE = 'cloudflare-redirects';
 /** Equal to package.json's version (a test checks it). */
-export const VERSION = '0.1.1';
+export const VERSION = '0.2.0';
 export const USER_AGENT = `${PACKAGE}/${VERSION}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redirhub/cloudflare-redirects",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Bulk redirects and 404 monitoring for Cloudflare Workers from a remote rules file: thousands of 301/302 redirects, short links and website migrations in front of your origin, live within a minute without a redeploy. RedirHub Integration Mode.",
   "keywords": [
     "cloudflare",