Many many changes

.eslintignore

@@ -6,3 +6,5 @@ coverage
 storage.json
 web/
 .esm-cache
+dist
+src/protos.d.ts

.eslintrc

@@ -1,98 +1,26 @@
 {
-  "parser": "babel-eslint",     // https://github.com/babel/babel-eslint
-  // Extend existing configuration from ESlint and eslint-plugin-react defaults.
-  "extends": [
-    "eslint:recommended",       // http://eslint.org/docs/rules/
-  ],
-  // Enable ES6 support. If you want to use custom Babel
-  // features, you will need to enable a custom parser
-  // as described in a section below.
-  "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module"
-  },
-  "env": {
-    "browser": true,
-    "node": true,
-    "es6": true,
-    "jest": true
-  },
-  // Enable custom plugin known as eslint-plugin-jest
-  "plugins": [
-    "jest"
-  ],
-  "rules": {
-    // Default to single quotes and raise an error if something
-    // else is used
-    "quotes": [2, "single"],
-    //Variables
-    "no-shadow": 2,                  // http://eslint.org/docs/rules/no-shadow
-    "no-shadow-restricted-names": 2, // http://eslint.org/docs/rules/no-shadow-restricted-names
-    "no-use-before-define": 0,       // http://eslint.org/docs/rules/no-use-before-define
-    //Possible errors
-    "no-alert": 2,                   // http://eslint.org/docs/rules/no-alert
-    "block-scoped-var": 0,           // http://eslint.org/docs/rules/block-scoped-var
-    //ES6
-    "no-var": 2,                     // http://eslint.org/docs/rules/no-var
-    "prefer-const": 2,               // http://eslint.org/docs/rules/prefer-const
-    //Best Practices
-    "curly": [2, "multi-line"],      // http://eslint.org/docs/rules/curly
-    "default-case": 2,               // http://eslint.org/docs/rules/default-case
-    "dot-notation": [2, {            // http://eslint.org/docs/rules/dot-notation
-      "allowKeywords": true,
-      "allowPattern": "^[a-z]+(-[a-z]+)+$",
-    }],
-    "comma-dangle": [2,             //http://eslint.org/docs/rules/comma-dangle
-      "always-multiline"
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+        "@typescript-eslint"
     ],
-    "eqeqeq": 2,                     // http://eslint.org/docs/rules/eqeqeq
-    "guard-for-in": 0,               // http://eslint.org/docs/rules/guard-for-in
-    "no-caller": 2,                  // http://eslint.org/docs/rules/no-caller
-    "no-eq-null": 2,                 // http://eslint.org/docs/rules/no-eq-null
-    "no-eval": 2,                    // http://eslint.org/docs/rules/no-eval
-    "no-extend-native": 2,           // http://eslint.org/docs/rules/no-extend-native
-    "no-extra-bind": 2,              // http://eslint.org/docs/rules/no-extra-bind
-    "no-fallthrough": 2,             // http://eslint.org/docs/rules/no-fallthrough
-    "no-floating-decimal": 2,        // http://eslint.org/docs/rules/no-floating-decimal
-    "no-implied-eval": 2,            // http://eslint.org/docs/rules/no-implied-eval
-    "no-lone-blocks": 2,             // http://eslint.org/docs/rules/no-lone-blocks
-    "no-loop-func": 2,               // http://eslint.org/docs/rules/no-loop-func
-    "no-multi-str": 2,               // http://eslint.org/docs/rules/no-multi-str
-    "no-native-reassign": 2,         // http://eslint.org/docs/rules/no-native-reassign
-    "no-new": 2,                     // http://eslint.org/docs/rules/no-new
-    "no-new-func": 2,                // http://eslint.org/docs/rules/no-new-func
-    "no-new-wrappers": 2,            // http://eslint.org/docs/rules/no-new-wrappers
-    "no-octal-escape": 2,            // http://eslint.org/docs/rules/no-octal-escape
-    "no-param-reassign": 2,          // http://eslint.org/docs/rules/no-param-reassign
-    "no-proto": 2,                   // http://eslint.org/docs/rules/no-proto
-    "no-redeclare": 2,               // http://eslint.org/docs/rules/no-redeclare
-    "no-return-assign": 2,           // http://eslint.org/docs/rules/no-return-assign
-    "no-script-url": 2,              // http://eslint.org/docs/rules/no-script-url
-    "no-self-compare": 2,            // http://eslint.org/docs/rules/no-self-compare
-    "no-sequences": 2,               // http://eslint.org/docs/rules/no-sequences
-    "no-throw-literal": 2,           // http://eslint.org/docs/rules/no-throw-literal
-    "no-trailing-spaces": 2,         //http://eslint.org/docs/rules/no-trailing-spaces
-    "no-underscore-dangle": 0,       //http://eslint.org/docs/rules/no-underscore-dangle
-    "no-with": 2,                    // http://eslint.org/docs/rules/no-with
-    "radix": 2,                      // http://eslint.org/docs/rules/radix
-    "semi": [2, "always", {          //http://eslint.org/docs/rules/semi
-       "omitLastInOneLineBlock": true
-    }],
-    "vars-on-top": 2,                // http://eslint.org/docs/rules/vars-on-top
-    "wrap-iife": [2, "any"],         // http://eslint.org/docs/rules/wrap-iife
-    "yoda": 2,                       // http://eslint.org/docs/rules/yoda
-    "no-console": 0,
-    "no-unused-vars": [2, { "ignoreRestSiblings": true }],
-    "key-spacing": [2, {
-      "beforeColon": true,
-      "afterColon": true,
-      "mode": "minimum",
-      "align": {
-          "beforeColon": true,
-          "afterColon": true,
-          "on": "colon",
-          "mode": "strict"
-      }
-    }]
-  }
-}
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-duplicate-enum-values": "off"
+    },
+    "overrides": [
+        {
+            "files": ["**/*.test"],
+            "plugins": ["jest"],
+            "extends": ["plugin:jest/recommended"],
+            "rules": {
+                "no-undef": "off",
+                "import/first": "off"
+            }
+        }
+    ]
+}

.gitignore

@@ -7,3 +7,9 @@ storage.json
 web/
 .esm-cache
 test/keys.js
+.history
+dist
+src/protos.d.ts
+*.tsbuildinfo
+yarn-error.log
+tests

.nvmrc

@@ -1 +1 @@
-8
+20

.yarnclean

@@ -0,0 +1 @@
+dist/*

CHANGELOG.md

@@ -0,0 +1,24 @@
+# @eneris/push-receiver
+
+## 4.0.1-beta
+### Braking changes
+- New parametrer `firebase` is now requried in the config - this is used mainly for FCM installation
+- FCM `installation` data were added into `fcm` part of `Credentials` containing Firebase Install credentials - Token refreshing is in TODO
+- Removed the `logLevel` option and replaced it with `debug: boolean`
+- Moved `sentTestMessage` into separate class called `PushSender`
+
+### Major changes
+- Replaced `axios` with native `fetch` in Node v20+
+- Added `index` export for `PushReceiver` and `PushSender`
+
+## 3.1.0
+
+### Minor Changes
+
+- Added automated Heartbeat messages
+  - new option `heartbeatIntervalMs` DEFAULT: 5 * 60 * 1000
+  - new events `ON_HEARTBEAT` - this is emited when socket recieves `ping` or `ack` messages
+
+### Patch Changes
+
+- Updated devDependencies

README.md

@@ -2,10 +2,6 @@
 
 A library to subscribe to GCM/FCM and receive notifications within a node process.
 
-For [Electron](https://github.com/electron/electron), you can use [electron-push-receiver](https://github.com/MatthieuLemoine/electron-push-receiver) instead which provides a convenient wrapper.
-
-See [this blog post](https://medium.com/@MatthieuLemoine/my-journey-to-bring-web-push-support-to-node-and-electron-ce70eea1c0b0) for more details.
-
 ## When should I use `push-receiver` ?
 
 - I want to **receive** push notifications sent using Firebase Cloud Messaging in an [electron](https://github.com/electron/electron) desktop application.
@@ -19,53 +15,79 @@ See [this blog post](https://medium.com/@MatthieuLemoine/my-journey-to-bring-web
 ## Install
 
 `
-npm i -S push-receiver
+npm i -S @eneris/push-receiver
 `
 
-## Requirements
+## Requirements 
 
-- Node v8 (async/await support)
-- Firebase sender id to receive notification
-- Firebase serverKey to send notification (optional)
+- Node v20 (async/await/randomUUID/fetch support)
+- Firebase credentials from `Step 1` - https://firebase.google.com/docs/web/setup
 
-## Usage
+## Acknowledgements 
+- https://github.com/MatthieuLemoine - for creating initial module on wich uppon in iterated
 
-### Electron
+## Usage
 
-You can use [electron-push-receiver](https://github.com/MatthieuLemoine/electron-push-receiver) instead which provides a convenient wrapper.
+### ClientConfig
+
+```typescript
+interface ClientConfig {
+    credentials?: Credentials // Will be generated if missing - save this after first use!
+    persistentIds?: PersistentId[] // Default - []
+    bundleId?: string // Default - 'receiver.push.com'
+    chromeId?: string // Default - 'org.chromium.linux'
+    chromeVersion?: string // Default - '94.0.4606.51'
+    debug?: boolean // Enables debug console logs
+    heartbeatIntervalMs?: number // Default - 5 * 60 * 1000
+    firebase: FirebaseConfig // Full client firebase credentials are now needed
+}
+```
 
-### Node
+### Node example
 
 ```javascript
-const { register, listen } = require('push-receiver');
-
-// First time
-// Register to GCM and FCM
-const credentials = await register(senderId); // You should call register only once and then store the credentials somewhere
-storeCredentials(credentials) // Store credentials to use it later
-const fcmToken = credentials.fcm.token; // Token to use to send notifications
-sendTokenToBackendOrWhatever(fcmToken);
-
-
-// Next times
-const credentials = getSavedCredentials() // get your saved credentials from somewhere (file, db, etc...)
-// persistentIds is the list of notification ids received to avoid receiving all already received notifications on start.
-const persistentIds = getPersistentIds() || [] // get all previous persistentIds from somewhere (file, db, etc...)
-await listen({ ...credentials, persistentIds}, onNotification);
-
-// Called on new notification
-function onNotification({ notification, persistentId }) {
-  // Update list of persistentId in file/db/...
-  updatePersistentIds([...persistentIds, persistentId]);
-  // Do someting with the notification
-  display(notification)
-}
-```
+import { PushReceiver } from '@eneris/push-receiver'
 
-### Test notification
+(async () => {
+    const instance = new PushReceiver({
+        debug: true,
+        persistentIds: [], // Recover stored ids of all previous notifications
+        firebase: {
+            // ...Firebase web credentials
+        },
+        credentials: null, // Insert credentials here after the first run
+    })
 
-To test, you can use the [send script](scripts/send/index.js) provided in this repo, you need to pass your serverKey and the FCM token as arguments :
+    const stopListeningToCredentials = instance.onCredentialsChanged(({ oldCredentials, newCredentials }) => {
+        console.log('Client generated new credentials.', newCredentials)
+        // Save them somewhere! And decide if thing are needed to re-subscribe
+    })
 
-```
-node scripts/send --serverKey="<FIREBASE_SERVER_KEY>" --token="<FIREBASE_TOKEN>"
+    const stopListeningToNotifications = instance.onNotification(notification => {
+        // Do someting with the notification
+        console.log('Notification received', notification)
+    })
+
+    await instance.connect()
+
+
+    await instance.connect()
+
+    console.log('connected')
+
+    const sender = new PushSender({
+        // Firebase service account credentials here
+    })
+
+    console.log('server created')
+
+    await sender.testMessage(instance.config.credentials.fcm.token)
+
+    console.log('message sent')
+
+    stopListeningToCredentials()
+    stopListeningToNotifications()
+
+    instance.destroy()
+})()
 ```

example.js

@@ -0,0 +1,21 @@
+const {
+    PushReceiver,
+    PushSender,
+} = require('./dist');
+
+(async () => {
+    const client = new PushReceiver({
+        debug: true,
+        persistentIds: [],
+        firebase: /* Insert firebase config here */,
+        credentials: null
+    })
+
+    await client.connect();
+
+    client.on('ON_MESSAGE_RECEIVED', console.log)
+
+    const sender = new PushSender(/* FIREBASE SERVICE ACCOUNT JSON */);
+
+    sender.testMessage(client.fcmToken);
+})()

jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+}