v1.3.0 - 2024-04-18 (#24)

Author: vijayasingam-paddle

.eslintrc.yml

@@ -5,6 +5,7 @@ extends: standard-with-typescript
 parserOptions:
   ecmaVersion: latest
   sourceType: module
+  project: tsconfig.cjs.json
 rules:
   '@typescript-eslint/semi': 'off'
   '@typescript-eslint/strict-boolean-expressions': 'off'

.github/workflows/build-test.yml

@@ -5,10 +5,12 @@ on:
     branches:
       - main
       - v1.X
+      - release/beta
   pull_request:
     branches:
       - main
       - v1.X
+      - release/beta
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
@@ -40,4 +42,4 @@ jobs:
         run: yarn build
 
       - name: Test
-        run: yarn test
+        run: yarn test

.github/workflows/linting.yml

@@ -5,10 +5,12 @@ on:
     branches:
       - main
       - v1.X
+      - release/beta
   pull_request:
     branches:
       - main
       - v1.X
+      - release/beta
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
@@ -39,4 +41,4 @@ jobs:
       - name: Lint
         run: |
           yarn lint
-          yarn prettier
+          yarn prettier

.github/workflows/publish-beta.yml

@@ -0,0 +1,40 @@
+name: Publish to Beta Tag
+
+on:
+  push:
+    branches:
+      - release/beta
+
+jobs:
+  run-publish:
+    name: Run publish
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      actions: write
+
+    steps:
+      - name: Check out git repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: "yarn"
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install yarn dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Test
+        run: yarn test
+
+      - name: Publish
+        run: yarn publish:beta
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -12,6 +12,15 @@ 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.
 
+## 1.3.0 - 2024-04-18
+
+### Changed
+
+- Updated the package to export both CommonJS and ES module formats.
+- Updated `Collection` to return `hasMore` and `estimatedTotal` properties
+
+---
+
 ## 1.2.2 - 2024-04-03
 
 ### Fixed

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
   "scripts": {
     "test": "jest",
     "prebuild": "node ./scripts/update-env-vars.js",
-    "build": "yarn clean && tsc",
+    "build": "yarn clean && tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",
     "prettier": "prettier --check ./src",
     "prettier:fix": "prettier --check ./src --write",
     "lint": "eslint --ext .ts,.tsx ./src",

src/internal/api/client.ts

@@ -4,7 +4,7 @@ import fetch from 'node-fetch';
 import { SDK_VERSION } from '../../version';
 import { type PaddleOptions } from '../types/config';
 import { Environment } from './environment';
-import { randomUUID } from 'crypto';
+import { randomUUID } from 'node:crypto';
 import { Logger } from '../base/logger';
 import { convertToSnakeCase } from './case-helpers';
 import { type ErrorResponse } from '../types/response';

src/internal/base/collection.ts

@@ -3,7 +3,8 @@ import { ApiError } from '../errors/generic';
 import { type ErrorResponse, type ResponsePaginated } from '../types/response';
 
 export abstract class Collection<T, C> implements AsyncIterable<C> {
-  private hasMore: boolean = true;
+  public hasMore: boolean = true;
+  public estimatedTotal: number = 0;
   private nextLink: string;
   private data: C[] = [];
 
@@ -21,6 +22,7 @@ export abstract class Collection<T, C> implements AsyncIterable<C> {
 
     this.hasMore = handledResponse.meta.pagination.has_more ?? false;
     this.nextLink = handledResponse.meta.pagination.next;
+    this.estimatedTotal = handledResponse.meta.pagination.estimated_total ?? 0;
     this.data = handledResponse.data.map((data) => this.fromJson(data));
 
     return this.data.length > 0 ? this.data : [];

src/notifications/helpers/webhooks-validator.ts

@@ -1,4 +1,4 @@
-import { createHmac } from 'crypto';
+import { createHmac } from 'node:crypto';
 
 interface ParsedHeaders {
   ts: number;

tsconfig.json renamed to tsconfig.base.json

@@ -4,9 +4,9 @@
     "lib": ["ESNext"],
     "module": "NodeNext",
     "rootDir": "./src",
-    "moduleResolution": "nodenext",
+    "moduleResolution": "Node",
     "baseUrl": "./src",
-    "declaration": true,
+    "declaration": false,
     "outDir": "./dist",
     "removeComments": true,
     "esModuleInterop": true,

tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs",
+    "module": "commonjs"
+  }
+}

tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "module": "esnext"
+  }
+}

tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist/types",
+    "declaration": true,
+    "moduleResolution": "NodeNext",
+    "emitDeclarationOnly": true
+  }
+}