transbank-sdk
Version:
Transbank SDK for Node.js
84 lines (78 loc) • 18 kB
HTML
<html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>transbank-sdk</title><meta name="description" content="Documentation for transbank-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">transbank-sdk</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>transbank-sdk</h1></div><div class="tsd-panel tsd-typography"><p><a href="https://github.com/TransbankDevelopers/transbank-sdk-nodejs/releases/latest"><img src="https://img.shields.io/github/v/tag/transbankdevelopers/transbank-sdk-nodejs" alt="GitHub tag (latest by date)"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/transbankdevelopers/transbank-sdk-nodejs" alt="GitHub"></a>
<a href="https://github.com/TransbankDevelopers/transbank-sdk-nodejs/graphs/contributors"><img src="https://img.shields.io/github/contributors/transbankdevelopers/transbank-sdk-nodejs" alt="GitHub contributors"></a></p>
<h1 id="transbank-sdk-nodejs" class="tsd-anchor-link">Transbank SDK Node.js<a href="#transbank-sdk-nodejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Este es el SDK oficial de Transbank para Node.js</p>
<h3 id="requisitos" class="tsd-anchor-link">Requisitos:<a href="#requisitos" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
<li>Node.js 18+</li>
</ul>
<h3 id="instalar-con" class="tsd-anchor-link">Instalar con <code>npm</code><a href="#instalar-con" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Puedes instalar SDK en tu proyecto usando NPM</p>
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">transbank-sdk</span>
</code><button type="button">Copy</button></pre>
<h3 id="instalar-con-1" class="tsd-anchor-link">Instalar con <code>yarn</code><a href="#instalar-con-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>ó también instalarlo usando <a href="https://yarnpkg.com/">Yarn</a></p>
<pre><code class="bash"><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">transbank-sdk</span>
</code><button type="button">Copy</button></pre>
<h3 id="detectar-vulnerabilidades-con" class="tsd-anchor-link">Detectar vulnerabilidades con <code>npm</code><a href="#detectar-vulnerabilidades-con" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-3"># Este comando te permite ver las vulnerabilidades</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">audit</span><br/><br/><span class="hl-3"># Este comando te permite reparar las vulnerabilidades</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">audit</span><span class="hl-1"> </span><span class="hl-2">fix</span>
</code><button type="button">Copy</button></pre>
<h3 id="compilar" class="tsd-anchor-link">Compilar<a href="#compilar" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
</code><button type="button">Copy</button></pre>
<h3 id="ejecutar-test" class="tsd-anchor-link">Ejecutar test<a href="#ejecutar-test" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test</span><br/><br/><span class="hl-3"># Tests con coverage</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test:coverage</span>
</code><button type="button">Copy</button></pre>
<h2 id="documentación" class="tsd-anchor-link">Documentación<a href="#documentación" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Puedes encontrar toda la documentación de cómo usar este SDK en el sitio <a href="https://www.transbankdevelopers.cl">www.transbankdevelopers.cl</a>.</p>
<p>La documentación relevante para usar este SDK es:</p>
<ul>
<li>Documentación general sobre los productos y sus diferencias:
<a href="https://www.transbankdevelopers.cl/producto/webpay">Webpay</a>.</li>
<li>Documentación sobre <a href="https://www.transbankdevelopers.cl/documentacion/como_empezar#ambientes">ambientes, deberes del comercio, puesta en producción,
etc</a>.</li>
<li>Primeros pasos con <a href="https://www.transbankdevelopers.cl/documentacion/webpay">Webpay</a>.</li>
<li>Referencia detallada sobre <a href="https://www.transbankdevelopers.cl/referencia/webpay">Webpay</a></li>
</ul>
<h2 id="información-para-contribuir-a-este-proyecto" class="tsd-anchor-link">Información para contribuir a este proyecto<a href="#información-para-contribuir-a-este-proyecto" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="forma-de-trabajo" class="tsd-anchor-link">Forma de trabajo<a href="#forma-de-trabajo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
<li>Para los mensajes de commits, nos basamos en las <a href="https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits">Git Commit Guidelines de Angular</a>.</li>
<li>Usamos inglés para los nombres de ramas y mensajes de commit.</li>
<li>Los mensajes de commit no deben llevar punto final.</li>
<li>Los mensajes de commit deben usar un lenguaje imperativo y estar en tiempo presente, por ejemplo, usar "change" en lugar de "changed" o "changes".</li>
<li>Los nombres de las ramas deben estar en minúsculas y las palabras deben separarse con guiones (-).</li>
<li>Todas las fusiones a la rama principal se deben realizar mediante solicitudes de Pull Request(PR). ⬇️</li>
<li>Se debe emplear tokens como "WIP" en el encabezado de un commit, separados por dos puntos (:), por ejemplo, "WIP: this is a useful commit message".</li>
<li>Una rama con nuevas funcionalidades que no tenga un PR, se considera que está en desarrollo.</li>
<li>Los nombres de las ramas deben comenzar con uno de los tokens definidos. Por ejemplo: "feat/tokens-configurations".</li>
</ul>
<h3 id="short-lead-tokens-permitidos" class="tsd-anchor-link">Short lead tokens permitidos<a href="#short-lead-tokens-permitidos" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>WIP</code> = En progreso.</p>
<p><code>feat</code> = Nuevos features.</p>
<p><code>fix</code> = Corrección de un bug.</p>
<p><code>docs</code> = Cambios solo de documentación.</p>
<p><code>style</code> = Cambios que no afectan el significado del código. (espaciado, formateo de código, comillas faltantes, etc)</p>
<p><code>refactor</code> = Un cambio en el código que no arregla un bug ni agrega una funcionalidad.</p>
<p><code>perf</code> = Cambio que mejora el rendimiento.</p>
<p><code>test</code> = Agregar test faltantes o los corrige.</p>
<p><code>chore</code> = Cambios en el build o herramientas auxiliares y librerías.</p>
<p><code>revert</code> = Revierte un commit.</p>
<p><code>release</code> = Para liberar una nueva versión.</p>
<h3 id="creación-de-un-pull-request" class="tsd-anchor-link">Creación de un Pull Request<a href="#creación-de-un-pull-request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
<li>El PR debe estar enfocado en un cambio en concreto, por ejemplo, agregar una nueva funcionalidad o solucionar un error, pero un solo PR no puede agregar una nueva funcionalidad y arreglar un error.</li>
<li>El título del los PR y mensajes de commit no debe comenzar con una letra mayúscula.</li>
<li>No se debe usar punto final en los títulos.</li>
<li>El título del PR debe comenzar con el short lead token definido para la rama, seguido de ":"" y una breve descripción del cambio.</li>
<li>La descripción del PR debe detallar los cambios que se están incorporando.</li>
<li>La descripción del PR debe incluir evidencias de que los test se ejecutan de forma correcta o incluir evidencias de que los cambios funcionan y no afectan la funcionalidad previa del proyecto.</li>
<li>Se pueden agregar capturas, gif o videos para complementar la descripción o demostrar el funcionamiento del PR.</li>
</ul>
<h4 id="flujo-de-trabajo" class="tsd-anchor-link">Flujo de trabajo<a href="#flujo-de-trabajo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ol>
<li>Crea tu rama desde develop.</li>
<li>Haz un push de los commits y publica la nueva rama.</li>
<li>Abre un Pull Request apuntando tus cambios a develop.</li>
<li>Espera a la revisión de los demás integrantes del equipo.</li>
<li>Para poder mezclar los cambios se debe contar con 2 aprobaciones de los revisores y no tener alertas por parte de las herramientas de inspección.</li>
</ol>
<h3 id="esquema-de-flujo-con-git" class="tsd-anchor-link">Esquema de flujo con git<a href="#esquema-de-flujo-con-git" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><img src="https://wac-cdn.atlassian.com/dam/jcr:cc0b526e-adb7-4d45-874e-9bcea9898b4a/04%20Hotfix%20branches.svg?cdnVersion=1324" alt="gitflow"></p>
<h2 id="generar-una-nueva-versión" class="tsd-anchor-link">Generar una nueva versión<a href="#generar-una-nueva-versión" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Para generar una nueva versión, se debe crear un PR (con un título "release: prepare release X.Y.Z" con los valores que correspondan para <code>X</code>, <code>Y</code> y <code>Z</code>). Se debe seguir el estándar <a href="https://semver.org/lang/es/">SemVer</a> para determinar si se incrementa el valor de <code>X</code> (si hay cambios no retrocompatibles), <code>Y</code> (para mejoras retrocompatibles) o <code>Z</code> (si sólo hubo correcciones a bugs).</p>
<p>En ese PR deben incluirse los siguientes cambios:</p>
<ol>
<li>Modificar el archivo <code>CHANGELOG.md</code> para incluir una nueva entrada (al comienzo) para <code>X.Y.Z</code> que explique en español los cambios.</li>
<li>Actualizar <code>README.md</code> en caso de que se requiera. Validar si cambiaron instrucciones o requerimientos.</li>
<li>Modificar el archivo <code>package.json</code> y modificar la versión.</li>
</ol>
<p>Luego de obtener aprobación del PR, debe mezclarse a master e inmediatamente generar un release en GitHub con el tag <code>X.Y.Z</code>. En la descripción del release debes poner lo mismo que agregaste al changelog.</p>
<p>Posterior a la liberación debes mezclar la rama release en develop, finalmente realizar un rebase de la rama develop utilizando como base la rama main.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#transbank-sdk-nodejs"><span>Transbank <wbr/>SDK <wbr/>Node.js</span></a><ul><li><ul><li><a href="#requisitos"><span>Requisitos:</span></a></li><li><a href="#instalar-con"><span>Instalar con </span></a></li><li><a href="#instalar-con-1"><span>Instalar con </span></a></li><li><a href="#detectar-vulnerabilidades-con"><span>Detectar vulnerabilidades con </span></a></li><li><a href="#compilar"><span>Compilar</span></a></li><li><a href="#ejecutar-test"><span>Ejecutar test</span></a></li></ul></li><li><a href="#documentación"><span>Documentación</span></a></li><li><a href="#información-para-contribuir-a-este-proyecto"><span>Información para contribuir a este proyecto</span></a></li><li><ul><li><a href="#forma-de-trabajo"><span>Forma de trabajo</span></a></li><li><a href="#short-lead-tokens-permitidos"><span>Short lead tokens permitidos</span></a></li><li><a href="#creación-de-un-pull-request"><span>Creación de un <wbr/>Pull <wbr/>Request</span></a></li><li><ul><li><a href="#flujo-de-trabajo"><span>Flujo de trabajo</span></a></li></ul></li><li><a href="#esquema-de-flujo-con-git"><span>Esquema de flujo con git</span></a></li></ul></li><li><a href="#generar-una-nueva-versión"><span>Generar una nueva versión</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">transbank-sdk</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>