pusher 5.1.3 → 5.3.2

package/.github/workflows/release.yml

@@ -1,3 +1,5 @@
+name: Release
+
 on:
   push:
     branches: [master]
@@ -7,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Prepare tag
@@ -26,7 +28,7 @@ jobs:
         id: release_output
         if: ${{ steps.prepare_tag.outcome == 'success' }}
         run: |
-          echo "::set-output name=tag::${{ env.TAG }}"
+          echo "tag=${{ env.TAG }}" >> $GITHUB_OUTPUT
     outputs:
       tag: ${{ steps.release_output.outputs.tag }}
 
@@ -34,8 +36,10 @@ jobs:
     runs-on: ubuntu-latest
     needs: check-release-tag
     if: ${{ needs.check-release-tag.outputs.tag }}
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Prepare tag
         run: |
           export TAG=v$(jq -r '.version' package.json)
@@ -49,34 +53,26 @@ jobs:
           csplit -s CHANGELOG.md "/##/" {1}
           cat xx01 > CHANGELOG.tmp
       - name: Create Release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ env.TAG }}
-          release_name: ${{ env.TAG }}
+          name: ${{ env.TAG }}
           body_path: CHANGELOG.tmp
           draft: false
           prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   publish-to-npm:
     runs-on: ubuntu-latest
     needs: create-github-release
     steps:
-      - uses: actions/checkout@v2
-      - uses: flood-io/is-published-on-npm@8478347e2650eb228d303975415458183d0a37e4
-        id: is-published
-      - run: echo "This version is already published on NPM"
-        if: ${{ steps.is-published.outputs.published == 'true' }}
-      - uses: actions/setup-node@v2
-        if: ${{ steps.is-published.outputs.published == 'false' }}
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: "14"
-          registry-url: https://registry.npmjs.org/
+          node-version: "20"
+          registry-url: "https://registry.npmjs.org"
       - run: npm install
-        if: ${{ steps.is-published.outputs.published == 'false' }}
       - run: npm publish --access public
-        if: ${{ steps.is-published.outputs.published == 'false' }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/release_pr.yml

@@ -11,13 +11,16 @@ jobs:
     name: Prepare release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PUSHER_CI_GITHUB_PRIVATE_TOKEN }}
+          fetch-depth: 0
       - name: Get current version
         shell: bash
         run: |
           CURRENT_VERSION=$(jq -r '.version' package.json)
           echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           repository: pusher/actions
           token: ${{ secrets.PUSHER_CI_GITHUB_PRIVATE_TOKEN }}
@@ -26,11 +29,12 @@ jobs:
         id: bump
         with:
           current_version: ${{ env.CURRENT_VERSION }}
-      - uses: actions/setup-node@v2
+          token: ${{ secrets.PUSHER_CI_GITHUB_PRIVATE_TOKEN }}
+      - uses: actions/setup-node@v4
         with:
-          node-version: "14"
+          node-version: "20"
       - run: npm install
-      - name: Push
+      - name: Commit and push version bump
         shell: bash
         run: |
           echo "$(jq '.version = "${{ steps.bump.outputs.new_version }}"' package.json)" > package.json

package/.github/workflows/test.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
@@ -17,7 +17,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
         uses: actions/setup-node@v2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 5.3.2
+
+- [Added] missing error types for Typescript support
+
+## 5.3.1
+
+- [CHANGED] Fix Github Actions.
+
+## 5.2.0
+
+- [CHANGED] Remove old notification references. It's no longer being used
+
 ## 5.1.3
 
 [FIXED] Parsing of the extraTokens in webhook's isValid method

package/README.md

@@ -5,6 +5,8 @@
 
 In order to use this library, you need to have an account on <https://pusher.com/channels>. After registering, you will need the application credentials for your app.
 
+For reporting issues, bugs, and feature requests, please feel free to open a pull request or open an issue. If you do not receive a timely response, feel free to check our [support portal](https://docs.bird.com/pusher).
+
 ## Supported platforms
 
 This SDK supports **Node.js** version 10+.

package/index.d.ts

@@ -190,5 +190,31 @@ declare namespace Pusher {
     getTime(): Date
   }
 
+  export class RequestError extends Error {
+    constructor(
+      message: string,
+      url: string,
+      error: Error,
+      status?: number,
+      body?: string
+    )
+    url: string
+    error: Error
+    status?: number
+    body?: string
+  }
+
+  export class WebHookError extends Error {
+    constructor(
+      message: string,
+      contentType: string,
+      body: string,
+      signature: string
+    )
+    contentType: string
+    body: string
+    signature: string
+  }
+
   export { Response }
 }

package/lib/pusher.js

@@ -9,7 +9,6 @@ const requests = require("./requests")
 const PusherConfig = require("./pusher_config")
 const Token = require("./token")
 const WebHook = require("./webhook")
-const NotificationClient = require("./notification_client")
 
 const validateChannel = function (channel) {
   if (
@@ -52,10 +51,8 @@ const validateUserData = function (userData) {
  * @constructor
  * @param {Object} options
  * @param {String} [options.host="api.pusherapp.com"] API hostname
- * @param {String} [options.notification_host="api.pusherapp.com"] Notification API hostname
  * @param {Boolean} [options.useTLS=false] whether to use TLS
  * @param {Boolean} [options.encrypted=false] deprecated; renamed to `useTLS`
- * @param {Boolean} [options.notification_encrypted=false] whether to use TLS for notifications
  * @param {Integer} [options.port] port, default depends on the scheme
  * @param {Integer} options.appId application ID
  * @param {String} options.key application key
@@ -65,11 +62,6 @@ const validateUserData = function (userData) {
  */
 function Pusher(options) {
   this.config = new PusherConfig(options)
-  const notificationOptions = Object.assign({}, options, {
-    host: options.notificationHost,
-    encrypted: options.notificationEncrypted,
-  })
-  this.notificationClient = new NotificationClient(notificationOptions)
 }
 
 /** Create a Pusher instance using a URL.
@@ -237,10 +229,6 @@ Pusher.prototype.triggerBatch = function (batch) {
   return events.triggerBatch(this, batch)
 }
 
-Pusher.prototype.notify = function () {
-  this.notificationClient.notify.apply(this.notificationClient, arguments)
-}
-
 /** Makes a POST request to Pusher, handles the authentication.
  *
  * Returns a promise resolving to a response, or rejecting to a RequestError.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pusher",
   "description": "Node.js client to interact with the Pusher Channels REST API",
-  "version": "5.1.3",
+  "version": "5.3.2",
   "author": "Pusher <support@pusher.com>",
   "contributors": [
     {

package/lib/notification_client.js

@@ -1,25 +0,0 @@
-const requests = require("./requests")
-const NotificationConfig = require("./notification_config")
-
-function NotificationClient(options) {
-  this.config = new NotificationConfig(options)
-}
-
-NotificationClient.prototype.notify = function (interests, notification) {
-  if (!Array.isArray(interests)) {
-    throw new Error("Interests must be an array")
-  }
-
-  if (interests.length == 0) {
-    throw new Error("Interests array must not be empty")
-  }
-
-  const body = Object.assign({ interests: interests }, notification)
-  return requests.send(this.config, {
-    method: "POST",
-    body: body,
-    path: "/notifications",
-  })
-}
-
-module.exports = NotificationClient

package/lib/notification_config.js

@@ -1,18 +0,0 @@
-const Config = require("./config")
-
-const DEFAULT_HOST = "nativepush-cluster1.pusher.com"
-const API_PREFIX = "server_api"
-const API_VERSION = "v1"
-
-function NotificationConfig(options) {
-  Config.call(this, options)
-  this.host = options.host || DEFAULT_HOST
-}
-
-Object.assign(NotificationConfig.prototype, Config.prototype)
-
-NotificationConfig.prototype.prefixPath = function (subPath) {
-  return "/" + API_PREFIX + "/" + API_VERSION + "/apps/" + this.appId + subPath
-}
-
-module.exports = NotificationConfig

package/tests/integration/pusher/notification_client.js

@@ -1,49 +0,0 @@
-const expect = require("expect.js")
-const NotificationClient = require("../../../lib/notification_client")
-const nock = require("nock")
-
-describe("NativeNotificationClient", function () {
-  let client
-
-  beforeEach(function () {
-    client = new NotificationClient({
-      appId: 1234,
-      key: "f00d",
-      secret: "tofu",
-    })
-    nock.cleanAll()
-    nock.disableNetConnect()
-  })
-
-  afterEach(function () {
-    nock.cleanAll()
-    nock.enableNetConnect()
-  })
-
-  xit("should send in the success case", function (done) {
-    const mock = nock("nativepush-cluster1.pusher.com:80")
-    client.notify(
-      ["yolo"],
-      {
-        apns: {
-          aps: {
-            alert: {
-              title: "yolo",
-              body: "woot",
-            },
-          },
-        },
-        gcm: {
-          notification: {
-            title: "huzzah",
-            icon: "woot",
-          },
-        },
-      },
-      function () {
-        expect(mock.isDone()).to.be(true)
-        done()
-      }
-    )
-  })
-})