@progressive-development/pd-provider-firebase-functions 1.3.0 → 1.4.0

package/dist/visits.js

@@ -1,105 +1,147 @@
-import { createHash } from 'node:crypto';
-import { Timestamp, FieldValue } from 'firebase-admin/firestore';
-import { getDb } from './firestore.js';
-
-const DEVICES = ["phone", "tablet", "desktop"];
-const BOTS = /bot|crawl|spider|slurp|preview|monitor|headless|lighthouse|curl|wget/i;
-const ALREADY_EXISTS = 6;
+import { getDb } from "./firestore.js";
+import { FieldValue, Timestamp } from "firebase-admin/firestore";
+import { createHash } from "node:crypto";
+//#region src/visits.ts
+var DEVICES = [
+	"phone",
+	"tablet",
+	"desktop"
+];
+/** Deliberately short: this keeps out the loudest noise, it is not a bot list. */
+var BOTS = /bot|crawl|spider|slurp|preview|monitor|headless|lighthouse|curl|wget/i;
+/** Firestore ALREADY_EXISTS — a gRPC status code, not an HTTP one. */
+var ALREADY_EXISTS = 6;
+/**
+* The day as YYYY-MM-DD in the given zone.
+*
+* "sv-SE" is the shortest way to an ISO-shaped date: `toISOString()` would be
+* UTC, and building it by hand from parts is where off-by-one bugs live.
+*/
 function visitDay(now, timeZone) {
-  return new Intl.DateTimeFormat("sv-SE", { timeZone }).format(now);
+	return new Intl.DateTimeFormat("sv-SE", { timeZone }).format(now);
 }
+/** The stretch of time a visitor key stays the same. */
 function visitPeriod(day, rotate) {
-  return rotate === "month" ? day.slice(0, 7) : day;
+	return rotate === "month" ? day.slice(0, 7) : day;
 }
+/** The technical key — short enough to read, long enough not to collide. */
 function visitorKey(period, ip, userAgent, secret = "") {
-  return createHash("sha256").update(`${secret}|${period}|${ip}|${userAgent}`).digest("hex").slice(0, 16);
+	return createHash("sha256").update(`${secret}|${period}|${ip}|${userAgent}`).digest("hex").slice(0, 16);
 }
+/** Unknown values are dropped, never guessed and never stored raw. */
 function cleanDevice(value) {
-  return typeof value === "string" && DEVICES.includes(value) ? value : void 0;
+	return typeof value === "string" && DEVICES.includes(value) ? value : void 0;
 }
+/** A host, nothing else — no path, no query, no room for someone else's data. */
 function cleanReferrer(value) {
-  if (typeof value !== "string") return void 0;
-  const host = value.trim().toLowerCase();
-  return /^[a-z0-9.\-:]{1,60}$/.test(host) ? host : void 0;
+	if (typeof value !== "string") return void 0;
+	const host = value.trim().toLowerCase();
+	return /^[a-z0-9.\-:]{1,60}$/.test(host) ? host : void 0;
 }
 function isBot(userAgent) {
-  return BOTS.test(userAgent);
+	return BOTS.test(userAgent);
 }
+/**
+* Browser family and major version.
+*
+* ORDER IS THE WHOLE TRICK, because these strings quote each other: Edge says
+* Edg AND Chrome AND Safari, Chrome says Chrome AND Safari. So the most
+* specific claim wins, and Safari is asked last. On iOS every engine is
+* Safari's, but the browsers name themselves (CriOS, FxiOS) — reported as what
+* the user sees, since that is what the question is about.
+*
+* Unclassified traffic becomes "other" rather than nothing: an unreadable
+* agent is a fact worth seeing, missing data is a different fact.
+*/
 function browserOf(userAgent) {
-  const rules = [
-    ["Edge", /Edg(?:iOS|A)?\/(\d+)/],
-    ["Opera", /OPR\/(\d+)/],
-    ["Samsung Internet", /SamsungBrowser\/(\d+)/],
-    ["Chrome", /CriOS\/(\d+)/],
-    ["Firefox", /FxiOS\/(\d+)/],
-    ["Firefox", /Firefox\/(\d+)/],
-    ["Chrome", /Chrome\/(\d+)/],
-    ["Safari", /Version\/(\d+)[\d.]*\s+(?:Mobile\/\S+\s+)?Safari/]
-  ];
-  for (const [browser, pattern] of rules) {
-    const hit = pattern.exec(userAgent);
-    if (hit) return { browser, version: hit[1] };
-  }
-  return { browser: "other" };
+	for (const [browser, pattern] of [
+		["Edge", /Edg(?:iOS|A)?\/(\d+)/],
+		["Opera", /OPR\/(\d+)/],
+		["Samsung Internet", /SamsungBrowser\/(\d+)/],
+		["Chrome", /CriOS\/(\d+)/],
+		["Firefox", /FxiOS\/(\d+)/],
+		["Firefox", /Firefox\/(\d+)/],
+		["Chrome", /Chrome\/(\d+)/],
+		["Safari", /Version\/(\d+)[\d.]*\s+(?:Mobile\/\S+\s+)?Safari/]
+	]) {
+		const hit = pattern.exec(userAgent);
+		if (hit) return {
+			browser,
+			version: hit[1]
+		};
+	}
+	return { browser: "other" };
 }
+/**
+* Operating system family, never a version.
+*
+* Android carries "Linux" in its agent and an iPad in desktop mode calls
+* itself a Macintosh — so the order matters here too, and the iPad stays
+* wrong. That is a limit of the source, not something to guess around.
+*/
 function osOf(userAgent) {
-  if (/iPhone|iPad|iPod/.test(userAgent)) return "iOS";
-  if (/Android/.test(userAgent)) return "Android";
-  if (/CrOS/.test(userAgent)) return "ChromeOS";
-  if (/Windows/.test(userAgent)) return "Windows";
-  if (/Macintosh|Mac OS X/.test(userAgent)) return "macOS";
-  if (/Linux/.test(userAgent)) return "Linux";
-  return "other";
+	if (/iPhone|iPad|iPod/.test(userAgent)) return "iOS";
+	if (/Android/.test(userAgent)) return "Android";
+	if (/CrOS/.test(userAgent)) return "ChromeOS";
+	if (/Windows/.test(userAgent)) return "Windows";
+	if (/Macintosh|Mac OS X/.test(userAgent)) return "macOS";
+	if (/Linux/.test(userAgent)) return "Linux";
+	return "other";
 }
+/** No list means no restriction; an empty match means this call does not count. */
 function originAllowed(origin, allowed) {
-  if (!allowed) return true;
-  const list = Array.isArray(allowed) ? allowed : [allowed];
-  return typeof origin === "string" && list.includes(origin);
+	if (!allowed) return true;
+	return typeof origin === "string" && (Array.isArray(allowed) ? allowed : [allowed]).includes(origin);
 }
+/** First entry of x-forwarded-for; the rest are proxies. */
 function clientIp(headers) {
-  const raw = headers["x-forwarded-for"];
-  const value = Array.isArray(raw) ? raw[0] : raw;
-  if (typeof value !== "string") return void 0;
-  const first = value.split(",")[0]?.trim();
-  return first || void 0;
+	const raw = headers["x-forwarded-for"];
+	const value = Array.isArray(raw) ? raw[0] : raw;
+	if (typeof value !== "string") return void 0;
+	return value.split(",")[0]?.trim() || void 0;
 }
+/**
+* Count one visit — or recognise that this visitor was already counted today.
+*
+* Never throws for the ordinary "does not count" cases (wrong origin, bot, no
+* address, already seen): the caller is a fire-and-forget call from a page
+* that must not care.
+*/
 async function countVisit(request, visit = {}, options = {}) {
-  const headers = request.rawRequest?.headers ?? {};
-  const day = visitDay(/* @__PURE__ */ new Date(), options.timeZone ?? "UTC");
-  const skip = { counted: false, day };
-  if (!originAllowed(headers.origin, options.origin)) return skip;
-  const userAgent = typeof headers["user-agent"] === "string" ? headers["user-agent"] : "";
-  if (!userAgent || isBot(userAgent)) return skip;
-  const ip = clientIp(headers);
-  if (!ip) return skip;
-  const { browser, version } = browserOf(userAgent);
-  const period = visitPeriod(day, options.rotate ?? "day");
-  const visitor = visitorKey(period, ip, userAgent, options.secret);
-  try {
-    await getDb(options.databaseId).collection(options.collection ?? "visits").doc(`${day}_${visitor}`).create({
-      day,
-      visitor,
-      at: FieldValue.serverTimestamp(),
-      // Missing is missing: getDb ignores undefined, so an absent value
-      // leaves no empty field behind.
-      device: cleanDevice(visit.device),
-      standalone: visit.standalone === true,
-      referrer: cleanReferrer(visit.referrer),
-      // Read from the agent the server already has — the client sends
-      // nothing for these. Family and MAJOR version only; the full string
-      // stays where it cannot be read back, in the key.
-      browser,
-      browserVersion: version,
-      os: osOf(userAgent),
-      expires: options.retentionDays ? Timestamp.fromMillis(
-        Date.now() + options.retentionDays * 864e5
-      ) : void 0
-    });
-    return { counted: true, day };
-  } catch (e) {
-    if (e?.code === ALREADY_EXISTS) return skip;
-    throw e;
-  }
+	const headers = request.rawRequest?.headers ?? {};
+	const day = visitDay(/* @__PURE__ */ new Date(), options.timeZone ?? "UTC");
+	const skip = {
+		counted: false,
+		day
+	};
+	if (!originAllowed(headers.origin, options.origin)) return skip;
+	const userAgent = typeof headers["user-agent"] === "string" ? headers["user-agent"] : "";
+	if (!userAgent || isBot(userAgent)) return skip;
+	const ip = clientIp(headers);
+	if (!ip) return skip;
+	const { browser, version } = browserOf(userAgent);
+	const visitor = visitorKey(visitPeriod(day, options.rotate ?? "day"), ip, userAgent, options.secret);
+	try {
+		await getDb(options.databaseId).collection(options.collection ?? "visits").doc(`${day}_${visitor}`).create({
+			day,
+			visitor,
+			at: FieldValue.serverTimestamp(),
+			device: cleanDevice(visit.device),
+			standalone: visit.standalone === true,
+			referrer: cleanReferrer(visit.referrer),
+			browser,
+			browserVersion: version,
+			os: osOf(userAgent),
+			expires: options.retentionDays ? Timestamp.fromMillis(Date.now() + options.retentionDays * 864e5) : void 0
+		});
+		return {
+			counted: true,
+			day
+		};
+	} catch (e) {
+		if (e?.code === ALREADY_EXISTS) return skip;
+		throw e;
+	}
 }
-
+//#endregion
 export { browserOf, cleanDevice, cleanReferrer, clientIp, countVisit, isBot, originAllowed, osOf, visitDay, visitPeriod, visitorKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progressive-development/pd-provider-firebase-functions",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Firebase Functions v2 utilities for pd-spa-helper backend",
   "author": "PD Progressive Development",
   "license": "SEE LICENSE IN LICENSE",
@@ -11,19 +11,22 @@
   "exports": {
     ".": "./dist/index.js"
   },
+  "bin": {
+    "pd-prepare-functions-deploy": "./bin/prepare-functions-deploy.mjs"
+  },
   "files": [
     "dist/",
+    "bin/",
     "package.json",
     "README.md",
     "LICENSE"
   ],
-  "dependencies": {
-    "firebase-admin": "^12.6.0",
-    "firebase-functions": "^6.0.0"
+  "engines": {
+    "node": "22"
   },
   "peerDependencies": {
-    "firebase-admin": "^12.6.0",
-    "firebase-functions": "^6.0.0"
+    "firebase-admin": ">=12.6.0 <15",
+    "firebase-functions": ">=6 <8"
   },
   "keywords": [
     "pd",
@@ -33,12 +36,16 @@
     "functions",
     "backend"
   ],
+  "devDependencies": {
+    "firebase-admin": "^14.3.0",
+    "firebase-functions": "^7.3.2"
+  },
   "scripts": {
     "build": "vite build",
     "clean": "rm -rf dist",
     "clean:all": "rm -rf dist node_modules pnpm-lock.yaml",
-    "lint": "eslint --ext .ts src --ignore-path ../../.eslintignore && prettier \"**/*.ts\" --check --ignore-path ../../.eslintignore",
-    "format": "eslint --ext .ts src --fix --ignore-path ../../.eslintignore && prettier \"**/*.ts\" --write --ignore-path ../../.eslintignore",
+    "lint": "eslint src && prettier \"**/*.ts\" --check --ignore-path ../../.eslintignore",
+    "format": "eslint src --fix && prettier \"**/*.ts\" --write --ignore-path ../../.eslintignore",
     "check": "pnpm run lint && pnpm run build",
     "test": "vitest run"
   }