sinfactura-types 1.10.78 → 1.10.80

package/dist/platform.d.ts

@@ -265,3 +265,39 @@ export interface PlatformOverridesRosterResponse {
     /** Unix ms. */
     builtAt: number;
 }
+/**
+ * Why a plan's marketing copy disagrees with the entitlements actually backing
+ * that tier. Advisory only — `PATCH /platform/billing/plans/{tier}` reports
+ * these and still applies the write. It never blocks: tiers are hand-tuned
+ * between pricing decisions, so a mismatch is routinely the intended
+ * intermediate state rather than an error.
+ *
+ * - `NUMERIC_MISMATCH` — a bullet advertises a number that differs from the
+ *   numeric entitlement it maps to.
+ * - `UNLIMITED_ADVERTISED_AS_CAPPED` — the entitlement is `-1` (unlimited) but
+ *   the copy advertises a finite cap. Reported separately because the equality
+ *   compare would otherwise render it as a nonsense mismatch against `-1`.
+ * - `UNBACKED_CAPABILITY` — the copy names a capability the tier does not have
+ *   `status: 'live'` and `enabled: true` for.
+ */
+export type CatalogWarningCode = 'NUMERIC_MISMATCH' | 'UNLIMITED_ADVERTISED_AS_CAPPED' | 'UNBACKED_CAPABILITY';
+/**
+ * One disagreement between a plan's copy and its entitlements.
+ *
+ * ⚠️ Absence of a warning is NOT a claim that the copy is correct. The matcher
+ * pairs a bullet to a feature only on a single unambiguous keyword; a bullet
+ * matching two keywords or none is skipped rather than guessed, so it
+ * deliberately understates. Reading an empty array as "this tier's copy is
+ * verified" inverts that design.
+ */
+export interface CatalogWarning {
+    code: CatalogWarningCode;
+    /** Which piece of copy produced it — one of the `bullets`, or the `description`. */
+    source: 'bullets' | 'description';
+    /** The offending bullet, or the description, verbatim. */
+    text: string;
+    /** The entitlement the copy was checked against. */
+    featureKey: FeatureKey;
+    /** Human-readable, already safe to render as-is. */
+    message: string;
+}

package/dist/userActivity.d.ts

@@ -124,10 +124,41 @@ declare global {
         event: 'Customer Created';
         customer_id: string;
     }
+    /**
+     * One staff-side change to a single `Customer.marketing` channel.
+     *
+     * ⚠️ `to` is the literal `false`, not `boolean`, and that is load-bearing.
+     * Staff may CLEAR a consent flag and may never grant one — a customer's
+     * consent can only ever come from the customer. Typing the literal makes
+     * the compiler refuse an emission that records a grant, so the rule is
+     * enforced at every call site rather than restated in a comment. Widening
+     * this to `boolean` would be a deliberate change to that policy, which is
+     * exactly the kind of decision that should cost a types publish.
+     *
+     * `from` is `null` when the channel had never been set, which is a
+     * different fact from `false` (explicitly opted out before) and must stay
+     * distinguishable in an audit record.
+     */
+    interface CustomerConsentChange {
+        channel: 'adds' | 'email' | 'phone' | 'sms' | 'whatsapp';
+        from: boolean | null;
+        to: false;
+    }
     interface CustomerEditedEvent extends UserActivityEventBase {
         event: 'Customer Edited';
         customer_id: string;
         fields_changed: string[];
+        /**
+         * Present only when a staff-side write touched `Customer.marketing`.
+         * Absent — not an empty array — when the edit left consent alone, so
+         * "no consent change" and "consent examined and unchanged" do not have
+         * to be told apart by a reader.
+         *
+         * `who` and `when` are already carried by `UserActivityEventBase`
+         * (`actor_full_name`, `actor_role`, `ts`); this adds only the per-
+         * channel before/after the base cannot express.
+         */
+        consent_changes?: CustomerConsentChange[];
     }
     interface CashDrawerOpenedEvent extends UserActivityEventBase {
         event: 'Cash Drawer Opened';

package/package.json

@@ -1,49 +1,49 @@
 {
-	"name": "sinfactura-types",
-	"version": "1.10.78",
-	"main": "dist/index.js",
-	"type": "module",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js",
-			"require": "./dist/cjs/index.js"
-		}
-	},
-	"scripts": {
-		"build": "tsc && tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({ type: 'commonjs' }) + '\\n')\"",
-		"prepublishOnly": "npm run build",
-		"login": "npm login",
-		"release": "npm version patch --no-git-tag-version",
-		"lint": "eslint ."
-	},
-	"publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org/"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/sinfactura/types"
-	},
-	"keywords": [],
-	"author": "Moises Samuel Maison Maison",
-	"license": "MIT",
-	"homepage": "https://sinfactura.com",
-	"files": [
-		"./dist"
-	],
-	"release": {
-		"branches": [
-			"main"
-		]
-	},
-	"devDependencies": {
-		"@eslint/js": "^10.0.1",
-		"eslint": "^10.8.0",
-		"globals": "^17.9.0",
-		"typescript": "^6.0.3",
-		"typescript-eslint": "^8.66.0"
-	},
-	"packageManager": "yarn@4.6.0+sha512.5383cc12567a95f1d668fbe762dfe0075c595b4bfff433be478dbbe24e05251a8e8c3eb992a986667c1d53b6c3a9c85b8398c35a960587fbd9fa3a0915406728"
+  "name": "sinfactura-types",
+  "version": "1.10.80",
+  "main": "dist/index.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({ type: 'commonjs' }) + '\\n')\"",
+    "prepublishOnly": "npm run build",
+    "login": "npm login",
+    "release": "npm version patch --no-git-tag-version",
+    "lint": "eslint ."
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sinfactura/types"
+  },
+  "keywords": [],
+  "author": "Moises Samuel Maison Maison",
+  "license": "MIT",
+  "homepage": "https://sinfactura.com",
+  "files": [
+    "./dist"
+  ],
+  "release": {
+    "branches": [
+      "main"
+    ]
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.8.0",
+    "globals": "^17.9.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.66.0"
+  },
+  "packageManager": "yarn@4.6.0+sha512.5383cc12567a95f1d668fbe762dfe0075c595b4bfff433be478dbbe24e05251a8e8c3eb992a986667c1d53b6c3a9c85b8398c35a960587fbd9fa3a0915406728"
 }