@cobre-npm/library-portal-core 0.48.0 → 0.51.0

package/README.md

@@ -241,27 +241,37 @@ hasCountryISOFlag("col")                // true — whether a flag asset is avai
 import {
   getMovementTypes, queryMovementTypes, type MovementType, type MovementTypeGroupLabel,
   type MovementTypeOption, type MovementTypeQuery,
+  type ClassificationLine, type ClassificationCategory,
   getMovementStatuses, queryMovementStatuses, type MovementStatus, type MovementStatusType,
   type MovementStatusOption, type MovementStatusQuery,
 } from "@cobre-npm/library-portal-core/movements"
 
-getMovementTypes("en").ach.label                    // "ACH"
+getMovementTypes("en").ach.label                    // "Transfer · ACH"
 getMovementTypes("en").on_ramp.groupLabel            // "Stablecoin"
-getMovementTypes("en").on_ramp.label                 // "On Ramp" (individual label, unchanged)
+getMovementTypes("en").on_ramp.label                 // "Conversion to stablecoin" (individual label)
+getMovementTypes("en").spei.category                 // "payments"
+queryMovementTypes({ lang: "en", category: "top_up" })        // r2p_top_up_bancolombia, r2p_top_up_pse
 queryMovementTypes({ lang: "en", groupLabel: "Stablecoin" })  // global, off_ramp, on_ramp, stable_payout
 getMovementStatuses("en").completed             // { code: "completed", label: "Completed", type: "success", icon: "icon-check" }
 queryMovementStatuses({ lang: "en", type: "error" })  // error, failed, rejected — localized
 ```
 
-- **types** (i18n): movement types (ACH, SPEI, R2P, …). `on_ramp`/`off_ramp`/`stable_payout`/`global`
+- **types** (i18n): movement types, usually labelled as "what you did · rail" (`Transfer · SPEI`,
+  `Collection · Bre-B`). Movement and transaction types share one classification, carried on each record as
+  codes, not translated text (nothing displays them yet): `line: ClassificationLine`
+  (`payin | payout | cbmm | stable | unclassified`) and `category: ClassificationCategory`
+  (`payments | collections | conversions | international | between_accounts | top_up | adjustment |
+  reward | unclassified`). Both types are exported from `/movements` and `/transactions` (the same types on
+  both subpaths). `on_ramp`/`off_ramp`/`stable_payout`/`global`
   additionally carry `groupLabel: "Stablecoin"` — a display grouping for views that need to show them
   under one label. `getMovementTypes()` keeps returning each rail's own individual `label` unchanged; a
   consumer that wants the grouped label picks `groupLabel ?? label`. There's no separate `getXLabel`
   for this — the value already comes back inside `getMovementTypes()`, same as everything else in this
   catalog.
 - **types query** (i18n `queryX()`): `queryMovementTypes({ lang, ...filters })` — same rules as
-  `queryTransactionTypes`/`queryDocumentTypes`, no default field. `groupLabel` is the only filterable
-  field besides `code`, and it's optional on the record: **a key that is present always filters**, so
+  `queryTransactionTypes`/`queryDocumentTypes`, no default field. `code`, `line`, `category`, `group` and
+  `groupLabel` are filterable (equality only; a list matches any of its values). Filter by `group`, not
+  `groupLabel` — the label is display text. Both are optional on the record: **a key that is present always filters**, so
   `groupLabel: undefined` matches the 19 rails that don't carry a group, not "no filter". An optional UI
   filter has to be spread in conditionally:
 
@@ -405,19 +415,31 @@ And two on rule 1: `{ minAmount: 1 }` is equality, not `>=`, which is rarely wha
 ```ts
 import {
   getTransactionTypes, queryTransactionTypes, type TransactionType, type TransactionTypeQuery,
+  type ClassificationLine, type ClassificationCategory,
   type Transaction, type EnrichedTransaction, /* ...interfaces */
 } from "@cobre-npm/library-portal-core/transactions"
 
-getTransactionTypes("en").spei_debit.label            // "Debit via SPEI"
-queryTransactionTypes({ lang: "en", code: "spei_debit" })  // [ { code: "spei_debit", label: "Debit via SPEI" } ]
+getTransactionTypes("en").spei_debit.label            // "Outgoing transfer · SPEI"
+getTransactionTypes("es-mex").spei_debit.label        // "Transferencia enviada · SPEI"
+queryTransactionTypes({ lang: "en", code: "spei_debit" })  // [ { code: "spei_debit", creditDebitType: "debit", line: "payout", category: "payments", label: "Outgoing transfer · SPEI" } ]
+queryTransactionTypes({ lang: "en", category: "top_up" })  // col_top_up_credit
 ```
 
 - **types** (i18n): `getTransactionTypes(lang)`; each record carries `code`, `creditDebitType`
-  (`"credit" | "debit"` — the same `CreditDebitType` used by the `Transaction` interface) and `label`.
+  (`"credit" | "debit"` — the same `CreditDebitType` used by the `Transaction` interface), `label`, and the same
+  `line: ClassificationLine` / `category: ClassificationCategory` codes as movement types (value sets
+  listed under [`movements`](#movements)). Labels are usually "what you did · rail" (`Outgoing transfer ·
+  SPEI`). Types that stand for a collapsed matrix row (`cbmm_*`, `internal_*`, `mex_*`, `col_debit`/`col_credit`, `misc_*`,
+  `adjustment_*`, `col_cb_*`, the corridors, ramps and `stable_payout_*`, plus `transfer_credit`) add a
+  "· débito" / "· crédito" (en "· debit" / "· credit") suffix; elsewhere the direction is in the verb
+  ("Outgoing transfer", "Incoming transfer"). `col_cb_*` keeps "Cobre Balance" in its label. `misc_*`,
+  `internal_*` and `adjustment_*` have `line: "unclassified"`, and `misc_*` also `category: "unclassified"`.
 - **types query** (i18n `queryX()`): `queryTransactionTypes({ lang, ...filters })` — `lang` is **required inside
   the query object**, not a separate argument, so the result is already localized. There is no default field
   (unlike `currencies`' `scope`): every transaction type comes back when only `lang` is given.
-  `queryTransactionTypes({ lang: "en", creditDebitType: "credit" })` narrows to only the credits.
+  `queryTransactionTypes({ lang: "en", creditDebitType: "credit" })` narrows to only the credits;
+  `line` and `category` are filterable the same way (equality, a list matches any of its values), e.g.
+  `queryTransactionTypes({ lang: "en", line: "payin", category: "collections" })`.
 - **interfaces**: `Transaction`, `EnrichedTransaction`, `TransactionMetadata`, `CreditDebitType`.
 
 ### `search` / `trustedSessions`

package/dist/cjs/financialInstitutions/locales/en.json

@@ -53,7 +53,7 @@
         "pr_col_1803": "Powwi",
         "pr_col_1811": "RappiPay",
         "pr_col_1813": "Santander Consumer",
-        "pr_col_1019": "Scotiabank Colpatria",
+        "pr_col_1019": "Davibank",
         "pr_col_1804": "Uala",
         "pr_mex_40133": "Actinver",
         "pr_mex_40062": "Afirme",

package/dist/cjs/financialInstitutions/locales/es-mex.json

@@ -53,7 +53,7 @@
         "pr_col_1803": "Powwi",
         "pr_col_1811": "RappiPay",
         "pr_col_1813": "Santander Consumer",
-        "pr_col_1019": "Scotiabank Colpatria",
+        "pr_col_1019": "Davibank",
         "pr_col_1804": "Ualá",
         "pr_mex_40133": "Actinver",
         "pr_mex_40062": "Afirme",

package/dist/cjs/movements/index.d.ts

@@ -1,4 +1,4 @@
-export type { MovementType, MovementTypeGroup, MovementTypeGroupLabel } from "./types/catalog";
+export type { ClassificationCategory, ClassificationLine, MovementType, MovementTypeGroup, MovementTypeGroupLabel } from "./types/catalog";
 export * from "./types/utils/movement-type.utils";
 export type { MovementStatus, MovementStatusType } from "./status/catalog";
 export * from "./status/utils/movement-status.utils";

package/dist/cjs/movements/types/catalog.d.ts

@@ -1,82 +1,135 @@
+export type ClassificationLine = "payin" | "payout" | "cbmm" | "stable" | "unclassified";
+export type ClassificationCategory = "payments" | "collections" | "conversions" | "international" | "between_accounts" | "top_up" | "adjustment" | "reward" | "unclassified";
 export type MovementTypeGroup = "stablecoin";
 export type MovementTypeGroupLabel = "Stablecoin";
 export declare const MOVEMENT_TYPES: {
     readonly ach: {
         readonly code: "ach";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly fast_pay: {
         readonly code: "fast_pay";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly spei: {
         readonly code: "spei";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly spei_card: {
         readonly code: "spei_card";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly spei_return: {
         readonly code: "spei_return";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly r2p: {
         readonly code: "r2p";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly r2p_bancolombia: {
         readonly code: "r2p_bancolombia";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly r2p_nequi: {
         readonly code: "r2p_nequi";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly r2p_pse: {
         readonly code: "r2p_pse";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly direct_debit: {
         readonly code: "direct_debit";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly r2p_breb: {
         readonly code: "r2p_breb";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly r2p_top_up_pse: {
         readonly code: "r2p_top_up_pse";
+        readonly line: "payin";
+        readonly category: "top_up";
     };
     readonly r2p_top_up_bancolombia: {
         readonly code: "r2p_top_up_bancolombia";
+        readonly line: "payin";
+        readonly category: "top_up";
     };
     readonly global: {
         readonly code: "global";
+        readonly line: "stable";
+        readonly category: "conversions";
         readonly group: "stablecoin";
         readonly groupLabel: "Stablecoin";
     };
     readonly r2p_spei: {
         readonly code: "r2p_spei";
+        readonly line: "payin";
+        readonly category: "collections";
     };
     readonly on_ramp: {
         readonly code: "on_ramp";
+        readonly line: "stable";
+        readonly category: "conversions";
         readonly group: "stablecoin";
         readonly groupLabel: "Stablecoin";
     };
     readonly off_ramp: {
         readonly code: "off_ramp";
+        readonly line: "stable";
+        readonly category: "conversions";
         readonly group: "stablecoin";
         readonly groupLabel: "Stablecoin";
     };
     readonly fedwire: {
         readonly code: "fedwire";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly global_pay_to_usa: {
         readonly code: "global_pay_to_usa";
+        readonly line: "cbmm";
+        readonly category: "international";
     };
     readonly usa_pay_to_global: {
         readonly code: "usa_pay_to_global";
+        readonly line: "cbmm";
+        readonly category: "international";
+    };
+    readonly cross_border: {
+        readonly code: "cross_border";
+        readonly line: "cbmm";
+        readonly category: "international";
     };
     readonly stable_payout: {
         readonly code: "stable_payout";
+        readonly line: "stable";
+        readonly category: "conversions";
         readonly group: "stablecoin";
         readonly groupLabel: "Stablecoin";
     };
     readonly breb: {
         readonly code: "breb";
+        readonly line: "payout";
+        readonly category: "payments";
     };
     readonly global_pay_to_generic: {
         readonly code: "global_pay_to_generic";
+        readonly line: "payout";
+        readonly category: "payments";
     };
 };
 export type MovementType = keyof typeof MOVEMENT_TYPES;

package/dist/cjs/movements/types/catalog.js

@@ -2,27 +2,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MOVEMENT_TYPES = void 0;
 exports.MOVEMENT_TYPES = {
-    ach: { code: "ach" },
-    fast_pay: { code: "fast_pay" },
-    spei: { code: "spei" },
-    spei_card: { code: "spei_card" },
-    spei_return: { code: "spei_return" },
-    r2p: { code: "r2p" },
-    r2p_bancolombia: { code: "r2p_bancolombia" },
-    r2p_nequi: { code: "r2p_nequi" },
-    r2p_pse: { code: "r2p_pse" },
-    direct_debit: { code: "direct_debit" },
-    r2p_breb: { code: "r2p_breb" },
-    r2p_top_up_pse: { code: "r2p_top_up_pse" },
-    r2p_top_up_bancolombia: { code: "r2p_top_up_bancolombia" },
-    global: { code: "global", group: "stablecoin", groupLabel: "Stablecoin" },
-    r2p_spei: { code: "r2p_spei" },
-    on_ramp: { code: "on_ramp", group: "stablecoin", groupLabel: "Stablecoin" },
-    off_ramp: { code: "off_ramp", group: "stablecoin", groupLabel: "Stablecoin" },
-    fedwire: { code: "fedwire" },
-    global_pay_to_usa: { code: "global_pay_to_usa" },
-    usa_pay_to_global: { code: "usa_pay_to_global" },
-    stable_payout: { code: "stable_payout", group: "stablecoin", groupLabel: "Stablecoin" },
-    breb: { code: "breb" },
-    global_pay_to_generic: { code: "global_pay_to_generic" },
+    ach: { code: "ach", line: "payout", category: "payments" },
+    fast_pay: { code: "fast_pay", line: "payout", category: "payments" },
+    spei: { code: "spei", line: "payout", category: "payments" },
+    spei_card: { code: "spei_card", line: "payout", category: "payments" },
+    spei_return: { code: "spei_return", line: "payout", category: "payments" },
+    r2p: { code: "r2p", line: "payin", category: "collections" },
+    r2p_bancolombia: { code: "r2p_bancolombia", line: "payin", category: "collections" },
+    r2p_nequi: { code: "r2p_nequi", line: "payin", category: "collections" },
+    r2p_pse: { code: "r2p_pse", line: "payin", category: "collections" },
+    direct_debit: { code: "direct_debit", line: "payin", category: "collections" },
+    r2p_breb: { code: "r2p_breb", line: "payin", category: "collections" },
+    r2p_top_up_pse: { code: "r2p_top_up_pse", line: "payin", category: "top_up" },
+    r2p_top_up_bancolombia: { code: "r2p_top_up_bancolombia", line: "payin", category: "top_up" },
+    global: { code: "global", line: "stable", category: "conversions", group: "stablecoin", groupLabel: "Stablecoin" },
+    r2p_spei: { code: "r2p_spei", line: "payin", category: "collections" },
+    on_ramp: { code: "on_ramp", line: "stable", category: "conversions", group: "stablecoin", groupLabel: "Stablecoin" },
+    off_ramp: { code: "off_ramp", line: "stable", category: "conversions", group: "stablecoin", groupLabel: "Stablecoin" },
+    fedwire: { code: "fedwire", line: "payout", category: "payments" },
+    global_pay_to_usa: { code: "global_pay_to_usa", line: "cbmm", category: "international" },
+    usa_pay_to_global: { code: "usa_pay_to_global", line: "cbmm", category: "international" },
+    cross_border: { code: "cross_border", line: "cbmm", category: "international" },
+    stable_payout: { code: "stable_payout", line: "stable", category: "conversions", group: "stablecoin", groupLabel: "Stablecoin" },
+    breb: { code: "breb", line: "payout", category: "payments" },
+    global_pay_to_generic: { code: "global_pay_to_generic", line: "payout", category: "payments" },
 };

package/dist/cjs/movements/types/locales/en.json

@@ -1,27 +1,28 @@
 {
     "movementTypes": {
-        "ach": "ACH",
-        "fast_pay": "Fast Pay",
-        "spei": "SPEI",
-        "spei_card": "SPEI Card",
-        "spei_return": "SPEI Refund",
-        "r2p": "Request",
-        "r2p_bancolombia": "Collection - Bancolombia Button",
-        "r2p_nequi": "Collection - Nequi Button",
-        "r2p_pse": "Collection - PSE",
-        "direct_debit": "Direct Debit",
-        "r2p_breb": "R2P Bre-B",
-        "r2p_top_up_pse": "R2P - PSE",
-        "r2p_top_up_bancolombia": "R2P - Bancolombia",
+        "ach": "Transfer · ACH",
+        "fast_pay": "Real-time payment · Fast Pay",
+        "spei": "Transfer · SPEI",
+        "spei_card": "Transfer · SPEI to debit card",
+        "spei_return": "Return · SPEI",
+        "r2p": "Payment button collection · Legacy",
+        "r2p_bancolombia": "Payment button collection · Bancolombia",
+        "r2p_nequi": "Payment button collection · Nequi",
+        "r2p_pse": "Payment button collection · PSE",
+        "direct_debit": "Direct debit",
+        "r2p_breb": "Collection · Bre-B",
+        "r2p_top_up_pse": "Own balance top-up · PSE",
+        "r2p_top_up_bancolombia": "Own balance top-up · Bancolombia",
         "global": "Global payout",
-        "r2p_spei": "R2P SPEI",
-        "on_ramp": "On Ramp",
-        "off_ramp": "Off Ramp",
-        "fedwire": "Fedwire",
-        "global_pay_to_usa": "FBO Top-Up",
-        "usa_pay_to_global": "Global Top-Up",
-        "stable_payout": "Stable payout",
-        "breb": "Bre-B",
-        "global_pay_to_generic": "Generic Transfer"
+        "r2p_spei": "Collection · SPEI",
+        "on_ramp": "Conversion to stablecoin",
+        "off_ramp": "Conversion to local currency",
+        "fedwire": "International transfer · Fedwire",
+        "global_pay_to_usa": "International transfer · USA corridor",
+        "usa_pay_to_global": "International transfer · Global corridor",
+        "cross_border": "International",
+        "stable_payout": "Stablecoin payment · Direct",
+        "breb": "Instant payment · Bre-B",
+        "global_pay_to_generic": "International payment"
     }
 }

package/dist/cjs/movements/types/locales/es-mex.json

@@ -1,27 +1,28 @@
 {
     "movementTypes": {
-        "ach": "ACH",
-        "fast_pay": "Fast Pay",
-        "spei": "SPEI",
-        "spei_card": "SPEI Card",
-        "spei_return": "Retorno SPEI",
-        "r2p": "Solicitud",
-        "r2p_bancolombia": "Recaudo - Botón Bancolombia",
-        "r2p_nequi": "Recaudo - Botón Nequi",
-        "r2p_pse": "Recaudo - PSE",
-        "direct_debit": "Débito a cuenta",
-        "r2p_breb": "Recaudo Bre-B",
-        "r2p_top_up_pse": "Recarga - PSE",
-        "r2p_top_up_bancolombia": "Recarga - Bancolombia",
+        "ach": "Transferencia · ACH",
+        "fast_pay": "Pago real time · Fast Pay",
+        "spei": "Transferencia · SPEI",
+        "spei_card": "Transferencia · SPEI a tarjeta de débito",
+        "spei_return": "Devolución · SPEI",
+        "r2p": "Recaudo con botón de pago · Legacy",
+        "r2p_bancolombia": "Recaudo con botón de pago · Bancolombia",
+        "r2p_nequi": "Recaudo con botón de pago · Nequi",
+        "r2p_pse": "Recaudo con botón de pago · PSE",
+        "direct_debit": "Débito automático",
+        "r2p_breb": "Recaudo · Bre-B",
+        "r2p_top_up_pse": "Recarga de saldo propio · PSE",
+        "r2p_top_up_bancolombia": "Recarga de saldo propio · Bancolombia",
         "global": "Pago global",
-        "r2p_spei": "Recaudo SPEI",
-        "on_ramp": "On Ramp",
-        "off_ramp": "Off Ramp",
-        "fedwire": "Fedwire",
-        "global_pay_to_usa": "Recarga FBO",
-        "usa_pay_to_global": "Recarga Global",
-        "stable_payout": "Pago stable",
-        "breb": "Bre-B",
-        "global_pay_to_generic": "Pago Genérico"
+        "r2p_spei": "Recaudo · SPEI",
+        "on_ramp": "Conversión a stablecoin",
+        "off_ramp": "Conversión a moneda local",
+        "fedwire": "Transferencia internacional · Fedwire",
+        "global_pay_to_usa": "Transferencia internacional · Corredor USA",
+        "usa_pay_to_global": "Transferencia internacional · Corredor Global",
+        "cross_border": "Internacional",
+        "stable_payout": "Pago en stablecoin · Directo",
+        "breb": "Pago instantáneo · Bre-B",
+        "global_pay_to_generic": "Pago internacional"
     }
 }

package/dist/cjs/transactions/index.d.ts

@@ -1,3 +1,4 @@
+export type { ClassificationCategory, ClassificationLine } from "../movements/types/catalog";
 export type { TransactionType } from "./types/catalog";
 export * from "./types/utils/transaction-type.utils";
 export * from "./interfaces/response.interface";