@raisenow/tamaro-cli 3.1.0 → 3.2.0-dev.1

package/README.md

@@ -282,7 +282,19 @@ pnpx @raisenow/tamaro-cli update-epms --tag WEB-123
 
 ## `validate`
 
-Validate the current configuration and fail on known issues such as invalid email templates.
+Validate the current configuration and fail on known issues such as:
+
+- Invalid email templates
+- Invalid `organisation_email` / `blind_copy` values in `email-config/parameters.yaml`
+- Invalid `.env` values
+- RaiseNow-generated tax receipts enabled without an uploaded organisation template
+
+When `autogeneratedDonationReceiptEnabled` (or
+`autogenerated_donation_receipt_enabled`) is `true`, this command authenticates
+with EPMS (browser login or client credentials) and checks that a donation
+tax-receipt PDF template exists for each configured account. See the
+[Confluence guide](https://raisenow.atlassian.net/wiki/spaces/PD/pages/6231687230/Tamaro+CLI+Commands#Tax-receipt-validation--how-CS-resolves-it)
+for how to resolve a failed check.
 
 ### Example
 

package/dist/cli.js

@@ -12,9 +12,9 @@ import ky from "ky";
 import { createServer } from "node:http";
 import open from "open";
 import { globSync } from "glob";
+import { codeFrameColumns } from "@babel/code-frame";
 import Handlebars from "handlebars";
 import helpers from "handlebars-helpers";
-import { codeFrameColumns } from "@babel/code-frame";
 import { config, parse } from "dotenv";
 import { getPortPromise } from "portfinder";
 import prompts from "prompts";
@@ -280,6 +280,8 @@ var EpmsClient = class EpmsClient {
 	#cacheKey;
 	#epmsClient;
 	#authType;
+	/** In-memory account UUID → organisation UUID cache for this client instance. */
+	#organisationIdByAccountUuid = /* @__PURE__ */ new Map();
 	/**
 	* Creates an instance of EpmsClient.
 	*
@@ -308,14 +310,24 @@ var EpmsClient = class EpmsClient {
 		return this.#epmsClient.get("users/myself").json().then((response) => myselfSchema.parse(response));
 	}
 	async getOrganisationIdByAccountUuid(accountUuid) {
+		const cached = this.#organisationIdByAccountUuid.get(accountUuid);
+		if (cached) return cached;
 		try {
 			const organisationUuid = (await this.#epmsClient.get(`accounts/${accountUuid}`).json()).organisation.uuid;
 			if (!organisationUuid) throw new Error("Organisation UUID not found in response");
+			this.#organisationIdByAccountUuid.set(accountUuid, organisationUuid);
 			return organisationUuid;
 		} catch (error) {
 			throw new Error(`Organisation UUID not found for account UUID: ${accountUuid}`, { cause: error });
 		}
 	}
+	async listOrganisationFiles(organisationUuid) {
+		try {
+			return await this.#epmsClient.get(`organisations/${organisationUuid}/files`).json();
+		} catch (error) {
+			throw new Error(`Failed to list organisation files for organisation UUID: ${organisationUuid}`, { cause: error });
+		}
+	}
 	async updateTamaro(configName, tag, json) {
 		return this.#epmsClient.put(`products/tamaro/${configName}/tags/${tag}`, { json }).json();
 	}
@@ -443,6 +455,99 @@ const assertArchiveTargetDoesNotExist = (archiveTarget) => {
 	if (fs.existsSync(archiveTarget)) halt(`Archive target already exists: ${archiveTarget}. Please remove it first.`);
 };
 //#endregion
+//#region src/lib/validators/validateDonationReceiptTemplates.ts
+/** Internal docs validation guide for CS */
+const DONATION_RECEIPT_VALIDATION_GUIDE_URL = "https://raisenow.atlassian.net/wiki/spaces/PD/pages/6231687230/Tamaro+CLI+Commands#Donation-tax-receipts";
+const FLAG_KEYS = ["autogeneratedDonationReceiptEnabled", "autogenerated_donation_receipt_enabled"];
+/**
+* Resolve which config.yml key enabled RaiseNow-generated donation tax
+* receipts. Supports both camelCase and snake_case keys used in customer
+* configs; returns undefined when the option is not strictly `true`.
+*/
+const isAutogeneratedDonationReceiptEnabled = (rawConfig) => {
+	if (!rawConfig || typeof rawConfig !== "object") return;
+	const config = rawConfig;
+	for (const key of FLAG_KEYS) if (config[key] === true) return key;
+};
+/**
+* Check that a donation tax receipt PDF template exists for the account in
+* the organisation files list. Matches Hub storage layout:
+* `{accountUuid}/donation-receipt-templates/{language}.pdf`
+*/
+const donationReceiptTemplateExists = (files, accountUuid) => {
+	const prefix = `${accountUuid}/donation-receipt-templates/`;
+	return files.some((file) => file.name.startsWith(prefix) && file.name.endsWith(".pdf") && file.name.slice(prefix.length).length > 0 && !file.name.slice(prefix.length).includes("/"));
+};
+/**
+* Locate the line of a top-level `key:` assignment in the config.yml source,
+* so the error can be rendered as a code frame pointing at the value.
+*/
+const findKeyLocation$2 = (source, key) => {
+	const lines = source.split("\n");
+	const assignment = new RegExp(String.raw`^\s*${key}\s*:`);
+	const index = lines.findIndex((line) => assignment.test(line));
+	if (index === -1) return;
+	const line = index + 1;
+	const valueStart = lines[index].indexOf(":") + 1;
+	return {
+		end: {
+			column: lines[index].length,
+			line
+		},
+		start: {
+			column: valueStart + 1,
+			line
+		}
+	};
+};
+/**
+* Format an error for a `key:` assignment as a code frame pointing at the
+* value, so it looks fancy like this:
+*
+* config.yml:51
+* 50 | show_stored_customer_donation_receipt: true
+* 51 | autogeneratedDonationReceiptEnabled: true
+*    |                                      ^^^^ No donation tax receipt PDF template found…
+*/
+const formatError$2 = (configYmlPath, source, key, message) => {
+	const location = findKeyLocation$2(source, key);
+	if (!location) return `${configYmlPath}: ${key}: ${message}`;
+	const frame = codeFrameColumns(source, location, {
+		forceColor: true,
+		highlightCode: true,
+		message
+	});
+	return `\n${configYmlPath}:${location.start.line}\n${frame}`;
+};
+/**
+* Validate that RaiseNow-generated tax receipts are only enabled when each
+* configured EPMS account has a donation tax receipt PDF template uploaded.
+*/
+const validateDonationReceiptTemplates = async (configYmlPath) => {
+	if (!fs.existsSync(configYmlPath)) return [];
+	const source = fs.readFileSync(configYmlPath, "utf8");
+	const flagKey = isAutogeneratedDonationReceiptEnabled(yaml.load(source));
+	if (!flagKey) return [];
+	const { accountUuidProd, accountUuidStage } = loadTamaroMetadataFromConfig(configYmlPath);
+	const errors = [];
+	const environments = [{
+		accountUuid: accountUuidStage,
+		env: "stage",
+		label: "Stage"
+	}, {
+		accountUuid: accountUuidProd,
+		env: "prod",
+		label: "Prod"
+	}];
+	for (const { accountUuid, env, label } of environments) {
+		if (!accountUuid) continue;
+		const epmsClient = epmsAuthenticate(env);
+		const organisationUuid = await epmsClient.getOrganisationIdByAccountUuid(accountUuid);
+		if (!donationReceiptTemplateExists(await epmsClient.listOrganisationFiles(organisationUuid), accountUuid)) errors.push(formatError$2(configYmlPath, source, flagKey, `No donation tax receipt PDF template found for the ${label} account (${accountUuid}). See: ${DONATION_RECEIPT_VALIDATION_GUIDE_URL}`));
+	}
+	return errors;
+};
+//#endregion
 //#region src/lib/validators/validateEmailTemplates.ts
 /**
 * Register custom Handlebars helpers - the same, which are used in the Email Service.
@@ -579,7 +684,7 @@ const coreVersionExists = async (version) => {
 * Locate the line of a `KEY=` assignment in the .env source, so the error can
 * be rendered as a code frame pointing at the value.
 */
-const findKeyLocation = (source, key) => {
+const findKeyLocation$1 = (source, key) => {
 	const lines = source.split("\n");
 	const assignment = new RegExp(String.raw`^\s*${key}\s*=`);
 	const index = lines.findIndex((line) => assignment.test(line));
@@ -606,8 +711,8 @@ const findKeyLocation = (source, key) => {
 * 2 | CORE_URL_PATTERN=adsf
 *   |                  ^^^^ Must contain the "{{version}}" placeholder
 */
-const formatError = (dotEnvPath, source, key, message) => {
-	const location = findKeyLocation(source, key);
+const formatError$1 = (dotEnvPath, source, key, message) => {
+	const location = findKeyLocation$1(source, key);
 	if (!location) return `${dotEnvPath}: ${key}: ${message}`;
 	const frame = codeFrameColumns(source, location, {
 		forceColor: true,
@@ -628,16 +733,117 @@ const validateEnv = async (dotEnvPath) => {
 		const errors = [];
 		for (const issue of result.error.issues) {
 			const keys = issue.code === "unrecognized_keys" ? issue.keys : [String(issue.path[0] ?? "")];
-			for (const key of keys) errors.push(formatError(dotEnvPath, source, key, issue.message));
+			for (const key of keys) errors.push(formatError$1(dotEnvPath, source, key, issue.message));
 		}
 		return errors;
 	}
 	if (parsed.CORE_VERSION) {
-		if (await coreVersionExists(parsed.CORE_VERSION) === false) return [formatError(dotEnvPath, source, "CORE_VERSION", `Version "${parsed.CORE_VERSION}" does not exist. See all versions at https://www.npmjs.com/package/@raisenow/tamaro-core?activeTab=versions`)];
+		if (await coreVersionExists(parsed.CORE_VERSION) === false) return [formatError$1(dotEnvPath, source, "CORE_VERSION", `Version "${parsed.CORE_VERSION}" does not exist. See all versions at https://www.npmjs.com/package/@raisenow/tamaro-core?activeTab=versions`)];
 	}
 	return [];
 };
 //#endregion
+//#region src/lib/validators/validateParametersYaml.ts
+/** Email-valued keys checked in `email-config/parameters.yaml` when set. */
+const EMAIL_KEYS = ["organisation_email", "blind_copy"];
+const emailSchema = z.email();
+/**
+* Bare `key:`, YAML null, or blank strings are common in customer configs and
+* must not fail validation.
+*/
+const isUnsetEmailValue = (value) => value == void 0 || typeof value === "string" && value.trim() === "";
+/**
+* Locate a `key: value` assignment in the YAML source so the error can be
+* rendered as a code frame pointing at the value.
+*
+* Prefers a key+value match so repeated keys across locales (`all` / `de` /
+* `en`, …) point at the right line; falls back to the first key match.
+*/
+const findKeyLocation = (source, key, value) => {
+	const lines = source.split("\n");
+	let index = -1;
+	if (value !== void 0) {
+		const escapedValue = value.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`);
+		const assignment = new RegExp(String.raw`^\s*${key}\s*:\s*['"]?${escapedValue}['"]?\s*(?:#.*)?$`);
+		index = lines.findIndex((line) => assignment.test(line));
+	}
+	if (index === -1) {
+		const keyOnly = new RegExp(String.raw`^\s*${key}\s*:`);
+		index = lines.findIndex((line) => keyOnly.test(line));
+	}
+	if (index === -1) return;
+	const line = index + 1;
+	const valueStart = lines[index].indexOf(":") + 1;
+	return {
+		end: {
+			column: lines[index].length,
+			line
+		},
+		start: {
+			column: valueStart + 1,
+			line
+		}
+	};
+};
+/**
+* Format an error for a `key:` assignment as a code frame pointing at the
+* value, so it looks fancy like this:
+*
+* email-config/parameters.yaml:3
+* 2 |   organisation_name: Example
+* 3 |   organisation_email: not-an-email
+*   |                       ^^^^^^^^^^^^ Invalid email address
+*/
+const formatError = (parametersPath, source, key, message, value) => {
+	const location = findKeyLocation(source, key, value);
+	if (!location) return `${parametersPath}: ${key}: ${message}`;
+	const frame = codeFrameColumns(source, location, {
+		forceColor: true,
+		highlightCode: true,
+		message
+	});
+	return `\n${parametersPath}:${location.start.line}\n${frame}`;
+};
+/**
+* Validate `organisation_email` and `blind_copy` under each locale block
+* (`all`, `de`, `en`, …) in `email-config/parameters.yaml`.
+*
+* Unset values are allowed; non-empty values must be valid email addresses.
+*/
+const validateParametersYaml = (parametersPath) => {
+	if (!fs.existsSync(parametersPath)) return [];
+	const source = fs.readFileSync(parametersPath, "utf8");
+	let parsed;
+	try {
+		parsed = yaml.load(source);
+	} catch (error) {
+		return [`${parametersPath}: Invalid YAML: ${error instanceof Error ? error.message : String(error)}`];
+	}
+	if (parsed == void 0) return [];
+	if (typeof parsed !== "object" || Array.isArray(parsed)) return [`${parametersPath}: Expected a mapping of locale blocks (e.g. \`all\`), got ${Array.isArray(parsed) ? "an array" : typeof parsed}`];
+	const errors = [];
+	for (const [locale, block] of Object.entries(parsed)) {
+		if (block == void 0) continue;
+		if (typeof block !== "object" || Array.isArray(block)) {
+			errors.push(`${parametersPath}: ${locale}: Expected a mapping of parameters, got ${Array.isArray(block) ? "an array" : typeof block}`);
+			continue;
+		}
+		const parameters = block;
+		for (const key of EMAIL_KEYS) {
+			if (!(key in parameters)) continue;
+			const value = parameters[key];
+			if (isUnsetEmailValue(value)) continue;
+			if (typeof value !== "string") {
+				errors.push(formatError(parametersPath, source, key, "Must be a string email address"));
+				continue;
+			}
+			const result = emailSchema.safeParse(value);
+			if (!result.success) errors.push(formatError(parametersPath, source, key, result.error.issues[0]?.message ?? "Invalid email address", value));
+		}
+	}
+	return errors;
+};
+//#endregion
 //#region src/commands/validate.ts
 /**
 * Validates the current Tamaro configuration to avoid common errors.
@@ -647,7 +853,12 @@ const validateEnv = async (dotEnvPath) => {
 * deployed.
 */
 const validate = async () => {
-	const errors = [...await validateEnv(".env"), ...validateEmailTemplates(globSync("email-config/templates/**/*.hbs").toSorted())];
+	const errors = [
+		...await validateEnv(".env"),
+		...validateEmailTemplates(globSync("email-config/templates/**/*.hbs").toSorted()),
+		...validateParametersYaml("email-config/parameters.yaml"),
+		...await validateDonationReceiptTemplates("config.yml")
+	];
 	if (errors.length > 0) {
 		logError("❌ Validation failed with the following errors:");
 		console.log(errors.map((el) => el.toString()).join("\n"));
@@ -1324,7 +1535,7 @@ const promptBucketTamaroEmailConfig = async () => {
 //#endregion
 //#region package.json
 var name = "@raisenow/tamaro-cli";
-var version = "3.1.0";
+var version = "3.2.0-dev.1";
 //#endregion
 //#region src/cli.ts
 const cli = createCommand().name(name).description("CLI for Tamaro Customer Configurations development").version(version, "-v, --version");

package/package.json

@@ -1,17 +1,30 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "3.1.0",
+  "version": "3.2.0-dev.1",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
   },
   "type": "module",
+  "bin": "dist/cli.js",
+  "packageManager": "pnpm@11.10.0",
   "engines": {
     "node": ">=24.18.0",
     "pnpm": ">=11.10.0",
     "npm": "please-use-pnpm",
     "yarn": "please-use-pnpm"
   },
+  "scripts": {
+    "typecheck": "tsc --build --emitDeclarationOnly",
+    "build": "tsdown",
+    "dev": "pnpm build --watch",
+    "readme": "pnpx http-server . --cors -o /readme.html",
+    "lint": "DEBUG=eslint:eslint-helpers eslint .",
+    "format": "prettier . --write --ignore-path ./.prettierignore",
+    "test": "vitest",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm build"
+  },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.1081.0",
     "@babel/code-frame": "^8.0.0",
@@ -54,17 +67,5 @@
       "eslint --fix",
       "prettier --write"
     ]
-  },
-  "scripts": {
-    "typecheck": "tsc --build --emitDeclarationOnly",
-    "build": "tsdown",
-    "dev": "pnpm build --watch",
-    "readme": "pnpx http-server . --cors -o /readme.html",
-    "lint": "DEBUG=eslint:eslint-helpers eslint .",
-    "format": "prettier . --write --ignore-path ./.prettierignore",
-    "test": "vitest"
-  },
-  "bin": {
-    "tamaro-cli": "dist/cli.js"
   }
-}
+}