earnrate 0.2.6 → 0.2.8

package/dist/schema/card-number.js

@@ -0,0 +1,31 @@
+// earnrate never stores card numbers, on any surface. A card number is 13 to
+// 19 digits; a phone number in a store's name is 10 or 11, so free text with
+// a longer run is refused or not kept.
+const digitsOnly = (text) => text.replace(/[\s.-]/g, '');
+export const hasCardNumber = (text) => /\d{13,}/.test(digitsOnly(text));
+// A checkout label may carry a last four, but never 8 or more digits.
+export const labelHasCardNumber = (text) => /\d{8,}/.test(digitsOnly(text));
+export const CARD_NUMBER_LABEL = 'The checkout label looks like it has a card number in it. earnrate never stores card numbers; use a name like "Amex Gold".';
+export const CARD_NUMBER_REDEMPTION = 'The redemption note looks like it has a card number in it. earnrate never stores card numbers.';
+// For wallets saved before the schema refused card numbers: drop the field
+// instead of failing to load, since a wallet that can't load can't be fixed.
+export function withoutCardNumbers(raw) {
+    if (!isRecord(raw))
+        return raw;
+    const wallet = { ...raw };
+    if (Array.isArray(wallet.cards))
+        wallet.cards = wallet.cards.map((card) => isRecord(card) && isCardNumber(card.checkout_label, labelHasCardNumber)
+            ? omit(card, 'checkout_label')
+            : card);
+    if (isRecord(wallet.valuations))
+        wallet.valuations = Object.fromEntries(Object.entries(wallet.valuations).map(([currency, value]) => [
+            currency,
+            isRecord(value) && isCardNumber(value.redemption, hasCardNumber)
+                ? omit(value, 'redemption')
+                : value,
+        ]));
+    return wallet;
+}
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const isCardNumber = (value, test) => typeof value === 'string' && test(value);
+const omit = (record, key) => Object.fromEntries(Object.entries(record).filter(([k]) => k !== key));

package/dist/schema/wallet.js

@@ -1,11 +1,15 @@
 import { z } from 'zod';
 import { CurrencyId, IsoDate, KebabId, PeriodKey, ValueRange, } from "./common.js";
+import { CARD_NUMBER_LABEL, CARD_NUMBER_REDEMPTION, hasCardNumber, labelHasCardNumber, } from "./card-number.js";
 const Valuation = z.union([
     z.number().positive(),
     z.strictObject({
         value: z.number().positive().optional(),
         range: ValueRange.optional(),
-        redemption: z.string().optional(),
+        redemption: z
+            .string()
+            .refine((t) => !hasCardNumber(t), CARD_NUMBER_REDEMPTION)
+            .optional(),
     }),
 ]);
 const CapUsage = z.strictObject({
@@ -14,7 +18,11 @@ const CapUsage = z.strictObject({
 });
 export const WalletCardSchema = z.strictObject({
     id: KebabId,
-    checkout_label: z.string().min(1).optional(),
+    checkout_label: z
+        .string()
+        .min(1)
+        .refine((t) => !labelHasCardNumber(t), CARD_NUMBER_LABEL)
+        .optional(),
     // MM-DD, needed only for cardmember_year caps.
     anniversary: z
         .string()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "earnrate",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Which credit card earns the most at a merchant, from your cards or every card, and why",
   "keywords": [
     "credit cards",