catsnake/src/catsnake.js

'use strict';
import {catsnakeConfig} from './config';

import {
  csModClientid,
  csModStringify,
  csModPublish,
  csModInfo,
  csModSubscribe,
  csModGrant,
  csModDeny
} from './modules/core/index';

import {
  csModHistory
} from './modules/persistance/index';

/**
 * Creates a new CatSnake client.
 * @class
 */
class CatSnake {
  /**
   * @constructs CatSnake
   * @param {string} address - the address of the catsnake server
   * @param {object} options - options such as common name and others
   */
  constructor(address, options) {
    this.socket = new WebSocket(address);
    this.socket.binaryType = 'arraybuffer';

    this.connected = false;

    // Genrate a unique clientid
    this.client = csModClientid();

    this.commonName = (options.commonName) ?
      options.commonName : config.defaultName;

    // Fired when the connection is made to the server
    this.socket.onopen = event => {
      this.connected = true;

      // Make sure we tell the server we're leaving.
      window.onbeforeunload = () => {
        this.socket.close();
      };
    };
  }

  stringify(data, callback) {
    /**
     * Tries to return a stringified object.
     * @function csModStringify
     * @param {object} data - the object to attempt to stringify
     * @callback {string} - Returns a stringified object
    */
    return csModStringify(data, callback);
  }

  publish(channel, data, privateKey) {
    /**
     * Publishes a message to all subscribers
     * @function csModPublish
     * @param {string} channel - the channel to publish to
     * @param {object} data - the object to publish
     * @param {string} privateKey - optional private key for private channels
     * @param {this} this - this inheratance
    */
    csModPublish(channel, data, privateKey, this);
  }

  info(channel, data, opts) {
    /**
     * List all clients
     * @function csModInfo
     * @param {string} channel - the channel to look at
     * @param {object} data - additional information for request
     * @param {object} opts - additional options for subscriptions
     * @param {this} this - this inheratance
    */
    csModInfo(channel, data, opts, this);
  }

  history(channel, limit, opts) {
    /**
     * List all clients
     * @function csModHistory
     * @param {string} channel - the channel to pull history from
     * @param {number} limit - the ammount of items to pull from history
     * @param {object} opts - options such as privateKeys
     * @param {this} this - this inheratance
    */
    csModHistory(channel, limit, opts, this);
  }

  subscribe(channel, callback, opts) {
    /**
     * Subscribe to a channel
     * @function csModSubscribe
     * @param {string} channel - the channel to subscribe to
     * @callback {function} callback - new messages are returned here via msg
     * @param {object} opts - additional options for subscriptions
     * @param {this} this - this inheratance
    */
    csModSubscribe(channel, callback, opts, this);
  }

  deny(channel, client, secret) {
    /**
     * Deny a client access to a channel
     * @function csModDeny
     * @param {string} channel - the channel in which to deny the client from
     * @param {string} client - the client to deny
     * @param {string} secret - the secret key associated with this channel
    */
    return csModDeny(channel, client, secret, this);
  }

  grant(channel, client, secret) {
    /**
     * Grant a client access to a channel
     * @function csModGrant
     * @param {string} channel - the channel in which to grant the client access to
     * @param {string} client - the client to grant access
     * @param {string} secret - the secret key associated with this channel
    */
    return cdModGrant(channel, client, secret, this);
  }
}