Bundled output for commit d268894e61

Includes transpiled JS/TS, and Typescript declaration files (typings).

[skip ci]

js/dist-typings/forum/utils/DiscussionControls.d.ts

@@ -2,159 +2,151 @@ declare namespace _default {
     /**
      * Get a list of controls for a discussion.
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>} context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      */
-    function controls(discussion: any, context: any): ItemList<any>;
+    function controls(discussion: import("../../common/models/Discussion").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get a list of controls for a discussion.
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>} context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      */
-    function controls(discussion: any, context: any): ItemList<any>;
+    function controls(discussion: import("../../common/models/Discussion").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion pertaining to the current user (e.g. reply,
      * follow).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function userControls(discussion: any, context: any): ItemList<any>;
+    function userControls(discussion: import("../../common/models/Discussion").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion pertaining to the current user (e.g. reply,
      * follow).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function userControls(discussion: any, context: any): ItemList<any>;
+    function userControls(discussion: import("../../common/models/Discussion").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion pertaining to moderation (e.g. rename, lock).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function moderationControls(discussion: any): ItemList<any>;
+    function moderationControls(discussion: import("../../common/models/Discussion").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion pertaining to moderation (e.g. rename, lock).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function moderationControls(discussion: any): ItemList<any>;
+    function moderationControls(discussion: import("../../common/models/Discussion").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion which are destructive (e.g. delete).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function destructiveControls(discussion: any): ItemList<any>;
+    function destructiveControls(discussion: import("../../common/models/Discussion").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a discussion which are destructive (e.g. delete).
      *
-     * @param {Discussion} discussion
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Discussion').default} discussion
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function destructiveControls(discussion: any): ItemList<any>;
+    function destructiveControls(discussion: import("../../common/models/Discussion").default): ItemList<import("mithril").Children>;
     /**
      * Open the reply composer for the discussion. A promise will be returned,
      * which resolves when the composer opens successfully. If the user is not
      * logged in, they will be prompted. If they don't have permission to
      * reply, the promise will be rejected.
      *
-     * @param {Boolean} goToLast Whether or not to scroll down to the last post if
-     *     the discussion is being viewed.
-     * @param {Boolean} forceRefresh Whether or not to force a reload of the
-     *     composer component, even if it is already open for this discussion.
-     * @return {Promise}
+     * @param {boolean} goToLast Whether or not to scroll down to the last post if the discussion is being viewed.
+     * @param {boolean} forceRefresh Whether or not to force a reload of the composer component, even if it is already open for this discussion.
+     *
+     * @return {Promise<void>}
      */
-    function replyAction(goToLast: boolean, forceRefresh: boolean): Promise<any>;
+    function replyAction(goToLast: boolean, forceRefresh: boolean): Promise<void>;
     /**
      * Open the reply composer for the discussion. A promise will be returned,
      * which resolves when the composer opens successfully. If the user is not
      * logged in, they will be prompted. If they don't have permission to
      * reply, the promise will be rejected.
      *
-     * @param {Boolean} goToLast Whether or not to scroll down to the last post if
-     *     the discussion is being viewed.
-     * @param {Boolean} forceRefresh Whether or not to force a reload of the
-     *     composer component, even if it is already open for this discussion.
-     * @return {Promise}
+     * @param {boolean} goToLast Whether or not to scroll down to the last post if the discussion is being viewed.
+     * @param {boolean} forceRefresh Whether or not to force a reload of the composer component, even if it is already open for this discussion.
+     *
+     * @return {Promise<void>}
      */
-    function replyAction(goToLast: boolean, forceRefresh: boolean): Promise<any>;
+    function replyAction(goToLast: boolean, forceRefresh: boolean): Promise<void>;
     /**
      * Hide a discussion.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function hideAction(): Promise<any>;
+    function hideAction(): Promise<void>;
     /**
      * Hide a discussion.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function hideAction(): Promise<any>;
+    function hideAction(): Promise<void>;
     /**
      * Restore a discussion.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function restoreAction(): Promise<any>;
+    function restoreAction(): Promise<void>;
     /**
      * Restore a discussion.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function restoreAction(): Promise<any>;
+    function restoreAction(): Promise<void>;
     /**
      * Delete the discussion after confirming with the user.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function deleteAction(): Promise<any>;
+    function deleteAction(): Promise<void>;
     /**
      * Delete the discussion after confirming with the user.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function deleteAction(): Promise<any>;
+    function deleteAction(): Promise<void>;
     /**
      * Rename the discussion.
-     *
-     * @return {Promise}
      */
-    function renameAction(): Promise<any>;
+    function renameAction(): any;
     /**
      * Rename the discussion.
-     *
-     * @return {Promise}
      */
-    function renameAction(): Promise<any>;
+    function renameAction(): any;
 }
 export default _default;
 import ItemList from "../../common/utils/ItemList";

js/dist-typings/forum/utils/Pane.d.ts

@@ -44,42 +44,30 @@ export default class Pane {
     protected showing: boolean;
     /**
      * Enable the pane.
-     *
-     * @public
      */
-    public enable(): void;
+    enable(): void;
     /**
      * Disable the pane.
-     *
-     * @public
      */
-    public disable(): void;
+    disable(): void;
     /**
      * Show the pane.
-     *
-     * @public
      */
-    public show(): void;
+    show(): void;
     /**
      * Hide the pane.
-     *
-     * @public
      */
-    public hide(): void;
+    hide(): void;
     /**
      * Begin a timeout to hide the pane, which can be cancelled by showing the
      * pane.
-     *
-     * @public
      */
-    public onmouseleave(): void;
+    onmouseleave(): void;
     hideTimeout: NodeJS.Timeout | undefined;
     /**
      * Toggle whether or not the pane is pinned.
-     *
-     * @public
      */
-    public togglePinned(): void;
+    togglePinned(): void;
     /**
      * Apply the appropriate CSS classes to the page element.
      *

js/dist-typings/forum/utils/PostControls.d.ts

@@ -2,131 +2,129 @@ declare namespace _default {
     /**
      * Get a list of controls for a post.
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      */
-    function controls(post: any, context: any): ItemList<any>;
+    function controls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get a list of controls for a post.
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      */
-    function controls(post: any, context: any): ItemList<any>;
+    function controls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post pertaining to the current user (e.g. report).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function userControls(post: any, context: any): ItemList<any>;
+    function userControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post pertaining to the current user (e.g. report).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function userControls(post: any, context: any): ItemList<any>;
+    function userControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post pertaining to moderation (e.g. edit).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function moderationControls(post: any, context: any): ItemList<any>;
+    function moderationControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post pertaining to moderation (e.g. edit).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function moderationControls(post: any, context: any): ItemList<any>;
+    function moderationControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post that are destructive (e.g. delete).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function destructiveControls(post: any, context: any): ItemList<any>;
+    function destructiveControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a post that are destructive (e.g. delete).
      *
-     * @param {Post} post
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/Post').default} post
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}')}
      * @protected
      */
-    function destructiveControls(post: any, context: any): ItemList<any>;
+    function destructiveControls(post: import("../../common/models/Post").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Open the composer to edit a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function editAction(): Promise<any>;
+    function editAction(): Promise<void>;
     /**
      * Open the composer to edit a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function editAction(): Promise<any>;
+    function editAction(): Promise<void>;
     /**
      * Hide a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function hideAction(): Promise<any>;
+    function hideAction(): Promise<void>;
     /**
      * Hide a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function hideAction(): Promise<any>;
+    function hideAction(): Promise<void>;
     /**
      * Restore a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function restoreAction(): Promise<any>;
+    function restoreAction(): Promise<void>;
     /**
      * Restore a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function restoreAction(): Promise<any>;
+    function restoreAction(): Promise<void>;
     /**
      * Delete a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function deleteAction(context: any): Promise<any>;
+    function deleteAction(context: any): Promise<void>;
     /**
      * Delete a post.
      *
-     * @return {Promise}
+     * @return {Promise<void>}
      */
-    function deleteAction(context: any): Promise<any>;
+    function deleteAction(context: any): Promise<void>;
 }
 export default _default;
 import ItemList from "../../common/utils/ItemList";

js/dist-typings/forum/utils/UserControls.d.ts

@@ -2,121 +2,119 @@ declare namespace _default {
     /**
      * Get a list of controls for a user.
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      */
-    function controls(user: any, context: any): ItemList<any>;
+    function controls(user: import("../../common/models/User").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get a list of controls for a user.
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
-     * @public
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      */
-    function controls(user: any, context: any): ItemList<any>;
+    function controls(user: import("../../common/models/User").default, context: import("../../common/Component").default<any, any>): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user pertaining to the current user (e.g. poke, follow).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function userControls(): ItemList<any>;
+    function userControls(): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user pertaining to the current user (e.g. poke, follow).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function userControls(): ItemList<any>;
+    function userControls(): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user pertaining to moderation (e.g. suspend, edit).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function moderationControls(user: any): ItemList<any>;
+    function moderationControls(user: import("../../common/models/User").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user pertaining to moderation (e.g. suspend, edit).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function moderationControls(user: any): ItemList<any>;
+    function moderationControls(user: import("../../common/models/User").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user which are destructive (e.g. delete).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function destructiveControls(user: any): ItemList<any>;
+    function destructiveControls(user: import("../../common/models/User").default): ItemList<import("mithril").Children>;
     /**
      * Get controls for a user which are destructive (e.g. delete).
      *
-     * @param {User} user
-     * @param {*} context The parent component under which the controls menu will
-     *     be displayed.
-     * @return {ItemList}
+     * @param {import('../../common/models/User').default} user
+     * @param {import('../../common/Component').default<any, any>}  context The parent component under which the controls menu will be displayed.
+     *
+     * @return {ItemList<import('mithril').Children>}
      * @protected
      */
-    function destructiveControls(user: any): ItemList<any>;
+    function destructiveControls(user: import("../../common/models/User").default): ItemList<import("mithril").Children>;
     /**
      * Delete the user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      */
-    function deleteAction(user: any): void;
+    function deleteAction(user: import("../../common/models/User").default): void;
     /**
      * Delete the user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      */
-    function deleteAction(user: any): void;
+    function deleteAction(user: import("../../common/models/User").default): void;
     /**
      * Show deletion alert of user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      * @param {string} type
      */
-    function showDeletionAlert(user: any, type: string): void;
+    function showDeletionAlert(user: import("../../common/models/User").default, type: string): void;
     /**
      * Show deletion alert of user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      * @param {string} type
      */
-    function showDeletionAlert(user: any, type: string): void;
+    function showDeletionAlert(user: import("../../common/models/User").default, type: string): void;
     /**
      * Edit the user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      */
-    function editAction(user: any): void;
+    function editAction(user: import("../../common/models/User").default): void;
     /**
      * Edit the user.
      *
-     * @param {User} user
+     * @param {import('../../common/models/User').default} user
      */
-    function editAction(user: any): void;
+    function editAction(user: import("../../common/models/User").default): void;
 }
 export default _default;
 import ItemList from "../../common/utils/ItemList";

js/dist-typings/forum/utils/alertEmailConfirmation.d.ts

@@ -1,6 +1,6 @@
 /**
  * Shows an alert if the user has not yet confirmed their email address.
  *
- * @param {ForumApplication} app
+ * @param {import('../ForumApplication').default} app
  */
-export default function alertEmailConfirmation(app: any): void;
+export default function alertEmailConfirmation(app: import('../ForumApplication').default): void;

js/dist-typings/forum/utils/slidable.d.ts

@@ -4,11 +4,14 @@
  * controls.
  *
  * It relies on the element having children with particular CSS classes.
- * TODO: document
  *
- * @param {DOMElement} element
- * @return {Object}
- * @property {function} reset Revert the slider to its original position. This
- *     should be called, for example, when a controls dropdown is closed.
+ * The function returns a record with a `reset` proeprty. This is a function
+ * which reverts the slider to its original position. This should be called,
+ * for example, when a controls dropdown is closed.
+ *
+ * @param {HTMLElement | SVGElement | Element} element
+ * @return {{ reset : () => void }}
  */
-export default function slidable(element: any): Object;
+export default function slidable(element: HTMLElement | SVGElement | Element): {
+    reset: () => void;
+};