pusher-js 7.0.0 → 7.0.4

package/.github/stale.yml

@@ -0,0 +1,26 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 90
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+daysUntilClose: 7
+
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: []
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+  - pinned
+  - security
+
+# Set to true to ignore issues with an assignee (defaults to false)
+exemptAssignees: true
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. If you'd
+  like this issue to stay open please leave a comment indicating how this issue
+  is affecting you. Thank you.

package/.github/workflows/release.yml

@@ -0,0 +1,112 @@
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  check-release-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Prepare tag
+        id: prepare_tag
+        continue-on-error: true
+        run: |
+          export TAG=v$(jq -r '.version' package.json)
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+          export CHECK_TAG=$(git tag | grep $TAG)
+          if [[ $CHECK_TAG ]]; then
+            echo "Skipping because release tag already exists"
+            exit 1
+          fi
+      - name: Output
+        id: release_output
+        if: ${{ steps.prepare_tag.outcome == 'success' }}
+        run: |
+          echo "::set-output name=tag::${{ env.TAG }}"
+    outputs:
+      tag: ${{ steps.release_output.outputs.tag }}
+
+  create-github-release:
+    runs-on: ubuntu-latest
+    needs: check-release-tag
+    if: ${{ needs.check-release-tag.outputs.tag }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Prepare tag
+        run: |
+          export TAG=v$(jq -r '.version' package.json)
+          echo "TAG=$TAG" >> $GITHUB_ENV
+      - name: Setup git
+        run: |
+          git config user.email "pusher-ci@pusher.com"
+          git config user.name "Pusher CI"
+      - name: Prepare description
+        run: |
+          csplit -s CHANGELOG.md "/##/" {1}
+          cat xx01 > CHANGELOG.tmp
+      - name: Create Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.TAG }}
+          release_name: ${{ env.TAG }}
+          body_path: CHANGELOG.tmp
+          draft: false
+          prerelease: false
+
+  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' }}
+        with:
+          node-version: '14'
+          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 }}
+
+  upload-to-s3:
+    runs-on: ubuntu-latest
+    needs: create-github-release
+    steps:
+      - uses: actions/checkout@v2
+      - name: Upload to S3
+        run: |
+          VERSION=$(jq -r '.version' package.json | cut -d'.' -f1,2,3)
+          VERSION_MIN=$(jq -r '.version' package.json | cut -d'.' -f1,2)
+
+          egrep -o '^[0-9]+\.[0-9]+\.[0-9]+' <<< $VERSION
+
+          aws s3 sync dist/web/ s3://${BUCKET_NAME}/latest/ --acl public-read --cache-control max-age=$MAX_AGE
+          aws s3 sync dist/worker/ s3://${BUCKET_NAME}/latest/ --acl public-read --cache-control max-age=$MAX_AGE
+
+          aws s3 sync dist/web/ s3://${BUCKET_NAME}/${VERSION}/ --acl public-read --cache-control max-age=$MAX_AGE
+          aws s3 sync dist/worker/ s3://${BUCKET_NAME}/${VERSION}/ --acl public-read --cache-control max-age=$MAX_AGE
+
+          aws s3 sync dist/web/ s3://${BUCKET_NAME}/${VERSION_MIN}/ --acl public-read --cache-control max-age=$MAX_AGE
+          aws s3 sync dist/worker/ s3://${BUCKET_NAME}/${VERSION_MIN}/ --acl public-read --cache-control max-age=$MAX_AGE
+
+          aws cloudfront create-invalidation --distribution-id ${CLOUDFRONT_DISTRIBUTION_ID} --paths "/latest/*" "/${VERSION}/*" "/${VERSION_MIN}/*"
+        env:
+          MAX_AGE: 2592000
+          BUCKET_NAME: ${{ secrets.BUCKET_NAME }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.PUSHERINOS_AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.PUSHERINOS_AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: eu-west-2
+          CLOUDFRONT_DISTRIBUTION_ID: ${{ secrets.CLOUDFRONT_DISTRIBUTION_ID }}

package/.github/workflows/release_pr.yml

@@ -0,0 +1,42 @@
+name: release
+
+on:
+  pull_request:
+    types: [ labeled ]
+    branches:
+      - master
+
+jobs:
+  prepare-release:
+    name: Prepare release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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
+        with:
+          repository: pusher/actions
+          token: ${{ secrets.PUSHER_CI_GITHUB_PRIVATE_TOKEN }}
+          path: .github/actions
+      - uses: ./.github/actions/prepare-version-bump
+        id: bump
+        with:
+          current_version: ${{ env.CURRENT_VERSION }}
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - run: npm install
+      - name: Push
+        shell: bash
+        run: |
+          echo "$(jq '.version = "${{ steps.bump.outputs.new_version }}"' package.json)" > package.json
+
+          make build_all
+
+          git add package.json CHANGELOG.md dist/
+          git commit -m "Bump to version ${{ steps.bump.outputs.new_version }}"
+          git push

package/.github/workflows/run-tests.yml

@@ -0,0 +1,38 @@
+name: test
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - master
+jobs:
+  run-web-tests:
+    runs-on: ubuntu-latest
+    env:
+      CI: ${{ github.event_name == 'push' && 'basic' || 'full' }}
+      MINIMAL_INTEGRATION_TESTS: ${{ github.event_name == 'push' && 'true' || '' }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - run: npm install
+      - run: npm run check-format
+      - run: make web_unit
+      - run: make web_integration
+        env:
+          BROWSER_STACK_ACCESS_KEY: ${{ secrets.BROWSER_STACK_ACCESS_KEY }}
+          BROWSER_STACK_USERNAME: ${{ secrets.BROWSER_STACK_USERNAME }}
+  run-node-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - run: npm install
+      - run: npm run check-format
+      - run: make node_unit
+      - run: make node_integration
+

package/.vscode/settings.json

@@ -0,0 +1,31 @@
+{
+    "yaml.customTags": [
+        "!And",
+        "!If",
+        "!Not",
+        "!Equals",
+        "!Or",
+        "!FindInMap",
+        "!Base64",
+        "!Cidr",
+        "!Ref",
+        "!Sub",
+        "!GetAtt",
+        "!GetAZs",
+        "!ImportValue",
+        "!Select",
+        "!Split",
+        "!Join",
+        "!And sequence",
+        "!If sequence",
+        "!Not sequence",
+        "!Equals sequence",
+        "!Or sequence",
+        "!FindInMap sequence",
+        "!Join sequence",
+        "!Sub sequence",
+        "!ImportValue sequence",
+        "!Select sequence",
+        "!Split sequence"
+    ]
+}

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 7.0.4
+
+* [FIXED] References to nonexistent source map #570 
+
+## 7.0.3 (2021-01-25)
+
+[UPDATED] Bumped version of faye-websocket (used only by the node runtime) from
+0.9.4 to 0.11.3. Thanks to @Akhawais for the PR.
+
+[UPDATED] Bumped version of @react-native-community/netinfo (used only by the
+react-native runtime) from 4.1.1 to 5.9.7. Thanks to @Yinabled for the PR.
+
+[ADDED] We were missing a react-native key in `package.json`. Thanks to @giaset
+for the PR
+
+[ADDED] Support for importing the worker builds (solving issue #499)
+
+## 7.0.2 (2020-11-26)
+
+[FIXED] Removes `AuthInfo` type from react-native and with-encryption builds.
+This type was removed everywhere else in v7.0.0. See [issue
+512](https://github.com/pusher/pusher-js/issues/512)
+
+## 7.0.1 (2020-11-02)
+
+[FIXED] Channels no longer get stuck in the `subscriptionPending` state
+after a failed request to an auth endpoint. [Fixes Issue
+255](https://github.com/pusher/pusher-js/issues/255)
+
 ## 7.0.0 (2020-07-30)
 
 [UPDATED] Type signatures for authorizer callback. Previously the authorizer

package/Makefile

@@ -1,17 +1,14 @@
 SHELL := /bin/bash
 
+.PHONY: build_all
 build_all: web react-native node worker
 
-# sockjs:
-# 	pushd src/runtimes/web/dom/sockjs && \
-# 	npm install &&  \
-# 	make build &&  \
-# 	popd
-
+.PHONY: json2
 json2:
 	cp src/runtimes/web/dom/json2.js dist/web
 	node_modules/.bin/uglifyjs dist/web/json2.js -o dist/web/json2.min.js
 
+.PHONY: web
 web:
 	@echo "Browser Release:"
 	MINIMIZE=false node_modules/webpack/bin/webpack.js --config=webpack/config.web.js
@@ -25,14 +22,17 @@ web:
 	@echo "Minified Browser Release (with encryption)"
 	INCLUDE_TWEETNACL=true node_modules/webpack/bin/webpack.js --config=webpack/config.web.js
 
+.PHONY: react-native
 react-native:
 	@echo "React Native Release:"
 	node_modules/webpack/bin/webpack.js --config=webpack/config.react-native.js
 
+.PHONY: node
 node:
 	@echo "NodeJS Release":
 	MINIMIZE=false node_modules/webpack/bin/webpack.js --config=webpack/config.node.js
 
+.PHONY: worker
 worker:
 	@echo "Web Worker Release"
 	MINIMIZE=false node_modules/webpack/bin/webpack.js --config=webpack/config.worker.js
@@ -46,27 +46,32 @@ worker:
 	@echo "Minified Web Worker Release (with encryption)"
 	INCLUDE_TWEETNACL=true node_modules/webpack/bin/webpack.js --config=webpack/config.worker.js
 
+.PHONY: web_unit
 web_unit:
 	node_modules/karma/bin/karma start spec/config/karma/unit.js
 
+.PHONY: web_integration
 web_integration:
 	node_modules/karma/bin/karma start spec/config/karma/integration.js
 
+.PHONY: worker_unit
 worker_unit:
 	WORKER=true node_modules/karma/bin/karma start spec/config/karma/unit.js
 
+.PHONY: worker_integration
 worker_integration:
 	WORKER=true node_modules/karma/bin/karma start spec/config/karma/integration.js
 
+.PHONY: node_unit
 node_unit:
-	node_modules/webpack/bin/webpack.js --config=spec/config/jasmine-node/webpack.unit.js && \
-	node spec/config/jasmine-node/config.js ./tmp/node_unit
+	node_modules/webpack/bin/webpack.js --config=spec/config/jasmine/webpack.unit.js && \
+	node_modules/.bin/jasmine --config=spec/config/jasmine/unit.json
 
+.PHONY: node_integration
 node_integration:
-	node_modules/webpack/bin/webpack.js --config=spec/config/jasmine-node/webpack.integration.js && \
-	node spec/config/jasmine-node/config.js ./tmp/node_integration
+	node_modules/webpack/bin/webpack.js --config=spec/config/jasmine/webpack.integration.js && \
+	node_modules/.bin/jasmine --config=spec/config/jasmine/integration.json
 
+.PHONY: serve
 serve:
 	node webpack/dev.server.js
-
-.PHONY: react-native build_all

package/README.md

@@ -1,5 +1,7 @@
 # Pusher Channels Javascript Client
 
+![test badge](https://github.com/pusher/pusher-js/workflows/test/badge.svg)
+
 This Pusher Channels client library supports web browsers, web workers, Node.js
 and React Native.
 
@@ -181,6 +183,18 @@ If you'd like to use encrypted channels:
 importScripts('https://js.pusher.com/7.0/pusher-with-encryption.worker.min.js');
 ```
 
+If you're building your worker with a bundler, you can import the worker entrypoint
+
+```
+import Pusher from 'pusher-js/worker'
+```
+
+If you'd like to use encrypted channels:
+
+```
+import Pusher from 'pusher-js/worker/with-encryption'
+```
+
 ### Node.js
 
 Having installed `pusher-js` via an NPM-compatible package manager, run:
@@ -598,6 +612,20 @@ channel.unbind_global();
 
 The `unbind_all` method is equivalent to calling `unbind()` and `unbind_global()` together; it removes all bindings, global and event specific.
 
+## Triggering Client Events
+
+It's possible to trigger [client events](https://pusher.com/docs/channels/using_channels/events#triggering-client-events) using the `trigger` method on an instance of the `Channel` class.
+
+A few gotchas to consider when using client events:
+- Client events can only be triggered on private/presence channels
+- Client events must be enabled in the settings page for your app: `https://dashboard.pusher.com/apps/$YOUR_APP_ID/settings`
+- The event name for client events *must* start with `client-`
+
+```
+channel.trigger('client-my-event', {message: 'Hello, world!'})
+```
+
+
 ## Batching auth requests (aka multi-auth)
 
 Currently, pusher-js itself does not support authenticating multiple channels in one HTTP request. However, thanks to @dirkbonhomme you can use the [pusher-js-auth](https://github.com/dirkbonhomme/pusher-js-auth) plugin that buffers subscription requests and sends auth requests to your endpoint in batches.