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

package/README.md

@@ -282,7 +282,16 @@ 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 `.env` values, or 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,10 @@ 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 { config } from "dotenv";
+import { config, parse } from "dotenv";
 import { getPortPromise } from "portfinder";
 import prompts from "prompts";
 import columnify from "columnify";
@@ -279,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.
 	*
@@ -307,14 +310,25 @@ 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 {
+			const response = await this.#epmsClient.get(`organisations/${organisationUuid}/files`).json();
+			return Array.isArray(response) ? response : response.data ?? [];
+		} 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();
 	}
@@ -442,6 +456,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$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));
+	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$1 = (configYmlPath, source, key, message) => {
+	const location = findKeyLocation$1(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$1(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.
@@ -545,6 +652,98 @@ const compileEmailTemplate = (template) => {
 	Handlebars.compile(template)({});
 };
 //#endregion
+//#region src/lib/validators/validateEnv.ts
+const envSchema = z.strictObject({
+	CORE_URL: z.url().optional(),
+	CORE_URL_PATTERN: z.string().includes("{{version}}", { message: "Must contain the \"{{version}}\" placeholder" }).optional(),
+	CORE_VERSION: z.string().refine((version) => version === version.trim(), { message: "There must be no leading or trailing whitespace in the version string" }).refine((version) => version === version.toLowerCase(), { message: "The version string must be lowercase" }).optional(),
+	DISABLE_URL_VERSION_OVERRIDE: z.enum([
+		"true",
+		"false",
+		"1",
+		"0"
+	]).optional(),
+	LOCAL_CORE: z.enum(["true", "false"]).optional()
+});
+const TAMARO_CORE_REGISTRY_URL = "https://registry.npmjs.org/@raisenow/tamaro-core";
+/**
+* Check that the configured version exists for "@raisenow/tamaro-core" on npm:
+* as a dist-tag (e.g. "latest", "lts_2026"), an exact version, or a partial
+* version ("2", "2.15") matching at least one published version.
+*/
+const coreVersionExists = async (version) => {
+	const metadata = await ky.get(TAMARO_CORE_REGISTRY_URL, {
+		headers: { accept: "application/vnd.npm.install-v1+json" },
+		retry: 0,
+		timeout: DEFAULT_HTTP_TIMEOUT
+	}).json();
+	const distTags = Object.keys(metadata["dist-tags"] ?? {});
+	const versions = Object.keys(metadata.versions ?? {});
+	return distTags.includes(version) || versions.includes(version) || versions.some((existing) => existing.startsWith(`${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 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,
+			line
+		}
+	};
+};
+/**
+* Format an error for a `KEY=` assignment as a code frame pointing at the
+* value, so it looks fancy like this:
+*
+* .env:2
+* 1 | CORE_VERSION=LTS_2026
+* 2 | CORE_URL_PATTERN=adsf
+*   |                  ^^^^ Must contain the "{{version}}" placeholder
+*/
+const formatError = (dotEnvPath, source, key, message) => {
+	const location = findKeyLocation(source, key);
+	if (!location) return `${dotEnvPath}: ${key}: ${message}`;
+	const frame = codeFrameColumns(source, location, {
+		forceColor: true,
+		highlightCode: true,
+		message
+	});
+	return `\n${dotEnvPath}:${location.start.line}\n${frame}`;
+};
+/**
+* Validate the environment variables in the config's .env file.
+*/
+const validateEnv = async (dotEnvPath) => {
+	if (!fs.existsSync(dotEnvPath)) return [];
+	const source = fs.readFileSync(dotEnvPath, "utf8");
+	const parsed = parse(source);
+	const result = envSchema.safeParse(parsed);
+	if (!result.success) {
+		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));
+		}
+		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`)];
+	}
+	return [];
+};
+//#endregion
 //#region src/commands/validate.ts
 /**
 * Validates the current Tamaro configuration to avoid common errors.
@@ -554,8 +753,16 @@ const compileEmailTemplate = (template) => {
 * deployed.
 */
 const validate = async () => {
-	const errors = validateEmailTemplates(globSync("email-config/templates/**/*.hbs").toSorted());
-	if (errors.length > 0) halt(errors.map((el) => el.toString()).join("\n"));
+	const errors = [
+		...await validateEnv(".env"),
+		...validateEmailTemplates(globSync("email-config/templates/**/*.hbs").toSorted()),
+		...await validateDonationReceiptTemplates("config.yml")
+	];
+	if (errors.length > 0) {
+		logError("❌ Validation failed with the following errors:");
+		console.log(errors.map((el) => el.toString()).join("\n"));
+		halt();
+	}
 	logTitle("Validated successfully");
 };
 //#endregion
@@ -631,6 +838,7 @@ const getOutDir = (configName) => {
 //#region src/commands/update-epms.ts
 const updateEpms = async (options) => {
 	const configName = getConfigName();
+	await validate();
 	if (!options.profile && !options.ci) {
 		assertAwsProfilesPresent();
 		options.profile = await promptAwsProfile();
@@ -912,6 +1120,7 @@ const dev = async (options) => {
 	const configName = getConfigName();
 	const configsPackageRoot = getConfigsPackageRoot();
 	assertCrtExists(configsPackageRoot);
+	await validate();
 	const port = await getPortPromise({ port: Number(DEFAULT_PORT) });
 	logTitle(`\nStarting Vite dev server for "${configName}" configuration...`);
 	runCommandSync(`pnpm vite dev --port ${port}`, {
@@ -1225,7 +1434,7 @@ const promptBucketTamaroEmailConfig = async () => {
 //#endregion
 //#region package.json
 var name = "@raisenow/tamaro-cli";
-var version = "3.0.0";
+var version = "3.1.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,6 +1,6 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "3.0.0",
+  "version": "3.1.0-dev.1",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
@@ -13,7 +13,8 @@
     "yarn": "please-use-pnpm"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1080.0",
+    "@aws-sdk/client-s3": "^3.1081.0",
+    "@babel/code-frame": "^8.0.0",
     "@rnw-npm/cli-helpers": "^2.0.1",
     "columnify": "^1.6.0",
     "commander": "^15.0.0",

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/tamaro-cli.iml" filepath="$PROJECT_DIR$/.idea/tamaro-cli.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/tamaro-cli.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/.idea/workspace.xml

@@ -1,62 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ChangeListManager">
-    <list default="true" id="03cc3f97-55ca-4737-9fe2-779ac8457ab2" name="Changes" comment="" />
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="MarkdownSettingsMigration">
-    <option name="stateVersion" value="1" />
-  </component>
-  <component name="ProjectId" id="3BwvHZOW2N4A0f0JXo7q8qDzYwY" />
-  <component name="ProjectViewState">
-    <option name="autoscrollFromSource" value="true" />
-    <option name="autoscrollToSource" value="true" />
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-    <option name="showMembers" value="true" />
-  </component>
-  <component name="PropertiesComponent">{
-  &quot;keyToString&quot;: {
-    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
-    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
-    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
-    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
-    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
-    &quot;nodejs_package_manager_path&quot;: &quot;pnpm&quot;,
-    &quot;prettierjs.PrettierConfiguration.Package&quot;: &quot;/Users/sigerello/dev/_raisenow/tools/tamaro-cli/node_modules/prettier&quot;,
-    &quot;ts.external.directory.path&quot;: &quot;/Users/sigerello/dev/_raisenow/tools/tamaro-cli/node_modules/typescript/lib&quot;,
-    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
-  }
-}</component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="03cc3f97-55ca-4737-9fe2-779ac8457ab2" name="Changes" comment="" />
-      <created>1775412859839</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1775412859839</updated>
-      <workItem from="1775412861312" duration="2060000" />
-      <workItem from="1776174639969" duration="1525000" />
-      <workItem from="1776736351878" duration="598000" />
-      <workItem from="1777934504965" duration="82000" />
-      <workItem from="1777936008103" duration="88000" />
-      <workItem from="1778477038620" duration="2530000" />
-      <workItem from="1780398242165" duration="1962000" />
-      <workItem from="1781661280180" duration="2828000" />
-      <workItem from="1782699840335" duration="599000" />
-      <workItem from="1782869357470" duration="598000" />
-      <workItem from="1783270034892" duration="1197000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-</project>