v2.0.0-rc.0 - Edge runtime support and more. (#45)

## 2.0.0-rc.0 - 2024-09-26

> **Breaking changes:** This version includes major improvements that introduce breaking changes. These are called out below.

### Added

- Added support for edge runtime.

### Changed

- **Breaking change:** Updated the minimum required Node.js version to v18.
- **Breaking change:** `Webhooks.unmarshal` and `Webhooks.isSignatureValid` now returns a promise.
- Enabled conditional exports based on runtimes.
- Switched from `node-fetch` to native `fetch` API.

---

Author: vijayasingam-paddle

.eslintrc.yml

@@ -22,3 +22,4 @@ rules:
 ignorePatterns:
   - 'jest.config.js'
   - '**/__tests__/**'
+  - 'index.esm.*.ts'

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "08:00"
+    groups:
+      npm:
+        patterns:
+          - "*"

.github/workflows/build-test.yml

@@ -4,12 +4,12 @@ on:
   push:
     branches:
       - main
-      - v1.X
+      - v1.x
       - release/beta
   pull_request:
     branches:
       - main
-      - v1.X
+      - v1.x
       - release/beta
 
 concurrency:
@@ -20,19 +20,21 @@ jobs:
   run-build-test:
     name: Run Build & test
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        node: [ 18, 20, 22 ]
     permissions:
       contents: read
       actions: write
 
     steps:
       - name: Check out git repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version: ${{ matrix.node }}
           cache: "yarn"
 
       - name: Install yarn dependencies

.github/workflows/linting.yml

@@ -4,12 +4,12 @@ on:
   push:
     branches:
       - main
-      - v1.X
+      - v1.x
       - release/beta
   pull_request:
     branches:
       - main
-      - v1.X
+      - v1.x
       - release/beta
 
 concurrency:
@@ -27,10 +27,10 @@ jobs:
 
     steps:
       - name: Check out git repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: "yarn"

.github/workflows/publish-beta.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - v1.x
 
 jobs:
   run-publish:
@@ -16,10 +17,10 @@ jobs:
 
     steps:
       - name: Check out git repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: "yarn"
@@ -35,6 +36,12 @@ jobs:
         run: yarn test
 
       - name: Publish
-        run: yarn publish:latest
+        run: |
+          VERSION=$(node -p "require('./package.json').version" )
+          if [[ "$VERSION" =~ (rc) ]]; then
+            yarn publish:rc
+          else
+            yarn publish:latest
+          fi
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-latest.yml renamed to .github/workflows/publish.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - v1.x
 
 jobs:
   release_on_push:

.github/workflows/release-on-push.yml

@@ -12,6 +12,23 @@ When we make [non-breaking changes](https://developer.paddle.com/api-reference/a
 
 This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by adding additional type guards.
 
+## 2.0.0-rc.0 - 2024-09-26
+
+> **Breaking changes:** This version includes major improvements that introduce breaking changes. These are called out below.
+
+### Added
+
+- Added support for edge runtime.
+
+### Changed
+
+- **Breaking change:** Updated the minimum required Node.js version to v18.
+- **Breaking change:** `Webhooks.unmarshal` and `Webhooks.isSignatureValid` now returns a promise.
+- Enabled conditional exports based on runtimes.
+- Switched from `node-fetch` to native `fetch` API.
+
+---
+
 ## 1.7.0 - 2024-09-18
 
 ### Fixed

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Upgrading
+
+All breaking changes will be documented in this file to assist with upgrading to newer versions of the SDK.
+
+## v2.0.0
+
+There are two breaking changes in this release:
+
+1. Minimum Node.js version is now 18.0.0. 
+   - We had to restrict the minimum version as we would like to use native `fetch` API instead of `node-fetch` package.
+   - If you are using Node.js version 16 or below, you will need to upgrade to Node.js version 18 or above.
+
+2. `Webhooks.unmarshal` and `Webhooks.isSignatureValid` now returns a promise.
+   - As we started supporting edge runtimes, we had to make these methods async as the edge version of crypto returns a promise.
+   - If you are using these methods, you will need to update your code to handle the promise.
+
+---

UPGRADING.md

@@ -9,6 +9,9 @@ const config = {
   testMatch: ['**/__tests__/**/*.test.ts'],
   testPathIgnorePatterns: ['/node_modules/', '/dist/'],
   cacheDirectory: process.env.JEST_CACHE_FOLDER || '/tmp/node-sdk/.jest-cache',
+  moduleNameMapper: {
+    '(.+)\\.js': '$1',
+  },
   coveragePathIgnorePatterns: [
     '/src/types/',
     '__tests__',