pingerchips-js 1.0.1-a → 2.0.0

package/index.js

@@ -0,0 +1,169 @@
+import { Socket } from "phoenix";
+
+export class Pingerchips {
+  constructor(appKey, options = {}) {
+    this.key = appKey;
+    this.options = options;
+    this.socket = null;
+    this.channels = {};
+    this.socketId = null;
+    this.authInfo = options.authInfo || {}; // Store auth_info from constructor
+
+    this.connect();
+  }
+
+  connect() {
+    const params = { app_key: this.key, ...this.options.params };
+    const endpoint =
+      this.options.endpoint || this.options.debug === "false"
+        ? "wss://pinger-processor.pingerchips.com/socket"
+        : "ws://localhost:4000/socket";
+
+    this.socket = new Socket(endpoint, { params });
+    this.socket.connect();
+
+    this.socket.onOpen(() => {
+      console.log("Pingerchips connected");
+      // Store socket ID when connection is established
+      // Phoenix socket uses a ref-based ID system
+      this.socketId = this.socket.connectionState();
+    });
+
+    this.socket.onClose(() => {
+      console.log("Pingerchips disconnected");
+    });
+  }
+
+  async subscribe(channelName) {
+    if (this.channels[channelName]) {
+      return this.channels[channelName];
+    }
+
+    // Topic format: "app:{app_key}:room:{channel_name}"
+    const topic = `app:${this.key}:room:${channelName}`;
+
+    // Check if authentication is needed
+    const isPrivate = channelName.startsWith("private-");
+    const isPresence = channelName.startsWith("presence-");
+
+    let joinParams = {};
+
+    if (isPrivate || isPresence) {
+      // Need to authenticate via user's auth endpoint
+      if (!this.options.authEndpoint) {
+        throw new Error(
+          "authEndpoint must be configured for private/presence channels"
+        );
+      }
+
+      try {
+        const authData = await this.authenticate(channelName);
+        joinParams = authData;
+      } catch (error) {
+        console.error(`Failed to authenticate for ${channelName}:`, error);
+        throw error;
+      }
+    }
+
+    const channel = this.socket.channel(topic, joinParams);
+
+    channel
+      .join()
+      .receive("ok", (resp) => {
+        console.log(`Joined ${channelName} successfully`, resp);
+      })
+      .receive("error", (resp) => {
+        console.log(`Unable to join ${channelName}`, resp);
+      });
+
+    const wrapper = new ChannelWrapper(channel);
+    this.channels[channelName] = wrapper;
+    return wrapper;
+  }
+
+  async authenticate(channelName) {
+    // Call user's auth endpoint with socket_id, channel_name, and auth_info
+    // User's server will use Pingerchips.authenticate() to sign the data
+    const socketId = this.getSocketId();
+
+    const body = {
+      socket_id: socketId,
+      channel_name: channelName,
+      auth_info: this.authInfo,
+    };
+
+    const response = await fetch(this.options.authEndpoint, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        ...this.options.authHeaders,
+      },
+      body: JSON.stringify(body),
+    });
+
+    if (!response.ok) {
+      const error = await response
+        .json()
+        .catch(() => ({ error: "Authentication failed" }));
+      throw new Error(error.error || "Authentication failed");
+    }
+
+    // Expected response from user's server: { auth: "app_key:signature", channel_data: "..." }
+    return await response.json();
+  }
+
+  getSocketId() {
+    // Phoenix socket generates a unique ref for each connection
+    // We can use the socket's internal state or generate a compatible ID
+    // For now, use a simple approach: use the socket's makeRef() output
+    if (!this.socketId) {
+      this.socketId = `socket-${Date.now()}-${Math.random()
+        .toString(36)
+        .substring(2, 11)}`;
+    }
+    return this.socketId;
+  }
+
+  getHttpEndpoint() {
+    const wsEndpoint = this.options.endpoint || "ws://localhost:4000/socket";
+    // Convert ws:// to http:// and wss:// to https://
+    return wsEndpoint
+      .replace("ws://", "http://")
+      .replace("wss://", "https://")
+      .replace("/socket", "");
+  }
+
+  unsubscribe(channelName) {
+    if (this.channels[channelName]) {
+      this.channels[channelName].leave();
+      delete this.channels[channelName];
+    }
+  }
+}
+
+class ChannelWrapper {
+  constructor(channel) {
+    this.channel = channel;
+  }
+
+  bind(eventName, callback) {
+    this.channel.on(eventName, callback);
+    return this;
+  }
+
+  unbind(eventName) {
+    this.channel.off(eventName);
+    return this;
+  }
+
+  trigger(eventName, data) {
+    this.channel.push(eventName, data);
+    return this;
+  }
+
+  leave() {
+    this.channel.leave();
+  }
+}
+
+export default Pingerchips;

package/package.json

@@ -1,70 +1,31 @@
 {
   "name": "pingerchips-js",
-  "version": "1.0.1a",
-  "description": "Pingerchips Channels JavaScript library for browsers, React Native, NodeJS and web workers",
-  "main": "dist/node/pingerchips.js",
-  "browser": "dist/web/pingerchips.js",
-  "react-native": "dist/react-native/pingerchips.js",
+  "version": "2.0.0",
+  "description": "Pingerchips JavaScript client SDK for real-time WebSocket connections",
+  "main": "index.js",
+  "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "format": "prettier --config .prettierrc --write 'src/**/*.ts' 'webpack/**/*.js'",
-    "check-format": "prettier --config .prettierrc --check 'src/**/*.ts' 'webpack/**/*.js'"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/sahilpohare/pingerchips-js-client"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
-    "pusher",
-    "client",
+    "pingerchips",
     "websocket",
-    "http",
-    "fallback",
-    "isomorphic",
-    "events",
-    "pubsub"
+    "realtime",
+    "phoenix",
+    "channels",
+    "pusher"
   ],
   "author": "Pingerchips",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/sahilpohare/pingerchips-js-client"
+  "dependencies": {
+    "phoenix": "^1.7.0"
   },
-  "homepage": "https://pingerchips.com",
-  "devDependencies": {
-    "@react-native-community/netinfo": "^5.9.7",
-    "@stablelib/base64": "^1.0.0",
-    "@stablelib/utf8": "^1.0.0",
-    "buffer": "^5.6.0",
-    "faye-websocket": "^0.11.3",
-    "fetch-mock": "git+https://git@github.com/jpatel531/fetch-mock.git",
-    "isomorphic-fetch": "^3.0.0",
-    "jasmine": "^4.5.0",
-    "jasmine-spec-reporter": "^7.0.0",
-    "karma": "^6.4.1",
-    "karma-browserstack-launcher": "^1.6.0",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-firefox-launcher": "^2.1.1",
-    "karma-jasmine": "^4.0.1",
-    "karma-jasmine-web-worker": "git+https://git@github.com/pusher/karma-jasmine-web-worker.git#jasmine_3",
-    "karma-opera-launcher": "^1.0.0",
-    "karma-safari-launcher": "^1.0.0",
-    "karma-spec-reporter": "0.0.32",
-    "karma-verbose-reporter": "0.0.6",
-    "karma-webpack": "^4.0.2",
-    "prettier": "^1.19.1",
-    "source-map-loader": "^1.1.3",
-    "ts-loader": "^6.0.4",
-    "typescript": "^5.1.3",
-    "uglify-js": "^2.6.2",
-    "webpack": "^4.46.0",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-server": "^4.11.1",
-    "webpack-merge": "^5.8.0",
-    "xmlhttprequest": "^1.8.0",
-    "@types/node": "^20.3.0",
-    "@types/express-serve-static-core": "4.17.28"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pingerchips/pingerchips-js"
   },
-  "dependencies": {
-    "tweetnacl": "^1.0.3"
-  }
-}
+  "bugs": {
+    "url": "https://github.com/pingerchips/pingerchips-js/issues"
+  },
+  "homepage": "https://pingerchips.com"
+}

package/.editorconfig

@@ -1,14 +0,0 @@
-# EditorConfig is awesome: http://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.js]
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.github/ISSUE_TEMPLATE.md

@@ -1,11 +0,0 @@
-**Do you want to request a *feature* or report a *bug*?**
-
-**What is the current behavior?**
-
-**If the current behavior is a bug, please provide the steps to reproduce and
-if possible a minimal demo of the problem via https://jsfiddle.net or similar.**
-
-**What is the expected behavior?**
-
-**Which versions of Pusher, and which browsers / OS are affected by this issue?
-Did this work in previous versions of Pusher? If so, which?**

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +0,0 @@
-## What does this PR do?
-
-[Description here]
-
-## Checklist
-
-- [ ] All new functionality has tests.
-- [ ] All tests are passing.
-- [ ] New or changed API methods have been documented.
-- [ ] `npm run format` has been run
-
-## CHANGELOG
-
-- [CHANGED] Describe your change here. Look at CHANGELOG.md to see the format.

package/.github/dependabot.yml

@@ -1,14 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "npm" 
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-    # Always increase the version requirement
-    # to match the new version.
-    versioning-strategy: increase

package/.github/stale.yml

@@ -1,26 +0,0 @@
-# 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

@@ -1,112 +0,0 @@
-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: '16'
-          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

@@ -1,43 +0,0 @@
-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/public_actions
-          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: '16'
-      - run: npm install
-      - name: Push
-        shell: bash
-        run: |
-          echo "$(jq '.version = "${{ steps.bump.outputs.new_version }}"' package.json)" > package.json
-
-          make build_all
-
-          git status
-
-          git add package.json package-lock.json CHANGELOG.md dist/ types/
-          git commit -m "Bump to version ${{ steps.bump.outputs.new_version }}"
-          git push

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

@@ -1,62 +0,0 @@
-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: '16'
-      - run: npm install
-      - run: npm run check-format
-      - run: make web_unit
-      - name: make web_integration
-        run: |
-          cd integration_tests_server
-          npm install
-          node index.js&
-          cd ..
-          make web_integration
-        env:
-          INTEGRATION_TESTS_APP_MT1_APP_ID: ${{ secrets.INTEGRATION_TESTS_APP_MT1_APP_ID }}
-          INTEGRATION_TESTS_APP_MT1_KEY: ${{ secrets.INTEGRATION_TESTS_APP_MT1_KEY }}
-          INTEGRATION_TESTS_APP_MT1_SECRET: ${{ secrets.INTEGRATION_TESTS_APP_MT1_SECRET }}
-          INTEGRATION_TESTS_APP_EU_APP_ID: ${{ secrets.INTEGRATION_TESTS_APP_EU_APP_ID }}
-          INTEGRATION_TESTS_APP_EU_KEY: ${{ secrets.INTEGRATION_TESTS_APP_EU_KEY }}
-          INTEGRATION_TESTS_APP_EU_SECRET: ${{ secrets.INTEGRATION_TESTS_APP_EU_SECRET }}
-          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: '16'
-      - run: npm install
-      - run: npm run check-format
-      - run: make node_unit
-      - name: make node_integration
-        run: |
-          cd integration_tests_server
-          npm install
-          node index.js&
-          cd ..
-          make node_integration
-        env:
-          INTEGRATION_TESTS_APP_MT1_APP_ID: ${{ secrets.INTEGRATION_TESTS_APP_MT1_APP_ID }}
-          INTEGRATION_TESTS_APP_MT1_KEY: ${{ secrets.INTEGRATION_TESTS_APP_MT1_KEY }}
-          INTEGRATION_TESTS_APP_MT1_SECRET: ${{ secrets.INTEGRATION_TESTS_APP_MT1_SECRET }}
-          INTEGRATION_TESTS_APP_EU_APP_ID: ${{ secrets.INTEGRATION_TESTS_APP_EU_APP_ID }}
-          INTEGRATION_TESTS_APP_EU_KEY: ${{ secrets.INTEGRATION_TESTS_APP_EU_KEY }}
-          INTEGRATION_TESTS_APP_EU_SECRET: ${{ secrets.INTEGRATION_TESTS_APP_EU_SECRET }}

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "sockjs-client"]
-	path = src/runtimes/web/dom/sockjs
-	url = https://github.com/pusher/sockjs-client.git

package/.prettierrc

@@ -1,2 +0,0 @@
-singleQuote: true
-parser: typescript