Merge branch 'master' into add-interruption-level-clean

Author: nathenialalleyne

.babelrc

@@ -4,7 +4,7 @@
       "@babel/preset-env",
       {
         "targets": {
-          "node": "6"
+          "node": "14"
         }
       }
     ]

.eslintrc

@@ -0,0 +1,54 @@
+# Copilot Instructions for AI Agents
+
+## Project Overview
+
+This repository implements a Node.js module for sending push notifications across multiple platforms: Apple (APN), Google (GCM/FCM), Windows (WNS), Amazon (ADM), and Web-Push. The core logic is in `lib/` and `src/`, with each platform handled by a dedicated file (e.g., `sendAPN.js`, `sendFCM.js`).
+
+## Architecture & Data Flow
+
+- **Entry Point:** Use `PushNotifications` from `lib/index.js` or `src/index.js`.
+- **Settings:** Each platform's credentials/config are passed to the constructor. See the example in `README.md`.
+- **Sending:** The main method is `push.send(registrationIds, data, callback)` or as a Promise. It auto-detects device type and routes to the correct sender.
+- **Platform Senders:** Each sender (e.g., `sendAPN.js`, `sendFCM.js`) implements the logic for its platform. Shared utilities are in `lib/utils/` and `src/utils/`.
+- **RegId Detection:** Device type is inferred from the registration ID structure. See `PN.getPushMethodByRegId` for details.
+
+## Developer Workflows
+
+- **Install:** `npm install`
+- **Test:** Run all tests with `npm test`. Tests are in `test/` and cover basic flows and platform-specific cases.
+- **Debug:** Use the callback or Promise error/result from `push.send`. Each result object includes method, success/failure counts, and error details per device.
+- **Build:** No build step required for basic usage. ES6 is used, but compatible with ES5 via Babel if needed.
+
+## Conventions & Patterns
+
+- **Platform-specific files:** Each push service has its own file for isolation and clarity.
+- **Unified Data Model:** The `data` object for notifications is normalized across platforms. See `README.md` for all supported fields.
+- **Error Handling:** Errors are unified and returned in the result array from `push.send`.
+- **RegId Format:** Prefer object format for registration IDs (`{id, type}`), but string format is supported for legacy reasons.
+- **Chunking:** Android tokens are chunked in batches of 1,000 automatically.
+- **Constants:** Use constants from `constants.js` for platform types.
+
+## Integration Points
+
+- **External Libraries:**
+  - APN: `node-apn`
+  - FCM: `firebase-admin`
+  - GCM: `node-gcm`
+  - ADM: `node-adm`
+  - WNS: `wns`
+  - Web-Push: `web-push`
+- **Credentials:** Place service account keys and certificates in appropriate locations (see `README.md` for examples).
+
+## Key Files & Directories
+
+- `lib/` and `src/`: Main implementation (mirrored structure)
+- `test/`: Test cases and sample credentials
+- `README.md`: Usage, configuration, and data model reference
+
+## Example Usage
+
+See `README.md` for a full example of settings, registration ID formats, and sending notifications.
+
+---
+
+For unclear or incomplete sections, please provide feedback or specify which workflows, patterns, or integrations need further documentation.

.github/copilot-instructions.md

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x, 24.x]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/ci.yml

@@ -1,4 +1,10 @@
 {
-    "singleQuote": true,
-    "trailingComma": "es5"
+  "semi": true,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "endOfLine": "lf"
 }

.prettierrc

@@ -21,6 +21,7 @@ A node.js module for interfacing with Apple Push Notification, Google Cloud Mess
 - [ADM](#adm)
 - [Web-Push](#web-push)
 - [Resources](#resources)
+- [Proxy](#proxy)
 - [LICENSE](#license)
 
 ## Installation
@@ -118,12 +119,12 @@ You can send to multiple devices, independently of platform, creating an array w
 
 ```js
 // Single destination
-const registrationIds = 'INSERT_YOUR_DEVICE_ID';
+const registrationIds = "INSERT_YOUR_DEVICE_ID";
 
 // Multiple destinations
 const registrationIds = [];
-registrationIds.push('INSERT_YOUR_DEVICE_ID');
-registrationIds.push('INSERT_OTHER_DEVICE_ID');
+registrationIds.push("INSERT_YOUR_DEVICE_ID");
+registrationIds.push("INSERT_OTHER_DEVICE_ID");
 ```
 
 The `PN.send()` method later detects device type and therefore used push method, based on the id stucture. Check out the method `PN.getPushMethodByRegId` how this detection works.
@@ -146,10 +147,10 @@ It can be of 2 types:
 Where type can be one of: 'apn', 'gcm', 'adm', 'wns', 'webPush'. The types are available as constants:
 
 ```js
-import { WEB, WNS, ADM, GCM, APN } from 'node-pushnotifications';
+import { WEB, WNS, ADM, GCM, APN } from "node-pushnotifications";
 
 const regId = {
-  id: 'INSERT_YOUR_DEVICE_ID',
+  id: "INSERT_YOUR_DEVICE_ID",
   type: APN,
 };
 ```
@@ -457,7 +458,7 @@ you can use the `phonegap` setting in order to adapt to the recommended behaviou
 ```js
 const settings = {
   gcm: {
-    id: '<yourId>',
+    id: "<yourId>",
     phonegap: true,
   },
 };
@@ -542,16 +543,14 @@ Settings:
   Note: one of `serviceAccountKey`, `credential` fcm options is required
 
 ```js
-const tokens = [
-  'e..Gwso:APA91.......7r910HljzGUVS_f...kbyIFk2sK6......D2s6XZWn2E21x',
-];
+const tokens = ["e..Gwso:APA91.......7r910HljzGUVS_f...kbyIFk2sK6......D2s6XZWn2E21x"];
 
 const notifications = {
-  collapseKey: Math.random().toString().replace('0.', ''),
-  priority: 'high',
-  sound: 'default',
-  title: 'Title 1',
-  body: 'Body 2',
+  collapseKey: Math.random().toString().replace("0.", ""),
+  priority: "high",
+  sound: "default",
+  title: "Title 1",
+  body: "Body 2",
   // titleLocKey: 'GREETING',
   // titleLocArgs: ['Smith', 'M'],
   // fcm_notification: {
@@ -566,16 +565,16 @@ const notifications = {
   // },
   custom: {
     friend_id: 54657,
-    list_id: 'N7jSif1INyZkA7r910HljzGUVS',
+    list_id: "N7jSif1INyZkA7r910HljzGUVS",
   },
 };
 
 pushNotifications.send(tokens, notifications, (error, result) => {
   if (error) {
-    console.log('[error]', error);
+    console.log("[error]", error);
     throw error;
   } else {
-    console.log('[result]', result, result.at(0));
+    console.log("[result]", result, result.at(0));
   }
 });
 ```
@@ -619,9 +618,7 @@ Fcm object that will be sent to provider ([Fcm message format](https://firebase.
       }
     }
   },
-  "tokens": [
-    "e..Gwso:APA91.......7r910HljzGUVS_f...kbyIFk2sK6......D2s6XZWn2E21x"
-  ]
+  "tokens": ["e..Gwso:APA91.......7r910HljzGUVS_f...kbyIFk2sK6......D2s6XZWn2E21x"]
 }
 ```
 
@@ -666,8 +663,7 @@ delete data.expiry;
 delete data.timeToLive;
 
 const ADMmesssage = {
-  expiresAfter:
-    expiry - Math.floor(Date.now() / 1000) || timeToLive || 28 * 86400,
+  expiresAfter: expiry - Math.floor(Date.now() / 1000) || timeToLive || 28 * 86400,
   consolidationKey,
   data,
 };
@@ -683,12 +679,34 @@ Data can be passed as a simple string payload. If you do not pass a string, the
 Settings are directly forwarded to `webPush.sendNotification`.
 
 ```js
-const payload = typeof data === 'string' ? data : JSON.stringify(data);
+const payload = typeof data === "string" ? data : JSON.stringify(data);
 webPush.sendNotification(regId, payload, settings.web);
 ```
 
 A working server example implementation can be found at [https://github.com/alex-friedl/webpush-example/blob/master/server/index.js](https://github.com/alex-friedl/webpush-example/blob/master/server/index.js)
 
+## Proxy
+
+To use the module with a proxy:
+
+```
+import { HttpsProxyAgent } from 'https-proxy-agent';
+...
+const settings = {
+    fcm: {
+		...,
+		httpAgent = new HttpsProxyAgent(`http://${env.proxy.host}:${env.proxy.port}`);
+    },
+    apn: {
+        ...
+		proxy: {
+			host: <proxy_address>,
+			port: <proxy_port>
+		}
+    }
+};
+```
+
 ## Resources
 
 - [Crossplatform integration example using this library and a React Native app](https://github.com/alex-friedl/crossplatform-push-notifications-example)

README.md

@@ -0,0 +1,63 @@
+import js from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import prettier from 'eslint-plugin-prettier/recommended';
+
+export default [
+  {
+    ignores: ['node_modules/', 'lib/', 'coverage/'],
+  },
+  js.configs.recommended,
+  {
+    files: ['src/**/*.js'],
+    plugins: {
+      import: importPlugin,
+    },
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'commonjs',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+      },
+    },
+    rules: {
+      'no-console': 'off',
+      'no-use-before-define': ['error', { functions: false }],
+      'import/no-extraneous-dependencies': 'error',
+      'import/no-unresolved': 'error',
+    },
+  },
+  {
+    files: ['test/**/*.js'],
+    plugins: {
+      import: importPlugin,
+    },
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'module',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        before: 'readonly',
+        after: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+      },
+    },
+    rules: {
+      'no-console': 'off',
+      'global-require': 'off',
+      'import/no-extraneous-dependencies': 'off',
+      'import/no-dynamic-require': 'off',
+    },
+  },
+  prettier,
+];

eslint.config.mjs

@@ -1 +1 @@
-module.exports = require('./lib/push-notifications');
+module.exports = require("./lib/push-notifications");