@prosopo/client-example-server 2.7.171 → 2.7.173

package/package.json

@@ -1,81 +1,82 @@
 {
-	"name": "@prosopo/client-example-server",
-	"version": "2.7.171",
-	"description": "Backend for client-example",
-	"main": "dist/app.js",
-	"types": "dist/app.d.ts",
-	"exports": {
-		".": {
-			"import": "./dist/index.js",
-			"require": "./dist/cjs/index.cjs",
-			"types": "./dist/app.d.ts"
-		}
-	},
-	"type": "module",
-	"engines": {
-		"node": "^24",
-		"npm": "^11"
-	},
-	"scripts": {
-		"dev": "NODE_ENV=${NODE_ENV:-development}; vite serve --mode=$NODE_ENV --config ./vite.config.ts --host",
-		"start": "NODE_ENV=${NODE_ENV:-development}; node ./dist/app.js",
-		"start:bundle": "node ./dist/bundle/prosopo_client_example_server.app.bundle.js",
-		"build": "npm run build:cross-env -- --mode ${NODE_ENV:-development}",
-		"build:cross-env": "vite build --config vite.esm.config.ts",
-		"build:tsc": "tsc --build --verbose",
-		"build:cjs": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
-		"docker-tag": "node ../../docker/docker-tag.mjs",
-		"build:docker": "docker buildx build --progress=plain --tag $(npm run --silent docker-tag) --platform linux/amd64 -f ./Dockerfile ../..",
-		"publish:docker": "docker push $(npm run --silent docker-tag)",
-		"typecheck": "tsc --project tsconfig.types.json",
-		"test": "NODE_ENV=${NODE_ENV:-test}; npx vitest run --config ./vite.test.config.ts",
-		"test:watch": "NODE_ENV=${NODE_ENV:-test}; npx vitest --config ./vite.test.config.ts",
-		"test:coverage": "NODE_ENV=${NODE_ENV:-test}; npx vitest run --coverage --config ./vite.test.config.ts",
-		"bundle": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.config.ts --mode $NODE_ENV"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/prosopo/captcha.git",
-		"directory": "demos/client-example-server"
-	},
-	"author": "PROSOPO LIMITED <info@prosopo.io>",
-	"license": "Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/prosopo/client-example-server/issues"
-	},
-	"homepage": "https://github.com/prosopo/client-example-server#readme",
-	"dependencies": {
-		"@noble/hashes": "2.4.0",
-		"@polkadot/util": "14.0.3",
-		"@polkadot/util-crypto": "14.0.3",
-		"@prosopo/common": "3.1.61",
-		"@prosopo/database": "4.1.3",
-		"@prosopo/logger": "2.1.2",
-		"@prosopo/dotenv": "3.0.59",
-		"@prosopo/keyring": "2.10.0",
-		"@prosopo/server": "2.12.14",
-		"@prosopo/types": "5.12.0",
-		"@prosopo/util": "3.3.13",
-		"@typegoose/auto-increment": "5.0.1",
-		"cors": "2.8.6",
-		"express": "4.22.2",
-		"jsonwebtoken": "9.0.3",
-		"mongodb-memory-server": "10.3.0",
-		"mongoose": "9.10.0",
-		"zod": "3.23.8"
-	},
-	"devDependencies": {
-		"@prosopo/config": "3.4.2",
-		"@types/jsonwebtoken": "9.0.10",
-		"@types/node": "22.10.2",
-		"@vitest/coverage-v8": "4.1.11",
-		"concurrently": "9.0.1",
-		"del-cli": "6.0.0",
-		"npm-run-all": "4.1.5",
-		"tslib": "2.7.0",
-		"tsx": "4.20.3",
-		"typescript": "5.6.2",
-		"vite": "8.1.5",
-		"vitest": "4.1.11"
-	}
-}
+  "name": "@prosopo/client-example-server",
+  "version": "2.7.173",
+  "description": "Backend for client-example",
+  "main": "dist/app.js",
+  "types": "dist/app.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.cjs",
+      "types": "./dist/app.d.ts"
+    }
+  },
+  "type": "module",
+  "engines": {
+    "node": "^24"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prosopo/captcha.git",
+    "directory": "demos/client-example-server"
+  },
+  "author": "PROSOPO LIMITED <info@prosopo.io>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/prosopo/client-example-server/issues"
+  },
+  "homepage": "https://github.com/prosopo/client-example-server#readme",
+  "dependencies": {
+    "@noble/hashes": "2.4.0",
+    "@polkadot/util": "14.0.3",
+    "@polkadot/util-crypto": "14.0.3",
+    "@prosopo/common": "3.1.63",
+    "@prosopo/database": "4.2.0",
+    "@prosopo/logger": "2.1.3",
+    "@prosopo/dotenv": "3.0.60",
+    "@prosopo/keyring": "2.10.2",
+    "@prosopo/server": "2.13.0",
+    "@prosopo/types": "5.14.0",
+    "@prosopo/util": "3.3.14",
+    "@typegoose/auto-increment": "5.0.1",
+    "cors": "2.8.6",
+    "express": "4.22.2",
+    "jsonwebtoken": "9.0.3",
+    "mongodb-memory-server": "10.3.0",
+    "mongoose": "9.10.0",
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "@prosopo/config": "3.4.3",
+    "@types/cors": "2.8.19",
+    "@types/express": "4.17.25",
+    "@types/jsonwebtoken": "9.0.10",
+    "@types/node": "22.10.2",
+    "@vitest/coverage-v8": "4.1.11",
+    "concurrently": "9.0.1",
+    "del-cli": "6.0.0",
+    "npm-run-all": "4.1.5",
+    "tslib": "2.7.0",
+    "tsx": "4.20.3",
+    "typescript": "5.6.2",
+    "vite": "8.1.5",
+    "vitest": "4.1.11"
+  },
+  "scripts": {
+    "dev": "NODE_ENV=${NODE_ENV:-development}; vite serve --mode=$NODE_ENV --config ./vite.config.ts --host",
+    "start": "NODE_ENV=${NODE_ENV:-development}; node ./dist/app.js",
+    "start:bundle": "node ./dist/bundle/prosopo_client_example_server.app.bundle.js",
+    "build": "pnpm run build:cross-env --mode ${NODE_ENV:-development}",
+    "build:cross-env": "vite build --config vite.esm.config.ts",
+    "build:tsc": "tsc --build --verbose",
+    "build:cjs": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
+    "docker-tag": "node ../../docker/docker-tag.mjs",
+    "build:docker": "docker buildx build --progress=plain --tag $(pnpm run --silent docker-tag) --platform linux/amd64 -f ./Dockerfile ../..",
+    "publish:docker": "docker push $(pnpm run --silent docker-tag)",
+    "typecheck": "tsc --project tsconfig.types.json",
+    "test": "NODE_ENV=${NODE_ENV:-test}; pnpm exec vitest run --config ./vite.test.config.ts",
+    "test:watch": "NODE_ENV=${NODE_ENV:-test}; pnpm exec vitest --config ./vite.test.config.ts",
+    "test:coverage": "NODE_ENV=${NODE_ENV:-test}; pnpm exec vitest run --coverage --config ./vite.test.config.ts",
+    "bundle": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.config.ts --mode $NODE_ENV"
+  }
+}

package/env.development

@@ -1,10 +0,0 @@
-PROSOPO_VERIFY_ENDPOINT=https://localhost:9235/development/siteverify
-PROSOPO_VERIFICATION_TYPE=api
-PROSOPO_SITE_KEY=5GCP69mhanZqJqnTvaaGvJCJZWSahz6xE2c7bTGETqSB5KDK
-PROSOPO_WEB2=true
-PROSOPO_SERVER_URL=https://localhost
-PROSOPO_SITE_PRIVATE_KEY=bottom drive obey lake curtain smoke basket hold race lonely fit walk
-PROSOPO_SERVER_PORT=9228
-PROSOPO_DEFAULT_ENVIRONMENT=development
-PROSOPO_MONGO_EVENTS_URI=mongodb+srv://<MONGO_URI_HERE>/frictionless_events
-_DEV_ONLY_WATCH_EVENTS=false

package/env.production

@@ -1,2 +0,0 @@
-PROSOPO_SITE_KEY=<YOUR SITE KEY HERE>
-PROSOPO_SITE_PRIVATE_KEY=<YOUR SECRET KEY HERE>

package/env.test

@@ -1,10 +0,0 @@
-PROSOPO_VERIFY_ENDPOINT=https://localhost:9235/test/siteverify
-PROSOPO_VERIFICATION_TYPE=api
-PROSOPO_SITE_KEY=5GCP69mhanZqJqnTvaaGvJCJZWSahz6xE2c7bTGETqSB5KDK
-PROSOPO_WEB2=true
-PROSOPO_SERVER_URL=https://localhost
-PROSOPO_SITE_PRIVATE_KEY=bottom drive obey lake curtain smoke basket hold race lonely fit walk
-PROSOPO_SERVER_PORT=9228
-PROSOPO_DEFAULT_ENVIRONMENT=test
-PROSOPO_MONGO_EVENTS_URI=mongodb+srv://<MONGO_URI_HERE>/frictionless_events
-_DEV_ONLY_WATCH_EVENTS=false

package/src/app.ts

@@ -1,210 +0,0 @@
-// Copyright 2021-2026 Prosopo (UK) Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import fs from "node:fs";
-import http from "node:http";
-import type { Server } from "node:http";
-import https from "node:https";
-import type { ServerOptions } from "node:https";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import { ProsopoEnvError } from "@prosopo/common";
-import { loadEnv } from "@prosopo/dotenv";
-import { getLogger } from "@prosopo/logger";
-import { getServerConfig } from "@prosopo/server";
-import type { ProsopoServerConfigOutput } from "@prosopo/types";
-import { at, isMain } from "@prosopo/util";
-import cors from "cors";
-import express from "express";
-import routesFactory from "./routes/routes.js";
-import connectionFactory from "./utils/connection.js";
-import memoryServerSetup from "./utils/database.js";
-
-export enum ProsopoVerificationType {
-	api = "api",
-	local = "local",
-}
-
-const logger = getLogger("info", "client-example-server:app");
-
-/**
- * The siteverify endpoint the deployment talks to. Non-production
- * environments get their name as a subdomain prefix. An unset NODE_ENV is
- * treated as production: prefixing it produced `undefined-api.prosopo.io`,
- * a host that does not exist.
- */
-export const resolveVerifyEndpoint = (): string => {
-	const environment = process.env.NODE_ENV;
-	const apiPrefix =
-		!environment || environment === "production" ? "" : `${environment}-`;
-	return (
-		process.env.PROSOPO_VERIFY_ENDPOINT ||
-		`https://${apiPrefix}api.prosopo.io/siteverify`
-	);
-};
-
-/** Anything the enum doesn't name falls back to the hosted API. */
-export const resolveVerifyType = (): ProsopoVerificationType =>
-	Object.keys(ProsopoVerificationType).includes(
-		process.env.PROSOPO_VERIFICATION_TYPE as string,
-	)
-		? (process.env.PROSOPO_VERIFICATION_TYPE as ProsopoVerificationType)
-		: ProsopoVerificationType.api;
-
-export const isDevelopmentOrTest = (): boolean =>
-	process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test";
-
-/** The express app, minus the routes, which need a database connection. */
-export const createApp = (): express.Express => {
-	const app = express();
-
-	// https://express-rate-limit.mintlify.app/guides/troubleshooting-proxy-issues
-	app.set("trust proxy", 1);
-
-	app.use(cors({ origin: true, credentials: true }));
-
-	app.use(express.urlencoded({ extended: true }));
-
-	app.use(express.json());
-
-	app.use((_, res, next) => {
-		res.setHeader("Access-Control-Allow-Origin", "*");
-		res.setHeader(
-			"Access-Control-Allow-Methods",
-			"GET, POST, PUT, PATCH, DELETE",
-		);
-		res.setHeader(
-			"Access-Control-Allow-Headers",
-			"Origin, Content-Type, X-Auth-Token, Authorization",
-		);
-		next();
-	});
-
-	// No explicit OPTIONS handler: cors() above already answers preflight
-	// requests with a 204 and never calls through, so the handler that used to
-	// sit here could not run.
-
-	return app;
-};
-
-export const DEFAULT_PORT = 9228;
-
-/**
- * The port is the last segment of the configured server URL. A URL without
- * one used to yield NaN, which node turns into an arbitrary free port — the
- * server came up on an address nothing was configured to talk to.
- */
-export const resolvePort = (config: ProsopoServerConfigOutput): number => {
-	if (!config.serverUrl) return DEFAULT_PORT;
-	const segments = config.serverUrl.split(":");
-	if (segments.length < 3) return DEFAULT_PORT;
-	const port = Number.parseInt(at(segments, 2));
-	return Number.isNaN(port) ? DEFAULT_PORT : port;
-};
-
-/**
- * HTTPS in development/test when the repo's certificates exist, plain HTTP
- * otherwise — in production Caddy terminates TLS.
- */
-export const startServer = (
-	app: express.Express,
-	port: number,
-	dirname: string = path.dirname(fileURLToPath(import.meta.url)),
-): Server => {
-	if (isDevelopmentOrTest()) {
-		const certsDir = path.resolve(dirname, "../../../certs");
-
-		const keyPath = path.join(certsDir, "server.key");
-		const certPath = path.join(certsDir, "server.crt");
-
-		if (fs.existsSync(keyPath) && fs.existsSync(certPath)) {
-			const httpsOptions: ServerOptions = {
-				key: fs.readFileSync(keyPath),
-				cert: fs.readFileSync(certPath),
-			};
-
-			return https.createServer(httpsOptions, app).listen(port, () => {
-				logger.info(() => ({ msg: `HTTPS server started on port ${port}` }));
-			});
-		}
-		logger.warn(() => ({
-			msg: "Certificates not found, starting HTTP server instead. Run ./setup_certs.sh to enable HTTPS in development.",
-		}));
-		return http.createServer(app).listen(port, () => {
-			logger.info(() => ({ msg: `HTTP server started on port ${port}` }));
-		});
-	}
-	return http.createServer(app).listen(port, () => {
-		logger.info(() => ({
-			msg: `HTTP server started on port ${port} (TLS handled by reverse proxy)`,
-		}));
-	});
-};
-
-export async function main(): Promise<Server> {
-	loadEnv();
-
-	const verifyEndpoint = resolveVerifyEndpoint();
-
-	logger.info(() => ({ data: { verifyEndpoint } }));
-
-	const verifyType = resolveVerifyType();
-
-	const app = createApp();
-
-	if (!process.env.MONGO_URI && !isDevelopmentOrTest()) {
-		throw new Error(
-			"Cannot run mongo memory when NODE_ENV is neither development nor test",
-		);
-	}
-	logger.info(() => ({ msg: process.env.MONGO_URI }));
-	const uri = process.env.MONGO_URI || (await memoryServerSetup());
-	logger.info(() => ({ msg: "mongo uri", data: { uri } }));
-	const mongoose = connectionFactory(uri);
-	if (!process.env.PROSOPO_SITE_PRIVATE_KEY) {
-		const mnemonicError = new ProsopoEnvError("GENERAL.MNEMONIC_UNDEFINED", {
-			context: { missingParams: ["PROSOPO_SITE_PRIVATE_KEY"] },
-			logger,
-		});
-
-		logger.error(() => ({ err: mnemonicError }));
-	}
-
-	const config = getServerConfig();
-
-	logger.info(() => ({ msg: "Config", data: { config } }));
-
-	app.use(routesFactory(mongoose, config, verifyEndpoint, verifyType));
-
-	const port = resolvePort(config);
-
-	logger.info(() => ({ msg: "Listening on port", data: { port } }));
-
-	return startServer(app, port);
-}
-
-// Only boot when run as a binary: importing this module (a test, or another
-// entrypoint reusing createApp) must not open a port or spin up mongo.
-if (isMain(import.meta.url)) {
-	main()
-		.then(() => {
-			logger.info(() => ({ msg: "Server started" }));
-		})
-		.catch((err) => {
-			logger.error(() => ({ err }));
-			// Non-zero, so a boot failure is visible to whatever supervises the
-			// process rather than reading as a clean shutdown.
-			process.exit(1);
-		});
-}