pusher-js 7.0.6 → 7.2.0

package/types/src/core/auth/options.d.ts

@@ -1,23 +1,42 @@
-import Channel from '../channels/channel';
-export interface AuthOptions {
-    params?: any;
-    headers?: any;
+export declare enum AuthRequestType {
+    UserAuthentication = "user-authentication",
+    ChannelAuthorization = "channel-authorization"
 }
-export interface AuthData {
+export interface ChannelAuthorizationData {
     auth: string;
     channel_data?: string;
     shared_secret?: string;
 }
-export declare type AuthorizerCallback = (error: Error | null, authData: AuthData) => void;
-export interface Authorizer {
-    authorize(socketId: string, callback: AuthorizerCallback): void;
+export declare type ChannelAuthorizationCallback = (error: Error | null, authData: ChannelAuthorizationData | null) => void;
+export interface ChannelAuthorizationRequestParams {
+    socketId: string;
+    channelName: string;
+}
+export interface ChannelAuthorizationHandler {
+    (params: ChannelAuthorizationRequestParams, callback: ChannelAuthorizationCallback): void;
+}
+export interface UserAuthenticationData {
+    auth: string;
+    user_data: string;
+}
+export declare type UserAuthenticationCallback = (error: Error | null, authData: UserAuthenticationData | null) => void;
+export interface UserAuthenticationRequestParams {
+    socketId: string;
 }
-export interface AuthorizerGenerator {
-    (channel: Channel, options: AuthorizerOptions): Authorizer;
+export interface UserAuthenticationHandler {
+    (params: UserAuthenticationRequestParams, callback: UserAuthenticationCallback): void;
 }
-export interface AuthorizerOptions {
-    authTransport: 'ajax' | 'jsonp';
-    authEndpoint: string;
-    auth?: AuthOptions;
-    authorizer?: AuthorizerGenerator;
+export declare type AuthTransportCallback = ChannelAuthorizationCallback | UserAuthenticationCallback;
+export interface AuthOptions<AuthHandler> {
+    transport: 'ajax' | 'jsonp';
+    endpoint: string;
+    params?: any;
+    headers?: any;
+    customHandler?: AuthHandler;
+}
+export interface InternalAuthOptions {
+    transport: 'ajax' | 'jsonp';
+    endpoint: string;
+    params?: any;
+    headers?: any;
 }

package/types/src/core/auth/user_authenticator.d.ts

@@ -0,0 +1,3 @@
+import { InternalAuthOptions, UserAuthenticationHandler } from './options';
+declare const UserAuthenticator: (authOptions: InternalAuthOptions) => UserAuthenticationHandler;
+export default UserAuthenticator;

package/types/src/core/channels/channel.d.ts

@@ -1,19 +1,21 @@
 import { default as EventsDispatcher } from '../events/dispatcher';
 import Pusher from '../pusher';
 import { PusherEvent } from '../connection/protocol/message-types';
-import { AuthorizerCallback } from '../auth/options';
+import { ChannelAuthorizationCallback } from '../auth/options';
 export default class Channel extends EventsDispatcher {
     name: string;
     pusher: Pusher;
     subscribed: boolean;
     subscriptionPending: boolean;
     subscriptionCancelled: boolean;
+    subscriptionCount: null;
     constructor(name: string, pusher: Pusher);
-    authorize(socketId: string, callback: AuthorizerCallback): void;
+    authorize(socketId: string, callback: ChannelAuthorizationCallback): void;
     trigger(event: string, data: any): boolean;
     disconnect(): void;
     handleEvent(event: PusherEvent): void;
     handleSubscriptionSucceededEvent(event: PusherEvent): void;
+    handleSubscriptionCountEvent(event: PusherEvent): void;
     subscribe(): void;
     unsubscribe(): void;
     cancelSubscription(): void;

package/types/src/core/channels/encrypted_channel.d.ts

@@ -1,13 +1,13 @@
 import PrivateChannel from './private_channel';
 import Pusher from '../pusher';
 import { PusherEvent } from '../connection/protocol/message-types';
-import { AuthorizerCallback } from '../auth/options';
+import { ChannelAuthorizationCallback } from '../auth/options';
 import * as nacl from 'tweetnacl';
 export default class EncryptedChannel extends PrivateChannel {
     key: Uint8Array;
     nacl: nacl;
     constructor(name: string, pusher: Pusher, nacl: nacl);
-    authorize(socketId: string, callback: AuthorizerCallback): void;
+    authorize(socketId: string, callback: ChannelAuthorizationCallback): void;
     trigger(event: string, data: any): boolean;
     handleEvent(event: PusherEvent): void;
     private handleEncryptedEvent;

package/types/src/core/channels/private_channel.d.ts

@@ -1,5 +1,5 @@
 import Channel from './channel';
-import { AuthorizerCallback } from '../auth/options';
+import { ChannelAuthorizationCallback } from '../auth/options';
 export default class PrivateChannel extends Channel {
-    authorize(socketId: string, callback: AuthorizerCallback): void;
+    authorize(socketId: string, callback: ChannelAuthorizationCallback): void;
 }

package/types/src/core/config.d.ts

@@ -1,12 +1,10 @@
 import { Options } from './options';
-import { AuthOptions, AuthorizerGenerator } from './auth/options';
+import { ChannelAuthorizationHandler, UserAuthenticationHandler } from './auth/options';
 import * as nacl from 'tweetnacl';
 export declare type AuthTransport = 'ajax' | 'jsonp';
 export declare type Transport = 'ws' | 'wss' | 'xhr_streaming' | 'xhr_polling' | 'sockjs';
 export interface Config {
     activityTimeout: number;
-    authEndpoint: string;
-    authTransport: AuthTransport;
     enableStats: boolean;
     httpHost: string;
     httpPath: string;
@@ -20,9 +18,9 @@ export interface Config {
     wsPath: string;
     wsPort: number;
     wssPort: number;
+    userAuthenticator: UserAuthenticationHandler;
+    channelAuthorizer: ChannelAuthorizationHandler;
     forceTLS?: boolean;
-    auth?: AuthOptions;
-    authorizer?: AuthorizerGenerator;
     cluster?: string;
     disabledTransports?: Transport[];
     enabledTransports?: Transport[];
@@ -30,4 +28,4 @@ export interface Config {
     nacl?: nacl;
     timelineParams?: any;
 }
-export declare function getConfig(opts: Options): Config;
+export declare function getConfig(opts: Options, pusher: any): Config;

package/types/src/core/defaults.d.ts

@@ -1,3 +1,4 @@
+import { AuthOptions, ChannelAuthorizationHandler, UserAuthenticationHandler } from './auth/options';
 import { AuthTransport } from './config';
 export interface DefaultConfig {
     VERSION: string;
@@ -16,6 +17,8 @@ export interface DefaultConfig {
     pongTimeout: number;
     unavailableTimeout: number;
     cluster: string;
+    userAuthentication: AuthOptions<UserAuthenticationHandler>;
+    channelAuthorization: AuthOptions<ChannelAuthorizationHandler>;
     cdn_http?: string;
     cdn_https?: string;
     dependency_suffix?: string;

package/types/src/core/errors.d.ts

@@ -1,6 +1,9 @@
 export declare class BadEventName extends Error {
     constructor(msg?: string);
 }
+export declare class BadChannelName extends Error {
+    constructor(msg?: string);
+}
 export declare class RequestTimedOut extends Error {
     constructor(msg?: string);
 }

package/types/src/core/options.d.ts

@@ -1,12 +1,15 @@
-import { AuthOptions, AuthorizerGenerator } from './auth/options';
+import { AuthOptions, ChannelAuthorizationHandler, UserAuthenticationHandler } from './auth/options';
+import { ChannelAuthorizerGenerator, DeprecatedAuthOptions } from './auth/deprecated_channel_authorizer';
 import { AuthTransport, Transport } from './config';
 import * as nacl from 'tweetnacl';
 export interface Options {
     activityTimeout?: number;
-    auth?: AuthOptions;
+    auth?: DeprecatedAuthOptions;
     authEndpoint?: string;
     authTransport?: AuthTransport;
-    authorizer?: AuthorizerGenerator;
+    authorizer?: ChannelAuthorizerGenerator;
+    channelAuthorization?: AuthOptions<ChannelAuthorizationHandler>;
+    userAuthentication?: AuthOptions<UserAuthenticationHandler>;
     cluster?: string;
     enableStats?: boolean;
     disableStats?: boolean;

package/types/src/core/pusher.d.ts

@@ -8,6 +8,7 @@ import ConnectionManager from './connection/connection_manager';
 import { PeriodicTimer } from './utils/timers';
 import { Options } from './options';
 import { Config } from './config';
+import UserFacade from './user';
 export default class Pusher {
     static instances: Pusher[];
     static isReady: boolean;
@@ -28,6 +29,7 @@ export default class Pusher {
     timelineSender: TimelineSender;
     connection: ConnectionManager;
     timelineSenderTimer: PeriodicTimer;
+    user: UserFacade;
     constructor(app_key: string, options?: Options);
     channel(name: string): Channel;
     allChannels(): Channel[];
@@ -43,4 +45,5 @@ export default class Pusher {
     unsubscribe(channel_name: string): void;
     send_event(event_name: string, data: any, channel?: string): boolean;
     shouldUseTLS(): boolean;
+    signin(): void;
 }

package/types/src/core/user.d.ts

@@ -0,0 +1,15 @@
+import Pusher from './pusher';
+import Channel from './channels/channel';
+import EventsDispatcher from './events/dispatcher';
+export default class UserFacade extends EventsDispatcher {
+    pusher: Pusher;
+    signin_requested: boolean;
+    user_data: any;
+    serverToUserChannel: Channel;
+    constructor(pusher: Pusher);
+    signin(): void;
+    private _signin;
+    private _onSigninSuccess;
+    private _subscribeChannels;
+    private _disconnect;
+}

package/types/src/core/utils/factory.d.ts

@@ -4,7 +4,6 @@ import Transport from '../transports/transport';
 import TransportManager from '../transports/transport_manager';
 import Handshake from '../connection/handshake';
 import TransportConnection from '../transports/transport_connection';
-import { AuthorizerOptions, Authorizer } from '../auth/options';
 import Timeline from '../timeline/timeline';
 import { default as TimelineSender, TimelineSenderOptions } from '../timeline/timeline_sender';
 import PresenceChannel from '../channels/presence_channel';
@@ -24,7 +23,6 @@ declare var Factory: {
     createPresenceChannel(name: string, pusher: Pusher): PresenceChannel;
     createEncryptedChannel(name: string, pusher: Pusher, nacl: nacl): EncryptedChannel;
     createTimelineSender(timeline: Timeline, options: TimelineSenderOptions): TimelineSender;
-    createAuthorizer(channel: Channel, options: AuthorizerOptions): Authorizer;
     createHandshake(transport: TransportConnection, callback: (HandshakePayload: any) => void): Handshake;
     createAssistantToTheTransportManager(manager: TransportManager, transport: Transport, options: PingDelayOptions): AssistantToTheTransportManager;
 };

package/types/src/runtimes/isomorphic/auth/xhr_auth.d.ts

@@ -1,3 +1,3 @@
 import { AuthTransport } from 'core/auth/auth_transports';
-declare var ajax: AuthTransport;
+declare const ajax: AuthTransport;
 export default ajax;

package/worker/with-encryption/index.js

@@ -1 +1 @@
-module.exports = require('../dist/worker/pusher-with-encryption.worker.js');
+module.exports = require('../../dist/worker/pusher-with-encryption.worker.js');

package/spec/javascripts/unit/core/pusher_authorizer_spec.js

@@ -1,160 +0,0 @@
-var TestEnv = require('testenv');
-var Authorizer = require('core/auth/pusher_authorizer').default;
-var Logger = require('core/logger');
-var Mocks = require('mocks');
-var Util = require('core/util').default;
-var Factory = require('core/utils/factory').default;
-var Logger = require('core/logger').default;
-var Runtime = require('runtime').default;
-
-describe("Authorizer", function() {
-
-  describe("initialization", function(){
-    it("should throw an error if the specified transport is unrecognized", function(){
-      expect(function(){
-        new Authorizer({name: "chan"}, {
-          authTransport: "yolo"
-        })
-      }).toThrow("'yolo' is not a recognized auth transport");
-    });
-  });
-
-  describe("#composeQuery", function() {
-    it("should return str with just socket id and channel name if no auth query options", function() {
-      var authorizer = new Authorizer({ name: "chan" }, {authTransport: "ajax"});
-
-      expect(authorizer.composeQuery("1.1"))
-        .toEqual("socket_id=1.1&channel_name=chan");
-    });
-
-    it("should add query params specified in options object", function() {
-      var authorizer = new Authorizer(
-        { name: "chan" },
-        { auth: {
-            params: { a: 1, b: 2 }
-          },
-          authTransport: "ajax"
-        }
-      );
-
-      expect(authorizer.composeQuery("1.1"))
-        .toEqual("socket_id=1.1&channel_name=chan&a=1&b=2");
-    });
-  });
-
-});
-
-if (TestEnv !== "worker") {
-  describe("AJAX Authorizer", function() {
-    var xhr;
-
-    beforeEach(function() {
-      xhr = new Mocks.getXHR();
-
-      if (TestEnv === "web" && !window.XMLHttpRequest) {
-        spyOn(Runtime, "createMicrosoftXHR").and.returnValue(xhr);
-      } else {
-        spyOn(Runtime, "createXHR").and.returnValue(xhr);
-      }
-    });
-
-    it("should pass headers in the request", function() {
-      var headers = { "foo": "bar", "n": 42 };
-      var authorizer = new Authorizer(
-        { name: "chan" },
-        { authTransport: "ajax",
-          auth: {
-            headers: headers
-          }
-        }
-      );
-      authorizer.authorize("1.23", function() {});
-
-      expect(xhr.setRequestHeader.calls.count()).toEqual(3);
-      expect(xhr.setRequestHeader).toHaveBeenCalledWith(
-        "Content-Type", "application/x-www-form-urlencoded"
-      );
-      expect(xhr.setRequestHeader).toHaveBeenCalledWith("foo", "bar");
-      expect(xhr.setRequestHeader).toHaveBeenCalledWith("n", 42);
-    });
-
-    it("should pass params in the query string", function() {
-      var params = { "a": 1, "b": 2 };
-      var authorizer = new Authorizer(
-        { name: "chan" },
-        { authTransport: "ajax",
-          auth: {
-            params: params
-          }
-        }
-      );
-      authorizer.authorize("1.23", function() {});
-
-      expect(xhr.send.calls.count()).toEqual(1);
-      expect(xhr.send).toHaveBeenCalledWith(
-        "socket_id=1.23&channel_name=chan&a=1&b=2"
-      );
-    });
-
-    it("should call back with auth result on success", function() {
-      var authorizer = new Authorizer(
-        { name: "chan" },
-        { authTransport: "ajax" }
-      );
-
-      var data = { foo: "bar", number: 1};
-      var dataJSON = JSON.stringify(data);
-
-      var callback = jasmine.createSpy("callback");
-      authorizer.authorize("1.23", callback);
-
-      if (TestEnv === "web" && !window.XMLHttpRequest) {
-        expect(Runtime.createMicrosoftXHR.calls.count()).toEqual(1);
-      } else {
-        expect(Runtime.createXHR.calls.count()).toEqual(1);
-      }
-
-      xhr.readyState = 4;
-      xhr.status = 200;
-      xhr.responseText = dataJSON;
-      xhr.onreadystatechange();
-
-      expect(callback.calls.count()).toEqual(1);
-      expect(callback).toHaveBeenCalledWith(null, data);
-    });
-
-    it("should call back with an error if JSON in xhr.responseText is invalid", function() {
-      var authorizer = new Authorizer(
-        { name: "chan" },
-        { authTransport: "ajax" }
-      );
-      var invalidJSON = 'INVALID { "something": "something"}';
-      var callback = jasmine.createSpy("callback");
-      authorizer.authorize("1.23", callback);
-
-      if (TestEnv === "web" && !window.XMLHttpRequest) {
-        expect(Runtime.createMicrosoftXHR.calls.count()).toEqual(1);
-      } else {
-        expect(Runtime.createXHR.calls.count()).toEqual(1);
-      }
-
-      xhr.readyState = 4;
-      xhr.status = 200;
-      xhr.responseText = invalidJSON;
-      xhr.onreadystatechange();
-
-      expect(callback.calls.count()).toEqual(1);
-      // For some reason comparing the Error types doesn't work properly in
-      // Safari on Mojave. Manually check the arguments.
-      let args = callback.calls.first().args;
-      expect(args.length).toEqual(2)
-      expect(args[0]).toEqual(jasmine.any(Error))
-      expect(args[0].message).toEqual(
-        "JSON returned from auth endpoint was invalid, yet status code was 200. " +
-        "Data was: " +
-        invalidJSON
-      );
-      expect(args[1]).toEqual({auth: ""});
-    });
-  });
-}

package/spec/javascripts/unit/worker/pusher_authorizer_spec.js

@@ -1,111 +0,0 @@
-var Authorizer = require('core/auth/pusher_authorizer').default;
-var fetchAuth = require('worker/auth/fetch_auth').default;
-var Runtime = require('runtime').default;
-var fetchMock = require('fetch-mock');
-
-var endpoint = 'http://example.org/pusher/auth';
-
-describe("Fetch Authorizer", function(){
-
-  beforeEach(function(){
-    Authorizer.authorizers = {ajax: fetchAuth}
-  });
-
-  afterEach(function(){
-    fetchMock.restore();
-  });
-
-  it("should pass headers in the request", function(){
-    fetchMock
-      .mock(endpoint, {body: {hello: "world"}});
-
-    var headers = { "foo": "bar", "n": 42 };
-    var authorizer = new Authorizer(
-      { name: "chan" },
-      { authTransport: "ajax",
-        authEndpoint: endpoint,
-        auth: {
-          headers: headers
-        }
-      }
-    );
-
-    authorizer.authorize("1.23", function() {});
-
-    var lastCall = fetchMock.lastCall(endpoint)[0];
-    var sentHeaders = lastCall.headers;
-    expect(sentHeaders.get("Content-Type")).toEqual("application/x-www-form-urlencoded");
-    expect(sentHeaders.get("foo")).toEqual("bar");
-    expect(sentHeaders.get("n")).toEqual('42');
-  });
-
-  it("should pass params in the query string", function(){
-    fetchMock
-      .mock(endpoint, {body: {hello: "world"}});
-
-    var params = { "a": 1, "b": 2 };
-    var authorizer = new Authorizer(
-      { name: "chan" },
-      { authTransport: "ajax",
-        authEndpoint: endpoint,
-        auth: {
-          params: params
-        }
-      }
-    );
-    authorizer.authorize("1.23", function() {}).then(function(){
-      var lastCall = fetchMock.lastCall(endpoint)[0];
-      console.log(lastCall);
-      expect(lastCall.body).toEqual("socket_id=1.23&channel_name=chan&a=1&b=2");
-    });
-  });
-
-  it("should call back with the auth result on success", function(){
-    var data = { foo: "bar", number: 1};
-    var dataJSON = JSON.stringify(data);
-
-    fetchMock.mock(endpoint, {
-      body: dataJSON
-    })
-
-    var authorizer = new Authorizer(
-      { name: "chan" },
-      {
-        authTransport: "ajax",
-        authEndpoint: endpoint
-      }
-    );
-    var callback = jasmine.createSpy("callback");
-    authorizer.authorize("1.23", callback).then(function(){
-      expect(callback.calls.count()).toEqual(1);
-      expect(callback).toHaveBeenCalledWith(false, data);
-    });
-  });
-
-  it("should call back with an error if JSON is invalid", function(){
-    var authorizer = new Authorizer(
-      { name: "chan" },
-      {
-        authTransport: "ajax",
-        authEndpoint: endpoint
-      }
-    );
-
-    var invalidJSON = 'INVALID { "something": "something"}';
-    fetchMock.mock(endpoint, {
-      body: invalidJSON
-    })
-
-    var callback = jasmine.createSpy("callback");
-
-    authorizer.authorize("1.23", callback).then(function(){
-      expect(callback.calls.count()).toEqual(1);
-      expect(callback).toHaveBeenCalledWith(
-        true,
-        "JSON returned from auth endpoint was invalid, yet status code was 200. " +
-          "Data was: " +
-          invalidJSON
-      );
-    });
-  });
-});

package/src/core/auth/pusher_authorizer.ts

@@ -1,64 +0,0 @@
-import Logger from '../logger';
-import Channel from '../channels/channel';
-import Factory from '../utils/factory';
-import Runtime from 'runtime';
-import { AuthTransports } from './auth_transports';
-import {
-  AuthOptions,
-  AuthorizerOptions,
-  Authorizer,
-  AuthorizerCallback
-} from './options';
-
-export default class PusherAuthorizer implements Authorizer {
-  static authorizers: AuthTransports;
-
-  channel: Channel;
-  type: string;
-  options: AuthorizerOptions;
-  authOptions: AuthOptions;
-
-  constructor(channel: Channel, options: AuthorizerOptions) {
-    this.channel = channel;
-
-    let { authTransport } = options;
-
-    if (typeof Runtime.getAuthorizers()[authTransport] === 'undefined') {
-      throw `'${authTransport}' is not a recognized auth transport`;
-    }
-
-    this.type = authTransport;
-    this.options = options;
-    this.authOptions = options.auth || {};
-  }
-
-  composeQuery(socketId: string): string {
-    var query =
-      'socket_id=' +
-      encodeURIComponent(socketId) +
-      '&channel_name=' +
-      encodeURIComponent(this.channel.name);
-
-    for (var i in this.authOptions.params) {
-      query +=
-        '&' +
-        encodeURIComponent(i) +
-        '=' +
-        encodeURIComponent(this.authOptions.params[i]);
-    }
-
-    return query;
-  }
-
-  authorize(socketId: string, callback: AuthorizerCallback): void {
-    PusherAuthorizer.authorizers =
-      PusherAuthorizer.authorizers || Runtime.getAuthorizers();
-
-    PusherAuthorizer.authorizers[this.type].call(
-      this,
-      Runtime,
-      socketId,
-      callback
-    );
-  }
-}

package/types/index.d.ts

@@ -1,15 +0,0 @@
-import Pusher from './src/core/pusher'
-import { Authorizer, AuthOptions, AuthorizerGenerator } from './src/core/auth/options';
-import { Options } from './src/core/options'
-import Channel from './src/core/channels/channel';
-import Runtime  from './src/runtimes/interface'
-
-export {
-  Options,
-  AuthOptions,
-  AuthorizerGenerator,
-  Authorizer,
-  Channel,
-  Runtime,
-}
-export default Pusher

package/types/src/core/auth/pusher_authorizer.d.ts

@@ -1,13 +0,0 @@
-import Channel from '../channels/channel';
-import { AuthTransports } from './auth_transports';
-import { AuthOptions, AuthorizerOptions, Authorizer, AuthorizerCallback } from './options';
-export default class PusherAuthorizer implements Authorizer {
-    static authorizers: AuthTransports;
-    channel: Channel;
-    type: string;
-    options: AuthorizerOptions;
-    authOptions: AuthOptions;
-    constructor(channel: Channel, options: AuthorizerOptions);
-    composeQuery(socketId: string): string;
-    authorize(socketId: string, callback: AuthorizerCallback): void;
-}

package/types/src/core/index.d.ts

@@ -1,6 +0,0 @@
-
-import Pusher from './pusher'
-import { Options } from './options'
-
-export { Options }
-export default Pusher

package/types/src/runtimes/react-native/tweetnacl-dummy.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    secretbox: {};
-    randomBytes: {};
-};
-export default _default;

package/types/src/runtimes/react-native/tweetnacl-util-dummy.d.ts

@@ -1,7 +0,0 @@
-declare const _default: {
-    encodeUTF8: {};
-    decodeUTF8: {};
-    encodeBase64: {};
-    decodeBase64: {};
-};
-export default _default;