@cloudflare/pages-shared 0.0.1

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/dist/metadata-generator/constants.js

@@ -0,0 +1,13 @@
+export const REDIRECTS_VERSION = 1;
+export const HEADERS_VERSION = 2;
+export const ANALYTICS_VERSION = 1;
+export const ROUTES_JSON_VERSION = 1;
+export const PERMITTED_STATUS_CODES = /* @__PURE__ */ new Set([301, 302, 303, 307, 308]);
+export const HEADER_SEPARATOR = ":";
+export const MAX_LINE_LENGTH = 2e3;
+export const MAX_HEADER_RULES = 100;
+export const MAX_DYNAMIC_REDIRECT_RULES = 100;
+export const MAX_STATIC_REDIRECT_RULES = 2e3;
+export const UNSET_OPERATOR = "! ";
+export const SPLAT_REGEX = /\*/g;
+export const PLACEHOLDER_REGEX = /:\w+/g;

package/dist/metadata-generator/createMetadataObject.js

@@ -0,0 +1,118 @@
+import {
+  ANALYTICS_VERSION,
+  REDIRECTS_VERSION,
+  HEADERS_VERSION,
+  SPLAT_REGEX,
+  PLACEHOLDER_REGEX
+} from "./constants";
+export function createMetadataObject({
+  redirects,
+  headers,
+  webAnalyticsToken,
+  deploymentId,
+  logger = () => {
+  }
+}) {
+  return {
+    ...constructRedirects({ redirects, logger }),
+    ...constructHeaders({ headers, logger }),
+    ...constructWebAnalytics({ webAnalyticsToken, logger }),
+    deploymentId
+  };
+}
+function constructRedirects({
+  redirects,
+  logger
+}) {
+  if (!redirects)
+    return {};
+  const num_valid = redirects.rules.length;
+  const num_invalid = redirects.invalid.length;
+  logger(
+    `Parsed ${num_valid} valid redirect rule${num_valid === 1 ? "" : "s"}.`
+  );
+  if (num_invalid > 0) {
+    logger(`Found invalid redirect lines:`);
+    for (const { line, lineNumber, message } of redirects.invalid) {
+      if (line)
+        logger(`  - ${lineNumber ? `#${lineNumber}: ` : ""}${line}`);
+      logger(`    ${message}`);
+    }
+  }
+  if (num_valid === 0) {
+    return {};
+  }
+  const staticRedirects = {};
+  const dynamicRedirects = {};
+  let canCreateStaticRule = true;
+  for (const rule of redirects.rules) {
+    if (!rule.from.match(SPLAT_REGEX) && !rule.from.match(PLACEHOLDER_REGEX)) {
+      if (canCreateStaticRule) {
+        staticRedirects[rule.from] = { status: rule.status, to: rule.to };
+        continue;
+      } else {
+        logger(
+          `Info: the redirect rule ${rule.from} \u2192 ${rule.status} ${rule.to} could be made more performant by bringing it above any lines with splats or placeholders.`
+        );
+      }
+    }
+    dynamicRedirects[rule.from] = { status: rule.status, to: rule.to };
+    canCreateStaticRule = false;
+  }
+  return {
+    redirects: {
+      version: REDIRECTS_VERSION,
+      staticRules: staticRedirects,
+      rules: dynamicRedirects
+    }
+  };
+}
+function constructHeaders({
+  headers,
+  logger
+}) {
+  if (!headers)
+    return {};
+  const num_valid = headers.rules.length;
+  const num_invalid = headers.invalid.length;
+  logger(`Parsed ${num_valid} valid header rule${num_valid === 1 ? "" : "s"}.`);
+  if (num_invalid > 0) {
+    logger(`Found invalid header lines:`);
+    for (const { line, lineNumber, message } of headers.invalid) {
+      if (line)
+        logger(`  - ${lineNumber ? `#${lineNumber}: ` : ""} ${line}`);
+      logger(`    ${message}`);
+    }
+  }
+  if (num_valid === 0) {
+    return {};
+  }
+  const rules = {};
+  for (const rule of headers.rules) {
+    rules[rule.path] = {};
+    if (Object.keys(rule.headers).length) {
+      rules[rule.path].set = rule.headers;
+    }
+    if (rule.unsetHeaders.length) {
+      rules[rule.path].unset = rule.unsetHeaders;
+    }
+  }
+  return {
+    headers: {
+      version: HEADERS_VERSION,
+      rules
+    }
+  };
+}
+function constructWebAnalytics({
+  webAnalyticsToken
+}) {
+  if (!webAnalyticsToken)
+    return {};
+  return {
+    analytics: {
+      version: ANALYTICS_VERSION,
+      token: webAnalyticsToken
+    }
+  };
+}

package/dist/metadata-generator/parseHeaders.js

@@ -0,0 +1,140 @@
+import {
+  MAX_LINE_LENGTH,
+  MAX_HEADER_RULES,
+  HEADER_SEPARATOR,
+  UNSET_OPERATOR
+} from "./constants";
+import { validateUrl } from "./validateURL";
+const LINE_IS_PROBABLY_A_PATH = new RegExp(/^([^\s]+:\/\/|^\/)/);
+export function parseHeaders(input) {
+  const lines = input.split("\n");
+  const rules = [];
+  const invalid = [];
+  let rule = void 0;
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i].trim();
+    if (line.length === 0 || line.startsWith("#"))
+      continue;
+    if (line.length > MAX_LINE_LENGTH) {
+      invalid.push({
+        message: `Ignoring line ${i + 1} as it exceeds the maximum allowed length of ${MAX_LINE_LENGTH}.`
+      });
+      continue;
+    }
+    if (LINE_IS_PROBABLY_A_PATH.test(line)) {
+      if (rules.length >= MAX_HEADER_RULES) {
+        invalid.push({
+          message: `Maximum number of rules supported is ${MAX_HEADER_RULES}. Skipping remaining ${lines.length - i} lines of file.`
+        });
+        break;
+      }
+      if (rule) {
+        if (isValidRule(rule)) {
+          rules.push({
+            path: rule.path,
+            headers: rule.headers,
+            unsetHeaders: rule.unsetHeaders
+          });
+        } else {
+          invalid.push({
+            line: rule.line,
+            lineNumber: i + 1,
+            message: "No headers specified"
+          });
+        }
+      }
+      const [path, pathError] = validateUrl(line);
+      if (pathError) {
+        invalid.push({
+          line,
+          lineNumber: i + 1,
+          message: pathError
+        });
+        rule = void 0;
+        continue;
+      }
+      rule = {
+        path,
+        line,
+        headers: {},
+        unsetHeaders: []
+      };
+      continue;
+    }
+    if (!line.includes(HEADER_SEPARATOR)) {
+      if (!rule) {
+        invalid.push({
+          line,
+          lineNumber: i + 1,
+          message: "Expected a path beginning with at least one forward-slash"
+        });
+      } else {
+        if (line.trim().startsWith(UNSET_OPERATOR)) {
+          rule.unsetHeaders.push(line.trim().replace(UNSET_OPERATOR, ""));
+        } else {
+          invalid.push({
+            line,
+            lineNumber: i + 1,
+            message: "Expected a colon-separated header pair (e.g. name: value)"
+          });
+        }
+      }
+      continue;
+    }
+    const [rawName, ...rawValue] = line.split(HEADER_SEPARATOR);
+    const name = rawName.trim().toLowerCase();
+    if (name.includes(" ")) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: "Header name cannot include spaces"
+      });
+      continue;
+    }
+    const value = rawValue.join(HEADER_SEPARATOR).trim();
+    if (name === "") {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: "No header name specified"
+      });
+      continue;
+    }
+    if (value === "") {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: "No header value specified"
+      });
+      continue;
+    }
+    if (!rule) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: `Path should come before header (${name}: ${value})`
+      });
+      continue;
+    }
+    const existingValues = rule.headers[name];
+    rule.headers[name] = existingValues ? `${existingValues}, ${value}` : value;
+  }
+  if (rule) {
+    if (isValidRule(rule)) {
+      rules.push({
+        path: rule.path,
+        headers: rule.headers,
+        unsetHeaders: rule.unsetHeaders
+      });
+    } else {
+      invalid.push({ line: rule.line, message: "No headers specified" });
+    }
+  }
+  return {
+    rules,
+    invalid
+  };
+}
+function isValidRule(rule) {
+  return Object.keys(rule.headers).length > 0 || rule.unsetHeaders.length > 0;
+}

package/dist/metadata-generator/parseRedirects.js

@@ -0,0 +1,100 @@
+import {
+  MAX_LINE_LENGTH,
+  MAX_DYNAMIC_REDIRECT_RULES,
+  MAX_STATIC_REDIRECT_RULES,
+  PERMITTED_STATUS_CODES,
+  SPLAT_REGEX,
+  PLACEHOLDER_REGEX
+} from "./constants";
+import { validateUrl } from "./validateURL";
+export function parseRedirects(input) {
+  const lines = input.split("\n");
+  const rules = [];
+  const seen_paths = /* @__PURE__ */ new Set();
+  const invalid = [];
+  let staticRules = 0;
+  let dynamicRules = 0;
+  let canCreateStaticRule = true;
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i].trim();
+    if (line.length === 0 || line.startsWith("#"))
+      continue;
+    if (line.length > MAX_LINE_LENGTH) {
+      invalid.push({
+        message: `Ignoring line ${i + 1} as it exceeds the maximum allowed length of ${MAX_LINE_LENGTH}.`
+      });
+      continue;
+    }
+    const tokens = line.split(/\s+/);
+    if (tokens.length < 2 || tokens.length > 3) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: `Expected exactly 2 or 3 whitespace-separated tokens. Got ${tokens.length}.`
+      });
+      continue;
+    }
+    const [str_from, str_to, str_status = "302"] = tokens;
+    const fromResult = validateUrl(str_from, true, false, false);
+    if (fromResult[0] === void 0) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: fromResult[1]
+      });
+      continue;
+    }
+    const from = fromResult[0];
+    if (canCreateStaticRule && !from.match(SPLAT_REGEX) && !from.match(PLACEHOLDER_REGEX)) {
+      staticRules += 1;
+      if (staticRules > MAX_STATIC_REDIRECT_RULES) {
+        invalid.push({
+          message: `Maximum number of static rules supported is ${MAX_STATIC_REDIRECT_RULES}. Skipping line.`
+        });
+        continue;
+      }
+    } else {
+      dynamicRules += 1;
+      canCreateStaticRule = false;
+      if (dynamicRules > MAX_DYNAMIC_REDIRECT_RULES) {
+        invalid.push({
+          message: `Maximum number of dynamic rules supported is ${MAX_DYNAMIC_REDIRECT_RULES}. Skipping remaining ${lines.length - i} lines of file.`
+        });
+        break;
+      }
+    }
+    const toResult = validateUrl(str_to, false, true, true);
+    if (toResult[0] === void 0) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: toResult[1]
+      });
+      continue;
+    }
+    const to = toResult[0];
+    const status = Number(str_status);
+    if (isNaN(status) || !PERMITTED_STATUS_CODES.has(status)) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: `Valid status codes are 301, 302 (default), 303, 307, or 308. Got ${str_status}.`
+      });
+      continue;
+    }
+    if (seen_paths.has(from)) {
+      invalid.push({
+        line,
+        lineNumber: i + 1,
+        message: `Ignoring duplicate rule for path ${from}.`
+      });
+      continue;
+    }
+    seen_paths.add(from);
+    rules.push({ from, to, status, lineNumber: i + 1 });
+  }
+  return {
+    rules,
+    invalid
+  };
+}

package/dist/metadata-generator/validateURL.js

@@ -0,0 +1,41 @@
+export const extractPathname = (path = "/", includeSearch, includeHash) => {
+  if (!path.startsWith("/"))
+    path = `/${path}`;
+  const url = new URL(`//${path}`, "relative://");
+  return `${url.pathname}${includeSearch ? url.search : ""}${includeHash ? url.hash : ""}`;
+};
+const URL_REGEX = /^https:\/\/+(?<host>[^/]+)\/?(?<path>.*)/;
+const PATH_REGEX = /^\//;
+export const validateUrl = (token, onlyRelative = false, includeSearch = false, includeHash = false) => {
+  const host = URL_REGEX.exec(token);
+  if (host && host.groups && host.groups.host) {
+    if (onlyRelative)
+      return [
+        void 0,
+        `Only relative URLs are allowed. Skipping absolute URL ${token}.`
+      ];
+    return [
+      `https://${host.groups.host}${extractPathname(
+        host.groups.path,
+        includeSearch,
+        includeHash
+      )}`,
+      void 0
+    ];
+  } else {
+    if (!token.startsWith("/") && onlyRelative)
+      token = `/${token}`;
+    const path = PATH_REGEX.exec(token);
+    if (path) {
+      try {
+        return [extractPathname(token, includeSearch, includeHash), void 0];
+      } catch {
+        return [void 0, `Error parsing URL segment ${token}. Skipping.`];
+      }
+    }
+  }
+  return [
+    void 0,
+    onlyRelative ? "URLs should begin with a forward-slash." : 'URLs should either be relative (e.g. begin with a forward-slash), or use HTTPS (e.g. begin with "https://").'
+  ];
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@cloudflare/pages-shared",
+	"version": "0.0.1",
+	"files": [
+		"tsconfig.json",
+		"dist/**/*"
+	],
+	"scripts": {
+		"build": "node scripts/build.js",
+		"check:type": "tsc"
+	},
+	"jest": {
+		"coverageReporters": [
+			"json",
+			"html",
+			"text",
+			"cobertura"
+		],
+		"restoreMocks": true,
+		"setupFilesAfterEnv": [
+			"<rootDir>/__tests__/jest.setup.ts"
+		],
+		"testRegex": ".*.(test|spec)\\.[jt]sx?$",
+		"testTimeout": 30000,
+		"transform": {
+			"^.+\\.c?(t|j)sx?$": [
+				"esbuild-jest",
+				{
+					"sourcemap": true
+				}
+			]
+		},
+		"transformIgnorePatterns": [
+			"node_modules/(?!find-up|locate-path|p-locate|p-limit|p-timeout|p-queue|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream|get-port|supports-color|pretty-bytes)"
+		]
+	},
+	"devDependencies": {
+		"@cloudflare/workers-types": "^3.16.0",
+		"concurrently": "^7.3.0",
+		"glob": "^8.0.3"
+	}
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.json",
+	"compilerOptions": {
+		"module": "CommonJS",
+		"types": ["@cloudflare/workers-types", "jest"]
+	}
+}