@happyvertical/smrt-commerce 0.37.11 → 0.38.0

package/dist/manifest.json

@@ -1,8 +1,8 @@
 {
   "version": "1.0.0",
-  "timestamp": 1783103718412,
+  "timestamp": 1783111249719,
   "packageName": "@happyvertical/smrt-commerce",
-  "packageVersion": "0.37.11",
+  "packageVersion": "0.38.0",
   "objects": {
     "@happyvertical/smrt-commerce:ContractCollection": {
       "name": "contractcollection",
@@ -1783,6 +1783,181 @@
         "version": "bf759c9b"
       }
     },
+    "@happyvertical/smrt-commerce:PaymentInstrumentCollection": {
+      "name": "paymentinstrumentcollection",
+      "className": "PaymentInstrumentCollection",
+      "qualifiedName": "@happyvertical/smrt-commerce:PaymentInstrumentCollection",
+      "collection": "paymentinstruments",
+      "filePath": "/home/runner/_work/smrt/smrt/packages/commerce/src/collections/PaymentInstrumentCollection.ts",
+      "packageName": "@happyvertical/smrt-commerce",
+      "fields": {},
+      "methods": {
+        "findByCustomer": {
+          "name": "findByCustomer",
+          "async": true,
+          "parameters": [
+            {
+              "name": "customerId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument[]>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findActiveByCustomer": {
+          "name": "findActiveByCustomer",
+          "async": true,
+          "parameters": [
+            {
+              "name": "customerId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument[]>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findDefaultForCustomer": {
+          "name": "findDefaultForCustomer",
+          "async": true,
+          "parameters": [
+            {
+              "name": "customerId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument | null>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findByProviderPaymentMethodId": {
+          "name": "findByProviderPaymentMethodId",
+          "async": true,
+          "parameters": [
+            {
+              "name": "providerPaymentMethodId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument | null>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "setDefaultForCustomer": {
+          "name": "setDefaultForCustomer",
+          "async": true,
+          "parameters": [
+            {
+              "name": "customerId",
+              "type": "string",
+              "optional": false
+            },
+            {
+              "name": "instrumentId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<void>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findByTenant": {
+          "name": "findByTenant",
+          "async": true,
+          "parameters": [
+            {
+              "name": "tenantId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument[]>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findGlobal": {
+          "name": "findGlobal",
+          "async": true,
+          "parameters": [],
+          "returnType": "Promise<PaymentInstrument[]>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "findWithGlobals": {
+          "name": "findWithGlobals",
+          "async": true,
+          "parameters": [
+            {
+              "name": "tenantId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<PaymentInstrument[]>",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {},
+      "extends": "SmrtCollection",
+      "extendsTypeArg": "PaymentInstrument",
+      "exportName": "PaymentInstrumentCollection",
+      "collectionExportName": "PaymentInstrumentCollectionCollection",
+      "schema": {
+        "tableName": "payment_instrument_collections",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"payment_instrument_collections\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          }
+        },
+        "indexes": [
+          {
+            "name": "payment_instrument_collections_id_idx",
+            "columns": [
+              "id"
+            ]
+          },
+          {
+            "name": "payment_instrument_collections_slug_context_idx",
+            "columns": [
+              "slug",
+              "context"
+            ],
+            "unique": true
+          }
+        ],
+        "version": "dd2ca72c"
+      }
+    },
     "@happyvertical/smrt-commerce:PaymentIntentCollection": {
       "name": "paymentintentcollection",
       "className": "PaymentIntentCollection",
@@ -13264,6 +13439,284 @@
         "version": "6868b743"
       }
     },
+    "@happyvertical/smrt-commerce:PaymentInstrument": {
+      "name": "paymentinstrument",
+      "className": "PaymentInstrument",
+      "qualifiedName": "@happyvertical/smrt-commerce:PaymentInstrument",
+      "collection": "paymentinstruments",
+      "filePath": "/home/runner/_work/smrt/smrt/packages/commerce/src/models/PaymentInstrument.ts",
+      "packageName": "@happyvertical/smrt-commerce",
+      "fields": {
+        "tenantId": {
+          "type": "text",
+          "required": false,
+          "_meta": {
+            "sqlType": "UUID",
+            "nullable": true,
+            "__tenancy": {
+              "isTenantIdField": true,
+              "autoFilter": true,
+              "required": false,
+              "autoPopulate": true,
+              "nullable": true,
+              "mode": "optional",
+              "field": "tenantId",
+              "allowSuperAdminBypass": false
+            }
+          }
+        },
+        "customerId": {
+          "type": "foreignKey",
+          "required": false,
+          "related": "Customer"
+        },
+        "backendId": {
+          "type": "text",
+          "required": false,
+          "default": ""
+        },
+        "providerCustomerId": {
+          "type": "text",
+          "required": false,
+          "default": ""
+        },
+        "providerPaymentMethodId": {
+          "type": "text",
+          "required": false,
+          "default": ""
+        },
+        "type": {
+          "type": "text",
+          "required": false,
+          "default": "card"
+        },
+        "brand": {
+          "type": "text",
+          "required": false,
+          "default": ""
+        },
+        "last4": {
+          "type": "text",
+          "required": false,
+          "default": ""
+        },
+        "expMonth": {
+          "type": "integer",
+          "required": false,
+          "default": 0
+        },
+        "expYear": {
+          "type": "integer",
+          "required": false,
+          "default": 0
+        },
+        "isDefault": {
+          "type": "boolean",
+          "required": false,
+          "default": false
+        },
+        "status": {
+          "type": "text",
+          "required": false
+        }
+      },
+      "methods": {
+        "isActive": {
+          "name": "isActive",
+          "async": false,
+          "parameters": [],
+          "returnType": "boolean",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "isExpired": {
+          "name": "isExpired",
+          "async": false,
+          "parameters": [],
+          "returnType": "boolean",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "isRemoved": {
+          "name": "isRemoved",
+          "async": false,
+          "parameters": [],
+          "returnType": "boolean",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "markExpired": {
+          "name": "markExpired",
+          "async": false,
+          "parameters": [],
+          "returnType": "void",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "markRemoved": {
+          "name": "markRemoved",
+          "async": false,
+          "parameters": [],
+          "returnType": "void",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {
+        "api": {
+          "include": [
+            "list",
+            "get",
+            "create",
+            "update"
+          ],
+          "writable": [
+            "customerId",
+            "backendId",
+            "providerCustomerId",
+            "providerPaymentMethodId",
+            "type",
+            "brand",
+            "last4",
+            "expMonth",
+            "expYear",
+            "status"
+          ]
+        },
+        "mcp": {
+          "include": [
+            "list",
+            "get"
+          ]
+        },
+        "cli": true,
+        "tenantScoped": {
+          "mode": "optional"
+        }
+      },
+      "extends": "SmrtObject",
+      "exportName": "PaymentInstrument",
+      "collectionExportName": "PaymentInstrumentCollection",
+      "schema": {
+        "tableName": "payment_instruments",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"payment_instruments\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"tenant_id\" UUID,\n  \"customer_id\" UUID,\n  \"backend_id\" TEXT DEFAULT '',\n  \"provider_customer_id\" TEXT DEFAULT '',\n  \"provider_payment_method_id\" TEXT DEFAULT '',\n  \"type\" TEXT DEFAULT 'card',\n  \"brand\" TEXT DEFAULT '',\n  \"last4\" TEXT DEFAULT '',\n  \"exp_month\" INTEGER DEFAULT 0,\n  \"exp_year\" INTEGER DEFAULT 0,\n  \"is_default\" BOOLEAN DEFAULT FALSE,\n  \"status\" TEXT\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "tenant_id": {
+            "type": "UUID",
+            "referenceKind": "tenantId",
+            "notNull": false,
+            "unique": false
+          },
+          "customer_id": {
+            "type": "UUID",
+            "referenceKind": "foreignKey",
+            "notNull": false,
+            "unique": false
+          },
+          "backend_id": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": ""
+          },
+          "provider_customer_id": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": ""
+          },
+          "provider_payment_method_id": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": ""
+          },
+          "type": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": "card"
+          },
+          "brand": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": ""
+          },
+          "last4": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false,
+            "default": ""
+          },
+          "exp_month": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false,
+            "default": 0
+          },
+          "exp_year": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false,
+            "default": 0
+          },
+          "is_default": {
+            "type": "BOOLEAN",
+            "notNull": false,
+            "unique": false,
+            "default": false
+          },
+          "status": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false
+          }
+        },
+        "indexes": [
+          {
+            "name": "payment_instruments_id_idx",
+            "columns": [
+              "id"
+            ]
+          },
+          {
+            "name": "payment_instruments_slug_context_idx",
+            "columns": [
+              "slug",
+              "context"
+            ],
+            "unique": true
+          }
+        ],
+        "version": "0aace928"
+      }
+    },
     "@happyvertical/smrt-commerce:PaymentIntent": {
       "name": "paymentintent",
       "className": "PaymentIntent",

package/dist/models/PaymentInstrument.d.ts

@@ -0,0 +1,111 @@
+import { SmrtObject } from '@happyvertical/smrt-core';
+import { PaymentInstrumentOptions, PaymentInstrumentStatus } from '../types/index.js';
+/**
+ * PaymentInstrument stores a reusable payment method a customer has saved with
+ * a payment backend (e.g. a card vaulted by Stripe), so it can be charged later
+ * without the customer present.
+ *
+ * It holds only **references and non-sensitive display metadata** — the
+ * provider customer id (`cus_...`), the provider payment-method id (`pm_...`),
+ * and card display fields (brand / last4 / expiry). The actual card number is
+ * vaulted by the payment backend and is never stored here.
+ *
+ * @example
+ * ```typescript
+ * const instrument = await instruments.create({
+ *   customerId: customer.id,
+ *   backendId: 'stripe',
+ *   providerCustomerId: 'cus_123',
+ *   providerPaymentMethodId: 'pm_123',
+ *   brand: 'visa',
+ *   last4: '4242',
+ *   expMonth: 12,
+ *   expYear: 2030,
+ *   isDefault: true,
+ * });
+ * await instrument.save();
+ * ```
+ */
+export declare class PaymentInstrument extends SmrtObject {
+    /**
+     * Tenant ID for multi-tenant isolation. Nullable to support both
+     * tenant-scoped and global instruments.
+     */
+    tenantId: string | null;
+    /**
+     * Customer this saved method belongs to.
+     */
+    customerId: string;
+    /**
+     * Stable identifier of the `PaymentBackend` adapter that vaulted the method —
+     * e.g. `stripe`. Mirrors {@link Payment.backendId}.
+     */
+    backendId: string;
+    /**
+     * Provider customer reference (e.g. a Stripe `cus_...`). A reference, not
+     * card data.
+     */
+    providerCustomerId: string;
+    /**
+     * Provider payment-method reference (e.g. a Stripe `pm_...`). Used, together
+     * with {@link providerCustomerId}, to charge the saved method off-session. A
+     * reference, not card data.
+     */
+    providerPaymentMethodId: string;
+    /**
+     * Instrument type as reported by the backend — e.g. `card`,
+     * `us_bank_account`.
+     */
+    type: string;
+    /**
+     * Card brand for display (e.g. `visa`). Display-only, not PCI-sensitive.
+     */
+    brand: string;
+    /**
+     * Last four digits for display. Not the full card number.
+     */
+    last4: string;
+    /**
+     * Card expiry month (1–12). `0` when unknown / not a card.
+     */
+    expMonth: number;
+    /**
+     * Card expiry year (four digits). `0` when unknown / not a card.
+     */
+    expYear: number;
+    /**
+     * Whether this is the customer's default instrument. Use
+     * {@link PaymentInstrumentCollection.setDefaultForCustomer} to flip the
+     * default so only one instrument per customer is marked default.
+     */
+    isDefault: boolean;
+    /**
+     * Lifecycle status — `active` while chargeable, `expired` once the card has
+     * lapsed, `removed` when the customer detaches it.
+     */
+    status: PaymentInstrumentStatus;
+    constructor(options?: PaymentInstrumentOptions);
+    /**
+     * True while the instrument is active (chargeable).
+     */
+    isActive(): boolean;
+    /**
+     * True once the instrument has been marked expired.
+     */
+    isExpired(): boolean;
+    /**
+     * True once the instrument has been removed/detached.
+     */
+    isRemoved(): boolean;
+    /**
+     * Mark the instrument expired (e.g. the card lapsed). A removed instrument
+     * is not revived by this.
+     */
+    markExpired(): void;
+    /**
+     * Mark the instrument removed/detached and clear its default flag.
+     */
+    markRemoved(): void;
+}
+export default PaymentInstrument;
+//# sourceMappingURL=PaymentInstrument.d.ts.map

package/dist/models/PaymentInstrument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaymentInstrument.d.ts","sourceRoot":"","sources":["../../src/models/PaymentInstrument.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAc,UAAU,EAAQ,MAAM,0BAA0B,CAAC;AAExE,OAAO,EACL,KAAK,wBAAwB,EAC7B,uBAAuB,EACxB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBA0Ba,iBAAkB,SAAQ,UAAU;IAC/C;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE/B;;OAEG;IAEH,UAAU,EAAE,MAAM,CAAM;IAExB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAM;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAM;IAEhC;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAM;IAErC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAU;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAM;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAM;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAK;IAEpB;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAS;IAE3B;;;OAGG;IACH,MAAM,EAAE,uBAAuB,CAAkC;gBAErD,OAAO,GAAE,wBAA6B;IAkBlD;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,WAAW,IAAI,IAAI;IAKnB;;OAEG;IACH,WAAW,IAAI,IAAI;CAIpB;AAED,eAAe,iBAAiB,CAAC"}

package/dist/models/index.d.ts

@@ -11,6 +11,7 @@ export { Invoice } from './Invoice.js';
 export { InvoiceLineItem } from './InvoiceLineItem.js';
 export { Payment } from './Payment.js';
 export { PaymentAllocation } from './PaymentAllocation.js';
+export { PaymentInstrument } from './PaymentInstrument.js';
 export { PaymentIntent } from './PaymentIntent.js';
 export { Payout } from './Payout.js';
 export { Vendor } from './Vendor.js';

package/dist/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,KAAK,qBAAqB,EAC1B,WAAW,EACX,KAAK,EACL,eAAe,EACf,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,KAAK,qBAAqB,EAC1B,WAAW,EACX,KAAK,EACL,eAAe,EACf,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}