Merge pull request #31 from Enrise/develop

v2.0 release

Author: woutse

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+- 
+
+## How to test
+<!--- Create a list of steps people can take to test the changes -->
+- [ ] `npm install`
+- [ ] ...

.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, v2 ]
+  pull_request:
+
+jobs:
+  lint-and-type-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Check linting and types
+      run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18, 20, 22, 24]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run tests
+      run: npm run test

.gitignore

@@ -4,4 +4,4 @@ build/*
 lib/*
 .idea/
 *.d.ts
-*.js
+coverage/

.prettierrc

@@ -0,0 +1,17 @@
+{
+    "bracketSpacing": true,
+    "bracketSameLine": true,
+    "singleQuote": true,
+    "arrowParens": "avoid",
+    "trailingComma": "all",
+    "tabWidth": 4,
+    "printWidth": 100,
+    "overrides": [
+        {
+            "files": ["*.yml", "*.yaml", "*.json"],
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## [2.0.0]
+
+### Changed
+- Refactored DirectDebit to new REST API.
+
+### Removed
+- Deprecated endpoints and dependencies, see UPGRADING.md for details.
+
+## [1.2.0]
+
+### Added
+- New order API endpoints.
+
+### Deprecated
+- All transaction endpoints, except for the status endpoint (see UPGRADING.md)
+
+### Changed
+- Package overhead maintenance (CI, linting, etc.).
+
+### Security
+- CVE-2023-28155: Updated `request` package.
+
+## [1.1.4]
+
+No changelog was recorded up to this release.

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+Thank you for considering contributing to this project! We welcome contributions from the community. Please follow the 
+guidelines below to ensure a smooth contribution process.
+
+## Code style and formatting
+
+We use ESLint to enforce code style and formatting. To ensure your code adheres to the project's standards, please run 
+the following command before submitting a pull request:
+
+```bash
+npm run lint
+// or
+npm run fix
+```
+
+## Running tests
+
+We use Jest for testing. To run the tests, run the following command:
+
+```bash
+npm run test
+```