Skip to content

C
converse.js
Commit c6f8ef0c authored by JC Brand's avatar JC Brand
Browse files
Options

Various JSDoc related fixes and improvements 

Using the `@method` directive on a `@class` means that the method
doesn't appear.
parent b44c0c26
Hide whitespace changes
Inline Side-by-side
Showing with 107 additions and 109 deletions
src/dom-navigator.js
View file @ c6f8ef0c
......@@ -55,8 +55,7 @@ function absoluteOffsetLeft(el) {
/**
* Adds the ability to navigate the DOM with the arrow keys
* @class
* @namespace DOMNavigator
* @class DOMNavigator
*/
class DOMNavigator {
/**
......@@ -162,7 +161,6 @@ class DOMNavigator {
/**
* Initialize the navigator.
* @method DOMNavigator#init
*/
init () {
this.selected = null;
......@@ -180,7 +178,6 @@ class DOMNavigator {
/**
* Enable this navigator.
* @method DOMNavigator#enable
*/
enable () {
this.getElements();
......@@ -191,7 +188,6 @@ class DOMNavigator {
/**
* Disable this navigator.
* @method DOMNavigator#disable
*/
disable () {
if (this.keydownHandler) {
......@@ -204,7 +200,6 @@ class DOMNavigator {
/**
* Destroy this navigator removing any event registered and any other data.
* @method DOMNavigator#destroy
*/
destroy () {
this.disable();
......@@ -214,7 +209,6 @@ class DOMNavigator {
}
/**
* @method DOMNavigator#getNextElement
* @param {'down'|'right'|'left'|'up'} direction
* @returns { HTMLElement }
*/
......@@ -266,7 +260,6 @@ class DOMNavigator {
/**
* Select the given element.
* @method DOMNavigator#select
* @param { Element } el The DOM element to select.
* @param { string } [direction] The direction.
*/
......@@ -287,7 +280,6 @@ class DOMNavigator {
/**
* Remove the current selection
* @method DOMNavigator#unselect
*/
unselect () {
if (this.selected) {
......@@ -298,7 +290,6 @@ class DOMNavigator {
/**
* Scroll the container to an element.
* @method DOMNavigator#scrollTo
* @param { HTMLElement } el The destination element.
* @param { String } direction The direction of the current navigation.
* @return void.
......@@ -345,7 +336,6 @@ class DOMNavigator {
/**
* Indicate if an element is in the container viewport.
* @method DOMNavigator#inScrollContainerViewport
* @param { HTMLElement } el The element to check.
* @return { Boolean } true if the given element is in the container viewport, otherwise false.
*/
......@@ -372,7 +362,6 @@ class DOMNavigator {
/**
* Find and store the navigable elements
* @method DOMNavigator#getElements
*/
getElements (direction) {
const selector = this.options.getSelector ? this.options.getSelector(direction) : this.options.selector;
......@@ -384,7 +373,6 @@ class DOMNavigator {
/**
* Return an array of navigable elements after an offset.
* @method DOMNavigator#elementsAfter
* @param { number } left The left offset.
* @param { number } top The top offset.
* @return { Array } An array of elements.
......@@ -395,7 +383,6 @@ class DOMNavigator {
/**
* Return an array of navigable elements before an offset.
* @method DOMNavigator#elementsBefore
* @param { number } left The left offset.
* @param { number } top The top offset.
* @return { Array } An array of elements.
......@@ -406,7 +393,6 @@ class DOMNavigator {
/**
* Handle the key down event.
* @method DOMNavigator#handleKeydown
* @param { Event } event The event object.
*/
handleKeydown (ev) {
......
src/headless/converse-mam.js
View file @ c6f8ef0c
......@@ -6,11 +6,13 @@
*/
import "./converse-disco";
import "./converse-rsm";
import { api } from "@converse/headless/converse-core";
import { intersection, pick } from 'lodash'
import { converse } from "./converse-core";
import log from "./log";
import sizzle from "sizzle";
let _converse;
const { Strophe, $iq, dayjs } = converse.env;
const u = converse.env.utils;
......@@ -18,6 +20,108 @@ const u = converse.env.utils;
const MAM_ATTRIBUTES = ['with', 'start', 'end'];
/**
* The MUC utils object. Contains utility functions related to multi-user chat.
* @mixin MAMEnabledChat
*/
const MAMEnabledChat = {
/**
* Fetches messages that might have been archived *after*
* the last archived message in our local cache.
* @private
*/
fetchNewestMessages () {
if (this.disable_mam) {
return;
}
const most_recent_msg = this.getMostRecentMessage();
if (most_recent_msg) {
const stanza_id = most_recent_msg.get(`stanza_id ${this.get('jid')}`);
if (stanza_id) {
this.fetchArchivedMessages({'after': stanza_id}, 'forwards');
} else {
this.fetchArchivedMessages({'start': most_recent_msg.get('time')}, 'forwards');
}
} else {
this.fetchArchivedMessages({'before': ''});
}
},
/**
* Fetch XEP-0313 archived messages based on the passed in criteria.
* @private
* @param { Object } options
* @param { integer } [options.max] - The maxinum number of items to return.
* Defaults to "archived_messages_page_size"
* @param { string } [options.after] - The XEP-0359 stanza ID of a message
* after which messages should be returned. Implies forward paging.
* @param { string } [options.before] - The XEP-0359 stanza ID of a message
* before which messages should be returned. Implies backward paging.
* @param { string } [options.end] - A date string in ISO-8601 format,
* before which messages should be returned. Implies backward paging.
* @param { string } [options.start] - A date string in ISO-8601 format,
* after which messages should be returned. Implies forward paging.
* @param { string } [options.with] - The JID of the entity with
* which messages were exchanged.
* @param { boolean } [options.groupchat] - True if archive in groupchat.
* @param { boolean } [page] - Whether this function should recursively
* page through the entire result set if a limited number of results
* were returned.
*/
async fetchArchivedMessages (options={}, page) {
if (this.disable_mam) {
return;
}
const is_groupchat = this.get('type') === _converse.CHATROOMS_TYPE;
const mam_jid = is_groupchat ? this.get('jid') : _converse.bare_jid;
if (!(await api.disco.supports(Strophe.NS.MAM, mam_jid))) {
return;
}
const msg_handler = is_groupchat ? s => this.queueMessage(s) : s => _converse.handleMessageStanza(s);
const query = Object.assign({
'groupchat': is_groupchat,
'max': api.settings.get('archived_messages_page_size'),
'with': this.get('jid'),
}, options);
const result = await api.archive.query(query);
/**
* *Hook* which allows plugins to inspect and potentially modify the result of a MAM query
* from {@link MAMEnabledChat.fetchArchivedMessages}.
* @event _converse#MAMResult
*/
api.hook('MAMResult', this, { result, query });
for (const message of result.messages) {
try {
await msg_handler(message);
} catch (e) {
log.error(e);
}
}
if (result.error) {
result.error.retry = () => this.fetchArchivedMessages(options, page);
this.createMessageFromError(result.error);
}
if (page && result.rsm) {
if (page === 'forwards') {
options = result.rsm.next(api.settings.get('archived_messages_page_size'), options.before);
} else if (page === 'backwards') {
options = result.rsm.previous(api.settings.get('archived_messages_page_size'), options.after);
}
return this.fetchArchivedMessages(options, page);
} else {
// TODO: Add a special kind of message which will
// render as a link to fetch further messages, either
// to fetch older messages or to fill in a gap.
}
}
}
converse.plugins.add('converse-mam', {
dependencies: ['converse-rsm', 'converse-disco', 'converse-muc'],
......@@ -27,8 +131,7 @@ converse.plugins.add('converse-mam', {
/* The initialize function gets called as soon as the plugin is
* loaded by Converse.js's plugin machinery.
*/
const { _converse } = this;
const { api } = _converse;
_converse = this._converse;
api.settings.update({
archived_messages_page_size: '50',
......@@ -36,97 +139,6 @@ converse.plugins.add('converse-mam', {
message_archiving_timeout: 20000, // Time (in milliseconds) to wait before aborting MAM request
});
const MAMEnabledChat = {
/**
* Fetches messages that might have been archived *after*
* the last archived message in our local cache.
* @private
*/
fetchNewestMessages () {
if (this.disable_mam) {
return;
}
const most_recent_msg = this.getMostRecentMessage();
if (most_recent_msg) {
const stanza_id = most_recent_msg.get(`stanza_id ${this.get('jid')}`);
if (stanza_id) {
this.fetchArchivedMessages({'after': stanza_id}, 'forwards');
} else {
this.fetchArchivedMessages({'start': most_recent_msg.get('time')}, 'forwards');
}
} else {
this.fetchArchivedMessages({'before': ''});
}
},
/**
* Fetch XEP-0313 archived messages based on the passed in criteria.
* @private
* @param { Object } options
* @param { integer } [options.max] - The maxinum number of items to return.
* Defaults to "archived_messages_page_size"
* @param { string } [options.after] - The XEP-0359 stanza ID of a message
* after which messages should be returned. Implies forward paging.
* @param { string } [options.before] - The XEP-0359 stanza ID of a message
* before which messages should be returned. Implies backward paging.
* @param { string } [options.end] - A date string in ISO-8601 format,
* before which messages should be returned. Implies backward paging.
* @param { string } [options.start] - A date string in ISO-8601 format,
* after which messages should be returned. Implies forward paging.
* @param { string } [options.with] - The JID of the entity with
* which messages were exchanged.
* @param { boolean } [options.groupchat] - True if archive in groupchat.
* @param { boolean } [page] - Whether this function should recursively
* page through the entire result set if a limited number of results
* were returned.
*/
async fetchArchivedMessages (options={}, page) {
if (this.disable_mam) {
return;
}
const is_groupchat = this.get('type') === _converse.CHATROOMS_TYPE;
const mam_jid = is_groupchat ? this.get('jid') : _converse.bare_jid;
if (!(await api.disco.supports(Strophe.NS.MAM, mam_jid))) {
return;
}
const msg_handler = is_groupchat ? s => this.queueMessage(s) : s => _converse.handleMessageStanza(s);
const query = Object.assign({
'groupchat': is_groupchat,
'max': api.settings.get('archived_messages_page_size'),
'with': this.get('jid'),
}, options);
const result = await api.archive.query(query);
api.hook('MAMResult', this, { result, query });
for (const message of result.messages) {
try {
await msg_handler(message);
} catch (e) {
log.error(e);
}
}
if (result.error) {
result.error.retry = () => this.fetchArchivedMessages(options, page);
this.createMessageFromError(result.error);
}
if (page && result.rsm) {
if (page === 'forwards') {
options = result.rsm.next(api.settings.get('archived_messages_page_size'), options.before);
} else if (page === 'backwards') {
options = result.rsm.previous(api.settings.get('archived_messages_page_size'), options.after);
}
return this.fetchArchivedMessages(options, page);
} else {
// TODO: Add a special kind of message which will
// render as a link to fetch further messages, either
// to fetch older messages or to fill in a gap.
}
}
}
Object.assign(_converse.ChatBox.prototype, MAMEnabledChat);
......
src/headless/utils/muc.js
View file @ c6f8ef0c
......@@ -11,7 +11,7 @@ const { Strophe, sizzle } = converse.env;
/**
* The MUC utils object. Contains utility functions related to multi-user chat.
* @namespace stanza_utils
* @namespace muc_utils
*/
const muc_utils = {
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7