@cobre-npm/library-portal-core 0.54.0 → 0.55.0

package/README.md

@@ -221,19 +221,34 @@ Groups two catalogs:
 
 ```ts
 import {
-  getCountries, type Country, type CountryOption,
-  getCountriesISO, getIndicativesWithCodes, hasCountryISOFlag,
-  type CountryISO, type CountryISOOption, type IndicativeWithCode,
+  getCountries, queryCountries, type Country, type CountryOption, type CountryQuery,
+  getCountriesISO, queryCountriesISO, getIndicativesWithCodes, hasCountryISOFlag,
+  type CountryISO, type CountryISOOption, type CountryISOQuery, type IndicativeWithCode,
 } from "@cobre-npm/library-portal-core/countries"
 
-getCountries("en").col.label            // "Colombia"
-getCountriesISO("en").col               // { code:"col", isoCode:"COL", indicative:"+57", label:"Colombia" }
-getIndicativesWithCodes("en")           // view-model for a phone dialing-code selector
-hasCountryISOFlag("col")                // true — whether a flag asset is available
+getCountries("en").col.label                          // "Colombia"
+queryCountries({ lang: "en", code: ["mex", "col"] })  // [ mex, col ]  → the list a picker needs
+getCountriesISO("en").col                             // { code:"col", isoCode:"COL", indicative:"+57", label:"Colombia" }
+queryCountriesISO({ lang: "en", isoCode: "MEX" })     // [ mex ]  → filter the full ISO catalog
+getIndicativesWithCodes("en")                         // view-model for a phone dialing-code selector
+hasCountryISOFlag("col")                              // true — whether a flag asset is available
 ```
 
 - **base** (i18n): business countries (`col`, `mex`, `usa`, `global`, …).
+  `queryCountries({ lang, ... })` returns the same catalog as a **list**, narrowed by `code` — same
+  matching rules as [`queryAccountTypes`](#accounts): `lang` is required (i18n domain, no default) inside
+  the query object, and there is no default field.
 - **iso** (i18n): full ISO catalog (~249 countries) with `isoCode` and `indicative`.
+  `queryCountriesISO({ lang, ... })` returns the same catalog as a **list**, narrowed by `code`/`isoCode`
+  — same rules as above, over the full ISO catalog instead of the small business one.
+
+As with every `queryX()`, **a key that is present always filters** — it's the absence of the key that
+doesn't. So `queryCountries({ lang, code: undefined })` returns `[]`, not "no filter". An optional UI
+filter has to be spread in conditionally:
+
+```ts
+queryCountries({ lang, ...(codes ? { code: codes } : {}) })
+```
 
 ### `movements`
 

package/dist/cjs/countries/base/utils/country.utils.d.ts

@@ -1,6 +1,13 @@
 import type { Country, CountryRecord } from "../catalog";
 import type { Locale } from "../../../lang";
+import type { CatalogQuery } from "../../../utils/catalog-query.utils";
 export type CountryOption = CountryRecord & {
     label: string;
 };
 export declare const getCountries: (lang: Locale) => Record<Country, CountryOption>;
+/** `lang` is required (i18n domain, no default) and travels inside the query object, never positional. */
+export type CountryQuery = CatalogQuery<CountryRecord> & {
+    lang: Locale;
+};
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+export declare const queryCountries: (query: CountryQuery) => CountryOption[];

package/dist/cjs/countries/base/utils/country.utils.js

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCountries = void 0;
+exports.queryCountries = exports.getCountries = void 0;
 const catalog_1 = require("../catalog");
 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 };
 const getCountries = (lang) => {
     const locale = locales[lang];
@@ -17,3 +18,10 @@ const getCountries = (lang) => {
     return result;
 };
 exports.getCountries = getCountries;
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+const queryCountries = (query) => {
+    const { lang, ...criteria } = query;
+    const countries = (0, exports.getCountries)(lang);
+    return Object.values(countries).filter(country => (0, catalog_query_utils_1.matchesQuery)(country, criteria));
+};
+exports.queryCountries = queryCountries;

package/dist/cjs/countries/iso/utils/country-iso.utils.d.ts

@@ -1,5 +1,6 @@
 import type { CountryISO, CountryISORecord } from "../catalog";
 import type { Locale } from "../../../lang";
+import type { CatalogQuery } from "../../../utils/catalog-query.utils";
 export declare const hasCountryISOFlag: (code: CountryISO) => boolean;
 export type CountryISOOption = CountryISORecord & {
     label: string;
@@ -12,4 +13,10 @@ export interface IndicativeWithCode {
     isoCode: string | undefined;
 }
 export declare const getCountriesISO: (lang: Locale) => Record<CountryISO, CountryISOOption>;
+/** `lang` is required (i18n domain, no default) and travels inside the query object, never positional. */
+export type CountryISOQuery = CatalogQuery<CountryISORecord> & {
+    lang: Locale;
+};
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+export declare const queryCountriesISO: (query: CountryISOQuery) => CountryISOOption[];
 export declare const getIndicativesWithCodes: (lang: Locale) => IndicativeWithCode[];

package/dist/cjs/countries/iso/utils/country-iso.utils.js

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIndicativesWithCodes = exports.getCountriesISO = exports.hasCountryISOFlag = void 0;
+exports.getIndicativesWithCodes = exports.queryCountriesISO = exports.getCountriesISO = exports.hasCountryISOFlag = void 0;
 const catalog_1 = require("../catalog");
 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 };
 const AVAILABLE_FLAG_CODES = new Set(["col", "mex", "usa"]);
 const hasCountryISOFlag = (code) => AVAILABLE_FLAG_CODES.has(code);
@@ -20,6 +21,13 @@ const getCountriesISO = (lang) => {
     return result;
 };
 exports.getCountriesISO = getCountriesISO;
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+const queryCountriesISO = (query) => {
+    const { lang, ...criteria } = query;
+    const countries = (0, exports.getCountriesISO)(lang);
+    return Object.values(countries).filter(country => (0, catalog_query_utils_1.matchesQuery)(country, criteria));
+};
+exports.queryCountriesISO = queryCountriesISO;
 const getIndicativesWithCodes = (lang) => {
     const locale = locales[lang];
     const seenDialCodes = new Set();

package/dist/esm/countries/base/utils/country.utils.js

@@ -1,6 +1,7 @@
 import { COUNTRIES } from "../catalog";
 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 };
 export const getCountries = (lang) => {
     const locale = locales[lang];
@@ -10,3 +11,9 @@ export const getCountries = (lang) => {
     }
     return result;
 };
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+export const queryCountries = (query) => {
+    const { lang, ...criteria } = query;
+    const countries = getCountries(lang);
+    return Object.values(countries).filter(country => matchesQuery(country, criteria));
+};

package/dist/esm/countries/iso/utils/country-iso.utils.js

@@ -1,6 +1,7 @@
 import { COUNTRIES_ISO } from "../catalog";
 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 };
 const AVAILABLE_FLAG_CODES = new Set(["col", "mex", "usa"]);
 export const hasCountryISOFlag = (code) => AVAILABLE_FLAG_CODES.has(code);
@@ -12,6 +13,12 @@ export const getCountriesISO = (lang) => {
     }
     return result;
 };
+/** The catalog as a list, narrowed by the query — see `matchesQuery` for the matching rules. */
+export const queryCountriesISO = (query) => {
+    const { lang, ...criteria } = query;
+    const countries = getCountriesISO(lang);
+    return Object.values(countries).filter(country => matchesQuery(country, criteria));
+};
 export const getIndicativesWithCodes = (lang) => {
     const locale = locales[lang];
     const seenDialCodes = new Set();

package/package.json

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