@prosopo/provider 4.15.14 → 4.15.16

package/dist/api/metrics.js

@@ -1,260 +1,248 @@
-import { ClientApiPaths, PublicApiPaths, AdminApiPaths } from "@prosopo/types";
-import { Registry, collectDefaultMetrics, Counter, Histogram, Gauge } from "prom-client";
-const metricsEnabled = () => process.env.PROSOPO_METRICS_ENABLED !== "false";
-const PREFIX = "prosopo_";
-const LATENCY_BUCKETS = [
-  5e-3,
-  0.01,
-  0.025,
-  0.05,
-  0.1,
-  0.25,
-  0.5,
-  1,
-  2.5,
-  5,
-  10
+import { AdminApiPaths, ClientApiPaths, PublicApiPaths } from "@prosopo/types";
+import { Counter, Gauge, Histogram, Registry, collectDefaultMetrics } from "prom-client";
+//#region src/api/metrics.ts
+var metricsEnabled = () => process.env.PROSOPO_METRICS_ENABLED !== "false";
+var PREFIX = "prosopo_";
+var LATENCY_BUCKETS = [
+	.005,
+	.01,
+	.025,
+	.05,
+	.1,
+	.25,
+	.5,
+	1,
+	2.5,
+	5,
+	10
 ];
-const SCORE_BUCKETS = [
-  0,
-  0.1,
-  0.2,
-  0.3,
-  0.4,
-  0.5,
-  0.6,
-  0.7,
-  0.8,
-  0.9,
-  1,
-  1.5,
-  2,
-  3,
-  5,
-  10
+var SCORE_BUCKETS = [
+	0,
+	.1,
+	.2,
+	.3,
+	.4,
+	.5,
+	.6,
+	.7,
+	.8,
+	.9,
+	1,
+	1.5,
+	2,
+	3,
+	5,
+	10
 ];
-const KNOWN_ROUTES = /* @__PURE__ */ new Set([
-  ...Object.values(ClientApiPaths),
-  ...Object.values(PublicApiPaths),
-  ...Object.values(AdminApiPaths)
+var KNOWN_ROUTES = /* @__PURE__ */ new Set([
+	...Object.values(ClientApiPaths),
+	...Object.values(PublicApiPaths),
+	...Object.values(AdminApiPaths)
 ]);
-const normaliseRoute = (req) => {
-  const path = req.path;
-  return KNOWN_ROUTES.has(path) ? path : "other";
-};
-let metrics;
-const buildMetrics = () => {
-  const registry = new Registry();
-  collectDefaultMetrics({ register: registry, prefix: PREFIX });
-  const httpRequestsTotal = new Counter({
-    name: `${PREFIX}http_requests_total`,
-    help: "Total HTTP requests handled by the provider API",
-    labelNames: ["route", "method", "status"],
-    registers: [registry]
-  });
-  const httpRequestDuration = new Histogram({
-    name: `${PREFIX}http_request_duration_seconds`,
-    help: "Provider API request duration in seconds",
-    labelNames: ["route", "method", "status"],
-    buckets: LATENCY_BUCKETS,
-    registers: [registry]
-  });
-  const captchaIssuedTotal = new Counter({
-    name: `${PREFIX}captcha_issued_total`,
-    help: "Captcha challenges issued, by type",
-    labelNames: ["type"],
-    registers: [registry]
-  });
-  const captchaIssueErrorsTotal = new Counter({
-    name: `${PREFIX}captcha_issue_errors_total`,
-    help: "Errors while issuing captcha challenges, by type",
-    labelNames: ["type"],
-    registers: [registry]
-  });
-  const captchaVerifyTotal = new Counter({
-    name: `${PREFIX}captcha_verify_total`,
-    help: "Captcha verification outcomes, by type/result/source",
-    labelNames: ["type", "result", "source"],
-    registers: [registry]
-  });
-  const frictionlessRoutedTotal = new Counter({
-    name: `${PREFIX}frictionless_routed_total`,
-    help: "Frictionless routing decisions (which captcha the user was sent to)",
-    labelNames: ["decision"],
-    registers: [registry]
-  });
-  const botScore = new Histogram({
-    name: `${PREFIX}bot_score`,
-    help: "Distribution of frictionless bot scores (0=human .. 1=bot; language-rule penalties can push it above 1)",
-    buckets: SCORE_BUCKETS,
-    registers: [registry]
-  });
-  const detectorTriggeredTotal = new Counter({
-    name: `${PREFIX}detector_triggered_total`,
-    help: "Count of times each bot detector was triggered",
-    labelNames: ["detector"],
-    registers: [registry]
-  });
-  const blockedRequestsTotal = new Counter({
-    name: `${PREFIX}blocked_requests_total`,
-    help: "Requests blocked before reaching a captcha handler, by reason",
-    labelNames: ["reason"],
-    registers: [registry]
-  });
-  const domainValidationTotal = new Counter({
-    name: `${PREFIX}domain_validation_total`,
-    help: "Domain/site-key validation outcomes",
-    labelNames: ["result"],
-    registers: [registry]
-  });
-  const spamEmailTotal = new Counter({
-    name: `${PREFIX}spam_email_total`,
-    help: "Spam email-domain check outcomes",
-    labelNames: ["result"],
-    registers: [registry]
-  });
-  const maintenanceMode = new Gauge({
-    name: `${PREFIX}maintenance_mode`,
-    help: "1 when the provider is in maintenance mode, else 0",
-    registers: [registry]
-  });
-  maintenanceMode.set(
-    process.env.MAINTENANCE_MODE?.toLowerCase() === "true" ? 1 : 0
-  );
-  const redisReady = new Gauge({
-    name: `${PREFIX}redis_ready`,
-    help: "1 when the given redis connection is ready, else 0",
-    labelNames: ["actor"],
-    registers: [registry]
-  });
-  return {
-    registry,
-    httpRequestsTotal,
-    httpRequestDuration,
-    captchaIssuedTotal,
-    captchaIssueErrorsTotal,
-    captchaVerifyTotal,
-    frictionlessRoutedTotal,
-    botScore,
-    detectorTriggeredTotal,
-    blockedRequestsTotal,
-    domainValidationTotal,
-    spamEmailTotal,
-    maintenanceMode,
-    redisReady
-  };
-};
-const getMetrics = () => {
-  if (!metrics) {
-    metrics = buildMetrics();
-  }
-  return metrics;
-};
-const recordCaptchaIssued = (type) => {
-  if (!metricsEnabled()) return;
-  getMetrics().captchaIssuedTotal.inc({ type });
-};
-const recordCaptchaIssueError = (type) => {
-  if (!metricsEnabled()) return;
-  getMetrics().captchaIssueErrorsTotal.inc({ type });
-};
-const recordCaptchaVerify = (args) => {
-  if (!metricsEnabled()) return;
-  getMetrics().captchaVerifyTotal.inc({
-    type: args.type,
-    result: args.verified ? "verified" : "failed",
-    source: args.source
-  });
-};
-const recordFrictionlessDecision = (decision) => {
-  if (!metricsEnabled()) return;
-  getMetrics().frictionlessRoutedTotal.inc({ decision });
-};
-const recordBotScore = (score) => {
-  if (!metricsEnabled()) return;
-  getMetrics().botScore.observe(score);
-};
-const recordDetectorTriggered = (detectors) => {
-  if (!metricsEnabled()) return;
-  const m = getMetrics();
-  for (const detector of detectors) {
-    m.detectorTriggeredTotal.inc({ detector: String(detector) });
-  }
-};
-const recordBlockedRequest = (reason) => {
-  if (!metricsEnabled()) return;
-  getMetrics().blockedRequestsTotal.inc({ reason });
-};
-const recordDomainValidation = (result) => {
-  if (!metricsEnabled()) return;
-  getMetrics().domainValidationTotal.inc({ result });
-};
-const recordSpamEmail = (result) => {
-  if (!metricsEnabled()) return;
-  getMetrics().spamEmailTotal.inc({ result });
-};
-const setMaintenanceModeGauge = (on) => {
-  if (!metricsEnabled()) return;
-  getMetrics().maintenanceMode.set(on ? 1 : 0);
-};
-const metricsMiddleware = () => {
-  return (req, res, next) => {
-    if (!metricsEnabled()) return next();
-    const start = process.hrtime.bigint();
-    res.on("finish", () => {
-      const route = normaliseRoute(req);
-      const labels = {
-        route,
-        method: req.method,
-        status: String(res.statusCode)
-      };
-      const durationSeconds = Number(process.hrtime.bigint() - start) / 1e9;
-      const m = getMetrics();
-      m.httpRequestsTotal.inc(labels);
-      m.httpRequestDuration.observe(labels, durationSeconds);
-    });
-    next();
-  };
-};
-const metricsHandler = (env) => {
-  return async (req, res) => {
-    const token = process.env.PROSOPO_METRICS_TOKEN;
-    if (token && req.headers.authorization !== `Bearer ${token}`) {
-      res.status(401).send("Unauthorized");
-      return;
-    }
-    const m = getMetrics();
-    try {
-      const db = env.getDb();
-      m.redisReady.set(
-        { actor: "general" },
-        db.getRedisConnection().isReady() ? 1 : 0
-      );
-      m.redisReady.set(
-        { actor: "uap" },
-        db.getRedisAccessRulesConnection().isReady() ? 1 : 0
-      );
-    } catch {
-      m.redisReady.set({ actor: "general" }, 0);
-      m.redisReady.set({ actor: "uap" }, 0);
-    }
-    res.set("Content-Type", m.registry.contentType);
-    res.end(await m.registry.metrics());
-  };
-};
-export {
-  getMetrics,
-  metricsEnabled,
-  metricsHandler,
-  metricsMiddleware,
-  recordBlockedRequest,
-  recordBotScore,
-  recordCaptchaIssueError,
-  recordCaptchaIssued,
-  recordCaptchaVerify,
-  recordDetectorTriggered,
-  recordDomainValidation,
-  recordFrictionlessDecision,
-  recordSpamEmail,
-  setMaintenanceModeGauge
-};
+var normaliseRoute = (req) => {
+	const path = req.path;
+	return KNOWN_ROUTES.has(path) ? path : "other";
+};
+var metrics;
+var buildMetrics = () => {
+	const registry = new Registry();
+	collectDefaultMetrics({
+		register: registry,
+		prefix: PREFIX
+	});
+	const httpRequestsTotal = new Counter({
+		name: `${PREFIX}http_requests_total`,
+		help: "Total HTTP requests handled by the provider API",
+		labelNames: [
+			"route",
+			"method",
+			"status"
+		],
+		registers: [registry]
+	});
+	const httpRequestDuration = new Histogram({
+		name: `${PREFIX}http_request_duration_seconds`,
+		help: "Provider API request duration in seconds",
+		labelNames: [
+			"route",
+			"method",
+			"status"
+		],
+		buckets: LATENCY_BUCKETS,
+		registers: [registry]
+	});
+	const captchaIssuedTotal = new Counter({
+		name: `${PREFIX}captcha_issued_total`,
+		help: "Captcha challenges issued, by type",
+		labelNames: ["type"],
+		registers: [registry]
+	});
+	const captchaIssueErrorsTotal = new Counter({
+		name: `${PREFIX}captcha_issue_errors_total`,
+		help: "Errors while issuing captcha challenges, by type",
+		labelNames: ["type"],
+		registers: [registry]
+	});
+	const captchaVerifyTotal = new Counter({
+		name: `${PREFIX}captcha_verify_total`,
+		help: "Captcha verification outcomes, by type/result/source",
+		labelNames: [
+			"type",
+			"result",
+			"source"
+		],
+		registers: [registry]
+	});
+	const frictionlessRoutedTotal = new Counter({
+		name: `${PREFIX}frictionless_routed_total`,
+		help: "Frictionless routing decisions (which captcha the user was sent to)",
+		labelNames: ["decision"],
+		registers: [registry]
+	});
+	const botScore = new Histogram({
+		name: `${PREFIX}bot_score`,
+		help: "Distribution of frictionless bot scores (0=human .. 1=bot; language-rule penalties can push it above 1)",
+		buckets: SCORE_BUCKETS,
+		registers: [registry]
+	});
+	const detectorTriggeredTotal = new Counter({
+		name: `${PREFIX}detector_triggered_total`,
+		help: "Count of times each bot detector was triggered",
+		labelNames: ["detector"],
+		registers: [registry]
+	});
+	const blockedRequestsTotal = new Counter({
+		name: `${PREFIX}blocked_requests_total`,
+		help: "Requests blocked before reaching a captcha handler, by reason",
+		labelNames: ["reason"],
+		registers: [registry]
+	});
+	const domainValidationTotal = new Counter({
+		name: `${PREFIX}domain_validation_total`,
+		help: "Domain/site-key validation outcomes",
+		labelNames: ["result"],
+		registers: [registry]
+	});
+	const spamEmailTotal = new Counter({
+		name: `${PREFIX}spam_email_total`,
+		help: "Spam email-domain check outcomes",
+		labelNames: ["result"],
+		registers: [registry]
+	});
+	const maintenanceMode = new Gauge({
+		name: `${PREFIX}maintenance_mode`,
+		help: "1 when the provider is in maintenance mode, else 0",
+		registers: [registry]
+	});
+	maintenanceMode.set(process.env.MAINTENANCE_MODE?.toLowerCase() === "true" ? 1 : 0);
+	return {
+		registry,
+		httpRequestsTotal,
+		httpRequestDuration,
+		captchaIssuedTotal,
+		captchaIssueErrorsTotal,
+		captchaVerifyTotal,
+		frictionlessRoutedTotal,
+		botScore,
+		detectorTriggeredTotal,
+		blockedRequestsTotal,
+		domainValidationTotal,
+		spamEmailTotal,
+		maintenanceMode,
+		redisReady: new Gauge({
+			name: `${PREFIX}redis_ready`,
+			help: "1 when the given redis connection is ready, else 0",
+			labelNames: ["actor"],
+			registers: [registry]
+		})
+	};
+};
+var getMetrics = () => {
+	if (!metrics) metrics = buildMetrics();
+	return metrics;
+};
+var recordCaptchaIssued = (type) => {
+	if (!metricsEnabled()) return;
+	getMetrics().captchaIssuedTotal.inc({ type });
+};
+var recordCaptchaIssueError = (type) => {
+	if (!metricsEnabled()) return;
+	getMetrics().captchaIssueErrorsTotal.inc({ type });
+};
+var recordCaptchaVerify = (args) => {
+	if (!metricsEnabled()) return;
+	getMetrics().captchaVerifyTotal.inc({
+		type: args.type,
+		result: args.verified ? "verified" : "failed",
+		source: args.source
+	});
+};
+var recordFrictionlessDecision = (decision) => {
+	if (!metricsEnabled()) return;
+	getMetrics().frictionlessRoutedTotal.inc({ decision });
+};
+var recordBotScore = (score) => {
+	if (!metricsEnabled()) return;
+	getMetrics().botScore.observe(score);
+};
+var recordDetectorTriggered = (detectors) => {
+	if (!metricsEnabled()) return;
+	const m = getMetrics();
+	for (const detector of detectors) m.detectorTriggeredTotal.inc({ detector: String(detector) });
+};
+var recordBlockedRequest = (reason) => {
+	if (!metricsEnabled()) return;
+	getMetrics().blockedRequestsTotal.inc({ reason });
+};
+var recordDomainValidation = (result) => {
+	if (!metricsEnabled()) return;
+	getMetrics().domainValidationTotal.inc({ result });
+};
+var recordSpamEmail = (result) => {
+	if (!metricsEnabled()) return;
+	getMetrics().spamEmailTotal.inc({ result });
+};
+var setMaintenanceModeGauge = (on) => {
+	if (!metricsEnabled()) return;
+	getMetrics().maintenanceMode.set(on ? 1 : 0);
+};
+var metricsMiddleware = () => {
+	return (req, res, next) => {
+		if (!metricsEnabled()) return next();
+		const start = process.hrtime.bigint();
+		res.on("finish", () => {
+			const labels = {
+				route: normaliseRoute(req),
+				method: req.method,
+				status: String(res.statusCode)
+			};
+			const durationSeconds = Number(process.hrtime.bigint() - start) / 1e9;
+			const m = getMetrics();
+			m.httpRequestsTotal.inc(labels);
+			m.httpRequestDuration.observe(labels, durationSeconds);
+		});
+		next();
+	};
+};
+var metricsHandler = (env) => {
+	return async (req, res) => {
+		const token = process.env.PROSOPO_METRICS_TOKEN;
+		if (token && req.headers.authorization !== `Bearer ${token}`) {
+			res.status(401).send("Unauthorized");
+			return;
+		}
+		const m = getMetrics();
+		try {
+			const db = env.getDb();
+			m.redisReady.set({ actor: "general" }, db.getRedisConnection().isReady() ? 1 : 0);
+			m.redisReady.set({ actor: "uap" }, db.getRedisAccessRulesConnection().isReady() ? 1 : 0);
+		} catch {
+			m.redisReady.set({ actor: "general" }, 0);
+			m.redisReady.set({ actor: "uap" }, 0);
+		}
+		res.set("Content-Type", m.registry.contentType);
+		res.end(await m.registry.metrics());
+	};
+};
+//#endregion
+export { getMetrics, metricsEnabled, metricsHandler, metricsMiddleware, recordBlockedRequest, recordBotScore, recordCaptchaIssueError, recordCaptchaIssued, recordCaptchaVerify, recordDetectorTriggered, recordDomainValidation, recordFrictionlessDecision, recordSpamEmail, setMaintenanceModeGauge };

package/dist/api/public.js

@@ -1,60 +1,58 @@
-import { handleErrors } from "@prosopo/api-express-router";
+import { metricsEnabled, metricsHandler } from "./metrics.js";
 import { ProsopoApiError } from "@prosopo/common";
 import { PublicApiPaths } from "@prosopo/types";
 import { version } from "@prosopo/util";
+import { handleErrors } from "@prosopo/api-express-router";
 import express from "express";
-import { metricsEnabled, metricsHandler } from "./metrics.js";
+//#region src/api/public.ts
+/**
+* Returns a router connected to the database which can interact with the Proposo protocol
+*
+* @return {Router} - A middleware router that can interact with the Prosopo protocol
+*/
 function publicRouter(env) {
-  const router = express.Router();
-  router.get(PublicApiPaths.Healthz, (req, res) => {
-    const host = env.config.host && env.config.host.length > 0 ? env.config.host : req.hostname;
-    return res.status(200).json({ ok: true, host });
-  });
-  if (metricsEnabled()) {
-    router.get(PublicApiPaths.Metrics, metricsHandler(env));
-  }
-  router.get(PublicApiPaths.GetProviderDetails, async (req, res, next) => {
-    try {
-      const db = env.getDb();
-      const redisConnection = db.getRedisConnection();
-      const redisAccessRulesConnection = db.getRedisAccessRulesConnection();
-      const response = {
-        version,
-        message: "Provider online",
-        redis: [
-          {
-            actor: "General",
-            isReady: redisConnection.isReady(),
-            awaitingTimeSeconds: Math.ceil(
-              redisConnection.getAwaitingTimeMs() / 1e3
-            )
-          },
-          {
-            actor: "UAP",
-            isReady: redisAccessRulesConnection.isReady(),
-            awaitingTimeSeconds: Math.ceil(
-              redisAccessRulesConnection.getAwaitingTimeMs() / 1e3
-            )
-          }
-        ]
-      };
-      return res.json(response);
-    } catch (err) {
-      env.logger.error(() => ({
-        err,
-        data: { reqParams: req.params },
-        msg: "Error getting provider details"
-      }));
-      return next(
-        new ProsopoApiError("API.BAD_REQUEST", {
-          context: { code: 500 }
-        })
-      );
-    }
-  });
-  router.use(handleErrors);
-  return router;
+	const router = express.Router();
+	router.get(PublicApiPaths.Healthz, (req, res) => {
+		const host = env.config.host && env.config.host.length > 0 ? env.config.host : req.hostname;
+		return res.status(200).json({
+			ok: true,
+			host
+		});
+	});
+	if (metricsEnabled()) router.get(PublicApiPaths.Metrics, metricsHandler(env));
+	/**
+	* Gets public details of the provider
+	*/
+	router.get(PublicApiPaths.GetProviderDetails, async (req, res, next) => {
+		try {
+			const db = env.getDb();
+			const redisConnection = db.getRedisConnection();
+			const redisAccessRulesConnection = db.getRedisAccessRulesConnection();
+			const response = {
+				version,
+				message: "Provider online",
+				redis: [{
+					actor: "General",
+					isReady: redisConnection.isReady(),
+					awaitingTimeSeconds: Math.ceil(redisConnection.getAwaitingTimeMs() / 1e3)
+				}, {
+					actor: "UAP",
+					isReady: redisAccessRulesConnection.isReady(),
+					awaitingTimeSeconds: Math.ceil(redisAccessRulesConnection.getAwaitingTimeMs() / 1e3)
+				}]
+			};
+			return res.json(response);
+		} catch (err) {
+			env.logger.error(() => ({
+				err,
+				data: { reqParams: req.params },
+				msg: "Error getting provider details"
+			}));
+			return next(new ProsopoApiError("API.BAD_REQUEST", { context: { code: 500 } }));
+		}
+	});
+	router.use(handleErrors);
+	return router;
 }
-export {
-  publicRouter
-};
+//#endregion
+export { publicRouter };

package/dist/api/robotsMiddleware.js

@@ -1,12 +1,12 @@
+//#region src/api/robotsMiddleware.ts
 function robotsMiddleware() {
-  return (_req, res, next) => {
-    res.setHeader("Strict-Transport-Security", "max-age=31536000;");
-    res.setHeader("X-XSS-Protection", "1; mode=block");
-    res.setHeader("X-Frame-Options", "DENY");
-    res.setHeader("X-Robots-Tag", "none");
-    next();
-  };
+	return (_req, res, next) => {
+		res.setHeader("Strict-Transport-Security", "max-age=31536000;");
+		res.setHeader("X-XSS-Protection", "1; mode=block");
+		res.setHeader("X-Frame-Options", "DENY");
+		res.setHeader("X-Robots-Tag", "none");
+		next();
+	};
 }
-export {
-  robotsMiddleware
-};
+//#endregion
+export { robotsMiddleware };