logos-bancos-br 0.1.0

package/dist/cli.cjs

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+"use strict"; function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+var _chunkBIKMT23Ncjs = require('./chunk-BIKMT23N.cjs');
+
+
+
+var _chunkZGDTPJIVcjs = require('./chunk-ZGDTPJIV.cjs');
+
+// src/cli.ts
+var _util = require('util');
+var HELP = `logos-bancos-br v${_chunkZGDTPJIVcjs.version} \u2014 logos e dados de bancos brasileiros (fontes oficiais)
+
+Uso:
+  logos-bancos-br copy --dest <dir> [--format png|svg|both] [--by compe|ispb] [--only 341,001]
+      Copia os logos para um diret\xF3rio do seu projeto (qualquer stack).
+      --format  png (padr\xE3o), svg ou both
+      --by      nome dos arquivos: compe (0341.png, padr\xE3o) ou ispb (60701190.png)
+      --only    restringe a c\xF3digos COMPE/ISPB separados por v\xEDrgula
+
+  logos-bancos-br list [--json]
+      Lista as institui\xE7\xF5es (COMPE, ISPB, nome, se h\xE1 logo). --json emite o dataset.
+
+  logos-bancos-br help
+`;
+function fail(message) {
+  console.error(`erro: ${message}
+`);
+  console.error(HELP);
+  process.exit(1);
+}
+var [command, ...rest] = process.argv.slice(2);
+switch (command) {
+  case "copy": {
+    const { values } = _util.parseArgs.call(void 0, {
+      args: rest,
+      options: {
+        dest: { type: "string" },
+        format: { type: "string", default: "png" },
+        by: { type: "string", default: "compe" },
+        only: { type: "string" }
+      }
+    });
+    if (!values.dest) fail("--dest \xE9 obrigat\xF3rio em `copy`");
+    if (!["png", "svg", "both"].includes(_nullishCoalesce(values.format, () => ( "")))) {
+      fail(`--format inv\xE1lido: ${values.format}`);
+    }
+    if (!["compe", "ispb"].includes(_nullishCoalesce(values.by, () => ( "")))) fail(`--by inv\xE1lido: ${values.by}`);
+    const only = values.only ? values.only.split(",").map((token) => token.trim()).filter(Boolean) : void 0;
+    const result = _chunkBIKMT23Ncjs.copyLogos.call(void 0, {
+      dest: values.dest,
+      format: values.format,
+      by: values.by,
+      only
+    });
+    console.log(`${result.copied.length} arquivo(s) copiado(s) para ${values.dest}`);
+    if (result.skippedNoSvg.length) {
+      console.log(
+        `${result.skippedNoSvg.length} institui\xE7\xE3o(\xF5es) sem SVG seguro (s\xF3 PNG): ${result.skippedNoSvg.join(", ")}`
+      );
+    }
+    break;
+  }
+  case "list": {
+    const { values } = _util.parseArgs.call(void 0, { args: rest, options: { json: { type: "boolean" } } });
+    const all = _chunkZGDTPJIVcjs.banks.call(void 0, );
+    if (values.json) {
+      console.log(JSON.stringify({ banks: all }, null, 2));
+      break;
+    }
+    for (const bank of all) {
+      const marker = bank.logo ? "\u25CF" : "\xB7";
+      console.log(`${marker} ${bank.compe4}  ${bank.ispb}  ${bank.shortName || bank.name}`);
+    }
+    const withLogo = all.filter((bank) => bank.logo).length;
+    console.log(`
+${all.length} institui\xE7\xF5es \xB7 ${withLogo} com logo (\u25CF)`);
+    break;
+  }
+  case "help":
+  case "--help":
+  case "-h":
+  case void 0:
+    console.log(HELP);
+    break;
+  default:
+    fail(`comando desconhecido: ${command}`);
+}

package/dist/cli.d.cts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+import {
+  copyLogos
+} from "./chunk-SPP4OABR.js";
+import {
+  banks,
+  version
+} from "./chunk-S4JZVP5E.js";
+
+// src/cli.ts
+import { parseArgs } from "util";
+var HELP = `logos-bancos-br v${version} \u2014 logos e dados de bancos brasileiros (fontes oficiais)
+
+Uso:
+  logos-bancos-br copy --dest <dir> [--format png|svg|both] [--by compe|ispb] [--only 341,001]
+      Copia os logos para um diret\xF3rio do seu projeto (qualquer stack).
+      --format  png (padr\xE3o), svg ou both
+      --by      nome dos arquivos: compe (0341.png, padr\xE3o) ou ispb (60701190.png)
+      --only    restringe a c\xF3digos COMPE/ISPB separados por v\xEDrgula
+
+  logos-bancos-br list [--json]
+      Lista as institui\xE7\xF5es (COMPE, ISPB, nome, se h\xE1 logo). --json emite o dataset.
+
+  logos-bancos-br help
+`;
+function fail(message) {
+  console.error(`erro: ${message}
+`);
+  console.error(HELP);
+  process.exit(1);
+}
+var [command, ...rest] = process.argv.slice(2);
+switch (command) {
+  case "copy": {
+    const { values } = parseArgs({
+      args: rest,
+      options: {
+        dest: { type: "string" },
+        format: { type: "string", default: "png" },
+        by: { type: "string", default: "compe" },
+        only: { type: "string" }
+      }
+    });
+    if (!values.dest) fail("--dest \xE9 obrigat\xF3rio em `copy`");
+    if (!["png", "svg", "both"].includes(values.format ?? "")) {
+      fail(`--format inv\xE1lido: ${values.format}`);
+    }
+    if (!["compe", "ispb"].includes(values.by ?? "")) fail(`--by inv\xE1lido: ${values.by}`);
+    const only = values.only ? values.only.split(",").map((token) => token.trim()).filter(Boolean) : void 0;
+    const result = copyLogos({
+      dest: values.dest,
+      format: values.format,
+      by: values.by,
+      only
+    });
+    console.log(`${result.copied.length} arquivo(s) copiado(s) para ${values.dest}`);
+    if (result.skippedNoSvg.length) {
+      console.log(
+        `${result.skippedNoSvg.length} institui\xE7\xE3o(\xF5es) sem SVG seguro (s\xF3 PNG): ${result.skippedNoSvg.join(", ")}`
+      );
+    }
+    break;
+  }
+  case "list": {
+    const { values } = parseArgs({ args: rest, options: { json: { type: "boolean" } } });
+    const all = banks();
+    if (values.json) {
+      console.log(JSON.stringify({ banks: all }, null, 2));
+      break;
+    }
+    for (const bank of all) {
+      const marker = bank.logo ? "\u25CF" : "\xB7";
+      console.log(`${marker} ${bank.compe4}  ${bank.ispb}  ${bank.shortName || bank.name}`);
+    }
+    const withLogo = all.filter((bank) => bank.logo).length;
+    console.log(`
+${all.length} institui\xE7\xF5es \xB7 ${withLogo} com logo (\u25CF)`);
+    break;
+  }
+  case "help":
+  case "--help":
+  case "-h":
+  case void 0:
+    console.log(HELP);
+    break;
+  default:
+    fail(`comando desconhecido: ${command}`);
+}

package/dist/index.cjs

@@ -0,0 +1,20 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+
+var _chunkZGDTPJIVcjs = require('./chunk-ZGDTPJIV.cjs');
+
+
+
+
+
+
+
+
+
+exports.banks = _chunkZGDTPJIVcjs.banks; exports.byCompe = _chunkZGDTPJIVcjs.byCompe; exports.byIspb = _chunkZGDTPJIVcjs.byIspb; exports.findBank = _chunkZGDTPJIVcjs.findBank; exports.logoCdnUrl = _chunkZGDTPJIVcjs.logoCdnUrl; exports.normalizeCompe = _chunkZGDTPJIVcjs.normalizeCompe; exports.normalizeIspb = _chunkZGDTPJIVcjs.normalizeIspb; exports.version = _chunkZGDTPJIVcjs.version;

package/dist/index.d.cts

@@ -0,0 +1,82 @@
+/**
+ * logos-bancos-br — Brazilian bank logos and data from official sources only.
+ *
+ * Universal entry point: works in Node, bundlers (web) and React Native.
+ * The dataset is inlined at build time; no filesystem or network access.
+ *
+ * - Node filesystem paths for the shipped assets: `logos-bancos-br/node`.
+ * - React Native static require() map: `logos-bancos-br/react-native`.
+ */
+interface BankLogoSource {
+    /**
+     * Where the logo came from:
+     * - `openfinance`: published by the institution in the Open Finance Brasil
+     *   participants directory (matched by ISPB/CNPJ);
+     * - `direct-uri`: a hand-reviewed direct URL;
+     * - `override`: a manually maintained file in the repository.
+     */
+    type: 'openfinance' | 'direct-uri' | 'override';
+    /** Open Finance organisation name, when type is `openfinance`. */
+    org: string | null;
+    /** Organisation CNPJ (14 digits), when type is `openfinance`. */
+    cnpj: string | null;
+    /** Source URI of the original artwork. */
+    uri: string;
+    /** SHA-256 of the original artwork (provenance / change detection). */
+    sha256: string;
+    /** ISO date (YYYY-MM-DD) of the last time the artwork changed. */
+    updatedAt: string;
+}
+interface BankLogo {
+    /** Package-relative path of the normalized 256×256 PNG. */
+    png: string;
+    /** Package-relative path of the original SVG, when safely redistributable. */
+    svg: string | null;
+    source: BankLogoSource;
+}
+interface Bank {
+    /** 8-digit ISPB (Central Bank identifier). */
+    ispb: string;
+    /** COMPE number as published by the Central Bank (e.g. "1", "341"). */
+    compe: string;
+    /** COMPE zero-padded to 4 digits (e.g. "0001", "0341"). */
+    compe4: string;
+    /** Official full name (Nome Extenso). */
+    name: string;
+    /** Official short name (Nome Reduzido). */
+    shortName: string;
+    /** Logo info, or null when the institution has no logo in the official sources. */
+    logo: BankLogo | null;
+}
+/** Package version (used to pin CDN URLs). */
+declare const version: string;
+/** Normalizes a COMPE code ("341", 341, "0341") to the 4-digit form. */
+declare function normalizeCompe(code: string | number): string;
+/** Normalizes an ISPB (number or string) to the 8-digit form. */
+declare function normalizeIspb(ispb: string | number): string;
+/** Every institution in the Central Bank STR list that has a COMPE number. */
+declare function banks(): readonly Bank[];
+/** Looks a bank up by COMPE code ("341", 341 and "0341" are equivalent). */
+declare function byCompe(code: string | number): Bank | undefined;
+/** Looks a bank up by 8-digit ISPB. */
+declare function byIspb(ispb: string | number): Bank | undefined;
+/**
+ * Convenience lookup: digits with more than 4 characters are treated as an
+ * ISPB, anything else as a COMPE code.
+ */
+declare function findBank(code: string | number | Bank): Bank | undefined;
+interface LogoCdnUrlOptions {
+    /** Which asset to link. Defaults to `png`; `svg` returns null when there is no safe SVG. */
+    format?: 'png' | 'svg';
+    /** Package version for the pinned URL. Defaults to this build's version. */
+    version?: string;
+}
+/**
+ * URL of the logo served by the jsDelivr CDN (no install required), pinned to
+ * this package version. Returns null when the bank is unknown or has no logo.
+ *
+ * Example: https://cdn.jsdelivr.net/npm/logos-bancos-br@0.1.0/logos/png/60701190.png
+ */
+declare function logoCdnUrl(code: string | number | Bank, { format, version: pinnedVersion }?: LogoCdnUrlOptions): string | null;
+
+export { type Bank, type BankLogo, type BankLogoSource, type LogoCdnUrlOptions, banks, byCompe, byIspb, findBank, logoCdnUrl, normalizeCompe, normalizeIspb, version };

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+/**
+ * logos-bancos-br — Brazilian bank logos and data from official sources only.
+ *
+ * Universal entry point: works in Node, bundlers (web) and React Native.
+ * The dataset is inlined at build time; no filesystem or network access.
+ *
+ * - Node filesystem paths for the shipped assets: `logos-bancos-br/node`.
+ * - React Native static require() map: `logos-bancos-br/react-native`.
+ */
+interface BankLogoSource {
+    /**
+     * Where the logo came from:
+     * - `openfinance`: published by the institution in the Open Finance Brasil
+     *   participants directory (matched by ISPB/CNPJ);
+     * - `direct-uri`: a hand-reviewed direct URL;
+     * - `override`: a manually maintained file in the repository.
+     */
+    type: 'openfinance' | 'direct-uri' | 'override';
+    /** Open Finance organisation name, when type is `openfinance`. */
+    org: string | null;
+    /** Organisation CNPJ (14 digits), when type is `openfinance`. */
+    cnpj: string | null;
+    /** Source URI of the original artwork. */
+    uri: string;
+    /** SHA-256 of the original artwork (provenance / change detection). */
+    sha256: string;
+    /** ISO date (YYYY-MM-DD) of the last time the artwork changed. */
+    updatedAt: string;
+}
+interface BankLogo {
+    /** Package-relative path of the normalized 256×256 PNG. */
+    png: string;
+    /** Package-relative path of the original SVG, when safely redistributable. */
+    svg: string | null;
+    source: BankLogoSource;
+}
+interface Bank {
+    /** 8-digit ISPB (Central Bank identifier). */
+    ispb: string;
+    /** COMPE number as published by the Central Bank (e.g. "1", "341"). */
+    compe: string;
+    /** COMPE zero-padded to 4 digits (e.g. "0001", "0341"). */
+    compe4: string;
+    /** Official full name (Nome Extenso). */
+    name: string;
+    /** Official short name (Nome Reduzido). */
+    shortName: string;
+    /** Logo info, or null when the institution has no logo in the official sources. */
+    logo: BankLogo | null;
+}
+/** Package version (used to pin CDN URLs). */
+declare const version: string;
+/** Normalizes a COMPE code ("341", 341, "0341") to the 4-digit form. */
+declare function normalizeCompe(code: string | number): string;
+/** Normalizes an ISPB (number or string) to the 8-digit form. */
+declare function normalizeIspb(ispb: string | number): string;
+/** Every institution in the Central Bank STR list that has a COMPE number. */
+declare function banks(): readonly Bank[];
+/** Looks a bank up by COMPE code ("341", 341 and "0341" are equivalent). */
+declare function byCompe(code: string | number): Bank | undefined;
+/** Looks a bank up by 8-digit ISPB. */
+declare function byIspb(ispb: string | number): Bank | undefined;
+/**
+ * Convenience lookup: digits with more than 4 characters are treated as an
+ * ISPB, anything else as a COMPE code.
+ */
+declare function findBank(code: string | number | Bank): Bank | undefined;
+interface LogoCdnUrlOptions {
+    /** Which asset to link. Defaults to `png`; `svg` returns null when there is no safe SVG. */
+    format?: 'png' | 'svg';
+    /** Package version for the pinned URL. Defaults to this build's version. */
+    version?: string;
+}
+/**
+ * URL of the logo served by the jsDelivr CDN (no install required), pinned to
+ * this package version. Returns null when the bank is unknown or has no logo.
+ *
+ * Example: https://cdn.jsdelivr.net/npm/logos-bancos-br@0.1.0/logos/png/60701190.png
+ */
+declare function logoCdnUrl(code: string | number | Bank, { format, version: pinnedVersion }?: LogoCdnUrlOptions): string | null;
+
+export { type Bank, type BankLogo, type BankLogoSource, type LogoCdnUrlOptions, banks, byCompe, byIspb, findBank, logoCdnUrl, normalizeCompe, normalizeIspb, version };

package/dist/index.js

@@ -0,0 +1,20 @@
+import {
+  banks,
+  byCompe,
+  byIspb,
+  findBank,
+  logoCdnUrl,
+  normalizeCompe,
+  normalizeIspb,
+  version
+} from "./chunk-S4JZVP5E.js";
+export {
+  banks,
+  byCompe,
+  byIspb,
+  findBank,
+  logoCdnUrl,
+  normalizeCompe,
+  normalizeIspb,
+  version
+};

package/dist/node.cjs

@@ -0,0 +1,11 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkBIKMT23Ncjs = require('./chunk-BIKMT23N.cjs');
+require('./chunk-ZGDTPJIV.cjs');
+
+
+
+
+exports.copyLogos = _chunkBIKMT23Ncjs.copyLogos; exports.logoPngPath = _chunkBIKMT23Ncjs.logoPngPath; exports.logoSvgPath = _chunkBIKMT23Ncjs.logoSvgPath;

package/dist/node.d.cts

@@ -0,0 +1,29 @@
+import { Bank } from './index.cjs';
+
+/**
+ * Node-only helpers: absolute filesystem paths of the shipped assets and the
+ * copy routine used by the CLI to vendor logos into any project (any stack).
+ */
+
+/** Absolute path of the bank's normalized PNG, or null when it has no logo. */
+declare function logoPngPath(code: string | number | Bank): string | null;
+/** Absolute path of the bank's original SVG, or null when unavailable. */
+declare function logoSvgPath(code: string | number | Bank): string | null;
+interface CopyLogosOptions {
+    /** Destination directory (created if missing). */
+    dest: string;
+    /** Which assets to copy. Defaults to `png`. */
+    format?: 'png' | 'svg' | 'both';
+    /** File naming: 4-digit COMPE (default) or 8-digit ISPB. */
+    by?: 'compe' | 'ispb';
+    /** Restrict to these COMPE/ISPB codes (any format). Copies all when omitted. */
+    only?: Array<string | number>;
+}
+interface CopyLogosResult {
+    copied: string[];
+    skippedNoSvg: string[];
+}
+/** Copies shipped logos into a project directory, named by COMPE or ISPB. */
+declare function copyLogos({ dest, format, by, only, }: CopyLogosOptions): CopyLogosResult;
+
+export { type CopyLogosOptions, type CopyLogosResult, copyLogos, logoPngPath, logoSvgPath };

package/dist/node.d.ts

@@ -0,0 +1,29 @@
+import { Bank } from './index.js';
+
+/**
+ * Node-only helpers: absolute filesystem paths of the shipped assets and the
+ * copy routine used by the CLI to vendor logos into any project (any stack).
+ */
+
+/** Absolute path of the bank's normalized PNG, or null when it has no logo. */
+declare function logoPngPath(code: string | number | Bank): string | null;
+/** Absolute path of the bank's original SVG, or null when unavailable. */
+declare function logoSvgPath(code: string | number | Bank): string | null;
+interface CopyLogosOptions {
+    /** Destination directory (created if missing). */
+    dest: string;
+    /** Which assets to copy. Defaults to `png`. */
+    format?: 'png' | 'svg' | 'both';
+    /** File naming: 4-digit COMPE (default) or 8-digit ISPB. */
+    by?: 'compe' | 'ispb';
+    /** Restrict to these COMPE/ISPB codes (any format). Copies all when omitted. */
+    only?: Array<string | number>;
+}
+interface CopyLogosResult {
+    copied: string[];
+    skippedNoSvg: string[];
+}
+/** Copies shipped logos into a project directory, named by COMPE or ISPB. */
+declare function copyLogos({ dest, format, by, only, }: CopyLogosOptions): CopyLogosResult;
+
+export { type CopyLogosOptions, type CopyLogosResult, copyLogos, logoPngPath, logoSvgPath };

package/dist/node.js

@@ -0,0 +1,11 @@
+import {
+  copyLogos,
+  logoPngPath,
+  logoSvgPath
+} from "./chunk-SPP4OABR.js";
+import "./chunk-S4JZVP5E.js";
+export {
+  copyLogos,
+  logoPngPath,
+  logoSvgPath
+};

package/llms.txt

@@ -0,0 +1,48 @@
+# logos-bancos-br
+
+> Brazilian bank institution list + official bank logos, rebuilt automatically every week from
+> official sources only: the Central Bank of Brazil (BCB) STR participants list and the Open
+> Finance Brasil participants directory. npm package: `logos-bancos-br`. Code and dataset are
+> MIT; the logos are trademarks of their respective institutions, redistributed for nominative
+> use (see DISCLAIMER.md).
+
+Key facts:
+
+- The **institution list is auto-updated**: every institution with a COMPE code in the BCB STR
+  participants list (currently ~470) ships in `data/bancos.json` with `ispb` (8 digits),
+  `compe`, `compe4` (zero-padded), official `name`, `shortName`, and `logo` (or `logo: null`).
+- The **logos are auto-updated** too: currently ~107 institutions, as normalized transparent
+  256×256 PNGs (`logos/png/<ISPB>.png`) plus sanitized original SVGs (`logos/svg/<ISPB>.svg`)
+  when available. Assets are keyed by **ISPB**, not COMPE.
+- **Update cadence**: a GitHub Action (`.github/workflows/update-logos.yml`) runs every Monday
+  (and on demand), rebuilds the list and the logos from the official sources, and opens a pull
+  request with a report and the visual diff. Nothing is hand-curated.
+- **Per-logo provenance**: each logo records the source URI, the SHA-256 of the original artwork
+  and the last-change date in `data/bancos.json`.
+- **Matching safety**: a logo is assigned automatically only when the institution's ISPB equals
+  the first 8 digits of the Open Finance organisation's CNPJ. Name similarity never assigns a
+  logo — it only produces suggestions that a human reviews and promotes to `forcedMatches` in
+  `pipeline/config.json`.
+- **JavaScript API** (`logos-bancos-br`): `banks()`, `byCompe('341' | 341 | '0341')`,
+  `byIspb('60701190')`, `findBank(code)`, `logoCdnUrl(code, { format: 'png' | 'svg' })`.
+  Node-only paths: `logoPngPath()` / `logoSvgPath()` from `logos-bancos-br/node`. React Native
+  static require() map: `logos-bancos-br/react-native` (keys: 4-digit COMPE and 8-digit ISPB).
+- **CLI for any stack** (Flutter, Kotlin, Swift, .NET, PHP…):
+  `npx logos-bancos-br copy --dest <dir> [--by compe|ispb] [--format png|svg|both] [--only 341,001]`
+  and `npx logos-bancos-br list [--json]`.
+- **CDN, no install** (pin a version):
+  `https://cdn.jsdelivr.net/npm/logos-bancos-br@<version>/logos/png/<ISPB>.png`. The COMPE→ISPB
+  mapping lives in `data/bancos.json`.
+
+## Docs
+
+- [README (português)](README.md)
+- [README (English)](README.en.md)
+- [Gallery of all shipped logos](PREVIEW.md)
+- [Trademark notice and takedown policy](DISCLAIMER.md)
+- [Maintenance and pipeline guide](CONTRIBUTING.md)
+
+## Official sources
+
+- [BCB STR participants CSV](https://www.bcb.gov.br/content/estabilidadefinanceira/str1/ParticipantesSTR.csv)
+- [Open Finance Brasil participants directory](https://data.directory.openbankingbrasil.org.br/participants)