pingerchips-js 1.0.0-a

package/types/src/core/transports/transport_manager.d.ts

@@ -0,0 +1,14 @@
+import AssistantToTheTransportManager from './assistant_to_the_transport_manager';
+import Transport from './transport';
+import PingDelayOptions from './ping_delay_options';
+export interface TransportManagerOptions extends PingDelayOptions {
+    lives?: number;
+}
+export default class TransportManager {
+    options: TransportManagerOptions;
+    livesLeft: number;
+    constructor(options: TransportManagerOptions);
+    getAssistant(transport: Transport): AssistantToTheTransportManager;
+    isAlive(): boolean;
+    reportDeath(): void;
+}

package/types/src/core/transports/transports_table.d.ts

@@ -0,0 +1,10 @@
+import Transport from './transport';
+interface TransportsTable {
+    ws: Transport;
+    xhr_streaming: Transport;
+    xdr_streaming?: Transport;
+    xhr_polling: Transport;
+    xdr_polling?: Transport;
+    sockjs?: Transport;
+}
+export default TransportsTable;

package/types/src/core/transports/url_scheme.d.ts

@@ -0,0 +1,11 @@
+export interface URLSchemeParams {
+    useTLS: boolean;
+    hostTLS: string;
+    hostNonTLS: string;
+    httpPath: string;
+}
+interface URLScheme {
+    getInitial(key: string, params: any): string;
+    getPath?(key: string, options: any): string;
+}
+export default URLScheme;

package/types/src/core/transports/url_schemes.d.ts

@@ -0,0 +1,4 @@
+import { default as URLScheme } from './url_scheme';
+export declare var ws: URLScheme;
+export declare var http: URLScheme;
+export declare var sockjs: URLScheme;

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

@@ -0,0 +1,21 @@
+import Channel from './channels/channel';
+import EventsDispatcher from './events/dispatcher';
+import Pingerchips from './pusher';
+import WatchlistFacade from './watchlist';
+export default class UserFacade extends EventsDispatcher {
+    pusher: Pingerchips;
+    signin_requested: boolean;
+    user_data: any;
+    serverToUserChannel: Channel;
+    signinDonePromise: Promise<any>;
+    watchlist: WatchlistFacade;
+    private _signinDoneResolve;
+    constructor(pusher: Pingerchips);
+    signin(): void;
+    private _signin;
+    private _onAuthorize;
+    private _onSigninSuccess;
+    private _subscribeChannels;
+    private _cleanup;
+    private _newSigninPromiseIfNeeded;
+}

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

@@ -0,0 +1,8 @@
+import TimedCallback from './utils/timers/timed_callback';
+import { OneOffTimer } from './utils/timers';
+declare var Util: {
+    now(): number;
+    defer(callback: TimedCallback): OneOffTimer;
+    method(name: string, ...args: any[]): Function;
+};
+export default Util;

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

@@ -0,0 +1,18 @@
+export declare function extend<T>(target: any, ...sources: any[]): T;
+export declare function stringify(): string;
+export declare function arrayIndexOf(array: any[], item: any): number;
+export declare function objectApply(object: any, f: Function): void;
+export declare function keys(object: any): string[];
+export declare function values(object: any): any[];
+export declare function apply(array: any[], f: Function, context?: any): void;
+export declare function map(array: any[], f: Function): any[];
+export declare function mapObject(object: any, f: Function): any;
+export declare function filter(array: any[], test: Function): any[];
+export declare function filterObject(object: Object, test: Function): {};
+export declare function flatten(object: Object): any[];
+export declare function any(array: any[], test: Function): boolean;
+export declare function all(array: any[], test: Function): boolean;
+export declare function encodeParamsObject(data: any): string;
+export declare function buildQueryString(data: any): string;
+export declare function decycleObject(object: any): any;
+export declare function safeJSONStringify(source: any): string;

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

@@ -0,0 +1,29 @@
+import Handshake from '../connection/handshake';
+import AssistantToTheTransportManager from '../transports/assistant_to_the_transport_manager';
+import PingDelayOptions from '../transports/ping_delay_options';
+import Transport from '../transports/transport';
+import TransportConnection from '../transports/transport_connection';
+import TransportManager from '../transports/transport_manager';
+import * as nacl from 'tweetnacl';
+import Channel from '../channels/channel';
+import Channels from '../channels/channels';
+import EncryptedChannel from '../channels/encrypted_channel';
+import PresenceChannel from '../channels/presence_channel';
+import PrivateChannel from '../channels/private_channel';
+import ConnectionManager from '../connection/connection_manager';
+import ConnectionManagerOptions from '../connection/connection_manager_options';
+import Pingerchips from '../pusher';
+import Timeline from '../timeline/timeline';
+import { default as TimelineSender, TimelineSenderOptions } from '../timeline/timeline_sender';
+declare var Factory: {
+    createChannels(): Channels;
+    createConnectionManager(key: string, options: ConnectionManagerOptions): ConnectionManager;
+    createChannel(name: string, pusher: Pingerchips): Channel;
+    createPrivateChannel(name: string, pusher: Pingerchips): PrivateChannel;
+    createPresenceChannel(name: string, pusher: Pingerchips): PresenceChannel;
+    createEncryptedChannel(name: string, pusher: Pingerchips, nacl: nacl): EncryptedChannel;
+    createTimelineSender(timeline: Timeline, options: TimelineSenderOptions): TimelineSender;
+    createHandshake(transport: TransportConnection, callback: (HandshakePayload: any) => void): Handshake;
+    createAssistantToTheTransportManager(manager: TransportManager, transport: Transport, options: PingDelayOptions): AssistantToTheTransportManager;
+};
+export default Factory;

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

@@ -0,0 +1,6 @@
+declare function flatPromise(): {
+    promise: Promise<unknown>;
+    resolve: any;
+    reject: any;
+};
+export default flatPromise;

package/types/src/core/utils/timers/abstract_timer.d.ts

@@ -0,0 +1,10 @@
+import TimedCallback from './timed_callback';
+import { Delay, Scheduler, Canceller } from './scheduling';
+declare abstract class Timer {
+    protected clear: Canceller;
+    protected timer: number | void;
+    constructor(set: Scheduler, clear: Canceller, delay: Delay, callback: TimedCallback);
+    isRunning(): boolean;
+    ensureAborted(): void;
+}
+export default Timer;

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

@@ -0,0 +1,9 @@
+import Timer from './abstract_timer';
+import TimedCallback from './timed_callback';
+import { Delay } from './scheduling';
+export declare class OneOffTimer extends Timer {
+    constructor(delay: Delay, callback: TimedCallback);
+}
+export declare class PeriodicTimer extends Timer {
+    constructor(delay: Delay, callback: TimedCallback);
+}

package/types/src/core/utils/timers/scheduling.d.ts

@@ -0,0 +1,8 @@
+interface Scheduler {
+    (TimedCallback: any, number: any): number;
+}
+interface Canceller {
+    (number: any): void;
+}
+type Delay = number;
+export { Scheduler, Canceller, Delay };

package/types/src/core/utils/timers/timed_callback.d.ts

@@ -0,0 +1,4 @@
+interface TimedCallback {
+    (number?: any): number | void;
+}
+export default TimedCallback;

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

@@ -0,0 +1,4 @@
+declare const _default: {
+    buildLogSuffix: (key: string) => string;
+};
+export default _default;

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

@@ -0,0 +1,8 @@
+import EventsDispatcher from './events/dispatcher';
+import Pingerchips from './pusher';
+export default class WatchlistFacade extends EventsDispatcher {
+    private pusher;
+    constructor(pusher: Pingerchips);
+    handleEvent(pusherEvent: any): void;
+    private bindWatchlistInternalEvent;
+}

package/types/src/runtimes/interface.d.ts

@@ -0,0 +1,43 @@
+import { AuthTransports } from '../core/auth/auth_transports';
+import { Config } from '../core/config';
+import Ajax from '../core/http/ajax';
+import HTTPFactory from '../core/http/http_factory';
+import HTTPRequest from '../core/http/http_request';
+import Pingerchips from '../core/pusher';
+import Reachability from '../core/reachability';
+import Socket from '../core/socket';
+import Strategy from '../core/strategies/strategy';
+import StrategyOptions from '../core/strategies/strategy_options';
+import TimelineTransport from '../core/timeline/timeline_transport';
+import TransportsTable from '../core/transports/transports_table';
+import JSONPRequest from './web/dom/jsonp_request';
+interface Runtime {
+    setup(PusherClass: {
+        new (key: string, options: any): Pingerchips;
+        ready(): void;
+    }): void;
+    getProtocol(): string;
+    getAuthorizers(): AuthTransports;
+    getLocalStorage(): any;
+    TimelineTransport: TimelineTransport;
+    createXHR(): Ajax;
+    createWebSocket(url: string): Socket;
+    getNetwork(): Reachability;
+    getDefaultStrategy(config: Config, options: StrategyOptions, defineTransport: Function): Strategy;
+    Transports: TransportsTable;
+    getWebSocketAPI(): new (url: string) => Socket;
+    getXHRAPI(): new () => Ajax;
+    addUnloadListener(listener: Function): void;
+    removeUnloadListener(listener: Function): void;
+    transportConnectionInitializer: Function;
+    HTTPFactory: HTTPFactory;
+    isXHRSupported(): boolean;
+    createSocketRequest(method: string, url: string): HTTPRequest;
+    randomInt(max: number): number;
+    getDocument?(): Document;
+    createScriptRequest?(url: string): any;
+    createJSONPRequest?(url: string, data: any): JSONPRequest;
+    ScriptReceivers?: any;
+    isXDRSupported?(useTLS?: boolean): boolean;
+}
+export default Runtime;

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

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

package/types/src/runtimes/isomorphic/default_strategy.d.ts

@@ -0,0 +1,5 @@
+import Strategy from 'core/strategies/strategy';
+import { Config } from 'core/config';
+import StrategyOptions from 'core/strategies/strategy_options';
+declare var getDefaultStrategy: (config: Config, baseOptions: StrategyOptions, defineTransport: Function) => Strategy;
+export default getDefaultStrategy;

package/types/src/runtimes/isomorphic/http/http.d.ts

@@ -0,0 +1,3 @@
+import HTTPFactory from 'core/http/http_factory';
+declare var HTTP: HTTPFactory;
+export default HTTP;

package/types/src/runtimes/isomorphic/http/http_xhr_request.d.ts

@@ -0,0 +1,3 @@
+import RequestHooks from 'core/http/request_hooks';
+declare var hooks: RequestHooks;
+export default hooks;

package/types/src/runtimes/isomorphic/runtime.d.ts

@@ -0,0 +1,2 @@
+declare var Isomorphic: any;
+export default Isomorphic;

package/types/src/runtimes/isomorphic/timeline/xhr_timeline.d.ts

@@ -0,0 +1,6 @@
+import TimelineSender from 'core/timeline/timeline_sender';
+declare var xhr: {
+    name: string;
+    getAgent: (sender: TimelineSender, useTLS: boolean) => (data: any, callback: Function) => void;
+};
+export default xhr;

package/types/src/runtimes/isomorphic/transports/transport_connection_initializer.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/types/src/runtimes/isomorphic/transports/transports.d.ts

@@ -0,0 +1,5 @@
+import TransportsTable from 'core/transports/transports_table';
+export declare var streamingConfiguration: unknown;
+export declare var pollingConfiguration: unknown;
+declare var Transports: TransportsTable;
+export default Transports;

package/types/src/runtimes/node/net_info.d.ts

@@ -0,0 +1,6 @@
+import { default as EventsDispatcher } from 'core/events/dispatcher';
+import Reachability from 'core/reachability';
+export declare class NetInfo extends EventsDispatcher implements Reachability {
+    isOnline(): boolean;
+}
+export declare var Network: NetInfo;

package/types/src/runtimes/node/runtime.d.ts

@@ -0,0 +1,3 @@
+import Runtime from '../interface';
+declare const NodeJS: Runtime;
+export default NodeJS;

package/types/src/runtimes/react-native/net_info.d.ts

@@ -0,0 +1,8 @@
+import EventsDispatcher from 'core/events/dispatcher';
+import Reachability from 'core/reachability';
+export declare class NetInfo extends EventsDispatcher implements Reachability {
+    online: boolean;
+    constructor();
+    isOnline(): boolean;
+}
+export declare var Network: NetInfo;

package/types/src/runtimes/react-native/runtime.d.ts

@@ -0,0 +1,3 @@
+import Runtime from '../interface';
+declare const ReactNative: Runtime;
+export default ReactNative;

package/types/src/runtimes/web/auth/jsonp_auth.d.ts

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

package/types/src/runtimes/web/browser.d.ts

@@ -0,0 +1,19 @@
+import AbstractRuntime from 'runtimes/interface';
+import { ScriptReceiverFactory } from './dom/script_receiver_factory';
+import ScriptRequest from './dom/script_request';
+import JSONPRequest from './dom/jsonp_request';
+import Ajax from 'core/http/ajax';
+interface Browser extends AbstractRuntime {
+    nextAuthCallbackID: number;
+    auth_callbacks: any;
+    ScriptReceivers: ScriptReceiverFactory;
+    DependenciesReceivers: ScriptReceiverFactory;
+    onDocumentBody(callback: Function): any;
+    getDocument(): any;
+    createJSONPRequest(url: string, data: any): JSONPRequest;
+    createScriptRequest(src: string): ScriptRequest;
+    isXDRSupported(useTLS?: boolean): boolean;
+    createXMLHttpRequest(): Ajax;
+    createMicrosoftXHR(): Ajax;
+}
+export default Browser;

package/types/src/runtimes/web/default_strategy.d.ts

@@ -0,0 +1,5 @@
+import Strategy from 'core/strategies/strategy';
+import StrategyOptions from 'core/strategies/strategy_options';
+import { Config } from 'core/config';
+declare var getDefaultStrategy: (config: Config, baseOptions: StrategyOptions, defineTransport: Function) => Strategy;
+export default getDefaultStrategy;

package/types/src/runtimes/web/dom/dependencies.d.ts

@@ -0,0 +1,4 @@
+import { ScriptReceiverFactory } from './script_receiver_factory';
+import DependencyLoader from './dependency_loader';
+export declare var DependenciesReceivers: ScriptReceiverFactory;
+export declare var Dependencies: DependencyLoader;

package/types/src/runtimes/web/dom/dependency_loader.d.ts

@@ -0,0 +1,10 @@
+import { ScriptReceiverFactory } from './script_receiver_factory';
+export default class DependencyLoader {
+    options: any;
+    receivers: ScriptReceiverFactory;
+    loading: any;
+    constructor(options: any);
+    load(name: string, options: any, callback: Function): void;
+    getRoot(options: any): string;
+    getPath(name: string, options: any): string;
+}

package/types/src/runtimes/web/dom/jsonp_request.d.ts

@@ -0,0 +1,10 @@
+import ScriptReceiver from './script_receiver';
+import ScriptRequest from './script_request';
+export default class JSONPRequest {
+    url: string;
+    data: any;
+    request: ScriptRequest;
+    constructor(url: string, data: any);
+    send(receiver: ScriptReceiver): void;
+    cleanup(): void;
+}

package/types/src/runtimes/web/dom/script_receiver.d.ts

@@ -0,0 +1,7 @@
+interface ScriptReceiver {
+    number: number;
+    id: string;
+    name: string;
+    callback: Function;
+}
+export default ScriptReceiver;

package/types/src/runtimes/web/dom/script_receiver_factory.d.ts

@@ -0,0 +1,10 @@
+import ScriptReceiver from './script_receiver';
+export declare class ScriptReceiverFactory {
+    lastId: number;
+    prefix: string;
+    name: string;
+    constructor(prefix: string, name: string);
+    create(callback: Function): ScriptReceiver;
+    remove(receiver: ScriptReceiver): void;
+}
+export declare var ScriptReceivers: ScriptReceiverFactory;

package/types/src/runtimes/web/dom/script_request.d.ts

@@ -0,0 +1,9 @@
+import ScriptReceiver from './script_receiver';
+export default class ScriptRequest {
+    src: string;
+    script: any;
+    errorScript: any;
+    constructor(src: string);
+    send(receiver: ScriptReceiver): void;
+    cleanup(): void;
+}

package/types/src/runtimes/web/http/http.d.ts

@@ -0,0 +1,2 @@
+import HTTP from 'isomorphic/http/http';
+export default HTTP;

package/types/src/runtimes/web/http/http_xdomain_request.d.ts

@@ -0,0 +1,3 @@
+import RequestHooks from 'core/http/request_hooks';
+declare var hooks: RequestHooks;
+export default hooks;

package/types/src/runtimes/web/net_info.d.ts

@@ -0,0 +1,7 @@
+import Reachability from 'core/reachability';
+import { default as EventsDispatcher } from 'core/events/dispatcher';
+export declare class NetInfo extends EventsDispatcher implements Reachability {
+    constructor();
+    isOnline(): boolean;
+}
+export declare var Network: NetInfo;

package/types/src/runtimes/web/runtime.d.ts

@@ -0,0 +1,3 @@
+import Browser from './browser';
+declare var Runtime: Browser;
+export default Runtime;

package/types/src/runtimes/web/timeline/jsonp_timeline.d.ts

@@ -0,0 +1,6 @@
+import TimelineSender from 'core/timeline/timeline_sender';
+declare var jsonp: {
+    name: string;
+    getAgent: (sender: TimelineSender, useTLS: boolean) => (data: any, callback: Function) => void;
+};
+export default jsonp;

package/types/src/runtimes/web/transports/transport_connection_initializer.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/types/src/runtimes/web/transports/transports.d.ts

@@ -0,0 +1,2 @@
+import { default as Transports } from 'isomorphic/transports/transports';
+export default Transports;

package/types/src/runtimes/worker/auth/fetch_auth.d.ts

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

package/types/src/runtimes/worker/net_info.d.ts

@@ -0,0 +1,6 @@
+import { default as EventsDispatcher } from 'core/events/dispatcher';
+import Reachability from 'core/reachability';
+export declare class NetInfo extends EventsDispatcher implements Reachability {
+    isOnline(): boolean;
+}
+export declare var Network: NetInfo;

package/types/src/runtimes/worker/runtime.d.ts

@@ -0,0 +1,3 @@
+import Runtime from '../interface';
+declare const Worker: Runtime;
+export default Worker;

package/types/src/runtimes/worker/timeline/fetch_timeline.d.ts

@@ -0,0 +1,6 @@
+import TimelineSender from 'core/timeline/timeline_sender';
+declare var fetchTimeline: {
+    name: string;
+    getAgent: (sender: TimelineSender, useTLS: boolean) => (data: any, callback: Function) => void;
+};
+export default fetchTimeline;

package/webpack/config.node.js

@@ -0,0 +1,26 @@
+var path = require('path');
+const { merge } = require('webpack-merge');
+var configShared = require('./config.shared');
+var webpack = require('webpack');
+
+module.exports = merge({}, configShared, {
+  entry: {
+    pusher: './src/core/pusher-with-encryption.js'
+  },
+  output: {
+    library: 'Pusher',
+    libraryTarget: 'commonjs2',
+    path: path.join(__dirname, '../dist/node'),
+    filename: 'pusher.js'
+  },
+  target: 'node',
+  resolve: {
+    // in order to import the appropriate runtime.ts
+    modules: ['src/runtimes/node']
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      RUNTIME: JSON.stringify('node')
+    })
+  ]
+});

package/webpack/config.react-native.js

@@ -0,0 +1,35 @@
+var path = require('path');
+var NormalModuleReplacementPlugin = require('webpack')
+  .NormalModuleReplacementPlugin;
+var version = require('../package').version;
+const { merge } = require('webpack-merge');
+var configShared = require('./config.shared');
+var webpack = require('webpack');
+var buffer = require('buffer');
+
+module.exports = merge({}, configShared, {
+  entry: {
+    pusher: './src/core/pusher-with-encryption.js'
+  },
+  output: {
+    library: 'Pusher',
+    libraryTarget: 'commonjs2',
+    path: path.join(__dirname, '../dist/react-native'),
+    filename: 'pusher.js'
+  },
+  externals: {
+    // our Reachability implementation needs to reference @react-native-community/netinfo.
+    '@react-native-community/netinfo': '@react-native-community/netinfo'
+  },
+  resolve: {
+    modules: ['src/runtimes/react-native']
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      RUNTIME: JSON.stringify('react-native')
+    }),
+    new webpack.ProvidePlugin({
+      Buffer: ['buffer', 'Buffer']
+    })
+  ]
+});

package/webpack/config.shared.js

@@ -0,0 +1,50 @@
+'use strict';
+
+var webpack = require('webpack');
+var fs = require('fs');
+var Config = require('./hosting_config');
+var banner = fs.readFileSync('./src/core/pusher-licence.js', 'utf8');
+banner = banner.replace('<VERSION>', Config.version);
+
+var minimize = process.env.MINIMIZE === 'false' ? false : true;
+
+module.exports = {
+  mode: process.env.MODE || 'production',
+  optimization: {
+    minimize: minimize
+  },
+  entry: {
+    pusher: './src/core/pusher.js'
+  },
+  devtool: 'source-map',
+  resolve: {
+    extensions: ['.webpack.js', '.web.js', '.ts', '.js'],
+    // add runtimes for easier importing of isomorphic runtime modules
+    modules: ['src', 'src/runtimes', 'node_modules']
+  },
+  module: {
+    rules: [
+      { test: /\.ts$/, loader: 'ts-loader' },
+      {
+        test: /\.js$/,
+        enforce: 'pre',
+        use: ['source-map-loader']
+      }
+    ]
+  },
+  node: {
+    // nacl uses Buffer on node.js but has a different code path for the browser.
+    // We don't need webpack to include a Buffer polyfill when seeing the usage,
+    // as it won't be used.
+    Buffer: false
+  },
+  plugins: [
+    new webpack.BannerPlugin({ banner: banner, raw: true }),
+    new webpack.DefinePlugin({
+      VERSION: JSON.stringify(Config.version),
+      CDN_HTTP: JSON.stringify(Config.cdn_http),
+      CDN_HTTPS: JSON.stringify(Config.cdn_https),
+      DEPENDENCY_SUFFIX: JSON.stringify(Config.dependency_suffix)
+    })
+  ]
+};

package/webpack/config.web.js

@@ -0,0 +1,36 @@
+var path = require('path');
+var webpack = require('webpack');
+var NormalModuleReplacementPlugin = webpack.NormalModuleReplacementPlugin;
+const { merge } = require('webpack-merge');
+var configShared = require('./config.shared');
+
+var filename = configShared.optimization.minimize
+  ? 'pusher.min.js'
+  : 'pusher.js';
+
+var entry = './src/core/pusher.js';
+if (process.env.INCLUDE_TWEETNACL === 'true') {
+  entry = './src/core/pusher-with-encryption.js';
+  filename = filename.replace('pusher', 'pusher-with-encryption');
+}
+
+module.exports = merge({}, configShared, {
+  entry: {
+    pusher: entry
+  },
+  output: {
+    library: 'Pusher',
+    path: path.join(__dirname, '../dist/web'),
+    filename: filename,
+    libraryTarget: 'umd'
+  },
+  resolve: {
+    modules: ['src/runtimes/web']
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      global: 'window',
+      RUNTIME: JSON.stringify('web')
+    })
+  ]
+});