@tokenoftrust/cli 3.0.3 → 3.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenoftrust/cli",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Token of Trust developer CLI — clone a tenant store, run it locally with save→reload, and submit it for preview. Installs the `tot` command.",
   "license": "Apache-2.0",
   "author": "Token of Trust",

package/src/declared-config.d.mts

@@ -22,6 +22,9 @@ export const DEFAULT_CURRENCY: "USD";
 export const CURRENCY_CODES: readonly string[];
 export function resolveStoreCurrency(declared: unknown): string;
 export function currencyDeclarationProblems(currency: unknown): string[];
+export const SHIPPING_KEYS: readonly string[];
+export const MAX_SHIPPING_AMOUNT: number;
+export function shippingDeclarationProblems(shipping: unknown): string[];
 export const COMPLIANCE_NOTICES: Record<string, string>;
 export const MANDATED_NOTICE_KEYS: string[];
 export function nearestKey(key: string, known: readonly string[]): string | null;

package/src/declared-config.mjs

@@ -19,7 +19,7 @@
 
 export const TOT_CONFIG_KEYS = [
   "$schema", "tenant", "scope", "mappings", "hostPlatform", "sample", "seed",
-  "displayName", "siteType", "compliance", "capabilities", "features", "embeds", "seo", "currency",
+  "displayName", "siteType", "compliance", "capabilities", "features", "embeds", "seo", "currency", "shipping",
 ];
 // Keys other tooling has written that the platform does NOT read, with the key it does.
 const RENAMED_CONFIG_KEYS = { appDomain: "scope", tenantId: "tenant" };
@@ -196,6 +196,46 @@ export function seoDeclarationProblems(seo) {
   return problems;
 }
 
+/** Every `shipping` key (mirrors packages/public-runtime/src/declared-tenant-config.mjs). */
+export const SHIPPING_KEYS = Object.freeze(["flatRate", "freeAtOrAbove"]);
+
+/** Largest shipping amount a declaration may state, in the cart's currency. */
+export const MAX_SHIPPING_AMOUNT = 100000;
+
+/** @param {unknown} value */
+const isShippingAmount = (value) =>
+  typeof value === "number" && Number.isFinite(value) && value >= 0 && value <= MAX_SHIPPING_AMOUNT
+  && Math.abs(value * 100 - Math.round(value * 100)) < 1e-6;
+
+/**
+ * What is wrong with a declared `shipping` value, one sentence per problem; `[]` when it is
+ * valid. A policy with any problem is refused whole, so checkout never charges half of one.
+ *
+ * @param {unknown} shipping
+ * @returns {string[]}
+ */
+export function shippingDeclarationProblems(shipping) {
+  if (!isPlainObject(shipping)) return ["`shipping` must be an object"];
+  const problems = [];
+  const source = /** @type {Record<string, unknown>} */ (shipping);
+  for (const key of Object.keys(source)) {
+    if (!SHIPPING_KEYS.includes(key)) problems.push(`\`shipping.${key}\` is not a shipping key (${SHIPPING_KEYS.join(", ")})`);
+  }
+  if (!isShippingAmount(source.flatRate)) {
+    problems.push(`\`shipping.flatRate\` must be an amount from 0 to ${MAX_SHIPPING_AMOUNT} with at most two decimal places`);
+  }
+  if (source.freeAtOrAbove !== undefined && !(isShippingAmount(source.freeAtOrAbove) && /** @type {number} */ (source.freeAtOrAbove) > 0)) {
+    problems.push(`\`shipping.freeAtOrAbove\` must be an amount above 0 and at most ${MAX_SHIPPING_AMOUNT} with at most two decimal places`);
+  }
+  return problems;
+}
+
+/** The owner-facing sentence for an invalid `shipping` declaration. */
+function shippingProblemMessage(problems) {
+  return `\`shipping\` is not a valid shipping policy (${problems.join("; ")}). ` +
+    "Checkout charges no shipping until it is fixed.";
+}
+
 
 /** What each compliance key puts on the page — the thing that is missing when it is. */
 export const COMPLIANCE_NOTICES = {
@@ -568,6 +608,8 @@ export function declarationFindings(current, previous) {
     if (warning.enabled && warning.problems.length > 0) {
       out.push(`CONFIG: ${nicotineWarningProblemMessage(warning.problems)}`);
     }
+    const shipping = current.shipping === undefined ? [] : shippingDeclarationProblems(current.shipping);
+    if (shipping.length > 0) out.push(`CONFIG: ${shippingProblemMessage(shipping)}`);
   }
   for (const { key, notice } of droppedMandatedNotices(previous, current)) {
     out.push(
@@ -656,6 +698,13 @@ export function validateDeclaredConfig(config, file = ".tot/config.json") {
       out.push(mk(ERROR, "config-seo", `${file} seo`, `${problem} — the whole \`seo\` declaration is ignored until it is fixed`));
     }
   }
+  if (config.shipping !== undefined) {
+    const problems = shippingDeclarationProblems(config.shipping);
+    if (problems.length > 0) {
+      out.push(mk(ERROR, "config-shipping", `${file} shipping`, shippingProblemMessage(problems),
+        'declare e.g. `"shipping": { "flatRate": 5.99, "freeAtOrAbove": 100 }`, or remove `shipping` to charge none'));
+    }
+  }
   return out;
 }