Merge pull request #420 from pusher/bundle-ts-types

Bundle ts types

index.d.ts

@@ -0,0 +1,16 @@
+export {
+  AuthInfo,
+  Authorizer,
+  AuthOptions,
+  AuthorizerGenerator,
+  AuthorizerCallback,
+} from './types/src/core/auth/options';
+export { Options } from './types/src/core/options'
+
+export {default as Channel} from './types/src/core/channels/channel';
+export {default as PresenceChannel} from './types/src/core/channels/presence_channel';
+export {default as Members} from './types/src/core/channels/members';
+export {default as  Runtime}  from './types/src/runtimes/interface'
+export {default as ConnectionManager}  from './types/src/core/connection/connection_manager'
+
+export {default} from './types/src/core/pusher'

spec/javascripts/unit/core/channels/channel_spec.js

@@ -30,7 +30,7 @@ describe("Channel", function() {
     it("should call back with false, {} immediately", function() {
       var callback = jasmine.createSpy("callback");
       channel.authorize("1.1", callback);
-      expect(callback).toHaveBeenCalledWith(false, {});
+      expect(callback).toHaveBeenCalledWith(false, {auth: ''});
     });
   });
 

src/core/auth/options.ts

@@ -5,8 +5,17 @@ export interface AuthOptions {
   headers: any;
 }
 
+export interface AuthData {
+  auth: string;
+  channel_data?: string;
+}
+
+export type AuthInfo = AuthData | string;
+
+export type AuthorizerCallback = (error: boolean, authInfo: AuthInfo) => void;
+
 export interface Authorizer {
-  authorize(socketId: string, callback: Function);
+  authorize(socketId: string, callback: AuthorizerCallback): void;
 }
 
 export interface AuthorizerGenerator {

src/core/auth/pusher_authorizer.ts

@@ -3,7 +3,12 @@ import Channel from '../channels/channel';
 import Factory from '../utils/factory';
 import Runtime from 'runtime';
 import { AuthTransports } from './auth_transports';
-import { AuthOptions, AuthorizerOptions, Authorizer } from './options';
+import {
+  AuthOptions,
+  AuthorizerOptions,
+  Authorizer,
+  AuthorizerCallback
+} from './options';
 
 export default class PusherAuthorizer implements Authorizer {
   static authorizers: AuthTransports;
@@ -45,10 +50,10 @@ export default class PusherAuthorizer implements Authorizer {
     return query;
   }
 
-  authorize(socketId: string, callback: Function): any {
+  authorize(socketId: string, callback: AuthorizerCallback): void {
     PusherAuthorizer.authorizers =
       PusherAuthorizer.authorizers || Runtime.getAuthorizers();
-    return PusherAuthorizer.authorizers[this.type].call(
+    PusherAuthorizer.authorizers[this.type].call(
       this,
       Runtime,
       socketId,

src/core/channels/channel.ts

@@ -5,6 +5,7 @@ import Pusher from '../pusher';
 import { PusherEvent } from '../connection/protocol/message-types';
 import Metadata from './metadata';
 import UrlStore from '../utils/url_store';
+import { AuthData, AuthorizerCallback } from '../auth/options';
 
 /** Provides base public channel interface with an event emitter.
  *
@@ -38,8 +39,8 @@ export default class Channel extends EventsDispatcher {
    *
    * @param {Function} callback
    */
-  authorize(socketId: string, callback: Function) {
-    return callback(false, {});
+  authorize(socketId: string, callback: AuthorizerCallback) {
+    return callback(false, { auth: '' });
   }
 
   /** Triggers an event */
@@ -104,6 +105,7 @@ export default class Channel extends EventsDispatcher {
         Logger.error(data);
         this.emit('pusher:subscription_error', data);
       } else {
+        data = data as AuthData;
         this.pusher.send_event('pusher:subscribe', {
           auth: data.auth,
           channel_data: data.channel_data,

src/core/channels/encrypted_channel.ts

@@ -5,6 +5,7 @@ import { secretbox } from 'tweetnacl';
 import { encodeUTF8, decodeBase64 } from 'tweetnacl-util';
 import Dispatcher from '../events/dispatcher';
 import { PusherEvent } from '../connection/protocol/message-types';
+import { AuthorizerCallback } from '../auth/options';
 
 /** Extends private channels to provide encrypted channel interface.
  *
@@ -19,7 +20,7 @@ export default class EncryptedChannel extends PrivateChannel {
    * @param  {String} socketId
    * @param  {Function} callback
    */
-  authorize(socketId: string, callback: Function) {
+  authorize(socketId: string, callback: AuthorizerCallback) {
     super.authorize(socketId, (error, authData) => {
       if (error) {
         callback(true, authData);

src/core/channels/presence_channel.ts

@@ -5,6 +5,7 @@ import Pusher from '../pusher';
 import UrlStore from 'core/utils/url_store';
 import { PusherEvent } from '../connection/protocol/message-types';
 import Metadata from './metadata';
+import { AuthData } from '../auth/options';
 
 export default class PresenceChannel extends PrivateChannel {
   members: Members;
@@ -27,6 +28,7 @@ export default class PresenceChannel extends PrivateChannel {
   authorize(socketId: string, callback: Function) {
     super.authorize(socketId, (error, authData) => {
       if (!error) {
+        authData = authData as AuthData;
         if (authData.channel_data === undefined) {
           let suffix = UrlStore.buildLogSuffix('authenticationEndpoint');
           Logger.error(

src/core/channels/private_channel.ts

@@ -1,5 +1,6 @@
 import Factory from '../utils/factory';
 import Channel from './channel';
+import { AuthorizerCallback } from '../auth/options';
 
 /** Extends public channels to provide private channel interface.
  *
@@ -12,7 +13,7 @@ export default class PrivateChannel extends Channel {
    * @param  {String} socketId
    * @param  {Function} callback
    */
-  authorize(socketId: string, callback: Function) {
+  authorize(socketId: string, callback: AuthorizerCallback) {
     var authorizer = Factory.createAuthorizer(this, this.pusher.config);
     return authorizer.authorize(socketId, callback);
   }

src/core/options.ts

@@ -1,7 +1,7 @@
 import ConnectionManager from './connection/connection_manager';
 import { AuthOptions, AuthorizerGenerator } from './auth/options';
 
-interface PusherOptions {
+export interface PusherOptions {
   cluster: string;
   disableStats: boolean;
   enableStats: boolean;
@@ -17,4 +17,32 @@ interface PusherOptions {
   authorizer: AuthorizerGenerator;
 }
 
-export default PusherOptions;
+type Transport = 'ws' | 'wss' | 'xhr_streaming' | 'xhr_polling' | 'sockjs';
+type AuthTransport = 'ajax' | 'jsonp';
+
+export interface Options {
+  activityTimeout?: number;
+  enableStats?: boolean;
+  disableStats?: boolean; // deprecated
+  authEndpoint?: string;
+  auth?: AuthOptions;
+  authTransport?: AuthTransport;
+  authorizer?: AuthorizerGenerator;
+  disabledTransports?: Transport[];
+  enabledTransports?: Transport[];
+  encrypted?: boolean;
+  forceTLS?: boolean;
+  ignoreNullOrigin?: boolean;
+  pongTimeout?: number;
+  statsHost?: string;
+  timelineParams?: any;
+  unavailable_timeout?: number;
+  cluster?: string;
+  wsHost?: string;
+  httpHost?: string;
+  wsPath?: string;
+  wsPort?: number;
+  wssPort?: number;
+  httpPort?: number;
+  httpsPort?: number;
+}

src/core/pusher.ts

@@ -16,7 +16,7 @@ import Defaults from './defaults';
 import * as DefaultConfig from './config';
 import Logger from './logger';
 import Factory from './utils/factory';
-import PusherOptions from './options';
+import { PusherOptions, Options } from './options';
 import UrlStore from 'core/utils/url_store';
 
 export default class Pusher {
@@ -59,7 +59,7 @@ export default class Pusher {
   connection: ConnectionManager;
   timelineSenderTimer: PeriodicTimer;
 
-  constructor(app_key: string, options: any) {
+  constructor(app_key: string, options?: Options) {
     checkAppKey(app_key);
     options = options || {};
     if (!options.cluster && !(options.wsHost || options.httpHost)) {

src/runtimes/web/auth/jsonp_auth.ts

@@ -3,8 +3,13 @@ import Logger from 'core/logger';
 import JSONPRequest from '../dom/jsonp_request';
 import { ScriptReceivers } from '../dom/script_receiver_factory';
 import { AuthTransport } from 'core/auth/auth_transports';
+import { AuthorizerCallback } from 'core/auth/options';
 
-var jsonp: AuthTransport = function(context: Browser, socketId, callback) {
+var jsonp: AuthTransport = function(
+  context: Browser,
+  socketId: string,
+  callback: AuthorizerCallback
+) {
   if (this.authOptions.headers !== undefined) {
     Logger.warn(
       'To send headers with the auth request, you must use AJAX, rather than JSONP.'

tsconfig.json

@@ -2,7 +2,8 @@
   "compilerOptions": {
     "sourceMap": true,
     "module": "es6",
-    "declaration": false,
+    "declaration": true,
+    "declarationDir": "types",
     "target": "es3",
     "removeComments": true,
     "moduleResolution": "node",

types/index.d.ts

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

types/spec/javascripts/helpers/node/mock-dom-dependencies.d.ts

@@ -0,0 +1 @@
+export declare var Dependencies: {};

types/spec/javascripts/helpers/pusher_integration_class.d.ts

@@ -0,0 +1,4 @@
+import Pusher from '../../../src/core/pusher';
+export default class PusherIntegration extends Pusher {
+    static Integration: any;
+}

types/src/core/auth/auth_transports.d.ts

@@ -0,0 +1,8 @@
+import AbstractRuntime from 'runtimes/interface';
+interface AuthTransport {
+    (context: AbstractRuntime, socketId: string, callback: Function): void;
+}
+interface AuthTransports {
+    [index: string]: AuthTransport;
+}
+export { AuthTransport, AuthTransports };

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

@@ -0,0 +1,22 @@
+import Channel from '../channels/channel';
+export interface AuthOptions {
+    params: any;
+    headers: any;
+}
+export interface AuthData {
+    auth: string;
+    channel_data?: string;
+}
+export declare type AuthInfo = AuthData | string;
+export declare type AuthorizerCallback = (error: boolean, authInfo: AuthInfo) => void;
+export interface Authorizer {
+    authorize(socketId: string, callback: AuthorizerCallback): void;
+}
+export interface AuthorizerGenerator {
+    (channel: Channel, options: AuthorizerOptions): Authorizer;
+}
+export interface AuthorizerOptions {
+    authTransport: 'ajax' | 'jsonp';
+    auth: AuthOptions;
+    authorizer: AuthorizerGenerator;
+}

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

@@ -0,0 +1,13 @@
+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;
+}

types/src/core/base64.d.ts

@@ -0,0 +1 @@
+export default function encode(s: any): string;

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

@@ -0,0 +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';
+export default class Channel extends EventsDispatcher {
+    name: string;
+    pusher: Pusher;
+    subscribed: boolean;
+    subscriptionPending: boolean;
+    subscriptionCancelled: boolean;
+    constructor(name: string, pusher: Pusher);
+    authorize(socketId: string, callback: AuthorizerCallback): void;
+    trigger(event: string, data: any): boolean;
+    disconnect(): void;
+    handleEvent(event: PusherEvent): void;
+    handleSubscriptionSucceededEvent(event: PusherEvent): void;
+    subscribe(): void;
+    unsubscribe(): void;
+    cancelSubscription(): void;
+    reinstateSubscription(): void;
+}

types/src/core/channels/channel_table.d.ts

@@ -0,0 +1,5 @@
+import Channel from './channel';
+interface ChannelTable {
+    [index: string]: Channel;
+}
+export default ChannelTable;

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

@@ -0,0 +1,12 @@
+import Channel from './channel';
+import ChannelTable from './channel_table';
+import Pusher from '../pusher';
+export default class Channels {
+    channels: ChannelTable;
+    constructor();
+    add(name: string, pusher: Pusher): Channel;
+    all(): Channel[];
+    find(name: string): Channel;
+    remove(name: string): Channel;
+    disconnect(): void;
+}

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

@@ -0,0 +1,12 @@
+import PrivateChannel from './private_channel';
+import Dispatcher from '../events/dispatcher';
+import { PusherEvent } from '../connection/protocol/message-types';
+import { AuthorizerCallback } from '../auth/options';
+export default class EncryptedChannel extends PrivateChannel {
+    key: Uint8Array;
+    authorize(socketId: string, callback: AuthorizerCallback): void;
+    trigger(event: string, data: any): boolean;
+    handleEvent(event: PusherEvent): void;
+    private handleEncryptedEvent;
+    emitJSON(eventName: string, data?: any): Dispatcher;
+}

types/src/core/channels/members.d.ts

@@ -0,0 +1,14 @@
+export default class Members {
+    members: any;
+    count: number;
+    myID: any;
+    me: any;
+    constructor();
+    get(id: string): any;
+    each(callback: Function): void;
+    setMyID(id: string): void;
+    onSubscription(subscriptionData: any): void;
+    addMember(memberData: any): any;
+    removeMember(memberData: any): any;
+    reset(): void;
+}

types/src/core/channels/metadata.d.ts

@@ -0,0 +1,4 @@
+interface Metadata {
+    user_id?: string;
+}
+export default Metadata;

types/src/core/channels/presence_channel.d.ts

@@ -0,0 +1,13 @@
+import PrivateChannel from './private_channel';
+import Members from './members';
+import Pusher from '../pusher';
+import { PusherEvent } from '../connection/protocol/message-types';
+export default class PresenceChannel extends PrivateChannel {
+    members: Members;
+    constructor(name: string, pusher: Pusher);
+    authorize(socketId: string, callback: Function): void;
+    handleEvent(event: PusherEvent): void;
+    handleInternalEvent(event: PusherEvent): void;
+    handleSubscriptionSucceededEvent(event: PusherEvent): void;
+    disconnect(): void;
+}

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

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