bankson-js-mb 1.0.6 → 2.0.0

package/src/types.ts

@@ -0,0 +1,116 @@
+export interface BaseResponse <T> {
+  total_count: number
+  items: T[]
+}
+
+export interface BankAccountResponse {
+  id: string
+  bic: string
+  iban: string
+  contract_id: string
+  customer_information: {
+    name: string
+    business_id: string | null
+    contact_person: string | null
+    contact_person_ssn: string | null
+    contact_person_email: string | null
+    contact_person_phone: string | null
+  } | null | undefined
+  balance?: number
+  balance_date?: string
+}
+
+export interface BankAccountStatementResponse {
+  id: string
+  from: string
+  to: string
+  legal_sequence_number: string
+  entries: {
+    entry_reference: number
+    archive_id: string
+    booking_date: string
+    value_date: string
+    payment_date: string
+    booking_information: string
+    amount: number
+    receiver: string
+    receiver_account: string
+    debitor: string
+    reference_number: string
+    additional_information: string[]
+  }[]
+  balances: {
+    booking_date: string
+    amount: number
+    available_amount?: number
+  }[]
+  created_at: string
+  updated_at: string
+  servicer_name: string
+  servicer_bic: string
+  account_owner_name: string
+  currency: string
+  test: boolean
+  transaction_summary: {
+    entry_count: number
+    credit_count: number
+    credit_amount: number
+    debit_count: number
+    debit_amount: number
+  }
+  bank_account: BankAccountResponse & {
+    deleted_at: string | null
+    restored_at: string | null
+  }
+}
+
+export interface OutboundPaymentResponse {
+  id: string
+  source: string
+  recipient_name: string
+  recipient_iban: string
+  recipient_bic: string
+  amount: string
+  reference_number: string | null
+  message: string | null
+  payment_date: string
+  vendor_reference: string | null
+  status: string | null
+  created_at: string
+  updated_at: string
+  bank_account: BankAccountResponse
+}
+
+export interface InboundPaymentResponse {
+  id: string
+  bank_account_id: string
+  debitor_name: string
+  amount: number
+  reference_number: string | null
+  message: string | null
+  payment_date: string
+  archive_id: string | null
+  booking_date: string | null
+  created_at: string
+  updated_at: string
+  bank_account: BankAccountResponse
+}
+
+export interface WebhookResponse {
+  id: string
+  description: string | null
+  url: string | null
+  test: boolean
+  production: boolean
+  created_at: string
+  updated_at: string
+}
+
+export interface CallResponse {
+  id: string
+  certificate_id: string
+  file_type: string
+  content: string
+  response: string
+  created_at: string
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2022"],
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "resolveJsonModule": true,
+    //"noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "target": "es2022",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "lib",
+    "allowJs": true,
+    "strictNullChecks": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/.eslintrc.cjs

@@ -1,27 +0,0 @@
-module.exports = {
-  plugins: [
-    'simple-import-sort',
-    'unicorn'
-  ],
-  extends: [
-    'madbooster-node-app'
-  ],
-  rules: {
-    'n/no-missing-import': 2,
-    'n/no-extraneous-import': 2,
-    'n/file-extension-in-import': 2,
-
-    'import/no-unresolved': 2,
-    'import/no-useless-path-segments': 2,
-    'import/no-extraneous-dependencies': 2,
-    'import/no-commonjs': [2, { allowRequire: true }],
-    'import/extensions': [2, 'ignorePackages'],
-    'simple-import-sort/imports': 2,
-    'sort-imports': 0, // import sort plugin needs this
-    'import/order': 0,
-    'import/newline-after-import': 2,
-    'unicorn/prefer-module': 2,
-    'unicorn/prefer-node-protocol': 2,
-    'lodash/prefer-lodash-typecheck': 0
-  }
-}

package/src/client.js

@@ -1,128 +0,0 @@
-import NodeRSA from 'node-rsa'
-
-import ApiKeys from './ext/apikeys.js'
-import Applications from './ext/applications.js'
-import BankAccountStatements from './ext/bank-account-statements.js'
-import BankAccounts from './ext/bank-accounts.js'
-import Certificates from './ext/bank-certificates.js'
-import Calls from './ext/calls.js'
-import InboundPayments from './ext/inbound-payments.js'
-import Payments from './ext/outbound-payments.js'
-import Webhooks from './ext/webhooks.js'
-
-export default class Client {
-  constructor(opts = {}) {
-    this.applications = new Applications(this)
-    this.webhooks = new Webhooks(this)
-    this.certificates = new Certificates(this)
-    this.calls = new Calls(this)
-    this.bankAccounts = new BankAccounts(this)
-    this.bankAccountStatements = new BankAccountStatements(this)
-    this.outboundPayments = new Payments(this)
-    this.apikeys = new ApiKeys(this)
-    this.inboundPayments = new InboundPayments(this)
-    this.beforeRequest = opts.beforeRequest || (() => Promise.resolve())
-    this.bearerToken = opts.bearerToken || '-'
-    this.baseUrl = opts.baseUrl || 'https://api.bankson.fi'
-    this.testMode = typeof opts.test !== 'undefined' ? opts.test : false
-    if(opts.privateKey && opts.apiKey) {
-      // ApiKey authentication
-      this.bearerToken = false
-      this.privateKey = new NodeRSA()
-      this.privateKey.importKey(opts.privateKey, 'private')
-      if(!this.privateKey.isPrivate()) throw new Error('Invalid private key')
-      this.apiKey = opts.apiKey
-    }
-  }
-
-  me() {
-    return this.get('/me')
-  }
-
-  meV2() {
-    return this.get('/v2/me')
-  }
-
-  authorizationHeader(bearerToken) {
-    if(this.bearerToken) return 'Bearer ' + bearerToken
-    const timestamp = Date.now()
-    const str = this.apiKey + timestamp
-    const signature = this.privateKey.sign(str, 'base64')
-    return 'BanksonRSA ' + [
-      'ApiKey=' + this.apiKey,
-      'Timestamp=' + timestamp,
-      'Signature=' + signature
-    ].join(', ')
-  }
-
-  headers(additionalHeaders = {}) {
-    return this.beforeRequest().then(result => {
-      const bearerToken = result?.bearerToken || this.bearerToken
-      const banksonTest = result && typeof result.test !== 'undefined' ? result.test : this.testMode
-      const headers = new Headers()
-      headers.append('Accept', additionalHeaders.Accept || 'application/json')
-      headers.append('Authorization', this.authorizationHeader(bearerToken))
-      if(banksonTest) headers.append('X-Bankson-Environment', 'Test')
-      return headers
-    })
-  }
-
-  get(path, options = {}) {
-    return this.headers(options.headers).then(headers => fetch(`${this.baseUrl}${path}`, { headers }).then(resp => this.handleResponse(resp, options)))
-  }
-
-  post(path, data) {
-    return this.request('POST', path, data)
-  }
-
-  put(path, data) {
-    return this.request('PUT', path, data)
-  }
-
-  request(method, path, data) {
-    return this.headers().then(headers => {
-      const isFormData = data instanceof FormData
-      if(!isFormData) {
-        headers.append('Content-Type', 'application/json')
-      }
-      return fetch(`${this.baseUrl}${path}`, {
-        method,
-        body: isFormData ? data : JSON.stringify(data),
-        headers
-      }).then(this.handleResponse)
-    })
-  }
-
-  delete(path) {
-    return this.headers().then(headers => fetch(`${this.baseUrl}${path}`, {
-      method: 'DELETE',
-      headers
-    })).then(this.handleResponse)
-  }
-
-  handleResponse(resp, options = {}) {
-    if(!resp.ok) {
-      if(resp.status >= 500 || resp.status < 400) {
-        const err = new Error(`Internal error (${resp.status}): ${resp.statusText}`)
-        err.status = resp.status
-        err.statusText = resp.statusText
-        throw err
-      }
-      return getBody(resp).then(json => {
-        const err = new Error('Request unsuccessfull')
-        err.status = resp.status
-        err.body = json
-        throw err
-      })
-    }
-    return getBody(resp)
-
-    function getBody(resp) {
-      if(!/application\/json/.test(resp.headers.get('Content-Type'))) {
-        if(options.responseType === 'arraybuffer') return resp.arrayBuffer()
-        return resp.text()
-      }
-      return resp.json()
-    }
-  }
-}

package/src/ext/bank-account-statements.js

@@ -1,77 +0,0 @@
-export default class BankAccountStatements {
-  constructor(base) {
-    this.base = base
-  }
-
-  fetch() {
-    return this.base.get('/bankaccountstatements')
-  }
-
-  statementHtml(id) {
-    return this.base.get(`/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'text/html'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  statementXml(id) {
-    return this.base.get(`/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'application/xml'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  statementText(id) {
-    return this.base.get(`/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'text/plain'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  refresh(id) {
-    return this.base.post('/bankaccountstatements', {
-      certificate_id: id
-    })
-  }
-
-  fetchV2() {
-    return this.base.get('/v2/bankaccountstatements')
-  }
-
-  statementHtmlV2(id) {
-    return this.base.get(`/v2/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'text/html'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  statementXmlV2(id) {
-    return this.base.get(`/v2/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'application/xml'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  statementTextV2(id) {
-    return this.base.get(`/v2/bankaccountstatements/${id}`, {
-      headers: {
-        Accept: 'text/plain'
-      },
-      responseType: 'arraybuffer'
-    })
-  }
-
-  refreshV2(id) {
-    throw new Error('Not implemented')
-  }
-}

package/src/ext/bank-accounts.js

@@ -1,27 +0,0 @@
-import Qs from 'qs'
-
-export default class BankAccounts {
-  constructor(base) {
-    this.base = base
-  }
-
-  fetch() {
-    return this.base.get('/bankaccounts')
-  }
-
-  create(data) {
-    return this.base.post('/bankaccounts', data)
-  }
-
-  fetchV2(opts) {
-    return this.base.get('/v2/bank-accounts?' + Qs.stringify(opts))
-  }
-
-  createV2(data) {
-    return this.base.post('/v2/bank-accounts', data)
-  }
-
-  updateV2(id, data) {
-    return this.base.put(`/v2/bank-accounts/${id}`, data)
-  }
-}

package/src/ext/calls.js

@@ -1,13 +0,0 @@
-export default class Calls {
-  constructor(base) {
-    this.base = base
-  }
-
-  fetch() {
-    return this.base.get('/calls')
-  }
-
-  fetchV2() {
-    return this.base.get('/v2/calls')
-  }
-}

package/src/ext/inbound-payments.js

@@ -1,40 +0,0 @@
-import Qs from 'qs'
-
-export default class InboundPayments {
-  constructor(base) {
-    this.base = base
-  }
-
-  fetch(opts) {
-    return this.base.get('/inboundpayments?' + Qs.stringify(opts))
-  }
-
-  refresh(certificateId) {
-    return this.base.post('/inboundpayments', { certificate_id: certificateId })
-  }
-
-  batch(batchId, type = 'json') {
-    let opts
-    if(type !== 'json') {
-      opts = {
-        headers: {
-          Accept: type === 'xml' ? 'application/xml' : 'text/plain'
-        },
-        responseType: 'arraybuffer'
-      }
-    }
-    return this.base.get(`/inboundpayments/batches/${batchId}`, opts)
-  }
-
-  fetchV2(opts) {
-    return this.base.get('/v2/inbound-payments?' + Qs.stringify(opts))
-  }
-
-  refreshV2(certificateId) {
-    throw new Error('Not implemented')
-  }
-
-  batchV2(batchId, type = 'json') {
-    throw new Error('Not implemented')
-  }
-}

package/src/ext/outbound-payments.js

@@ -1,31 +0,0 @@
-import Qs from 'qs'
-
-export default class Payments {
-  constructor(base) {
-    this.base = base
-  }
-
-  fetch() {
-    return this.base.get('/payments')
-  }
-
-  fetchFeedback() {
-    return this.base.post('/payments/feedback', {})
-  }
-
-  fetchV2(opts) {
-    return this.base.get('/v2/outbound-payments?' + Qs.stringify(opts))
-  }
-
-  addV2(data) {
-    return this.base.post('/v2/outbound-payments', data)
-  }
-
-  removeV2(id) {
-    return this.base.delete(`/v2/outbound-payments/${id}`)
-  }
-
-  fetchFeedbackV2() {
-    throw new Error('Not implemented')
-  }
-}