feat: initial commit

.eslintrc.json

@@ -0,0 +1,26 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint/eslint-plugin",
+    "prettier"
+  ],
+  "extends": [
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:prettier/recommended"
+  ],
+  "root": true,
+  "env": {
+    "node": true,
+    "jest": true
+  },
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off"
+  }
+}

.github/workflows/gitleaks.yaml

@@ -0,0 +1,22 @@
+name: gitleaks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  gitleaks:
+    name: gitleaks
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+      - name: gitleaks-action
+        uses: zricethezav/[email protected]

.github/workflows/main.yaml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    name: Test
+    runs-on: ubuntu-latest
+    container: node:lts
+    timeout-minutes: 5
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - uses: actions/[email protected]
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+          scope: '@acid-tango'
+      - uses: actions/[email protected]
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Lint
+        run: yarn lint
+      - name: Tests
+        run: yarn test
+        env:
+          ARCUS_API_KEY: ${{secrets.ARCUS_API_KEY}}
+          ARCUS_SECRET_KEY: ${{secrets.ARCUS_SECRET_KEY}}

.github/workflows/pull_request.yaml

@@ -0,0 +1,36 @@
+name: CI
+
+on: pull_request
+
+jobs:
+  tests:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ["12", "14", "16"]
+    container: node:lts
+    timeout-minutes: 5
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - uses: actions/[email protected]
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org
+          scope: '@acid-tango'
+      - uses: actions/[email protected]
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Lint
+        run: yarn lint
+      - name: Tests
+        run: yarn test
+        env:
+          ARCUS_API_KEY: ${{secrets.ARCUS_API_KEY}}
+          ARCUS_SECRET_KEY: ${{secrets.ARCUS_SECRET_KEY}}

.github/workflows/release.yaml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  tests:
+    name: Test
+    runs-on: ubuntu-latest
+    container: node:lts
+    timeout-minutes: 5
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - uses: actions/[email protected]
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+          scope: '@acid-tango'
+      - uses: actions/[email protected]
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Lint
+        run: yarn lint
+      - name: Tests
+        run: yarn test
+        env:
+          ARCUS_API_KEY: ${{secrets.ARCUS_API_KEY}}
+          ARCUS_SECRET_KEY: ${{secrets.ARCUS_SECRET_KEY}}
+      - name: Publish
+        run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPMJS_TOKEN}}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.idea
+lib
+.vscode

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit "$1"

.prettierignore

@@ -0,0 +1 @@
+src/migrations/*.ts

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100
+}

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021 AcidTango
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,96 @@
+# arcus-js
+
+[![NPM version](https://img.shields.io/npm/v/@acid-tango/arcus-js.svg)](https://www.npmjs.com/package/@acid-tango/arcus-js)
+[![CI](https://github.com/acidtango/arcus-js/actions/workflows/main.yaml/badge.svg)](https://github.com/acidtango/arcus-js/actions/workflows/main.yaml)
+
+Arcus TypeScript client library for [Arcus API v3.x](https://docs.arcusfi.com/api/3.mx/endpoints/)
+
+## Installation
+
+```bash
+npm install --save @acid-tango/arcus-js
+# or
+yarn add @acid-tango/arcus-js
+```
+
+## Usage
+
+- [Authentication](#authentication)
+- [Account](#account)
+- [Billers](#billers)
+- [Payment](#payment)
+- [Transactions](#transactions)
+
+### Authentication
+
+```typescript
+import { Arcus } from '@acid-tango/arcus-js';
+
+const arcusClient = Arcus.create(
+    process.env.ARCUS_API_KEY as string,
+    process.env.ARCUS_SECRET_KEY as string,
+  );
+```
+
+### Get account info
+
+Returns all the info about your account.
+
+```typescript
+const account = await arcusClient.getAccount()
+```
+
+### Billers methods
+
+Return all billers:
+
+```typescript
+const allBillers = await arcusClient.getBillers()
+```
+
+Return billers by type:
+
+```typescript
+const utilities = await arcusClient.getBillersUtilities()
+const topUps = await arcusClient.getBillersTopUps()
+const giftCards = await arcusClient.getBillersGiftCards()
+```
+
+### Payment
+
+```typescript
+// Creates a single payment and returns the created transaction
+const singlePayParams: ArcusSinglePayParams = {...}
+
+const transaction = await arcusClient.singlePay(singlePayParams)
+```
+
+### Transactions
+
+Get a transaction by id:
+
+```typescript
+const transaction = await arcusClient.getTransaction(transactionId)
+```
+
+Cancel a transaction by id:
+
+```typescript
+await arcusClient.cancelTransaction(transactionId)
+```
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'feat: Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## 📲 Contact
+
+The project was mainly developed by [Abel García](mailto:[email protected]), [Aarón Pérez](mailto:[email protected]), [Daniel Ramos](mailto:[email protected]) and [Daniel Gak](mailto:[email protected]) from [Acid Tango](https://acidtango.com/) with ❤️ and 💪 for [Rabbit](https://www.rabbitmx.com/).
+
+## License
+
+[MIT](LICENSE)

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

examples/pay-netflix.ts

@@ -0,0 +1,28 @@
+import { Arcus } from '../src/Arcus';
+
+const main = async () => {
+  const arcus = Arcus.create(
+    process.env.ARCUS_API_KEY as string,
+    process.env.ARCUS_SECRET_KEY as string,
+  );
+
+  const giftCards = await arcus.getBillersGiftCards();
+
+  const netflix = giftCards.find((giftCard) => giftCard.id === 13723); // CÓDIGO NETFLIX $300
+
+  if (!netflix) throw new Error("Couldn't find netflix");
+
+  await arcus.singlePay({
+    billerId: netflix.id,
+    accountNumber: '321654871238120',
+    amount: 130,
+    currency: 'MXN',
+    externalId: '84bce950-c878-483e-aeca-41217f969301',
+  });
+
+  const transactions = await arcus.getTransactions();
+
+  console.log(transactions);
+};
+
+main().catch((err) => console.error(err));