Bundled output for commit 3d754461b0

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

[skip ci]

framework/core/js/dist-typings/@types/global.d.ts

@@ -21,7 +21,20 @@ declare type KeysOfType<Type extends object, Match> = {
  */
 declare type KeyOfType<Type extends object, Match> = KeysOfType<Type, Match>[keyof Type];
 
-declare type VnodeElementTag<Attrs = Record<string, unknown>, State = Record<string, unknown>> = string | ComponentTypes<Attrs, State>;
+type Component<A> = import('mithril').Component<A>;
+
+declare type ComponentClass<Attrs = Record<string, unknown>, C extends Component<Attrs> = Component<Attrs>> = {
+  new (...args: any[]): Component<Attrs>;
+  prototype: C;
+};
+
+/**
+ * Unfortunately, TypeScript only supports strings and classes for JSX tags.
+ * Therefore, our type definition should only allow for those two types.
+ *
+ * @see https://github.com/microsoft/TypeScript/issues/14789#issuecomment-412247771
+ */
+declare type VnodeElementTag<Attrs = Record<string, unknown>, C extends Component<Attrs> = Component<Attrs>> = string | ComponentClass<Attrs, C>;
 
 /**
  * @deprecated Please import `app` from a namespace instead of using it as a global variable.

framework/core/js/dist-typings/admin/components/AdminPage.d.ts

@@ -2,8 +2,8 @@ import type Mithril from 'mithril';
 import Page, { IPageAttrs } from '../../common/components/Page';
 import Stream from '../../common/utils/Stream';
 export interface AdminHeaderOptions {
-    title: string;
-    description: string;
+    title: Mithril.Children;
+    description: Mithril.Children;
     icon: string;
     /**
      * Will be used as the class for the AdminPage.

framework/core/js/dist-typings/admin/components/LoadingModal.d.ts

@@ -1,6 +1,8 @@
 /// <reference path="../../../src/common/translator-icu-rich.d.ts" />
-import Modal from '../../common/components/Modal';
-export default class LoadingModal<ModalAttrs = {}> extends Modal<ModalAttrs> {
+import Modal, { IInternalModalAttrs } from '../../common/components/Modal';
+export interface ILoadingModalAttrs extends IInternalModalAttrs {
+}
+export default class LoadingModal<ModalAttrs extends ILoadingModalAttrs = ILoadingModalAttrs> extends Modal<ModalAttrs> {
     /**
      * @inheritdoc
      */

framework/core/js/dist-typings/admin/components/ReadmeModal.d.ts

@@ -1,8 +1,18 @@
-export default class ReadmeModal extends Modal<import("../../common/components/Modal").IInternalModalAttrs> {
-    constructor();
-    name: any;
-    extName: any;
-    loadReadme(): Promise<void>;
-    readme: import("../../common/Store").ApiResponseSingle<import("../../common/Model").default> | undefined;
+/// <reference path="../../../src/common/translator-icu-rich.d.ts" />
+import Modal, { IInternalModalAttrs } from '../../common/components/Modal';
+import ExtensionReadme from '../models/ExtensionReadme';
+import type Mithril from 'mithril';
+import type { Extension } from '../AdminApplication';
+export interface IReadmeModalAttrs extends IInternalModalAttrs {
+    extension: Extension;
+}
+export default class ReadmeModal<CustomAttrs extends IReadmeModalAttrs = IReadmeModalAttrs> extends Modal<CustomAttrs> {
+    protected name: string;
+    protected extName: string;
+    protected readme: ExtensionReadme;
+    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
+    className(): string;
+    title(): import("@askvortsov/rich-icu-message-formatter").NestedStringArray;
+    content(): JSX.Element;
+    loadReadme(): Promise<void>;
 }
-import Modal from "../../common/components/Modal";

framework/core/js/dist-typings/admin/components/UserListPage.d.ts

@@ -7,7 +7,7 @@ declare type ColumnData = {
     /**
      * Column title
      */
-    name: String;
+    name: Mithril.Children;
     /**
      * Component(s) to show for this column.
      */

framework/core/js/dist-typings/common/Model.d.ts

@@ -24,10 +24,10 @@ export interface SavedModelData {
     relationships?: ModelRelationships;
 }
 export declare type ModelData = UnsavedModelData | SavedModelData;
-interface SaveRelationships {
+export interface SaveRelationships {
     [relationship: string]: Model | Model[];
 }
-interface SaveAttributes {
+export interface SaveAttributes {
     [key: string]: unknown;
     relationships?: SaveRelationships;
 }
@@ -145,4 +145,3 @@ export default abstract class Model {
      */
     protected static getIdentifier(model: Model): ModelIdentifier;
 }
-export {};

framework/core/js/dist-typings/common/Session.d.ts

@@ -5,10 +5,8 @@ export declare type LoginParams = {
      * The username/email
      */
     identification: string;
-    /**
-     * Password
-     */
     password: string;
+    remember: boolean;
 };
 /**
  * The `Session` class defines the current user session. It stores a reference

framework/core/js/dist-typings/common/components/EditUserModal.d.ts

@@ -1,26 +1,31 @@
-/**
- * The `EditUserModal` component displays a modal dialog with a login form.
- */
-export default class EditUserModal extends Modal<import("./Modal").IInternalModalAttrs> {
-    constructor();
-    username: Stream<any> | undefined;
-    email: Stream<any> | undefined;
-    isEmailConfirmed: Stream<any> | undefined;
-    setPassword: Stream<boolean> | undefined;
-    password: Stream<any> | undefined;
-    groups: {} | undefined;
-    fields(): ItemList<any>;
+/// <reference path="../../../src/common/translator-icu-rich.d.ts" />
+import Modal, { IInternalModalAttrs } from './Modal';
+import ItemList from '../utils/ItemList';
+import Stream from '../utils/Stream';
+import type Mithril from 'mithril';
+import type User from '../models/User';
+import type { SaveAttributes } from '../Model';
+export interface IEditUserModalAttrs extends IInternalModalAttrs {
+    user: User;
+}
+export default class EditUserModal<CustomAttrs extends IEditUserModalAttrs = IEditUserModalAttrs> extends Modal<CustomAttrs> {
+    protected username: Stream<string>;
+    protected email: Stream<string>;
+    protected isEmailConfirmed: Stream<boolean>;
+    protected setPassword: Stream<boolean>;
+    protected password: Stream<string>;
+    protected groups: Record<string, Stream<boolean>>;
+    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
+    className(): string;
+    title(): import("@askvortsov/rich-icu-message-formatter").NestedStringArray;
+    content(): JSX.Element;
+    fields(): ItemList<unknown>;
     activate(): void;
-    data(): {
-        relationships: {};
-    };
-    nonAdminEditingAdmin(): any;
+    data(): SaveAttributes;
+    onsubmit(e: SubmitEvent): void;
+    nonAdminEditingAdmin(): boolean | null;
     /**
      * @internal
-     * @protected
      */
-    protected userIsAdmin(user: any): any;
+    protected userIsAdmin(user: User | null): boolean | null;
 }
-import Modal from "./Modal";
-import Stream from "../utils/Stream";
-import ItemList from "../utils/ItemList";

framework/core/js/dist-typings/common/components/Modal.d.ts

@@ -22,8 +22,8 @@ export default abstract class Modal<ModalAttrs extends IInternalModalAttrs = IIn
     /**
      * Attributes for an alert component to show below the header.
      */
-    alertAttrs: AlertAttrs;
-    oninit(vnode: Mithril.VnodeDOM<ModalAttrs, this>): void;
+    alertAttrs: AlertAttrs | null;
+    oninit(vnode: Mithril.Vnode<ModalAttrs, this>): void;
     oncreate(vnode: Mithril.VnodeDOM<ModalAttrs, this>): void;
     onbeforeremove(vnode: Mithril.VnodeDOM<ModalAttrs, this>): Promise<void> | void;
     /**
@@ -37,7 +37,7 @@ export default abstract class Modal<ModalAttrs extends IInternalModalAttrs = IIn
     /**
      * Get the title of the modal dialog.
      */
-    abstract title(): string;
+    abstract title(): Mithril.Children;
     /**
      * Get the content of the modal.
      */

framework/core/js/dist-typings/common/components/RequestErrorModal.d.ts

@@ -1,4 +1,12 @@
-export default class RequestErrorModal extends Modal<import("./Modal").IInternalModalAttrs> {
-    constructor();
+/// <reference types="mithril" />
+import type RequestError from '../utils/RequestError';
+import Modal, { IInternalModalAttrs } from './Modal';
+export interface IRequestErrorModalAttrs extends IInternalModalAttrs {
+    error: RequestError;
+    formattedError: string[];
+}
+export default class RequestErrorModal<CustomAttrs extends IRequestErrorModalAttrs = IRequestErrorModalAttrs> extends Modal<CustomAttrs> {
+    className(): string;
+    title(): string;
+    content(): JSX.Element;
 }
-import Modal from "./Modal";

framework/core/js/dist-typings/common/states/AlertManagerState.d.ts

@@ -24,7 +24,7 @@ export default class AlertManagerState {
      */
     show(children: Mithril.Children): AlertIdentifier;
     show(attrs: AlertAttrs, children: Mithril.Children): AlertIdentifier;
-    show(componentClass: Alert, attrs: AlertAttrs, children: Mithril.Children): AlertIdentifier;
+    show(componentClass: typeof Alert, attrs: AlertAttrs, children: Mithril.Children): AlertIdentifier;
     /**
      * Dismiss an alert.
      */

framework/core/js/dist-typings/common/states/ModalManagerState.d.ts

@@ -1,4 +1,16 @@
+import type Component from '../Component';
 import Modal from '../components/Modal';
+/**
+ * Ideally, `show` would take a higher-kinded generic, ala:
+ *  `show<Attrs, C>(componentClass: C<Attrs>, attrs: Attrs): void`
+ * Unfortunately, TypeScript does not support this:
+ * https://github.com/Microsoft/TypeScript/issues/1213
+ * Therefore, we have to use this ugly, messy workaround.
+ */
+declare type UnsafeModalClass = ComponentClass<any, Modal> & {
+    isDismissible: boolean;
+    component: typeof Component.component;
+};
 /**
  * Class used to manage modal state.
  *
@@ -9,7 +21,7 @@ export default class ModalManagerState {
      * @internal
      */
     modal: null | {
-        componentClass: typeof Modal;
+        componentClass: UnsafeModalClass;
         attrs?: Record<string, unknown>;
     };
     private closeTimeout?;
@@ -25,7 +37,7 @@ export default class ModalManagerState {
      * // This "hack" is needed due to quirks with nested redraws in Mithril.
      * setTimeout(() => app.modal.show(MyCoolModal, { attr: 'value' }), 0);
      */
-    show(componentClass: typeof Modal, attrs?: Record<string, unknown>): void;
+    show(componentClass: UnsafeModalClass, attrs?: Record<string, unknown>): void;
     /**
      * Closes the currently open dialog, if one is open.
      */
@@ -37,3 +49,4 @@ export default class ModalManagerState {
      */
     isModalOpen(): boolean;
 }
+export {};

framework/core/js/dist-typings/forum/components/ForgotPasswordModal.d.ts

@@ -1,25 +1,25 @@
+/// <reference path="../../../src/common/translator-icu-rich.d.ts" />
+import Modal, { IInternalModalAttrs } from '../../common/components/Modal';
+import Stream from '../../common/utils/Stream';
+import Mithril from 'mithril';
+import RequestError from '../../common/utils/RequestError';
+export interface IForgotPasswordModalAttrs extends IInternalModalAttrs {
+    email?: string;
+}
 /**
  * The `ForgotPasswordModal` component displays a modal which allows the user to
  * enter their email address and request a link to reset their password.
- *
- * ### Attrs
- *
- * - `email`
  */
-export default class ForgotPasswordModal extends Modal<import("../../common/components/Modal").IInternalModalAttrs> {
-    constructor();
+export default class ForgotPasswordModal<CustomAttrs extends IForgotPasswordModalAttrs = IForgotPasswordModalAttrs> extends Modal<CustomAttrs> {
     /**
      * The value of the email input.
-     *
-     * @type {Function}
      */
-    email: Function | undefined;
-    /**
-     * Whether or not the password reset email was sent successfully.
-     *
-     * @type {Boolean}
-     */
-    success: boolean | undefined;
-    alert: any;
+    email: Stream<string>;
+    success: boolean;
+    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
+    className(): string;
+    title(): import("@askvortsov/rich-icu-message-formatter").NestedStringArray;
+    content(): JSX.Element;
+    onsubmit(e: SubmitEvent): void;
+    onerror(error: RequestError): void;
 }
-import Modal from "../../common/components/Modal";

framework/core/js/dist-typings/forum/components/LogInModal.d.ts

@@ -1,48 +1,45 @@
-/**
- * The `LogInModal` component displays a modal dialog with a login form.
- *
- * ### Attrs
- *
- * - `identification`
- * - `password`
- */
-export default class LogInModal extends Modal<import("../../common/components/Modal").IInternalModalAttrs> {
-    constructor();
+/// <reference path="../../../src/common/translator-icu-rich.d.ts" />
+import Modal, { IInternalModalAttrs } from '../../common/components/Modal';
+import ItemList from '../../common/utils/ItemList';
+import Stream from '../../common/utils/Stream';
+import type Mithril from 'mithril';
+import RequestError from '../../common/utils/RequestError';
+export interface ILoginModalAttrs extends IInternalModalAttrs {
+    identification?: string;
+    password?: string;
+    remember?: boolean;
+}
+export default class LogInModal<CustomAttrs extends ILoginModalAttrs = ILoginModalAttrs> extends Modal<CustomAttrs> {
     /**
      * The value of the identification input.
-     *
-     * @type {Function}
      */
-    identification: Function | undefined;
+    identification: Stream<string>;
     /**
      * The value of the password input.
-     *
-     * @type {Function}
      */
-    password: Function | undefined;
+    password: Stream<string>;
     /**
      * The value of the remember me input.
-     *
-     * @type {Function}
      */
-    remember: Function | undefined;
+    remember: Stream<boolean>;
+    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
+    className(): string;
+    title(): import("@askvortsov/rich-icu-message-formatter").NestedStringArray;
+    content(): JSX.Element[];
     body(): JSX.Element[];
-    fields(): ItemList<any>;
+    fields(): ItemList<unknown>;
     footer(): (string | JSX.Element)[];
     /**
      * Open the forgot password modal, prefilling it with an email if the user has
      * entered one.
-     *
-     * @public
      */
-    public forgotPassword(): void;
+    forgotPassword(): void;
     /**
      * Open the sign up modal, prefilling it with an email/username/password if
      * the user has entered one.
-     *
-     * @public
      */
-    public signUp(): void;
+    signUp(): void;
+    onready(): void;
+    onsubmit(e: SubmitEvent): void;
+    onerror(error: RequestError): void;
 }
-import Modal from "../../common/components/Modal";
-import ItemList from "../../common/utils/ItemList";

framework/core/js/dist-typings/forum/components/SignUpModal.d.ts

@@ -1,36 +1,43 @@
-/**
- * The `SignUpModal` component displays a modal dialog with a singup form.
- *
- * ### Attrs
- *
- * - `username`
- * - `email`
- * - `password`
- * - `token` An email token to sign up with.
- */
-export default class SignUpModal extends Modal<import("../../common/components/Modal").IInternalModalAttrs> {
-    constructor();
+/// <reference path="../../../src/common/translator-icu-rich.d.ts" />
+import Modal, { IInternalModalAttrs } from '../../common/components/Modal';
+import ItemList from '../../common/utils/ItemList';
+import Stream from '../../common/utils/Stream';
+import type Mithril from 'mithril';
+export interface ISignupModalAttrs extends IInternalModalAttrs {
+    username?: string;
+    email?: string;
+    password?: string;
+    token?: string;
+    provided?: string[];
+}
+export declare type SignupBody = {
+    username: string;
+    email: string;
+} & ({
+    token: string;
+} | {
+    password: string;
+});
+export default class SignUpModal<CustomAttrs extends ISignupModalAttrs = ISignupModalAttrs> extends Modal<CustomAttrs> {
     /**
      * The value of the username input.
-     *
-     * @type {Function}
      */
-    username: Function | undefined;
+    username: Stream<string>;
     /**
      * The value of the email input.
-     *
-     * @type {Function}
      */
-    email: Function | undefined;
+    email: Stream<string>;
     /**
      * The value of the password input.
-     *
-     * @type {Function}
      */
-    password: Function | undefined;
-    isProvided(field: any): any;
-    body(): (string | JSX.Element)[];
-    fields(): ItemList<any>;
+    password: Stream<string>;
+    oninit(vnode: Mithril.Vnode<CustomAttrs, this>): void;
+    className(): string;
+    title(): import("@askvortsov/rich-icu-message-formatter").NestedStringArray;
+    content(): JSX.Element[];
+    isProvided(field: string): boolean;
+    body(): (false | JSX.Element)[];
+    fields(): ItemList<unknown>;
     footer(): JSX.Element[];
     /**
      * Open the log in modal, prefilling it with an email/username/password if
@@ -38,14 +45,11 @@ export default class SignUpModal extends Modal<import("../../common/components/M
      *
      * @public
      */
-    public logIn(): void;
+    logIn(): void;
+    onready(): void;
+    onsubmit(e: SubmitEvent): void;
     /**
      * Get the data that should be submitted in the sign-up request.
-     *
-     * @return {Object}
-     * @protected
      */
-    protected submitData(): Object;
+    submitData(): SignupBody;
 }
-import Modal from "../../common/components/Modal";
-import ItemList from "../../common/utils/ItemList";