feat: convert the module to typescript (#45)

.eslintrc

@@ -1,28 +1,32 @@
 {
-  "extends": "airbnb-base",
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript/base",
+    "prettier",
+    "plugin:import/recommended",
+    "plugin:import/typescript"
+  ],
   "env": {
-    "node": true,
-    "jest":  true
+    "es2022": true,
+    "jest":  true,
+    "node": true
   },
-  "rules":{
-    "indent": ["error", 4],
-    "linebreak-style": 0,
-    "no-await-in-loop": 0,
-    "no-param-reassign": 0,
-    "no-underscore-dangle": ["error", { "allow": ["_id"] }],
-    "max-len": ["error", 120, 2, {
-      "ignoreUrls": true,
-      "ignoreComments": false,
-      "ignoreRegExpLiterals": true,
-      "ignoreStrings": true,
-      "ignoreTemplateLiterals": true
-    }]
+  "plugins": ["prettier"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
   },
-  "settings": {
-    "import/resolver": {
-      "node": {
-        "paths": ["."]
+  "rules": {
+    "@typescript-eslint/lines-between-class-members": "off",
+    "indent": ["error", 2],
+    "no-await-in-loop": 0,
+    "prettier/prettier": [
+      "error",
+      {
+        "singleQuote": true,
+        "endOfLine": "auto"
       }
-    }
+    ]
   }
 }

.github/workflows/test.yml

@@ -2,7 +2,8 @@ name: test
 
 on:
   pull_request:
-    branches: [ master ]
+    branches:
+      - '*'
 
 env:
   AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -14,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [18.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use node.js ${{ matrix.node-version }}
@@ -28,5 +29,7 @@ jobs:
           key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/package-lock.json') }}
       - name: Install
         run: npm ci
+      - name: Build
+        run: npm run build
       - name: run test
         run: npm run test

.gitignore

@@ -1,5 +1,6 @@
 .idea
 node_modules
+dist
 test/data
 test/multipart-data
 test/sync

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [4.0.0]
+
+### Breaking Changes
+
+* the abort feature from the TransferMonitor class has been replaced with a new abortSignal option
+* `sync` method now returns a SyncBucketWithBucketCommandOutput, SyncBucketWithLocalCommandOutput or SyncLocalWithBucketCommandOutput object
+* old methods `bucketWithBucket`, `bucketWithLocal` and `localWithBucket` have been removed. `sync` method should be used instead
+* dynamic aws command input options can now be set by passing a function to the `commandInput` option (functions were previously defined for each commandInput property)
+
+### Features
+
+* migrate the module to typescript
+
+### Test
+
+* replace `jest` with the native node test runner
+
 ## [3.0.0]
 
 ### Breaking Changes

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.