@cobre-npm/library-portal-core 0.64.0 → 0.65.0

package/README.md

@@ -706,12 +706,14 @@ import {
 import {
   getFinancialInstitutions, queryFinancialInstitutions,
   type FinancialInstitution, type FinancialInstitutionGeo,
-  type FinancialInstitutionOption, type FinancialInstitutionQuery, type FinancialInstitutionScope,
+  type FinancialInstitutionCatalog, type FinancialInstitutionOption, type FinancialInstitutionQuery,
+  type FinancialInstitutionScope,
 } from "@cobre-npm/library-portal-core/financialInstitutions"
 
 getFinancialInstitutions("en").pr_col_1007            // { code: "pr_col_1007", rawCode: "1007", geo: "col", label: "Bancolombia" }
 queryFinancialInstitutions({ lang: "en", geo: "col" }) // FinancialInstitutionOption[]  → every COL institution
 queryFinancialInstitutions({ lang: "en", geo: "col", scope: "checkout" }) // → only the COL ones the checkout offers
+getFinancialInstitutions("en")[`pr_col_${bankCode}`]?.label ?? bankCode // bankCode: string from an API payload, no cast
 ```
 
 - **institutions** (i18n): `getFinancialInstitutions(lang)`; each record carries `code`, `rawCode`, `geo`
@@ -728,6 +730,11 @@ queryFinancialInstitutions({ lang: "en", geo: "col", scope: "checkout" }) // →
 - `scope` (`"checkout"`, optional on the record) marks the subset of institutions the checkout offers for PSE.
   Unlike `scope` in `currencies` it has **no default**: leaving it out returns the whole catalog, and
   `scope: "checkout"` narrows it. An institution without `scope` is not offered in the checkout.
+- `getFinancialInstitutions(lang)` is also indexable by a plain `string`, for codes that arrive from a payload
+  (`pr_<geo>_<rawCode>` built from a bare bank code): a known code stays non-optional, any other
+  string reads as `FinancialInstitutionOption | undefined`, so an unknown code is handled with `?.` and no cast.
+  The catch is `Object.values(getFinancialInstitutions(lang))`, which is then typed
+  `(FinancialInstitutionOption | undefined)[]`: for a list use `queryFinancialInstitutions`.
 - Bank names have no real translation between `en` and `es-mex`: `es-mex` keeps the name as published by
   the source (accented characters included, e.g. `"Banco de Bogotá"`), `en` is the same string with
   special Spanish characters stripped (`"Banco de Bogota"`) rather than left untranslated with accents.

package/dist/cjs/financialInstitutions/utils/financial-institution.utils.d.ts

@@ -4,11 +4,18 @@ import type { CatalogQuery } from "../../utils/catalog-query.utils";
 export type FinancialInstitutionOption = FinancialInstitutionRecord & {
     label: string;
 };
+/**
+ * The catalog by code. Indexed by a plain string (e.g. a code from an API payload) instead of a known code,
+ * the lookup is `FinancialInstitutionOption | undefined`, so an unknown code needs no cast to be handled.
+ */
+export interface FinancialInstitutionCatalog extends Record<FinancialInstitution, FinancialInstitutionOption> {
+    [code: string]: FinancialInstitutionOption | undefined;
+}
 /**
  * The catalog indexed by code (same shape as FINANCIAL_INSTITUTIONS), each record enriched
- * with its label for the given language. Access by code directly, or Object.values for a list.
+ * with its label for the given language. Access by code directly; for a list use `queryFinancialInstitutions`.
  */
-export declare const getFinancialInstitutions: (lang: Locale) => Record<FinancialInstitution, FinancialInstitutionOption>;
+export declare const getFinancialInstitutions: (lang: Locale) => FinancialInstitutionCatalog;
 /** `lang` is required (i18n domain, no default) and travels inside the query object, never positional. */
 export type FinancialInstitutionQuery = CatalogQuery<FinancialInstitutionRecord> & {
     lang: Locale;

package/dist/cjs/financialInstitutions/utils/financial-institution.utils.js

@@ -9,11 +9,8 @@ const en_json_1 = __importDefault(require("../locales/en.json"));
 const es_mex_json_1 = __importDefault(require("../locales/es-mex.json"));
 const catalog_query_utils_1 = require("../../utils/catalog-query.utils");
 const locales = { en: en_json_1.default, "es-mex": es_mex_json_1.default };
-/**
- * The catalog indexed by code (same shape as FINANCIAL_INSTITUTIONS), each record enriched
- * with its label for the given language. Access by code directly, or Object.values for a list.
- */
-const getFinancialInstitutions = (lang) => {
+// Built with the strict type so `queryFinancialInstitutions` lists it without the string index signature.
+const buildFinancialInstitutions = (lang) => {
     const locale = locales[lang];
     const result = {};
     for (const record of Object.values(catalog_1.FINANCIAL_INSTITUTIONS)) {
@@ -21,11 +18,15 @@ const getFinancialInstitutions = (lang) => {
     }
     return result;
 };
+/**
+ * The catalog indexed by code (same shape as FINANCIAL_INSTITUTIONS), each record enriched
+ * with its label for the given language. Access by code directly; for a list use `queryFinancialInstitutions`.
+ */
+const getFinancialInstitutions = (lang) => buildFinancialInstitutions(lang);
 exports.getFinancialInstitutions = getFinancialInstitutions;
 /** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
 const queryFinancialInstitutions = (query) => {
     const { lang, ...criteria } = query;
-    const institutions = (0, exports.getFinancialInstitutions)(lang);
-    return Object.values(institutions).filter(institution => (0, catalog_query_utils_1.matchesQuery)(institution, criteria));
+    return Object.values(buildFinancialInstitutions(lang)).filter(institution => (0, catalog_query_utils_1.matchesQuery)(institution, criteria));
 };
 exports.queryFinancialInstitutions = queryFinancialInstitutions;

package/dist/esm/financialInstitutions/utils/financial-institution.utils.js

@@ -3,11 +3,8 @@ import enLocale from "../locales/en.json";
 import esMexLocale from "../locales/es-mex.json";
 import { matchesQuery } from "../../utils/catalog-query.utils";
 const locales = { en: enLocale, "es-mex": esMexLocale };
-/**
- * The catalog indexed by code (same shape as FINANCIAL_INSTITUTIONS), each record enriched
- * with its label for the given language. Access by code directly, or Object.values for a list.
- */
-export const getFinancialInstitutions = (lang) => {
+// Built with the strict type so `queryFinancialInstitutions` lists it without the string index signature.
+const buildFinancialInstitutions = (lang) => {
     const locale = locales[lang];
     const result = {};
     for (const record of Object.values(FINANCIAL_INSTITUTIONS)) {
@@ -15,9 +12,13 @@ export const getFinancialInstitutions = (lang) => {
     }
     return result;
 };
+/**
+ * The catalog indexed by code (same shape as FINANCIAL_INSTITUTIONS), each record enriched
+ * with its label for the given language. Access by code directly; for a list use `queryFinancialInstitutions`.
+ */
+export const getFinancialInstitutions = (lang) => buildFinancialInstitutions(lang);
 /** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
 export const queryFinancialInstitutions = (query) => {
     const { lang, ...criteria } = query;
-    const institutions = getFinancialInstitutions(lang);
-    return Object.values(institutions).filter(institution => matchesQuery(institution, criteria));
+    return Object.values(buildFinancialInstitutions(lang)).filter(institution => matchesQuery(institution, criteria));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobre-npm/library-portal-core",
-  "version": "0.64.0",
+  "version": "0.65.0",
   "description": "Shared configurations and resources for Portal MFEs",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",