@tokenoftrust/cli 3.7.4 → 3.7.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenoftrust/cli",
-  "version": "3.7.4",
+  "version": "3.7.5",
   "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

@@ -23,7 +23,10 @@ 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 SHIPPING_TIER_KEYS: readonly string[];
 export const MAX_SHIPPING_AMOUNT: number;
+export const MAX_SHIPPING_TIERS: number;
+export const MAX_SHIPPING_LABEL_LENGTH: number;
 export function shippingDeclarationProblems(shipping: unknown): string[];
 export const COMPLIANCE_NOTICES: Record<string, string>;
 export const MANDATED_NOTICE_KEYS: string[];

package/src/declared-config.mjs

@@ -197,20 +197,38 @@ export function seoDeclarationProblems(seo) {
 }
 
 /** Every `shipping` key (mirrors packages/public-runtime/src/declared-tenant-config.mjs). */
-export const SHIPPING_KEYS = Object.freeze(["flatRate", "freeAtOrAbove"]);
+export const SHIPPING_KEYS = Object.freeze(["tiers"]);
+
+/** Every key of one `shipping.tiers` entry. */
+export const SHIPPING_TIER_KEYS = Object.freeze(["atOrAbove", "rate", "label"]);
 
 /** Largest shipping amount a declaration may state, in the cart's currency. */
 export const MAX_SHIPPING_AMOUNT = 100000;
 
+/** Most tiers one policy may declare. */
+export const MAX_SHIPPING_TIERS = 10;
+
+/** Longest shipping-line label, in characters. */
+export const MAX_SHIPPING_LABEL_LENGTH = 100;
+
 /** @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;
 
+/** @param {unknown} value */
+const isShippingLabel = (value) =>
+  typeof value === "string" && value.trim() === value && value.length > 0
+  && [...value].length <= MAX_SHIPPING_LABEL_LENGTH && !/[\u0000-\u001f\u007f]/.test(value);
+
 /**
  * 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.
  *
+ * Tiers are ordered by the item subtotal they start at. The first starts at 0 and states no
+ * `atOrAbove`; each later tier's `atOrAbove` is above the one before it and is inclusive, so an
+ * order whose subtotal equals it pays that tier's `rate`.
+ *
  * @param {unknown} shipping
  * @returns {string[]}
  */
@@ -221,12 +239,38 @@ export function shippingDeclarationProblems(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`);
+  const tiers = source.tiers;
+  if (!Array.isArray(tiers) || tiers.length === 0 || tiers.length > MAX_SHIPPING_TIERS) {
+    problems.push(`\`shipping.tiers\` must be a list of 1 to ${MAX_SHIPPING_TIERS} tiers`);
+    return problems;
   }
+  let previous = 0;
+  tiers.forEach((tier, index) => {
+    const at = `shipping.tiers[${index}]`;
+    if (!isPlainObject(tier)) {
+      problems.push(`\`${at}\` must be an object`);
+      return;
+    }
+    const entry = /** @type {Record<string, unknown>} */ (tier);
+    for (const key of Object.keys(entry)) {
+      if (!SHIPPING_TIER_KEYS.includes(key)) problems.push(`\`${at}.${key}\` is not a tier key (${SHIPPING_TIER_KEYS.join(", ")})`);
+    }
+    if (!isShippingAmount(entry.rate)) {
+      problems.push(`\`${at}.rate\` must be an amount from 0 to ${MAX_SHIPPING_AMOUNT} with at most two decimal places`);
+    }
+    if (entry.label !== undefined && !isShippingLabel(entry.label)) {
+      problems.push(`\`${at}.label\` must be text of 1 to ${MAX_SHIPPING_LABEL_LENGTH} characters with no surrounding spaces or line breaks`);
+    }
+    if (index === 0) {
+      if (entry.atOrAbove !== undefined) problems.push(`\`${at}\` starts at 0, so it states no \`atOrAbove\``);
+      return;
+    }
+    if (!(isShippingAmount(entry.atOrAbove) && /** @type {number} */ (entry.atOrAbove) > previous)) {
+      problems.push(`\`${at}.atOrAbove\` must be an amount above ${previous}, where the tier before it starts, and at most ${MAX_SHIPPING_AMOUNT} with at most two decimal places`);
+      return;
+    }
+    previous = /** @type {number} */ (entry.atOrAbove);
+  });
   return problems;
 }
 
@@ -702,7 +746,7 @@ export function validateDeclaredConfig(config, file = ".tot/config.json") {
     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'));
+        'declare e.g. `"shipping": { "tiers": [ { "rate": 5.99 }, { "atOrAbove": 100, "rate": 0, "label": "Free shipping" } ] }`, or remove `shipping` to charge none'));
     }
   }
   return out;