DefinitelyTyped/types/wampy/index.d.ts

// Type definitions for wampy.js v3.0.x
// Project: https://github.com/KSDaemon/wampy.js
// Definitions by: Konstantin Burkalev <https://github.com/KSDaemon>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

interface WampyOptions
{
    autoReconnect?: boolean;
    reconnectInterval?: number;
    maxRetries?: number;
    realm?: string;
    helloCustomDetails?: any;
    onChallenge?: (auth_method: string, challenge_details: string) => string;
    authid?: string;
    onConnect?: () => void;
    onClose?: () => void;
    onError?: () => void;
    onReconnect?: () => void;
    onReconnectSuccess?: () => void;
    ws?: any;
    serializer?: any;
}

interface WampyOpStatus
{
    code: number;
    description: string;
    reqId?: number;
}

interface SuccessErrorCallbacksHash
{
    onSuccess?: (args: any[], kwargs: any) => void;
    onError?: (err: string, details: any) => void;
}

interface SubscribeCallbacksHash extends SuccessErrorCallbacksHash
{
    onEvent: (args: any[], kwargs: any) => void;
}

interface RegisterCallbacksHash extends SuccessErrorCallbacksHash
{
    rpc: (args: any[], kwargs: any, options: any) => any[];
}

interface CallSuccessErrorCallbacksHash
{
    onSuccess: (args: any[], kwargs: any) => any;
    onError?: (err: string, details: any, args: any[], kwargs: any) => void;
}

interface AdvancedOptions
{
    exclude?: number | number[];
    eligible?: number | number[];
    exclude_me?: boolean;
    disclose_me?: boolean;
}

interface PublishAdvancedOptions extends AdvancedOptions
{
    exclude_authid?: string | string[];
    exclude_authrole?: string | string[];
    eligible_authid?: string | string[];
    eligible_authrole?: string | string[];
}

interface CallAdvancedOptions
{
    disclose_me?: boolean;
    receive_progress?: boolean;
    timeout?: number;
}

interface CancelAdvancedOptions
{
    mode?: "skip" | "kill" | "killnowait";
}

interface Wampy
{
    new (url?: string, options?: WampyOptions): Wampy;
    options(opts?: WampyOptions): WampyOptions | Wampy;
    getOpStatus(): WampyOpStatus;
    getSessionId(): number;
    connect(url?: string): Wampy;
    disconnect(): Wampy;
    abort(): Wampy;
    subscribe(topicURI: string, callbacks: (((args: any[], kwargs: any) => void) | SubscribeCallbacksHash)): Wampy;
    unsubscribe(topicURI: string, callbacks?: (((args: any[], kwargs: any) => void) | SubscribeCallbacksHash)): Wampy;
    publish(topicURI: string,
            payload?: any,
            callbacks?: SuccessErrorCallbacksHash,
            advancedOptions?: PublishAdvancedOptions): Wampy;
    call(topicURI: string,
         payload?: any,
         callbacks?: (((args: any[], kwargs: any) => void) | CallSuccessErrorCallbacksHash),
         advancedOptions?: CallAdvancedOptions): Wampy;
    cancel(reqId: number,
           callbacks?: ((() => void) | SuccessErrorCallbacksHash),
           advancedOptions?: CancelAdvancedOptions): Wampy;
    register(topicURI: string, callbacks: (((args: any[], kwargs: any, options: any) => any[]) | RegisterCallbacksHash)): Wampy;
    unregister(topicURI: string, callbacks?: ((() => void) | SuccessErrorCallbacksHash)): Wampy;
}

declare var wampy: Wampy;

declare module 'wampy'
{
    export = wampy;
}