Converse converse.js

API Documentation

Source: headless/shared/_converse.js

  1. import i18n from './i18n.js';
  2. import log from '../log.js';
  3. import pluggable from 'pluggable.js/src/pluggable.js';
  4. import { Events } from '@converse/skeletor/src/events.js';
  5. import { Router } from '@converse/skeletor/src/router.js';
  6. import { createStore, getDefaultStore } from '../utils/storage.js';
  7. import { getInitSettings } from './settings/utils.js';
  8. import { getOpenPromise } from '@converse/openpromise';
  9. import { shouldClearCache } from '../utils/core.js';
  11. import {
  12.     ACTIVE,
  13.     ANONYMOUS,
  14.     CHATROOMS_TYPE,
  15.     CLOSED,
  16.     COMPOSING,
  17.     CONTROLBOX_TYPE,
  18.     DEFAULT_IMAGE,
  19.     DEFAULT_IMAGE_TYPE,
  20.     EXTERNAL,
  21.     FAILURE,
  22.     GONE,
  23.     HEADLINES_TYPE,
  24.     INACTIVE,
  25.     LOGIN,
  26.     LOGOUT,
  27.     OPENED,
  28.     PAUSED,
  29.     PREBIND,
  30.     PRIVATE_CHAT_TYPE,
  31.     SUCCESS,
  32.     VERSION_NAME
  33. } from './constants';
  36. /**
  37.  * A private, closured object containing the private api (via {@link _converse.api})
  38.  * as well as private methods and internal data-structures.
  39.  * @global
  40.  * @namespace _converse
  41.  */
  42. const _converse = {
  43.     log,
  45.     shouldClearCache, // TODO: Should be moved to utils with next major release
  46.     VERSION_NAME,
  48.     templates: {},
  49.     promises: {
  50.         'initialized': getOpenPromise()
  51.     },
  53.     // TODO: remove constants in next major release
  54.     ANONYMOUS,
  55.     CLOSED,
  56.     EXTERNAL,
  57.     LOGIN,
  58.     LOGOUT,
  59.     OPENED,
  60.     PREBIND,
  62.     SUCCESS,
  63.     FAILURE,
  65.     DEFAULT_IMAGE_TYPE,
  66.     DEFAULT_IMAGE,
  68.     INACTIVE,
  69.     ACTIVE,
  70.     COMPOSING,
  71.     PAUSED,
  72.     GONE,
  74.     PRIVATE_CHAT_TYPE,
  75.     CHATROOMS_TYPE,
  76.     HEADLINES_TYPE,
  77.     CONTROLBOX_TYPE,
  79.     // Set as module attr so that we can override in tests.
  80.     // TODO: replace with config settings
  81.     TIMEOUTS: {
  82.         PAUSED: 10000,
  83.         INACTIVE: 90000
  84.     },
  86.     default_connection_options: {'explicitResourceBinding': true},
  87.     router: new Router(),
  89.     isTestEnv: () => {
  90.         return getInitSettings()['bosh_service_url'] === 'montague.lit/http-bind';
  91.     },
  93.     getDefaultStore,
  94.     createStore,
  96.     /**
  97.      * Translate the given string based on the current locale.
  98.      * @method __
  99.      * @private
  100.      * @memberOf _converse
  101.      * @param { String } str
  102.      */
  103.     '__': (...args) => i18n.__(...args),
  105.     /**
  106.      * A no-op method which is used to signal to gettext that the passed in string
  107.      * should be included in the pot translation file.
  108.      *
  109.      * In contrast to the double-underscore method, the triple underscore method
  110.      * doesn't actually translate the strings.
  111.      *
  112.      * One reason for this method might be because we're using strings we cannot
  113.      * send to the translation function because they require variable interpolation
  114.      * and we don't yet have the variables at scan time.
  115.      *
  116.      * @method ___
  117.      * @private
  118.      * @memberOf _converse
  119.      * @param { String } str
  120.      */
  121.     '___': str => str
  122. }
  124. // Make _converse an event emitter
  125. Object.assign(_converse, Events);
  127. // Make _converse pluggable
  128. pluggable.enable(_converse, '_converse', 'pluggable');
  130. export default _converse;