1
0
mirror of https://github.com/flarum/core.git synced 2025-08-18 14:22:02 +02:00

Compare commits

..

2 Commits

Author SHA1 Message Date
David Wheatley
61be08577d fix: .container set to width larger than viewport 2021-12-24 13:37:21 +01:00
David Wheatley
d1dd3d952d feat: use position: sticky on discussion sidenav 2021-12-24 13:33:42 +01:00
177 changed files with 1587 additions and 1743 deletions

1
.gitattributes vendored
View File

@@ -13,6 +13,5 @@ tests export-ignore
js/dist/* -diff js/dist/* -diff
js/dist/* linguist-generated js/dist/* linguist-generated
js/dist-typings/* linguist-generated js/dist-typings/* linguist-generated
js/yarn.lock -diff
* text=auto eol=lf * text=auto eol=lf

View File

@@ -1,15 +0,0 @@
name: Core PHP
on: [workflow_dispatch, push, pull_request]
# The reusable workflow definitions will be moved to the `flarum/framework` repo soon.
# This will break your current script.
# When this happens, run `flarum-cli audit infra --fix` to update your infrastructure.
jobs:
run:
uses: flarum/.github/.github/workflows/REUSABLE_backend.yml@main
with:
enable_backend_testing: true
backend_directory: .

View File

@@ -1,21 +0,0 @@
name: Core JS
on: [workflow_dispatch, push, pull_request]
# The reusable workflow definitions will be moved to the `flarum/framework` repo soon.
# This will break your current script.
# When this happens, run `flarum-cli audit infra --fix` to update your infrastructure.
jobs:
run:
uses: flarum/.github/.github/workflows/REUSABLE_frontend.yml@main
with:
enable_bundlewatch: true
enable_prettier: true
enable_typescript: true
frontend_directory: ./js
main_git_branch: master
secrets:
bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

137
.github/workflows/js.yml vendored Normal file
View File

@@ -0,0 +1,137 @@
name: JS
on: [workflow_dispatch, push, pull_request]
env:
NODE_VERSION: 16
jobs:
prettier:
name: Prettier
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: "yarn"
cache-dependency-path: js/yarn.lock
- name: Install JS dependencies
run: yarn install --immutable
working-directory: ./js
- name: Check JS formatting
run: yarn run format-check
working-directory: ./js
typecheck:
name: Typecheck
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: "yarn"
cache-dependency-path: js/yarn.lock
- name: Install JS dependencies
run: yarn --frozen-lockfile
working-directory: ./js
- name: Typecheck
run: yarn run check-typings
working-directory: ./js
type-coverage:
name: Type Coverage
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: "yarn"
cache-dependency-path: js/yarn.lock
- name: Install JS dependencies
run: yarn --frozen-lockfile
working-directory: ./js
- name: Check type coverage
run: yarn run check-typings-coverage
working-directory: ./js
build-prod:
name: Build and commit
runs-on: ubuntu-latest
needs: [prettier, typecheck, type-coverage]
# Only commit JS on push to master branch
# Remember to change in `build-test` job too
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: "yarn"
cache-dependency-path: js/yarn.lock
# Our action will install npm, cd into `./js`, run `npm run build` and
# `npm run build-typings`, then commit and upload any changes
- name: Build production JS
uses: flarum/action-build@2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
build_script: build
package_manager: yarn
typings_script: build-typings
build-test:
name: Test build
runs-on: ubuntu-latest
needs: [prettier, typecheck, type-coverage]
# Inverse check of `build-prod`
# Remember to change in `build-prod` job too
if: github.ref != 'refs/heads/master' || github.event_name != 'push'
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: ${{ env.NODE_VERSION }}
cache: "yarn"
cache-dependency-path: js/yarn.lock
# Our action will install npm, cd into `./js`, run `npm run build` and
# `npm run build-typings`, then commit and upload any changes
- name: Build production JS
uses: flarum/action-build@2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
build_script: build
package_manager: yarn
typings_script: build-typings
do_not_commit: true

45
.github/workflows/pr_size_change.yml vendored Normal file
View File

@@ -0,0 +1,45 @@
name: Bundle size checker
on:
workflow_dispatch:
push:
paths:
- "js/**"
pull_request:
paths:
- "js/**"
jobs:
bundlewatch:
runs-on: ubuntu-latest
name: Bundlewatch
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: "14"
- name: Use npm v7
run: sudo npm install -g npm@7.x.x
- name: Install JS dependencies
# We need to use `npm install` here. If we don't, the workflow will fail.
run: npm install
working-directory: ./js
- name: Build production assets
run: npm run build
working-directory: ./js
- name: Check bundle size change
run: node_modules/.bin/bundlewatch --config .bundlewatch.config.json
working-directory: ./js
env:
BUNDLEWATCH_GITHUB_TOKEN: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
CI_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}

79
.github/workflows/test.yml vendored Normal file
View File

@@ -0,0 +1,79 @@
name: Tests
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
php: [7.3, 7.4, '8.0', '8.1']
service: ['mysql:5.7', mariadb]
prefix: ['', flarum_]
include:
- service: 'mysql:5.7'
db: MySQL
- service: mariadb
db: MariaDB
- prefix: flarum_
prefixStr: (prefix)
exclude:
- php: 7.3
service: 'mysql:5.7'
prefix: flarum_
- php: 7.3
service: mariadb
prefix: flarum_
- php: 8.0
service: 'mysql:5.7'
prefix: flarum_
- php: 8.0
service: mariadb
prefix: flarum_
services:
mysql:
image: ${{ matrix.service }}
ports:
- 13306:3306
name: 'PHP ${{ matrix.php }} / ${{ matrix.db }} ${{ matrix.prefixStr }}'
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Setup PHP
uses: shivammathur/setup-php@0b9d33cd0782337377999751fc10ea079fdd7104 # pin@v2
with:
php-version: ${{ matrix.php }}
coverage: xdebug
extensions: curl, dom, gd, json, mbstring, openssl, pdo_mysql, tokenizer, zip
tools: phpunit, composer:v2
# The authentication alter is necessary because newer mysql versions use the `caching_sha2_password` driver,
# which isn't supported prior to PHP7.4
# When we drop support for PHP7.3, we should remove this from the setup.
- name: Create MySQL Database
run: |
sudo systemctl start mysql
mysql -uroot -proot -e 'CREATE DATABASE flarum_test;' --port 13306
mysql -uroot -proot -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';" --port 13306
- name: Install Composer dependencies
run: composer install
- name: Setup Composer tests
run: composer test:setup
env:
DB_PORT: 13306
DB_PASSWORD: root
DB_PREFIX: ${{ matrix.prefix }}
- name: Run Composer tests
run: composer test
env:
COMPOSER_PROCESS_TIMEOUT: 600

1
.gitignore vendored
View File

@@ -1,7 +1,6 @@
/vendor /vendor
composer.lock composer.lock
composer.phar composer.phar
.DS_Store .DS_Store
Thumbs.db Thumbs.db
tests/.phpunit.result.cache tests/.phpunit.result.cache

View File

@@ -1,120 +1,5 @@
# Changelog # Changelog
## [1.2.1](https://github.com/flarum/core/compare/v1.2.0...v1.2.1)
### Fixed
- Don't escape single quotes in discussion title meta tags (60600f4d2b8f0c5dac94c329041427a0a08fad42)
## [1.2.0](https://github.com/flarum/core/compare/v1.1.1...v1.2.0)
### Added
- View `README` documentation in extension pages (https://github.com/flarum/core/pull/3094).
- Declare & Use CSS Custom Properties (https://github.com/flarum/core/pull/3146).
- Lazy draw dropdowns to improve performance (https://github.com/flarum/core/pull/2925).
- Default Settings Extender (https://github.com/flarum/core/pull/3127).
- Add `textarea` setting type to admin pages (https://github.com/flarum/core/pull/3141).
- Allow registering settings as `Less` config vars through Settings Extender (https://github.com/flarum/core/pull/3011).
- Allow replacing of blade template namespaces via extender (https://github.com/flarum/core/pull/3167).
- Update to Webpack 5 (https://github.com/flarum/core/pull/3135).
- Introduce `Less` custom function extender with a `is-extension-enabled` function (https://github.com/flarum/core/pull/3190).
- Support for `few` in ICU Message syntax (https://github.com/flarum/core/pull/3122).
- ES6 local support for number formatting (https://github.com/flarum/core/pull/3099).
- Added dedicated endpoint for retrieving single groups (https://github.com/flarum/core/pull/3084).
- Callback `loadWhere` relation eager loading extender (https://github.com/flarum/core/pull/3116).
- Extensible document title driver implementation (https://github.com/flarum/core/pull/3109).
- Type checks, typescript coverage GH action (https://github.com/flarum/core/pull/3136).
- Add color indicator in appearance admin page instead of validating colors (https://github.com/flarum/core/pull/3140).
- Add typing files for our translator libraries (https://github.com/flarum/core/pull/3175).
- `StatusWidget` tools extensibility (https://github.com/flarum/core/pull/3189).
- Allow switching the `ImageManager` driver (https://github.com/flarum/core/pull/3195).
- Events for notification read/all read actions (https://github.com/flarum/core/pull/3203).
### Changed
- Testing with php8.1 (https://github.com/flarum/core/pull/3102).
- Migrate fully to Yarn (https://github.com/flarum/core/pull/3155).
- Handle post rendering errors to avoid crashes (https://github.com/flarum/core/pull/3061).
- Added basic filtering, sorting, and pagination to groups endpoint (https://github.com/flarum/core/pull/3084).
- Pass IP address to API Client pipeline (https://github.com/flarum/core/pull/3124).
- Rename Extension Page "Uninstall" to "Purge" (https://github.com/flarum/core/pull/3123).
- [A11Y] Improve accessibility for discussion reply count on post stream (https://github.com/flarum/core/pull/3090).
- Improved post loading support (https://github.com/flarum/core/pull/3100).
- Rewrite SubtreeRetainer into Typescript (https://github.com/flarum/core/pull/3137).
- Rewrite ModalManager and state to Typescript (https://github.com/flarum/core/pull/3007).
- Rewrite frontend application files to Typescript (https://github.com/flarum/core/pull/3006).
- Allow extensions to modify the minimum search length in the Search component (https://github.com/flarum/core/pull/3130).
- Allow use of any tag in `listItems` helper (https://github.com/flarum/core/pull/3147).
- Replace `for ... in` with `Array.reduce` (https://github.com/flarum/core/pull/3149).
- Page title format is now implemented through translations (https://github.com/flarum/core/pull/3077, https://github.com/flarum/core/pull/3228)
- Add `aria-label` attribute to the navigation drawer button (https://github.com/flarum/core/pull/3157).
- Convert extend util to TypeScript (https://github.com/flarum/core/pull/2928).
- Better typings for DiscussionListState (https://github.com/flarum/core/pull/3132).
- Rewrite ItemList, update `ItemList` typings (https://github.com/flarum/core/pull/3005).
- Add priority order to discussion page controls (https://github.com/flarum/core/pull/3165).
- Use `@php` in Blade templates (https://github.com/flarum/core/pull/3172).
- Convert some common classes/utils to TS (https://github.com/flarum/core/pull/2929).
- Convert routes to Typescript (https://github.com/flarum/core/pull/3177).
- Move admin `colorItems` to an `ItemList` (https://github.com/flarum/core/pull/3186).
- Centralize pagination/canonical meta URL generation in Document (https://github.com/flarum/core/pull/3077).
- Use revision versioner to allow custom asset versioning (https://github.com/flarum/core/pull/3183).
- Split up application error handling (https://github.com/flarum/core/pull/3184).
- Make SlugManager available to blade template (https://github.com/flarum/core/pull/3194).
- Convert models to TS (https://github.com/flarum/core/pull/3174).
- Allow loading relations in other discussion endpoints (https://github.com/flarum/core/pull/3191).
- Improve selected text stylization (https://github.com/flarum/core/pull/2961).
- Extract notification `primaryControl` items to an ItemList (https://github.com/flarum/core/pull/3204).
- Frontend code housekeeping (#3214, #3213).
- Only retain scroll position if coming from discussion (https://github.com/flarum/core/pull/3229).
- Use `aria-live` regions to focus screenreader attention on alerts as they appear (https://github.com/flarum/core/pull/3237).
- Prevent unwarranted `a11y` warnings on custom Button subclasses (https://github.com/flarum/core/pull/3238).
### Fixed
- Missing locale text in the user editing modal (https://github.com/flarum/core/pull/3093).
- Dashes in table prefix prevent installation (https://github.com/flarum/core/pull/3089).
- Missing autocomplete attributes to input fields (https://github.com/flarum/core/pull/3088).
- Missing route parameters throwing an error (https://github.com/flarum/core/pull/3118).
- Mail settings select component never used (https://github.com/flarum/core/pull/3120).
- White avatar image throws javascript errors on the profile page (https://github.com/flarum/core/pull/3119).
- Unformatted avatar upload validation errors (https://github.com/flarum/core/pull/2946).
- Webkit input clear button shows up with the custom one (https://github.com/flarum/core/pull/3128).
- Media query breakpoints conflict with Windows display scaling (https://github.com/flarum/core/pull/3139).
- `typeof this` not recognized by some IDEs (https://github.com/flarum/core/pull/3142).
- `Model.save()` cannot save `null` `hasOne` relationship (https://github.com/flarum/core/pull/3131).
- Edit post `until reply` policy broken on PHP 8 (https://github.com/flarum/core/pull/3145).
- Inaccurate `Component.component` argument typings (https://github.com/flarum/core/pull/3148).
- Scrolling notification list infinitely repeats (https://github.com/flarum/core/pull/3159).
- Argument for INFO constant was assigned to `maxfiles` argument incorrectly (bfd81a83cfd0fa8125395a147ff0c9ce622f38e3).
- `Activated` event is sent every time an email is confirmed instead of just once (https://github.com/flarum/core/pull/3163).
- [A11Y] Modal close button missing accessible label (https://github.com/flarum/core/pull/3161).
- [A11Y] Auth modal inputs missing accessible labels (https://github.com/flarum/core/pull/3207).
- [A11Y] Triggering click on drawer button can cause layered backdrops (https://github.com/flarum/core/pull/3018).
- [A11Y] Focus can leave open nav drawer on mobile (https://github.com/flarum/core/pull/3018).
- [A11Y] Post action items not showing when focus is within the post (https://github.com/flarum/core/pull/3173).
- [A11Y] Missing accessible label for alert dismiss button (https://github.com/flarum/core/pull/3237).
- Error accessing the forum after saving a setting with more than 65k characters (https://github.com/flarum/core/pull/3162).
- Cannot restart queue from within (https://github.com/flarum/core/pull/3166).
- `Post--by-actor` not showing when comparing user instances (https://github.com/flarum/core/pull/3170).
- Incorrect typings for Modal `hide()` method (https://github.com/flarum/core/pull/3180).
- Avatar Upload throws errors with correct mimetype and incorrect extension (https://github.com/flarum/core/pull/3181).
- Clicking the dropdown button on a post opens all dropdowns in `Post-actions` (https://github.com/flarum/core/pull/3185).
- `getPlainContent()` causes external content to be fetched (https://github.com/flarum/core/pull/3193).
- `listItems` not accepting all `Mithril.Children` (https://github.com/flarum/core/pull/3176).
- Notifications mark as read option updates all notifications including the read ones (https://github.com/flarum/core/pull/3202).
- Post meta permalink not properly generated (https://github.com/flarum/core/pull/3216).
- Broken contribution link in README (https://github.com/flarum/core/pull/3211).
- `WelcomeHero` is displayed when content is empty (https://github.com/flarum/core/pull/3219).
- `last_activity_at, last_seen_at` updated on all API requests (https://github.com/flarum/core/pull/3231).
- `RememberMe` access token updated twice in API requests (https://github.com/flarum/core/pull/3233).
- Error in `funding` item in `composer.json` bricks the frontend (https://github.com/flarum/core/pull/3239).
- Escaped quotes in window title (https://github.com/flarum/core/pull/3264)
- `schedule:list` command fails due to missing timezone configuration.
### Deprecated
- Unused `evented` utility (https://github.com/flarum/core/pull/3125).
## [1.1.1](https://github.com/flarum/core/compare/v1.1.0...v1.1.1)
### Fixed
- Performance issue with very large communities.
## [1.1.0](https://github.com/flarum/core/compare/v1.0.4...v1.1.0) ## [1.1.0](https://github.com/flarum/core/compare/v1.0.4...v1.1.0)

View File

View File

@@ -86,7 +86,7 @@
"wikimedia/less.php": "^3.0" "wikimedia/less.php": "^3.0"
}, },
"require-dev": { "require-dev": {
"flarum/testing": "^1.0.0" "flarum/testing": "1.0@dev"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {
@@ -107,28 +107,6 @@
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "1.x-dev" "dev-master": "1.x-dev"
},
"flarum-cli": {
"excludeScaffolding": [
"LICENSE.md",
"js/tsconfig.json",
"js/webpack.config.js"
],
"modules": {
"backendTesting": true,
"js": true,
"gitConf": true,
"githubActions": true,
"prettier": true,
"typescript": true,
"bundlewatch": true,
"editorConfig": true,
"styleci": true,
"admin": true,
"forum": true,
"jsCommon": true,
"css": true
}
} }
}, },
"scripts": { "scripts": {

File diff suppressed because one or more lines are too long

View File

@@ -1,3 +1,2 @@
yarnPath: .yarn/releases/yarn-3.1.0.cjs
nodeLinker: node-modules nodeLinker: node-modules
yarnPath: .yarn/releases/yarn-3.1.1.cjs

View File

@@ -1,2 +1,2 @@
export * from './src/common'; export * from './src/common';
export * from './src/forum'; export * from './src/admin';

View File

@@ -4,8 +4,8 @@ declare var _default: {
Store: typeof import("../common/Store").default; Store: typeof import("../common/Store").default;
'utils/BasicEditorDriver': typeof import("../common/utils/BasicEditorDriver").default; 'utils/BasicEditorDriver': typeof import("../common/utils/BasicEditorDriver").default;
'utils/evented': { 'utils/evented': {
handlers: Record<string, unknown>; handlers: Object;
getHandlers(event: string): Function[]; getHandlers(event: string): any[];
trigger(event: string, ...args: any[]): void; trigger(event: string, ...args: any[]): void;
on(event: string, handler: Function): void; on(event: string, handler: Function): void;
one(event: string, handler: Function): void; one(event: string, handler: Function): void;

View File

@@ -5,9 +5,9 @@ export default class AdminNav extends Component<import("../../common/Component")
/** /**
* Build an item list of main links to show in the admin navigation. * Build an item list of main links to show in the admin navigation.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
extensionItems(): ItemList<any>; extensionItems(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";

View File

@@ -7,12 +7,10 @@ export default class BasicsPage extends AdminPage<import("../../common/component
* Build a list of options for the default homepage. Each option must be an * Build a list of options for the default homepage. Each option must be an
* object with `path` and `label` properties. * object with `path` and `label` properties.
* *
* @return {ItemList<{ path: string, label: import('mithril').Children }>} * @return {ItemList}
* @public
*/ */
homePageItems(): ItemList<{ public homePageItems(): ItemList<any>;
path: string;
label: import('mithril').Children;
}>;
} }
import AdminPage from "./AdminPage"; import AdminPage from "./AdminPage";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -3,14 +3,14 @@ export default class DashboardWidget extends Component<import("../../common/Comp
/** /**
* Get the class name to apply to the widget. * Get the class name to apply to the widget.
* *
* @return {string} * @return {String}
*/ */
className(): string; className(): string;
/** /**
* Get the content of the widget. * Get the content of the widget.
* *
* @return {import('mithril').Children} * @return {VirtualElement}
*/ */
content(): import('mithril').Children; content(): any;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";

View File

@@ -8,9 +8,9 @@ export default class HeaderPrimary extends Component<import("../../common/Compon
/** /**
* Build an item list for the controls. * Build an item list for the controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -6,9 +6,9 @@ export default class HeaderSecondary extends Component<import("../../common/Comp
/** /**
* Build an item list for the controls. * Build an item list for the controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -13,16 +13,16 @@ export default class UploadImageButton extends Button<import("../../common/compo
/** /**
* After a successful upload/removal, reload the page. * After a successful upload/removal, reload the page.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
protected success(response: object): void; protected success(response: Object): void;
/** /**
* If upload/removal fails, stop loading. * If upload/removal fails, stop loading.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
protected failure(response: object): void; protected failure(response: Object): void;
} }
import Button from "../../common/components/Button"; import Button from "../../common/components/Button";

View File

@@ -73,8 +73,6 @@ export interface RouteResolver<Attrs extends ComponentAttrs, Comp extends Compon
* *
* Returns the component class, and **not** a Vnode or JSX * Returns the component class, and **not** a Vnode or JSX
* expression. * expression.
*
* @see https://mithril.js.org/route.html#routeresolveronmatch
*/ */
onmatch(this: this, args: RouteArgs, requestedPath: string, route: string): { onmatch(this: this, args: RouteArgs, requestedPath: string, route: string): {
new (): Comp; new (): Comp;
@@ -82,14 +80,9 @@ export interface RouteResolver<Attrs extends ComponentAttrs, Comp extends Compon
/** /**
* A function which renders the provided component. * A function which renders the provided component.
* *
* If not specified, the route will default to rendering the
* component on its own, inside of a fragment.
*
* Returns a Mithril Vnode or other children. * Returns a Mithril Vnode or other children.
*
* @see https://mithril.js.org/route.html#routeresolverrender
*/ */
render?(this: this, vnode: Mithril.Vnode<Attrs, Comp>): Mithril.Children; render(this: this, vnode: Mithril.Vnode<Attrs, Comp>): Mithril.Children;
} }
/** /**
* The `App` class provides a container for an application, as well as various * The `App` class provides a container for an application, as well as various
@@ -222,6 +215,9 @@ export default class Application {
* Make an AJAX request, handling any low-level errors that may occur. * Make an AJAX request, handling any low-level errors that may occur.
* *
* @see https://mithril.js.org/request.html * @see https://mithril.js.org/request.html
*
* @param options
* @return {Promise}
*/ */
request<ResponseType>(originalOptions: FlarumRequestOptions<ResponseType>): Promise<ResponseType>; request<ResponseType>(originalOptions: FlarumRequestOptions<ResponseType>): Promise<ResponseType>;
/** /**

View File

@@ -28,8 +28,8 @@ export default abstract class Fragment {
* containing all of the `li` elements inside the DOM element of this * containing all of the `li` elements inside the DOM element of this
* fragment. * fragment.
* *
* @param [selector] a jQuery-compatible selector string * @param {String} [selector] a jQuery-compatible selector string
* @returns the jQuery object for the DOM node * @returns {jQuery} the jQuery object for the DOM node
* @final * @final
*/ */
$(selector?: string): JQuery; $(selector?: string): JQuery;

View File

@@ -78,7 +78,7 @@ export default class Store {
* within the 'data' key of the payload. * within the 'data' key of the payload.
*/ */
pushPayload<M extends Model>(payload: ApiPayloadSingle): ApiResponseSingle<M>; pushPayload<M extends Model>(payload: ApiPayloadSingle): ApiResponseSingle<M>;
pushPayload<Ms extends Model[]>(payload: ApiPayloadPlural): ApiResponsePlural<Ms[number]>; pushPayload<Ms extends Model[]>(payload: ApiPayloadPlural): ApiResponseSingle<Ms[number]>;
/** /**
* Create a model to represent a resource object (or update an existing one), * Create a model to represent a resource object (or update an existing one),
* and push it into the store. * and push it into the store.

View File

@@ -4,8 +4,8 @@ declare var _default: {
Store: typeof Store; Store: typeof Store;
'utils/BasicEditorDriver': typeof BasicEditorDriver; 'utils/BasicEditorDriver': typeof BasicEditorDriver;
'utils/evented': { 'utils/evented': {
handlers: Record<string, unknown>; handlers: Object;
getHandlers(event: string): Function[]; getHandlers(event: string): any[];
trigger(event: string, ...args: any[]): void; trigger(event: string, ...args: any[]): void;
on(event: string, handler: Function): void; on(event: string, handler: Function): void;
one(event: string, handler: Function): void; one(event: string, handler: Function): void;

View File

@@ -15,14 +15,14 @@ export default class Checkbox extends Component<import("../Component").Component
/** /**
* Get the template for the checkbox's display (tick/cross icon). * Get the template for the checkbox's display (tick/cross icon).
* *
* @return {import('mithril').Children} * @return {*}
* @protected * @protected
*/ */
protected getDisplay(): import('mithril').Children; protected getDisplay(): any;
/** /**
* Run a callback when the state of the checkbox is changed. * Run a callback when the state of the checkbox is changed.
* *
* @param {boolean} checked * @param {Boolean} checked
* @protected * @protected
*/ */
protected onchange(checked: boolean): void; protected onchange(checked: boolean): void;

View File

@@ -22,17 +22,17 @@ export default class Dropdown extends Component<import("../Component").Component
/** /**
* Get the template for the button. * Get the template for the button.
* *
* @return {import('mithril').Children} * @return {*}
* @protected * @protected
*/ */
protected getButton(children: any): import('mithril').Children; protected getButton(children: any): any;
/** /**
* Get the template for the button's content. * Get the template for the button's content.
* *
* @return {import('mithril').Children} * @return {*}
* @protected * @protected
*/ */
protected getButtonContent(children: any): import('mithril').Children; protected getButtonContent(children: any): any;
getMenu(items: any): JSX.Element; getMenu(items: any): JSX.Element;
} }
import Component from "../Component"; import Component from "../Component";

View File

@@ -16,10 +16,10 @@ export default class LinkButton extends Button<import("./Button").IButtonAttrs>
/** /**
* Determine whether a component with the given attrs is 'active'. * Determine whether a component with the given attrs is 'active'.
* *
* @param {object} attrs * @param {Object} attrs
* @return {boolean} * @return {Boolean}
*/ */
static isActive(attrs: object): boolean; static isActive(attrs: Object): boolean;
constructor(); constructor();
} }
import Button from "./Button"; import Button from "./Button";

View File

@@ -18,23 +18,23 @@ export default class Navigation extends Component<import("../Component").Compone
/** /**
* Get the back button. * Get the back button.
* *
* @return {import('mithril').Children} * @return {Object}
* @protected * @protected
*/ */
protected getBackButton(): import('mithril').Children; protected getBackButton(): Object;
/** /**
* Get the pane pinned toggle button. * Get the pane pinned toggle button.
* *
* @return {import('mithril').Children} * @return {Object|String}
* @protected * @protected
*/ */
protected getPaneButton(): import('mithril').Children; protected getPaneButton(): Object | string;
/** /**
* Get the drawer toggle button. * Get the drawer toggle button.
* *
* @return {import('mithril').Children} * @return {Object|String}
* @protected * @protected
*/ */
protected getDrawerButton(): import('mithril').Children; protected getDrawerButton(): Object | string;
} }
import Component from "../Component"; import Component from "../Component";

View File

@@ -7,10 +7,9 @@ export default class SplitDropdown extends Dropdown {
* Get the first child. If the first child is an array, the first item in that * Get the first child. If the first child is an array, the first item in that
* array will be returned. * array will be returned.
* *
* @param {unknown[] | unknown} children * @return {*}
* @return {unknown}
* @protected * @protected
*/ */
protected getFirstChild(children: unknown[] | unknown): unknown; protected getFirstChild(children: any): any;
} }
import Dropdown from "./Dropdown"; import Dropdown from "./Dropdown";

View File

@@ -36,19 +36,19 @@ export default class TextEditor extends Component<import("../Component").Compone
/** /**
* Build an item list for the text editor controls. * Build an item list for the text editor controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
controlItems(): ItemList<import('mithril').Children>; controlItems(): ItemList<any>;
/** /**
* Build an item list for the toolbar controls. * Build an item list for the toolbar controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
toolbarItems(): ItemList<import('mithril').Children>; toolbarItems(): ItemList<any>;
/** /**
* Handle input into the textarea. * Handle input into the textarea.
* *
* @param {string} value * @param {String} value
*/ */
oninput(value: string): void; oninput(value: string): void;
/** /**

View File

@@ -23,7 +23,7 @@
* @param methods The name or names of the method(s) to extend * @param methods The name or names of the method(s) to extend
* @param callback A callback which mutates the method's output * @param callback A callback which mutates the method's output
*/ */
export declare function extend<T extends Record<string, any>, K extends KeyOfType<T, Function>>(object: T, methods: K | K[], callback: (this: T, val: ReturnType<T[K]>, ...args: Parameters<T[K]>) => void): void; export declare function extend<T extends object, K extends KeyOfType<T, Function>>(object: T, methods: K | K[], callback: (this: T, val: ReturnType<T[K]>, ...args: Parameters<T[K]>) => void): void;
/** /**
* Override an object's method by replacing it with a new function, so that the * Override an object's method by replacing it with a new function, so that the
* new function will be run every time the object's method is called. * new function will be run every time the object's method is called.
@@ -51,4 +51,4 @@ export declare function extend<T extends Record<string, any>, K extends KeyOfTyp
* @param methods The name or names of the method(s) to override * @param methods The name or names of the method(s) to override
* @param newMethod The method to replace it with * @param newMethod The method to replace it with
*/ */
export declare function override<T extends Record<any, any>, K extends KeyOfType<T, Function>>(object: T, methods: K | K[], newMethod: (this: T, orig: T[K], ...args: Parameters<T[K]>) => void): void; export declare function override<T extends object, K extends KeyOfType<T, Function>>(object: T, methods: K | K[], newMethod: (this: T, orig: T[K], ...args: Parameters<T[K]>) => void): void;

View File

@@ -6,7 +6,7 @@
* punctuateSeries(['Toby', 'Franz', 'Dominion']) // Toby, Franz, and Dominion * punctuateSeries(['Toby', 'Franz', 'Dominion']) // Toby, Franz, and Dominion
* ``` * ```
* *
* @param {import('mithril').Children[]} items * @param {Array} items
* @return {import('mithril').Children}')} * @return {VirtualElement}
*/ */
export default function punctuateSeries(items: import('mithril').Children[]): import('mithril').Children; export default function punctuateSeries(items: any[]): any;

View File

@@ -1,13 +1,3 @@
import 'expose-loader?exposes=$,jQuery!jquery'; import * as Extend from "./extend/index";
import 'expose-loader?exposes=m!mithril'; import app from "./app";
import 'expose-loader?exposes=dayjs!dayjs';
import 'bootstrap/js/affix';
import 'bootstrap/js/dropdown';
import 'bootstrap/js/modal';
import 'bootstrap/js/tooltip';
import 'bootstrap/js/transition';
import 'jquery.hotkeys/jquery.hotkeys';
import * as Extend from './extend/index';
import app from './app';
export { Extend, app }; export { Extend, app };
import './utils/arrayFlatPolyfill';

View File

@@ -20,7 +20,7 @@ export default class AlertManagerState {
/** /**
* Show an Alert in the alerts area. * Show an Alert in the alerts area.
* *
* @return The alert's ID, which can be used to dismiss the alert. * @returns The alert's ID, which can be used to dismiss the alert.
*/ */
show(children: Mithril.Children): AlertIdentifier; show(children: Mithril.Children): AlertIdentifier;
show(attrs: AlertAttrs, children: Mithril.Children): AlertIdentifier; show(attrs: AlertAttrs, children: Mithril.Children): AlertIdentifier;

View File

@@ -23,13 +23,7 @@ export default class ModalManagerState {
modal: null | { modal: null | {
componentClass: UnsafeModalClass; componentClass: UnsafeModalClass;
attrs?: Record<string, unknown>; attrs?: Record<string, unknown>;
key: number;
}; };
/**
* Used to force re-initialization of modals if a modal
* is replaced by another of the same type.
*/
private key;
private closeTimeout?; private closeTimeout?;
/** /**
* Shows a modal dialog. * Shows a modal dialog.
@@ -51,7 +45,7 @@ export default class ModalManagerState {
/** /**
* Checks if a modal is currently open. * Checks if a modal is currently open.
* *
* @return `true` if a modal dialog is currently open, otherwise `false`. * @returns `true` if a modal dialog is currently open, otherwise `false`.
*/ */
isModalOpen(): boolean; isModalOpen(): boolean;
} }

View File

@@ -5,11 +5,12 @@ export default class PageState {
/** /**
* Determine whether the page matches the given class and data. * Determine whether the page matches the given class and data.
* *
* @param {object} type The page class to check against. Subclasses are accepted as well. * @param {object} type The page class to check against. Subclasses are
* @param {Record<string, unknown>} data * accepted as well.
* @param {object} data
* @return {boolean} * @return {boolean}
*/ */
matches(type: object, data?: Record<string, unknown>): boolean; matches(type: object, data?: object): boolean;
get(key: any): any; get(key: any): any;
set(key: any, value: any): void; set(key: any, value: any): void;
} }

View File

@@ -34,15 +34,20 @@ export default class Drawer {
* Check whether or not the drawer is currently open. * Check whether or not the drawer is currently open.
* *
* @return {boolean} * @return {boolean}
* @public
*/ */
isOpen(): boolean; public isOpen(): boolean;
/** /**
* Hide the drawer. * Hide the drawer.
*
* @public
*/ */
hide(): void; public hide(): void;
/** /**
* Show the drawer. * Show the drawer.
*
* @public
*/ */
show(): void; public show(): void;
$backdrop: JQuery<HTMLElement> | undefined; $backdrop: JQuery<HTMLElement> | undefined;
} }

View File

@@ -192,7 +192,7 @@ export default class ItemList<T> {
* *
* @param content The item's content (objects only) * @param content The item's content (objects only)
* @param key The item's key * @param key The item's key
* @return Proxied content * @returns Proxied content
* *
* @internal * @internal
*/ */

View File

@@ -6,6 +6,7 @@ export default class ScrollListener {
/** /**
* @param {(top: number) => void} callback The callback to run when the scroll position * @param {(top: number) => void} callback The callback to run when the scroll position
* changes. * changes.
* @public
*/ */
constructor(callback: (top: number) => void); constructor(callback: (top: number) => void);
callback: (top: number) => void; callback: (top: number) => void;
@@ -19,15 +20,21 @@ export default class ScrollListener {
protected loop(): void; protected loop(): void;
/** /**
* Run the callback, whether there was a scroll event or not. * Run the callback, whether there was a scroll event or not.
*
* @public
*/ */
update(): void; public update(): void;
/** /**
* Start listening to and handling the window's scroll position. * Start listening to and handling the window's scroll position.
*
* @public
*/ */
start(): void; public start(): void;
active: (() => void) | null | undefined; active: (() => void) | null | undefined;
/** /**
* Stop listening to and handling the window's scroll position. * Stop listening to and handling the window's scroll position.
*
* @public
*/ */
stop(): void; public stop(): void;
} }

View File

@@ -8,7 +8,7 @@
* position can be anchor to an element that is in or below the viewport, so * position can be anchor to an element that is in or below the viewport, so
* the content in the viewport will stay the same. * the content in the viewport will stay the same.
* *
* @param {HTMLElement | SVGElement | Element} element The element to anchor the scroll position to. * @param {DOMElement} element The element to anchor the scroll position to.
* @param {() => void} callback The callback to run that will change page content. * @param {Function} callback The callback to run that will change page content.
*/ */
export default function anchorScroll(element: HTMLElement | SVGElement | Element, callback: () => void): void; export default function anchorScroll(element: any, callback: Function): void;

View File

@@ -3,8 +3,9 @@ import Model from '../Model';
* The `computed` utility creates a function that will cache its output until * The `computed` utility creates a function that will cache its output until
* any of the dependent values are dirty. * any of the dependent values are dirty.
* *
* @param dependentKeys The keys of the dependent values. * @param {...String} dependentKeys The keys of the dependent values.
* @param compute The function which computes the value using the * @param {function} compute The function which computes the value using the
* dependent values. * dependent values.
* @return {Function}
*/ */
export default function computed<T, M = Model>(...args: [...string[], (this: M, ...args: unknown[]) => T]): () => T; export default function computed<T, M = Model>(...args: [...string[], (this: M, ...args: unknown[]) => T]): () => T;

View File

@@ -1,97 +1,79 @@
declare namespace _default { declare namespace _default {
const handlers: Record<string, unknown>; const handlers: Object;
/** /**
* Get all of the registered handlers for an event. * Get all of the registered handlers for an event.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @return {Function[]} * @return {Array}
* @protected * @protected
*
* @deprecated
*/ */
function getHandlers(event: string): Function[]; function getHandlers(event: string): any[];
/** /**
* Get all of the registered handlers for an event. * Get all of the registered handlers for an event.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @return {Function[]} * @return {Array}
* @protected * @protected
*
* @deprecated
*/ */
function getHandlers(event: string): Function[]; function getHandlers(event: string): any[];
/** /**
* Trigger an event. * Trigger an event.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {any[]} args Arguments to pass to event handlers. * @param {...*} args Arguments to pass to event handlers.
* * @public
* @deprecated
*/ */
function trigger(event: string, ...args: any[]): void; function trigger(event: string, ...args: any[]): void;
/** /**
* Trigger an event. * Trigger an event.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {any[]} args Arguments to pass to event handlers. * @param {...*} args Arguments to pass to event handlers.
* * @public
* @deprecated
*/ */
function trigger(event: string, ...args: any[]): void; function trigger(event: string, ...args: any[]): void;
/** /**
* Register an event handler. * Register an event handler.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function to handle the event. * @param {function} handler The function to handle the event.
*
* @deprecated
*/ */
function on(event: string, handler: Function): void; function on(event: string, handler: Function): void;
/** /**
* Register an event handler. * Register an event handler.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function to handle the event. * @param {function} handler The function to handle the event.
*
* @deprecated
*/ */
function on(event: string, handler: Function): void; function on(event: string, handler: Function): void;
/** /**
* Register an event handler so that it will run only once, and then * Register an event handler so that it will run only once, and then
* unregister itself. * unregister itself.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function to handle the event. * @param {function} handler The function to handle the event.
*
* @deprecated
*/ */
function one(event: string, handler: Function): void; function one(event: string, handler: Function): void;
/** /**
* Register an event handler so that it will run only once, and then * Register an event handler so that it will run only once, and then
* unregister itself. * unregister itself.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function to handle the event. * @param {function} handler The function to handle the event.
*
* @deprecated
*/ */
function one(event: string, handler: Function): void; function one(event: string, handler: Function): void;
/** /**
* Unregister an event handler. * Unregister an event handler.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function that handles the event. * @param {function} handler The function that handles the event.
*
* @deprecated
*/ */
function off(event: string, handler: Function): void; function off(event: string, handler: Function): void;
/** /**
* Unregister an event handler. * Unregister an event handler.
* *
* @param {string} event The name of the event. * @param {String} event The name of the event.
* @param {Function} handler The function that handles the event. * @param {function} handler The function that handles the event.
*
* @deprecated
*/ */
function off(event: string, handler: Function): void; function off(event: string, handler: Function): void;
} }

View File

@@ -5,8 +5,8 @@
* @example * @example
* class MyClass extends mixin(ExistingClass, evented, etc) {} * class MyClass extends mixin(ExistingClass, evented, etc) {}
* *
* @param {object} Parent The class to extend the new class from. * @param {Class} Parent The class to extend the new class from.
* @param {Record<string, any>[]} mixins The objects to mix in. * @param {...Object} mixins The objects to mix in.
* @return {object} A new class that extends Parent and contains the mixins. * @return {Class} A new class that extends Parent and contains the mixins.
*/ */
export default function mixin(Parent: object, ...mixins: Record<string, any>[]): object; export default function mixin(Parent: any, ...mixins: Object[]): any;

View File

@@ -4,8 +4,8 @@ declare var _default: {
Store: typeof import("../common/Store").default; Store: typeof import("../common/Store").default;
'utils/BasicEditorDriver': typeof BasicEditorDriver; 'utils/BasicEditorDriver': typeof BasicEditorDriver;
'utils/evented': { 'utils/evented': {
handlers: Record<string, unknown>; handlers: Object;
getHandlers(event: string): Function[]; getHandlers(event: string): any[];
trigger(event: string, ...args: any[]): void; trigger(event: string, ...args: any[]): void;
on(event: string, handler: Function): void; on(event: string, handler: Function): void;
one(event: string, handler: Function): void; one(event: string, handler: Function): void;
@@ -92,38 +92,38 @@ declare var _default: {
'states/PaginatedListState': typeof import("../common/states/PaginatedListState").default; 'states/PaginatedListState': typeof import("../common/states/PaginatedListState").default;
} & { } & {
'utils/PostControls': { 'utils/PostControls': {
controls(post: import("../common/models/Post").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; controls(post: any, context: any): import("../common/utils/ItemList").default<any>;
userControls(post: import("../common/models/Post").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; userControls(post: any, context: any): import("../common/utils/ItemList").default<any>;
moderationControls(post: import("../common/models/Post").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; moderationControls(post: any, context: any): import("../common/utils/ItemList").default<any>;
destructiveControls(post: import("../common/models/Post").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; destructiveControls(post: any, context: any): import("../common/utils/ItemList").default<any>;
editAction(): Promise<void>; editAction(): Promise<any>;
hideAction(): Promise<void>; hideAction(): Promise<any>;
restoreAction(): Promise<void>; restoreAction(): Promise<any>;
deleteAction(context: any): Promise<void>; deleteAction(context: any): Promise<any>;
}; };
'utils/KeyboardNavigatable': typeof KeyboardNavigatable; 'utils/KeyboardNavigatable': typeof KeyboardNavigatable;
'utils/slidable': typeof slidable; 'utils/slidable': typeof slidable;
'utils/History': typeof History; 'utils/History': typeof History;
'utils/DiscussionControls': { 'utils/DiscussionControls': {
controls(discussion: import("../common/models/Discussion").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; controls(discussion: any, context: any): import("../common/utils/ItemList").default<any>;
userControls(discussion: import("../common/models/Discussion").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; userControls(discussion: any, context: any): import("../common/utils/ItemList").default<any>;
moderationControls(discussion: import("../common/models/Discussion").default): import("../common/utils/ItemList").default<import("mithril").Children>; moderationControls(discussion: any): import("../common/utils/ItemList").default<any>;
destructiveControls(discussion: import("../common/models/Discussion").default): import("../common/utils/ItemList").default<import("mithril").Children>; destructiveControls(discussion: any): import("../common/utils/ItemList").default<any>;
replyAction(goToLast: boolean, forceRefresh: boolean): Promise<void>; replyAction(goToLast: boolean, forceRefresh: boolean): Promise<any>;
hideAction(): Promise<void>; hideAction(): Promise<any>;
restoreAction(): Promise<void>; restoreAction(): Promise<any>;
deleteAction(): Promise<void>; deleteAction(): Promise<any>;
renameAction(): any; renameAction(): Promise<any>;
}; };
'utils/alertEmailConfirmation': typeof alertEmailConfirmation; 'utils/alertEmailConfirmation': typeof alertEmailConfirmation;
'utils/UserControls': { 'utils/UserControls': {
controls(user: import("../common/models/User").default, context: import("../common/Component").default<any, any>): import("../common/utils/ItemList").default<import("mithril").Children>; controls(user: any, context: any): import("../common/utils/ItemList").default<any>;
userControls(): import("../common/utils/ItemList").default<import("mithril").Children>; userControls(): import("../common/utils/ItemList").default<any>;
moderationControls(user: import("../common/models/User").default): import("../common/utils/ItemList").default<import("mithril").Children>; moderationControls(user: any): import("../common/utils/ItemList").default<any>;
destructiveControls(user: import("../common/models/User").default): import("../common/utils/ItemList").default<import("mithril").Children>; destructiveControls(user: any): import("../common/utils/ItemList").default<any>;
deleteAction(user: import("../common/models/User").default): void; deleteAction(user: any): void;
showDeletionAlert(user: import("../common/models/User").default, type: string): void; showDeletionAlert(user: any, type: string): void;
editAction(user: import("../common/models/User").default): void; editAction(user: any): void;
}; };
'utils/Pane': typeof Pane; 'utils/Pane': typeof Pane;
'utils/BasicEditorDriver': typeof BasicEditorDriver; 'utils/BasicEditorDriver': typeof BasicEditorDriver;

View File

@@ -24,36 +24,36 @@ export default class AvatarEditor extends Component<import("../../common/Compone
/** /**
* Get the items in the edit avatar dropdown menu. * Get the items in the edit avatar dropdown menu.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
controlItems(): ItemList<import('mithril').Children>; controlItems(): ItemList<any>;
/** /**
* Enable dragover style * Enable dragover style
* *
* @param {DragEvent} e * @param {Event} e
*/ */
enableDragover(e: DragEvent): void; enableDragover(e: Event): void;
/** /**
* Disable dragover style * Disable dragover style
* *
* @param {DragEvent} e * @param {Event} e
*/ */
disableDragover(e: DragEvent): void; disableDragover(e: Event): void;
/** /**
* Upload avatar when file is dropped into dropzone. * Upload avatar when file is dropped into dropzone.
* *
* @param {DragEvent} e * @param {Event} e
*/ */
dropUpload(e: DragEvent): void; dropUpload(e: Event): void;
/** /**
* If the user doesn't have an avatar, there's no point in showing the * If the user doesn't have an avatar, there's no point in showing the
* controls dropdown, because only one option would be viable: uploading. * controls dropdown, because only one option would be viable: uploading.
* Thus, when the avatar editor's dropdown toggle button is clicked, we prompt * Thus, when the avatar editor's dropdown toggle button is clicked, we prompt
* the user to upload an avatar immediately. * the user to upload an avatar immediately.
* *
* @param {MouseEvent} e * @param {Event} e
*/ */
quickUpload(e: MouseEvent): void; quickUpload(e: Event): void;
/** /**
* Upload avatar using file picker * Upload avatar using file picker
*/ */
@@ -72,17 +72,17 @@ export default class AvatarEditor extends Component<import("../../common/Compone
* After a successful upload/removal, push the updated user data into the * After a successful upload/removal, push the updated user data into the
* store, and force a recomputation of the user's avatar color. * store, and force a recomputation of the user's avatar color.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
protected success(response: object): void; protected success(response: Object): void;
/** /**
* If avatar upload/removal fails, stop loading. * If avatar upload/removal fails, stop loading.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
protected failure(response: object): void; protected failure(response: Object): void;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -32,9 +32,9 @@ export default class CommentPost extends Post {
/** /**
* Build an item list for the post's header. * Build an item list for the post's header.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
headerItems(): ItemList<import('mithril').Children>; headerItems(): ItemList<any>;
} }
import Post from "./Post"; import Post from "./Post";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -21,9 +21,9 @@ export default class Composer extends Component<import("../../common/Component")
/** /**
* Resize the composer according to mouse movement. * Resize the composer according to mouse movement.
* *
* @param {MouseEvent} e * @param {Event} e
*/ */
onmousemove(e: MouseEvent): void; onmousemove(e: Event): void;
/** /**
* Finish resizing the composer when the mouse is released. * Finish resizing the composer when the mouse is released.
*/ */
@@ -83,23 +83,23 @@ export default class Composer extends Component<import("../../common/Component")
/** /**
* Build an item list for the composer's controls. * Build an item list for the composer's controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
controlItems(): ItemList<import('mithril').Children>; controlItems(): ItemList<any>;
/** /**
* Initialize default Composer height. * Initialize default Composer height.
*/ */
initializeHeight(): void; initializeHeight(): void;
/** /**
* Default height of the Composer in case none is saved. * Default height of the Composer in case none is saved.
* @returns {number} * @returns {Integer}
*/ */
defaultHeight(): number; defaultHeight(): any;
/** /**
* Save a new Composer height and update the DOM. * Save a new Composer height and update the DOM.
* @param {number} height * @param {Integer} height
*/ */
changeHeight(height: number): void; changeHeight(height: any): void;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -27,15 +27,15 @@ export default class ComposerBody extends Component<import("../../common/Compone
/** /**
* Check if there is any unsaved data. * Check if there is any unsaved data.
* *
* @return {boolean} * @return {String}
*/ */
hasChanges(): boolean; hasChanges(): string;
/** /**
* Build an item list for the composer's header. * Build an item list for the composer's header.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
headerItems(): ItemList<import('mithril').Children>; headerItems(): ItemList<any>;
/** /**
* Handle the submit event of the text editor. * Handle the submit event of the text editor.
* *

View File

@@ -21,14 +21,14 @@ export default class DiscussionComposer extends ComposerBody {
* Handle the title input's keydown event. When the return key is pressed, * Handle the title input's keydown event. When the return key is pressed,
* move the focus to the start of the text editor. * move the focus to the start of the text editor.
* *
* @param {KeyboardEvent} e * @param {Event} e
*/ */
onkeydown(e: KeyboardEvent): void; onkeydown(e: Event): void;
/** /**
* Get the data to submit to the server when the discussion is saved. * Get the data to submit to the server when the discussion is saved.
* *
* @return {Record<string, unknown>} * @return {Object}
*/ */
data(): Record<string, unknown>; data(): Object;
} }
import ComposerBody from "./ComposerBody"; import ComposerBody from "./ComposerBody";

View File

@@ -10,9 +10,9 @@ export default class DiscussionHero extends Component<import("../../common/Compo
/** /**
* Build an item list for the contents of the discussion hero. * Build an item list for the contents of the discussion hero.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -23,7 +23,7 @@ export default class DiscussionListItem extends Component<import("../../common/C
/** /**
* Determine whether or not the discussion is currently being viewed. * Determine whether or not the discussion is currently being viewed.
* *
* @return {boolean} * @return {Boolean}
*/ */
active(): boolean; active(): boolean;
/** /**
@@ -31,14 +31,14 @@ export default class DiscussionListItem extends Component<import("../../common/C
* should be displayed instead of information about the most recent reply to * should be displayed instead of information about the most recent reply to
* the discussion. * the discussion.
* *
* @return {boolean} * @return {Boolean}
*/ */
showFirstPost(): boolean; showFirstPost(): boolean;
/** /**
* Determine whether or not the number of replies should be shown instead of * Determine whether or not the number of replies should be shown instead of
* the number of unread posts. * the number of unread posts.
* *
* @return {boolean} * @return {Boolean}
*/ */
showRepliesCount(): boolean; showRepliesCount(): boolean;
/** /**
@@ -49,9 +49,9 @@ export default class DiscussionListItem extends Component<import("../../common/C
* Build an item list of info for a discussion listing. By default this is * Build an item list of info for a discussion listing. By default this is
* just the first/last post indicator. * just the first/last post indicator.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
infoItems(): ItemList<import('mithril').Children>; infoItems(): ItemList<any>;
replyCountItem(): JSX.Element; replyCountItem(): JSX.Element;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";

View File

@@ -31,24 +31,34 @@ export default class DiscussionPage<CustomAttrs extends IDiscussionPageAttrs = I
view(): JSX.Element; view(): JSX.Element;
/** /**
* List of components shown while the discussion is loading. * List of components shown while the discussion is loading.
*
* @returns {ItemList}
*/ */
loadingItems(): ItemList<Mithril.Children>; loadingItems(): ItemList<unknown>;
/** /**
* Function that renders the `sidebarItems` ItemList. * Function that renders the `sidebarItems` ItemList.
*
* @returns {import('mithril').Children}
*/ */
sidebar(): Mithril.Children; sidebar(): JSX.Element;
/** /**
* Renders the discussion's hero. * Renders the discussion's hero.
*
* @returns {import('mithril').Children}
*/ */
hero(): Mithril.Children; hero(): JSX.Element;
/** /**
* List of items rendered as the main page content. * List of items rendered as the main page content.
*
* @returns {ItemList}
*/ */
pageContent(): ItemList<Mithril.Children>; pageContent(): ItemList<unknown>;
/** /**
* List of items rendered inside the main page content container. * List of items rendered inside the main page content container.
*
* @returns {ItemList}
*/ */
mainContent(): ItemList<Mithril.Children>; mainContent(): ItemList<unknown>;
/** /**
* Load the discussion from the API or use the preloaded one. * Load the discussion from the API or use the preloaded one.
*/ */
@@ -56,8 +66,15 @@ export default class DiscussionPage<CustomAttrs extends IDiscussionPageAttrs = I
/** /**
* Get the parameters that should be passed in the API request to get the * Get the parameters that should be passed in the API request to get the
* discussion. * discussion.
*
* @return {Object}
*/ */
requestParams(): Record<string, unknown>; requestParams(): {
bySlug: boolean;
page: {
near: number;
};
};
/** /**
* Initialize the component to display the given discussion. * Initialize the component to display the given discussion.
*/ */
@@ -65,7 +82,7 @@ export default class DiscussionPage<CustomAttrs extends IDiscussionPageAttrs = I
/** /**
* Build an item list for the contents of the sidebar. * Build an item list for the contents of the sidebar.
*/ */
sidebarItems(): ItemList<Mithril.Children>; sidebarItems(): ItemList<Mithril.Vnode<{}, {}>>;
/** /**
* When the posts that are visible in the post stream change (i.e. the user * When the posts that are visible in the post stream change (i.e. the user
* scrolls up or down), then we update the URL and mark the posts as read. * scrolls up or down), then we update the URL and mark the posts as read.

View File

@@ -17,8 +17,8 @@ export default class EditPostComposer extends ComposerBody {
/** /**
* Get the data to submit to the server when the post is saved. * Get the data to submit to the server when the post is saved.
* *
* @return {Record<string, unknown>} * @return {Object}
*/ */
data(): Record<string, unknown>; data(): Object;
} }
import ComposerBody from "./ComposerBody"; import ComposerBody from "./ComposerBody";

View File

@@ -13,27 +13,27 @@ export default class EventPost extends Post {
/** /**
* Get the name of the event icon. * Get the name of the event icon.
* *
* @return {string} * @return {String}
*/ */
icon(): string; icon(): string;
/** /**
* Get the description text for the event. * Get the description text for the event.
* *
* @param {Record<string, unknown>} data * @param {Object} data
* @return {import('mithril').Children} The description to render in the DOM * @return {String|Object} The description to render in the DOM
*/ */
description(data: Record<string, unknown>): import('mithril').Children; description(data: Object): string | Object;
/** /**
* Get the translation key for the description of the event. * Get the translation key for the description of the event.
* *
* @return {string} * @return {String}
*/ */
descriptionKey(): string; descriptionKey(): string;
/** /**
* Get the translation data for the description of the event. * Get the translation data for the description of the event.
* *
* @return {Record<string, unknown>} * @return {Object}
*/ */
descriptionData(): Record<string, unknown>; descriptionData(): Object;
} }
import Post from "./Post"; import Post from "./Post";

View File

@@ -7,9 +7,9 @@ export default class HeaderPrimary extends Component<import("../../common/Compon
/** /**
* Build an item list for the controls. * Build an item list for the controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -10,47 +10,49 @@ export default class IndexPage extends Page<import("../../common/components/Page
/** /**
* Get the component to display as the hero. * Get the component to display as the hero.
* *
* @return {import('mithril').Children} * @return {MithrilComponent}
*/ */
hero(): import('mithril').Children; hero(): any;
/** /**
* Build an item list for the sidebar of the index page. By default this is a * Build an item list for the sidebar of the index page. By default this is a
* "New Discussion" button, and then a DropdownSelect component containing a * "New Discussion" button, and then a DropdownSelect component containing a
* list of navigation items. * list of navigation items.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
sidebarItems(): ItemList<import('mithril').Children>; sidebarItems(): ItemList<any>;
/** /**
* Build an item list for the navigation in the sidebar of the index page. By * Build an item list for the navigation in the sidebar of the index page. By
* default this is just the 'All Discussions' link. * default this is just the 'All Discussions' link.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
navItems(): ItemList<import('mithril').Children>; navItems(): ItemList<any>;
/** /**
* Build an item list for the part of the toolbar which is concerned with how * Build an item list for the part of the toolbar which is concerned with how
* the results are displayed. By default this is just a select box to change * the results are displayed. By default this is just a select box to change
* the way discussions are sorted. * the way discussions are sorted.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
viewItems(): ItemList<import('mithril').Children>; viewItems(): ItemList<any>;
/** /**
* Build an item list for the part of the toolbar which is about taking action * Build an item list for the part of the toolbar which is about taking action
* on the results. By default this is just a "mark all as read" button. * on the results. By default this is just a "mark all as read" button.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
actionItems(): ItemList<import('mithril').Children>; actionItems(): ItemList<any>;
/** /**
* Open the composer for a new discussion or prompt the user to login. * Open the composer for a new discussion or prompt the user to login.
* *
* @return {Promise<void>} * @return {Promise}
*/ */
newDiscussionAction(): Promise<void>; newDiscussionAction(): Promise<any>;
/** /**
* Mark all discussions as read. * Mark all discussions as read.
*
* @return void
*/ */
markAllAsRead(): void; markAllAsRead(): void;
} }

View File

@@ -6,9 +6,10 @@ export default class LogInButtons extends Component<import("../../common/Compone
/** /**
* Build a list of LogInButton components. * Build a list of LogInButton components.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
* @public
*/ */
items(): ItemList<import('mithril').Children>; public items(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -13,31 +13,31 @@ export default class Notification extends Component<import("../../common/Compone
/** /**
* Get the name of the icon that should be displayed in the notification. * Get the name of the icon that should be displayed in the notification.
* *
* @return {string} * @return {String}
* @abstract * @abstract
*/ */
icon(): string; icon(): string;
/** /**
* Get the URL that the notification should link to. * Get the URL that the notification should link to.
* *
* @return {string} * @return {String}
* @abstract * @abstract
*/ */
href(): string; href(): string;
/** /**
* Get the content of the notification. * Get the content of the notification.
* *
* @return {import('mithril').Children} * @return {VirtualElement}
* @abstract * @abstract
*/ */
content(): import('mithril').Children; content(): any;
/** /**
* Get the excerpt of the notification. * Get the excerpt of the notification.
* *
* @return {import('mithril').Children} * @return {VirtualElement}
* @abstract * @abstract
*/ */
excerpt(): import('mithril').Children; excerpt(): any;
/** /**
* Mark the notification as read. * Mark the notification as read.
*/ */

View File

@@ -11,55 +11,47 @@ export default class NotificationGrid extends Component<import("../../common/Com
/** /**
* Information about the available notification methods. * Information about the available notification methods.
* *
* @type {({ name: string, icon: string, label: import('mithril').Children })[]} * @type {Array}
*/ */
methods: { methods: any[] | undefined;
name: string;
icon: string;
label: import('mithril').Children;
}[] | undefined;
/** /**
* A map of which notification checkboxes are loading. * A map of which notification checkboxes are loading.
* *
* @type {Record<string, boolean>} * @type {Object}
*/ */
loading: Record<string, boolean> | undefined; loading: Object | undefined;
/** /**
* Information about the available notification types. * Information about the available notification types.
* *
* @type {({ name: string, icon: string, label: import('mithril').Children })[]} * @type {Array}
*/ */
types: { types: any[] | undefined;
name: string;
icon: string;
label: import('mithril').Children;
}[] | undefined;
/** /**
* Toggle the state of the given preferences, based on the value of the first * Toggle the state of the given preferences, based on the value of the first
* one. * one.
* *
* @param {string[]} keys * @param {Array} keys
*/ */
toggle(keys: string[]): void; toggle(keys: any[]): void;
/** /**
* Toggle all notification types for the given method. * Toggle all notification types for the given method.
* *
* @param {string} method * @param {String} method
*/ */
toggleMethod(method: string): void; toggleMethod(method: string): void;
/** /**
* Toggle all notification methods for the given type. * Toggle all notification methods for the given type.
* *
* @param {string} type * @param {String} type
*/ */
toggleType(type: string): void; toggleType(type: string): void;
/** /**
* Get the name of the preference key for the given notification type-method * Get the name of the preference key for the given notification type-method
* combination. * combination.
* *
* @param {string} type * @param {String} type
* @param {string} method * @param {String} method
* @return {string} * @return {String}
*/ */
preferenceKey(type: string, method: string): string; preferenceKey(type: string, method: string): string;
/** /**
@@ -71,13 +63,9 @@ export default class NotificationGrid extends Component<import("../../common/Com
* - `icon` The icon to display in the column header. * - `icon` The icon to display in the column header.
* - `label` The label to display in the column header. * - `label` The label to display in the column header.
* *
* @return {ItemList<{ name: string, icon: string, label: import('mithril').Children }>} * @return {ItemList}
*/ */
notificationMethods(): ItemList<{ notificationMethods(): ItemList<any>;
name: string;
icon: string;
label: import('mithril').Children;
}>;
/** /**
* Build an item list for the notification types to display in the grid. * Build an item list for the notification types to display in the grid.
* *
@@ -87,14 +75,9 @@ export default class NotificationGrid extends Component<import("../../common/Com
* - `icon` The icon to display in the notification grid row. * - `icon` The icon to display in the notification grid row.
* - `label` The label to display in the notification grid row. * - `label` The label to display in the notification grid row.
* *
* @return {ItemList<{ name: string, icon: string, label: import('mithril').Children}>} * @return {ItemList}
*/ */
notificationTypes(): ItemList<{ notificationTypes(): ItemList<any>;
name: string;
icon: string;
label: import('mithril').Children;
}>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";
import icon from "../../common/helpers/icon";

View File

@@ -25,34 +25,34 @@ export default class Post extends Component<import("../../common/Component").Com
/** /**
* Get attributes for the post element. * Get attributes for the post element.
* *
* @return {Record<string, unknown>} * @return {Object}
*/ */
elementAttrs(): Record<string, unknown>; elementAttrs(): Object;
/** /**
* Get the post's content. * Get the post's content.
* *
* @return {import('mithril').Children} * @return {Array}
*/ */
content(): import('mithril').Children; content(): any[];
/** /**
* Get the post's classes. * Get the post's classes.
* *
* @param {string} existing * @param existing string
* @returns {string[]} * @returns {string[]}
*/ */
classes(existing: string): string[]; classes(existing: any): string[];
/** /**
* Build an item list for the post's actions. * Build an item list for the post's actions.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
actionItems(): ItemList<import('mithril').Children>; actionItems(): ItemList<any>;
/** /**
* Build an item list for the post's footer. * Build an item list for the post's footer.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
footerItems(): ItemList<import('mithril').Children>; footerItems(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import SubtreeRetainer from "../../common/utils/SubtreeRetainer"; import SubtreeRetainer from "../../common/utils/SubtreeRetainer";

View File

@@ -12,9 +12,9 @@ export default class PostMeta extends Component<import("../../common/Component")
/** /**
* Get the permalink for the given post. * Get the permalink for the given post.
* *
* @param {import('../../common/models/Post').default} post * @param {Post} post
* @returns {string} * @returns {String}
*/ */
getPermalink(post: import('../../common/models/Post').default): string; getPermalink(post: any): string;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";

View File

@@ -20,17 +20,17 @@ export default class PostStream extends Component<import("../../common/Component
triggerScroll(): void; triggerScroll(): void;
/** /**
* *
* @param {number} top * @param {Integer} top
*/ */
onscroll(top?: number): void; onscroll(top?: any): void;
calculatePositionTimeout: NodeJS.Timeout | undefined; calculatePositionTimeout: NodeJS.Timeout | undefined;
/** /**
* Check if either extreme of the post stream is in the viewport, * Check if either extreme of the post stream is in the viewport,
* and if so, trigger loading the next/previous page. * and if so, trigger loading the next/previous page.
* *
* @param {number} top * @param {Integer} top
*/ */
loadPostsIfNeeded(top?: number): void; loadPostsIfNeeded(top?: any): void;
updateScrubber(top?: number): void; updateScrubber(top?: number): void;
/** /**
* Work out which posts (by number) are currently visible in the viewport, and * Work out which posts (by number) are currently visible in the viewport, and
@@ -41,43 +41,43 @@ export default class PostStream extends Component<import("../../common/Component
* Get the distance from the top of the viewport to the point at which we * Get the distance from the top of the viewport to the point at which we
* would consider a post to be the first one visible. * would consider a post to be the first one visible.
* *
* @return {number} * @return {Integer}
*/ */
getMarginTop(): number; getMarginTop(): any;
/** /**
* Scroll down to a certain post by number and 'flash' it. * Scroll down to a certain post by number and 'flash' it.
* *
* @param {number} number * @param {Integer} number
* @param {boolean} animate * @param {Boolean} animate
* @return {JQueryDeferred} * @return {jQuery.Deferred}
*/ */
scrollToNumber(number: number, animate: boolean): JQueryDeferred<any>; scrollToNumber(number: any, animate: boolean): any;
/** /**
* Scroll down to a certain post by index. * Scroll down to a certain post by index.
* *
* @param {number} index * @param {Integer} index
* @param {boolean} animate * @param {Boolean} animate
* @param {boolean} reply Whether or not to scroll to the reply placeholder. * @param {Boolean} reply Whether or not to scroll to the reply placeholder.
* @return {JQueryDeferred} * @return {jQuery.Deferred}
*/ */
scrollToIndex(index: number, animate: boolean, reply: boolean): JQueryDeferred<any>; scrollToIndex(index: any, animate: boolean, reply: boolean): any;
/** /**
* Scroll down to the given post. * Scroll down to the given post.
* *
* @param {JQuery} $item * @param {jQuery} $item
* @param {boolean} animate * @param {Boolean} animate
* @param {boolean} force Whether or not to force scrolling to the item, even * @param {Boolean} force Whether or not to force scrolling to the item, even
* if it is already in the viewport. * if it is already in the viewport.
* @param {boolean} reply Whether or not to scroll to the reply placeholder. * @param {Boolean} reply Whether or not to scroll to the reply placeholder.
* @return {JQueryDeferred} * @return {jQuery.Deferred}
*/ */
scrollToItem($item: JQuery, animate: boolean, force: boolean, reply: boolean): JQueryDeferred<any>; scrollToItem($item: JQueryStatic, animate: boolean, force: boolean, reply: boolean): any;
/** /**
* 'Flash' the given post, drawing the user's attention to it. * 'Flash' the given post, drawing the user's attention to it.
* *
* @param {JQuery} $item * @param {jQuery} $item
*/ */
flashItem($item: JQuery): void; flashItem($item: JQueryStatic): void;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ScrollListener from "../../common/utils/ScrollListener"; import ScrollListener from "../../common/utils/ScrollListener";

View File

@@ -19,13 +19,9 @@ export default class PostStreamScrubber extends Component<import("../../common/C
* Update the scrollbar's position to reflect the current values of the * Update the scrollbar's position to reflect the current values of the
* index/visible properties. * index/visible properties.
* *
* @param {Partial<{fromScroll: boolean, forceHeightChange: boolean, animate: boolean}>} options * @param {Boolean} animate
*/ */
updateScrubberValues(options?: Partial<{ updateScrubberValues(options?: {}): void;
fromScroll: boolean;
forceHeightChange: boolean;
animate: boolean;
}>): void;
adjustingHeight: boolean | undefined; adjustingHeight: boolean | undefined;
/** /**
* Go to the first post in the discussion. * Go to the first post in the discussion.
@@ -44,16 +40,13 @@ export default class PostStreamScrubber extends Component<import("../../common/C
* Get the percentage of the height of the scrubber that should be allocated * Get the percentage of the height of the scrubber that should be allocated
* to each post. * to each post.
* *
* @return {{ index: number, visible: number }} * @return {Object}
* @property {Number} index The percent per post for posts on either side of * @property {Number} index The percent per post for posts on either side of
* the visible part of the scrubber. * the visible part of the scrubber.
* @property {Number} visible The percent per post for the visible part of the * @property {Number} visible The percent per post for the visible part of the
* scrubber. * scrubber.
*/ */
percentPerPost(): { percentPerPost(): Object;
index: number;
visible: number;
};
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ScrollListener from "../../common/utils/ScrollListener"; import ScrollListener from "../../common/utils/ScrollListener";

View File

@@ -20,35 +20,39 @@ export default class PostsUserPage extends UserPage {
* *
* @type {Post[]} * @type {Post[]}
*/ */
posts: Post[] | undefined; posts: any[] | undefined;
/** /**
* The number of activity items to load per request. * The number of activity items to load per request.
* *
* @type {number} * @type {Integer}
*/ */
loadLimit: number | undefined; loadLimit: any;
/** /**
* Clear and reload the user's activity feed. * Clear and reload the user's activity feed.
*
* @public
*/ */
refresh(): void; public refresh(): void;
/** /**
* Load a new page of the user's activity feed. * Load a new page of the user's activity feed.
* *
* @param {number} [offset] The position to start getting results from. * @param {Integer} [offset] The position to start getting results from.
* @return {Promise<import('../../common/models/Post').default[]>} * @return {Promise}
* @protected * @protected
*/ */
protected loadResults(offset?: number | undefined): Promise<import('../../common/models/Post').default[]>; protected loadResults(offset?: any): Promise<any>;
/** /**
* Load the next page of results. * Load the next page of results.
*
* @public
*/ */
loadMore(): void; public loadMore(): void;
/** /**
* Parse results and append them to the activity feed. * Parse results and append them to the activity feed.
* *
* @param {import('../../common/models/Post').default[]} results * @param {Post[]} results
* @return {import('../../common/models/Post').default[]} * @return {Post[]}
*/ */
parseResults(results: import('../../common/models/Post').default[]): import('../../common/models/Post').default[]; parseResults(results: any[]): any[];
} }
import UserPage from "./UserPage"; import UserPage from "./UserPage";

View File

@@ -16,8 +16,8 @@ export default class ReplyComposer extends ComposerBody {
/** /**
* Get the data to submit to the server when the reply is saved. * Get the data to submit to the server when the reply is saved.
* *
* @return {Record<string, unknown>} * @return {Object}
*/ */
data(): Record<string, unknown>; data(): Object;
} }
import ComposerBody from "./ComposerBody"; import ComposerBody from "./ComposerBody";

View File

@@ -65,7 +65,7 @@ export default class Search<T extends SearchAttrs = SearchAttrs> extends Compone
/** /**
* An array of SearchSources. * An array of SearchSources.
*/ */
protected sources?: SearchSource[]; protected sources: SearchSource[];
/** /**
* The number of sources that are still loading results. * The number of sources that are still loading results.
*/ */

View File

@@ -6,9 +6,9 @@ export default class SessionDropdown extends Dropdown {
/** /**
* Build an item list for the contents of the dropdown menu. * Build an item list for the contents of the dropdown menu.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items(): ItemList<import('mithril').Children>; items(): ItemList<any>;
} }
import Dropdown from "../../common/components/Dropdown"; import Dropdown from "../../common/components/Dropdown";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -6,27 +6,27 @@ export default class SettingsPage extends UserPage {
/** /**
* Build an item list for the user's settings controls. * Build an item list for the user's settings controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
settingsItems(): ItemList<import('mithril').Children>; settingsItems(): ItemList<any>;
/** /**
* Build an item list for the user's account settings. * Build an item list for the user's account settings.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
accountItems(): ItemList<import('mithril').Children>; accountItems(): ItemList<any>;
/** /**
* Build an item list for the user's notification settings. * Build an item list for the user's notification settings.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
notificationsItems(): ItemList<import('mithril').Children>; notificationsItems(): ItemList<any>;
/** /**
* Build an item list for the user's privacy settings. * Build an item list for the user's privacy settings.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
privacyItems(): ItemList<import('mithril').Children>; privacyItems(): ItemList<any>;
discloseOnlineLoading: boolean | undefined; discloseOnlineLoading: boolean | undefined;
} }
import UserPage from "./UserPage"; import UserPage from "./UserPage";

View File

@@ -42,6 +42,8 @@ export default class SignUpModal<CustomAttrs extends ISignupModalAttrs = ISignup
/** /**
* Open the log in modal, prefilling it with an email/username/password if * Open the log in modal, prefilling it with an email/username/password if
* the user has entered one. * the user has entered one.
*
* @public
*/ */
logIn(): void; logIn(): void;
onready(): void; onready(): void;

View File

@@ -15,9 +15,9 @@ export default class UserCard extends Component<import("../../common/Component")
/** /**
* Build an item list of tidbits of info to show on this user's profile. * Build an item list of tidbits of info to show on this user's profile.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
infoItems(): ItemList<import('mithril').Children>; infoItems(): ItemList<any>;
} }
import Component from "../../common/Component"; import Component from "../../common/Component";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -16,36 +16,36 @@ export default class UserPage extends Page<import("../../common/components/Page"
/** /**
* Get the content to display in the user page. * Get the content to display in the user page.
* *
* @return {import('mithril').Children} * @return {VirtualElement}
*/ */
content(): import('mithril').Children; content(): any;
/** /**
* Initialize the component with a user, and trigger the loading of their * Initialize the component with a user, and trigger the loading of their
* activity feed. * activity feed.
* *
* @param {import('../../common/models/User').default} user * @param {User} user
* @protected * @protected
*/ */
protected show(user: import('../../common/models/User').default): void; protected show(user: any): void;
/** /**
* Given a username, load the user's profile from the store, or make a request * Given a username, load the user's profile from the store, or make a request
* if we don't have it yet. Then initialize the profile page with that user. * if we don't have it yet. Then initialize the profile page with that user.
* *
* @param {string} username * @param {String} username
*/ */
loadUser(username: string): void; loadUser(username: string): void;
/** /**
* Build an item list for the content of the sidebar. * Build an item list for the content of the sidebar.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
sidebarItems(): ItemList<import('mithril').Children>; sidebarItems(): ItemList<any>;
/** /**
* Build an item list for the navigation in the sidebar. * Build an item list for the navigation in the sidebar.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
navItems(): ItemList<import('mithril').Children>; navItems(): ItemList<any>;
} }
import Page from "../../common/components/Page"; import Page from "../../common/components/Page";
import ItemList from "../../common/utils/ItemList"; import ItemList from "../../common/utils/ItemList";

View File

@@ -10,7 +10,7 @@ export declare function makeRouteHelpers(app: ForumApplication): {
/** /**
* Generate a URL to a discussion. * Generate a URL to a discussion.
*/ */
discussion: (discussion: Discussion, near?: number | undefined) => string; discussion: (discussion: Discussion, near: number) => string;
/** /**
* Generate a URL to a post. * Generate a URL to a post.
*/ */

View File

@@ -15,9 +15,9 @@ declare class ComposerState {
* The composer's intended height, which can be modified by the user * The composer's intended height, which can be modified by the user
* (by dragging the composer handle). * (by dragging the composer handle).
* *
* @type {number} * @type {Integer}
*/ */
height: number; height: any;
/** /**
* The dynamic component being shown inside the composer. * The dynamic component being shown inside the composer.
* *
@@ -33,15 +33,16 @@ declare class ComposerState {
/** /**
* Load a content component into the composer. * Load a content component into the composer.
* *
* @param {typeof import('../components/ComposerBody').default} componentClass * @param {ComposerBody} componentClass
* @public
*/ */
load(componentClass: typeof import('../components/ComposerBody').default, attrs: any): void; public load(componentClass: any, attrs: any): void;
/** /**
* Clear the composer's content component. * Clear the composer's content component.
*/ */
clear(): void; clear(): void;
onExit: { onExit: {
callback: () => boolean; callback: Function;
message: string; message: string;
} | null | undefined; } | null | undefined;
fields: { fields: {
@@ -49,34 +50,47 @@ declare class ComposerState {
} | undefined; } | undefined;
/** /**
* Show the composer. * Show the composer.
*
* @public
*/ */
show(): void; public show(): void;
/** /**
* Close the composer. * Close the composer.
*
* @public
*/ */
hide(): void; public hide(): void;
/** /**
* Confirm with the user so they don't lose their content, then close the * Confirm with the user so they don't lose their content, then close the
* composer. * composer.
*
* @public
*/ */
close(): void; public close(): void;
/** /**
* Minimize the composer. Has no effect if the composer is hidden. * Minimize the composer. Has no effect if the composer is hidden.
*
* @public
*/ */
minimize(): void; public minimize(): void;
/** /**
* Take the composer into fullscreen mode. Has no effect if the composer is * Take the composer into fullscreen mode. Has no effect if the composer is
* hidden. * hidden.
*
* @public
*/ */
fullScreen(): void; public fullScreen(): void;
/** /**
* Exit fullscreen mode. * Exit fullscreen mode.
*
* @public
*/ */
exitFullScreen(): void; public exitFullScreen(): void;
/** /**
* Determine whether the body matches the given component class and data. * Determine whether the body matches the given component class and data.
* *
* @param {object} type The component class to check against. Subclasses are accepted as well. * @param {object} type The component class to check against. Subclasses are
* accepted as well.
* @param {object} data * @param {object} data
* @return {boolean} * @return {boolean}
*/ */
@@ -96,22 +110,23 @@ declare class ComposerState {
* This will be true if the Composer is in full-screen mode on desktop, * This will be true if the Composer is in full-screen mode on desktop,
* or if we are on a mobile device, where we always consider the composer as full-screen.. * or if we are on a mobile device, where we always consider the composer as full-screen..
* *
* @return {boolean} * @return {Boolean}
* @public
*/ */
isFullScreen(): boolean; public isFullScreen(): boolean;
/** /**
* Check whether or not the user is currently composing a reply to a * Check whether or not the user is currently composing a reply to a
* discussion. * discussion.
* *
* @param {import('../../common/models/Discussion').default} discussion * @param {Discussion} discussion
* @return {boolean} * @return {Boolean}
*/ */
composingReplyTo(discussion: import('../../common/models/Discussion').default): boolean; composingReplyTo(discussion: any): boolean;
/** /**
* Confirm with the user that they want to close the composer and lose their * Confirm with the user that they want to close the composer and lose their
* content. * content.
* *
* @return {boolean} Whether or not the exit was cancelled. * @return {Boolean} Whether or not the exit was cancelled.
*/ */
preventExit(): boolean; preventExit(): boolean;
/** /**
@@ -121,27 +136,27 @@ declare class ComposerState {
* confirmation is necessary. If the callback returns true at the time of * confirmation is necessary. If the callback returns true at the time of
* closing, the provided text will be shown in a standard confirmation dialog. * closing, the provided text will be shown in a standard confirmation dialog.
* *
* @param {() => boolean} callback * @param {Function} callback
* @param {string} message * @param {String} message
*/ */
preventClosingWhen(callback: () => boolean, message: string): void; preventClosingWhen(callback: Function, message: string): void;
/** /**
* Minimum height of the Composer. * Minimum height of the Composer.
* @returns {number} * @returns {Integer}
*/ */
minimumHeight(): number; minimumHeight(): any;
/** /**
* Maxmimum height of the Composer. * Maxmimum height of the Composer.
* @returns {number} * @returns {Integer}
*/ */
maximumHeight(): number; maximumHeight(): any;
/** /**
* Computed the composer's current height, based on the intended height, and * Computed the composer's current height, based on the intended height, and
* the composer's current state. This will be applied to the composer * the composer's current state. This will be applied to the composer's
* content's DOM element. * content's DOM element.
* @returns {number | string} * @returns {Integer|String}
*/ */
computedHeight(): number | string; computedHeight(): any | string;
} }
declare namespace ComposerState { declare namespace ComposerState {
namespace Position { namespace Position {

View File

@@ -6,7 +6,7 @@ declare class PostStreamState {
* *
* @type {Discussion} * @type {Discussion}
*/ */
discussion: Discussion; discussion: any;
/** /**
* Whether or not the infinite-scrolling auto-load functionality is * Whether or not the infinite-scrolling auto-load functionality is
* disabled. * disabled.
@@ -46,30 +46,33 @@ declare class PostStreamState {
/** /**
* Update the stream so that it loads and includes the latest posts in the * Update the stream so that it loads and includes the latest posts in the
* discussion, if the end is being viewed. * discussion, if the end is being viewed.
*
* @public
*/ */
update(): Promise<void>; public update(): Promise<any>;
visibleEnd: any; visibleEnd: any;
/** /**
* Load and scroll up to the first post in the discussion. * Load and scroll up to the first post in the discussion.
* *
* @return {Promise<void>} * @return {Promise}
*/ */
goToFirst(): Promise<void>; goToFirst(): Promise<any>;
/** /**
* Load and scroll down to the last post in the discussion. * Load and scroll down to the last post in the discussion.
* *
* @return {Promise<void>} * @return {Promise}
*/ */
goToLast(): Promise<void>; goToLast(): Promise<any>;
/** /**
* Load and scroll to a post with a certain number. * Load and scroll to a post with a certain number.
* *
* @param {number | string} number The post number to go to. If 'reply', go to the last post and scroll the reply preview into view. * @param {number|String} number The post number to go to. If 'reply', go to
* @param {boolean} [noAnimation] * the last post and scroll the reply preview into view.
* @return {Promise<void>} * @param {Boolean} noAnimation
* @return {Promise}
*/ */
goToNumber(number: number | string, noAnimation?: boolean | undefined): Promise<void>; goToNumber(number: number | string, noAnimation?: boolean): Promise<any>;
loadPromise: Promise<void> | undefined; loadPromise: Promise<any> | undefined;
needsScroll: boolean | undefined; needsScroll: boolean | undefined;
targetPost: { targetPost: {
number: string | number; number: string | number;
@@ -83,28 +86,28 @@ declare class PostStreamState {
* Load and scroll to a certain index within the discussion. * Load and scroll to a certain index within the discussion.
* *
* @param {number} index * @param {number} index
* @param {boolean} [noAnimation] * @param {Boolean} noAnimation
* @return {Promise<void>} * @return {Promise}
*/ */
goToIndex(index: number, noAnimation?: boolean | undefined): Promise<void>; goToIndex(index: number, noAnimation?: boolean): Promise<any>;
/** /**
* Clear the stream and load posts near a certain number. Returns a promise. * Clear the stream and load posts near a certain number. Returns a promise.
* If the post with the given number is already loaded, the promise will be * If the post with the given number is already loaded, the promise will be
* resolved immediately. * resolved immediately.
* *
* @param {number} number * @param {number} number
* @return {Promise<void>} * @return {Promise}
*/ */
loadNearNumber(number: number): Promise<void>; loadNearNumber(number: number): Promise<any>;
/** /**
* Clear the stream and load posts near a certain index. A page of posts * Clear the stream and load posts near a certain index. A page of posts
* surrounding the given index will be loaded. Returns a promise. If the given * surrounding the given index will be loaded. Returns a promise. If the given
* index is already loaded, the promise will be resolved immediately. * index is already loaded, the promise will be resolved immediately.
* *
* @param {number} index * @param {number} index
* @return {Promise<void>} * @return {Promise}
*/ */
loadNearIndex(index: number): Promise<void>; loadNearIndex(index: number): Promise<any>;
/** /**
* Load the next page of posts. * Load the next page of posts.
*/ */
@@ -119,7 +122,7 @@ declare class PostStreamState {
* *
* @param {number} start * @param {number} start
* @param {number} end * @param {number} end
* @param {boolean} backwards * @param {Boolean} backwards
*/ */
loadPage(start: number, end: number, backwards?: boolean): void; loadPage(start: number, end: number, backwards?: boolean): void;
/** /**
@@ -128,15 +131,15 @@ declare class PostStreamState {
* *
* @param {number} start * @param {number} start
* @param {number} end * @param {number} end
* @return {Promise<void>} * @return {Promise}
*/ */
loadRange(start: number, end: number): Promise<void>; loadRange(start: number, end: number): Promise<any>;
/** /**
* Set up the stream with the given array of posts. * Set up the stream with the given array of posts.
* *
* @param {import('../../common/models/Post').default[]} posts * @param {Post[]} posts
*/ */
show(posts: import('../../common/models/Post').default[]): void; show(posts: any[]): void;
/** /**
* Reset the stream so that a specific range of posts is displayed. If a range * Reset the stream so that a specific range of posts is displayed. If a range
* is not specified, the first page of posts will be displayed. * is not specified, the first page of posts will be displayed.
@@ -150,7 +153,7 @@ declare class PostStreamState {
* *
* @return {Post[]} * @return {Post[]}
*/ */
posts(): Post[]; posts(): any[];
/** /**
* Get the total number of posts in the discussion. * Get the total number of posts in the discussion.
* *
@@ -161,7 +164,7 @@ declare class PostStreamState {
* Check whether or not the scrubber should be disabled, i.e. if all of the * Check whether or not the scrubber should be disabled, i.e. if all of the
* posts are visible in the viewport. * posts are visible in the viewport.
* *
* @return {boolean} * @return {Boolean}
*/ */
disabled(): boolean; disabled(): boolean;
/** /**

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

2
js/dist/admin.js generated vendored

File diff suppressed because one or more lines are too long

2
js/dist/admin.js.map generated vendored

File diff suppressed because one or more lines are too long

2
js/dist/forum.js generated vendored

File diff suppressed because one or more lines are too long

2
js/dist/forum.js.map generated vendored

File diff suppressed because one or more lines are too long

View File

@@ -1,2 +1,2 @@
export * from './src/common'; export * from './src/common';
export * from './src/admin'; export * from './src/forum';

View File

@@ -3,7 +3,7 @@
"name": "@flarum/core", "name": "@flarum/core",
"prettier": "@flarum/prettier-config", "prettier": "@flarum/prettier-config",
"dependencies": { "dependencies": {
"@askvortsov/rich-icu-message-formatter": "^0.2.4", "@askvortsov/rich-icu-message-formatter": "^0.2.1",
"@ultraq/icu-message-formatter": "^0.12.0", "@ultraq/icu-message-formatter": "^0.12.0",
"bootstrap": "^3.4.1", "bootstrap": "^3.4.1",
"clsx": "^1.1.1", "clsx": "^1.1.1",
@@ -20,7 +20,7 @@
}, },
"devDependencies": { "devDependencies": {
"@flarum/prettier-config": "^1.0.0", "@flarum/prettier-config": "^1.0.0",
"@types/jquery": "^3.5.10", "@types/jquery": "^3.5.8",
"@types/mithril": "^2.0.8", "@types/mithril": "^2.0.8",
"@types/punycode": "^2.1.0", "@types/punycode": "^2.1.0",
"@types/textarea-caret": "^3.0.1", "@types/textarea-caret": "^3.0.1",
@@ -29,23 +29,23 @@
"expose-loader": "^3.1.0", "expose-loader": "^3.1.0",
"flarum-tsconfig": "^1.0.2", "flarum-tsconfig": "^1.0.2",
"flarum-webpack-config": "^2.0.0", "flarum-webpack-config": "^2.0.0",
"prettier": "^2.5.1", "prettier": "^2.4.1",
"typescript": "^4.5.4", "typescript": "^4.4.4",
"typescript-coverage-report": "^0.6.1", "typescript-coverage-report": "^0.6.1",
"webpack": "^5.65.0", "webpack": "^5.61.0",
"webpack-cli": "^4.9.1", "webpack-cli": "^4.9.1",
"webpack-merge": "^5.8.0" "webpack-merge": "^5.8.0"
}, },
"scripts": { "scripts": {
"dev": "webpack --mode development --watch", "dev": "webpack --mode development --watch",
"build": "webpack --mode production", "build": "webpack --mode production",
"analyze": "cross-env ANALYZER=true yarn build", "analyze": "cross-env ANALYZER=true npm run build",
"format": "prettier --write src", "format": "prettier --write src",
"format-check": "prettier --check src", "format-check": "prettier --check src",
"clean-typings": "npx rimraf dist-typings && mkdir dist-typings", "clean-typings": "npx rimraf dist-typings && mkdir dist-typings",
"build-typings": "npm run clean-typings && tsc && [ -e src/@types ] && cp -r src/@types dist-typings/@types", "build-typings": "npm run clean-typings && cp -r src/@types dist-typings/@types && tsc",
"check-typings": "tsc --noEmit --emitDeclarationOnly false", "check-typings": "tsc --noEmit --emitDeclarationOnly false",
"check-typings-coverage": "typescript-coverage-report" "check-typings-coverage": "typescript-coverage-report"
}, },
"packageManager": "yarn@3.1.1" "packageManager": "yarn@3.1.0"
} }

View File

@@ -55,7 +55,7 @@ export default class AdminNav extends Component {
/** /**
* Build an item list of main links to show in the admin navigation. * Build an item list of main links to show in the admin navigation.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items() { items() {
const items = new ItemList(); const items = new ItemList();

View File

@@ -120,7 +120,8 @@ export default class BasicsPage extends AdminPage {
* Build a list of options for the default homepage. Each option must be an * Build a list of options for the default homepage. Each option must be an
* object with `path` and `label` properties. * object with `path` and `label` properties.
* *
* @return {ItemList<{ path: string, label: import('mithril').Children }>} * @return {ItemList}
* @public
*/ */
homePageItems() { homePageItems() {
const items = new ItemList(); const items = new ItemList();

View File

@@ -8,7 +8,7 @@ export default class DashboardWidget extends Component {
/** /**
* Get the class name to apply to the widget. * Get the class name to apply to the widget.
* *
* @return {string} * @return {String}
*/ */
className() { className() {
return ''; return '';
@@ -17,9 +17,9 @@ export default class DashboardWidget extends Component {
/** /**
* Get the content of the widget. * Get the content of the widget.
* *
* @return {import('mithril').Children} * @return {VirtualElement}
*/ */
content() { content() {
return null; return [];
} }
} }

View File

@@ -18,7 +18,7 @@ export default class EditCustomCssModal extends SettingsModal {
})} })}
</p>, </p>,
<div className="Form-group"> <div className="Form-group">
<textarea className="FormControl" rows="30" bidi={this.setting('custom_less')} spellcheck={false} /> <textarea className="FormControl" rows="30" bidi={this.setting('custom_less')} />
</div>, </div>,
]; ];
} }

View File

@@ -21,7 +21,7 @@ export default class HeaderPrimary extends Component {
/** /**
* Build an item list for the controls. * Build an item list for the controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items() { items() {
return new ItemList(); return new ItemList();

View File

@@ -16,7 +16,7 @@ export default class HeaderSecondary extends Component {
/** /**
* Build an item list for the controls. * Build an item list for the controls.
* *
* @return {ItemList<import('mithril').Children>} * @return {ItemList}
*/ */
items() { items() {
const items = new ItemList(); const items = new ItemList();
@@ -28,7 +28,7 @@ export default class HeaderSecondary extends Component {
</LinkButton> </LinkButton>
); );
items.add('session', <SessionDropdown />); items.add('session', SessionDropdown.component());
return items; return items;
} }

View File

@@ -78,7 +78,7 @@ export default class UploadImageButton extends Button {
/** /**
* After a successful upload/removal, reload the page. * After a successful upload/removal, reload the page.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
success(response) { success(response) {
@@ -88,7 +88,7 @@ export default class UploadImageButton extends Button {
/** /**
* If upload/removal fails, stop loading. * If upload/removal fails, stop loading.
* *
* @param {object} response * @param {Object} response
* @protected * @protected
*/ */
failure(response) { failure(response) {

View File

@@ -9,7 +9,6 @@ import Translator from './Translator';
import Store, { ApiPayload, ApiResponse, ApiResponsePlural, ApiResponseSingle, payloadIsPlural } from './Store'; import Store, { ApiPayload, ApiResponse, ApiResponsePlural, ApiResponseSingle, payloadIsPlural } from './Store';
import Session from './Session'; import Session from './Session';
import extract from './utils/extract'; import extract from './utils/extract';
import extractText from './utils/extractText';
import Drawer from './utils/Drawer'; import Drawer from './utils/Drawer';
import mapRoutes from './utils/mapRoutes'; import mapRoutes from './utils/mapRoutes';
import RequestError, { InternalFlarumRequestOptions } from './utils/RequestError'; import RequestError, { InternalFlarumRequestOptions } from './utils/RequestError';
@@ -106,21 +105,14 @@ export interface RouteResolver<
* *
* Returns the component class, and **not** a Vnode or JSX * Returns the component class, and **not** a Vnode or JSX
* expression. * expression.
*
* @see https://mithril.js.org/route.html#routeresolveronmatch
*/ */
onmatch(this: this, args: RouteArgs, requestedPath: string, route: string): { new (): Comp }; onmatch(this: this, args: RouteArgs, requestedPath: string, route: string): { new (): Comp };
/** /**
* A function which renders the provided component. * A function which renders the provided component.
* *
* If not specified, the route will default to rendering the
* component on its own, inside of a fragment.
*
* Returns a Mithril Vnode or other children. * Returns a Mithril Vnode or other children.
*
* @see https://mithril.js.org/route.html#routeresolverrender
*/ */
render?(this: this, vnode: Mithril.Vnode<Attrs, Comp>): Mithril.Children; render(this: this, vnode: Mithril.Vnode<Attrs, Comp>): Mithril.Children;
} }
/** /**
@@ -373,21 +365,9 @@ export default class Application {
updateTitle(): void { updateTitle(): void {
const count = this.titleCount ? `(${this.titleCount}) ` : ''; const count = this.titleCount ? `(${this.titleCount}) ` : '';
const onHomepage = m.route.get() === this.forum.attribute('basePath') + '/'; const pageTitleWithSeparator = this.title && m.route.get() !== this.forum.attribute('basePath') + '/' ? this.title + ' - ' : '';
const title = this.forum.attribute('title');
const params = { document.title = count + pageTitleWithSeparator + title;
pageTitle: this.title,
forumName: this.forum.attribute('title'),
// Until we add page numbers to the frontend, this is constant at 1
// so that the page number portion doesn't show up in the URL.
pageNumber: 1,
};
const title =
onHomepage || !this.title
? extractText(app.translator.trans('core.lib.meta_titles.without_page_title', params))
: extractText(app.translator.trans('core.lib.meta_titles.with_page_title', params));
document.title = count + title;
} }
protected transformRequestOptions<ResponseType>(flarumOptions: FlarumRequestOptions<ResponseType>): InternalFlarumRequestOptions<ResponseType> { protected transformRequestOptions<ResponseType>(flarumOptions: FlarumRequestOptions<ResponseType>): InternalFlarumRequestOptions<ResponseType> {
@@ -471,6 +451,9 @@ export default class Application {
* Make an AJAX request, handling any low-level errors that may occur. * Make an AJAX request, handling any low-level errors that may occur.
* *
* @see https://mithril.js.org/request.html * @see https://mithril.js.org/request.html
*
* @param options
* @return {Promise}
*/ */
request<ResponseType>(originalOptions: FlarumRequestOptions<ResponseType>): Promise<ResponseType> { request<ResponseType>(originalOptions: FlarumRequestOptions<ResponseType>): Promise<ResponseType> {
const options = this.transformRequestOptions(originalOptions); const options = this.transformRequestOptions(originalOptions);
@@ -547,11 +530,7 @@ export default class Application {
console.group(`${method} ${url} ${status}`); console.group(`${method} ${url} ${status}`);
if (formattedErrors.length) { console.error(...(formattedErrors || [e]));
console.error(...formattedErrors);
} else {
console.error(e);
}
console.groupEnd(); console.groupEnd();
} }

View File

@@ -30,8 +30,8 @@ export default abstract class Fragment {
* containing all of the `li` elements inside the DOM element of this * containing all of the `li` elements inside the DOM element of this
* fragment. * fragment.
* *
* @param [selector] a jQuery-compatible selector string * @param {String} [selector] a jQuery-compatible selector string
* @returns the jQuery object for the DOM node * @returns {jQuery} the jQuery object for the DOM node
* @final * @final
*/ */
public $(selector?: string): JQuery { public $(selector?: string): JQuery {

View File

@@ -1,6 +1,5 @@
import app from '../common/app'; import app from '../common/app';
import { FlarumRequestOptions } from './Application'; import { FlarumRequestOptions } from './Application';
import { fireDeprecationWarning } from './helpers/fireDebugWarning';
import Store, { ApiPayloadSingle, ApiResponseSingle, MetaInformation } from './Store'; import Store, { ApiPayloadSingle, ApiResponseSingle, MetaInformation } from './Store';
export interface ModelIdentifier { export interface ModelIdentifier {
@@ -112,19 +111,6 @@ export default abstract class Model {
if ('attributes' in data) { if ('attributes' in data) {
this.data.attributes ||= {}; this.data.attributes ||= {};
// @deprecated
// Filter out relationships that got in by accident.
for (const key in data.attributes) {
const val = data.attributes[key];
if (val && val instanceof Model) {
fireDeprecationWarning('Providing models as attributes to `Model.pushData()` or `Model.pushAttributes()` is deprecated.', '3249');
delete data.attributes[key];
data.relationships ||= {};
data.relationships[key] = { data: Model.getIdentifier(val) };
}
}
Object.assign(this.data.attributes, data.attributes); Object.assign(this.data.attributes, data.attributes);
} }

View File

@@ -94,7 +94,7 @@ export default class Store {
* within the 'data' key of the payload. * within the 'data' key of the payload.
*/ */
pushPayload<M extends Model>(payload: ApiPayloadSingle): ApiResponseSingle<M>; pushPayload<M extends Model>(payload: ApiPayloadSingle): ApiResponseSingle<M>;
pushPayload<Ms extends Model[]>(payload: ApiPayloadPlural): ApiResponsePlural<Ms[number]>; pushPayload<Ms extends Model[]>(payload: ApiPayloadPlural): ApiResponseSingle<Ms[number]>;
pushPayload<M extends Model | Model[]>(payload: ApiPayload): ApiResponse<FlatArray<M, 1>> { pushPayload<M extends Model | Model[]>(payload: ApiPayload): ApiResponse<FlatArray<M, 1>> {
if (payload.included) payload.included.map(this.pushObject.bind(this)); if (payload.included) payload.included.map(this.pushObject.bind(this));

View File

@@ -3,8 +3,6 @@ import Button from './Button';
import listItems from '../helpers/listItems'; import listItems from '../helpers/listItems';
import extract from '../utils/extract'; import extract from '../utils/extract';
import type Mithril from 'mithril'; import type Mithril from 'mithril';
import classList from '../utils/classList';
import app from '../app';
export interface AlertAttrs extends ComponentAttrs { export interface AlertAttrs extends ComponentAttrs {
/** The type of alert this is. Will be used to give the alert a class name of `Alert--{type}`. */ /** The type of alert this is. Will be used to give the alert a class name of `Alert--{type}`. */
@@ -26,7 +24,7 @@ export default class Alert<T extends AlertAttrs = AlertAttrs> extends Component<
const attrs = Object.assign({}, this.attrs); const attrs = Object.assign({}, this.attrs);
const type = extract(attrs, 'type'); const type = extract(attrs, 'type');
attrs.className = classList('Alert', `Alert--${type}`, attrs.className); attrs.className = 'Alert Alert--' + type + ' ' + (attrs.className || '');
const content = extract(attrs, 'content') || vnode.children; const content = extract(attrs, 'content') || vnode.children;
const controls = (extract(attrs, 'controls') || []) as Mithril.Vnode[]; const controls = (extract(attrs, 'controls') || []) as Mithril.Vnode[];
@@ -39,20 +37,13 @@ export default class Alert<T extends AlertAttrs = AlertAttrs> extends Component<
const dismissControl: Mithril.Vnode[] = []; const dismissControl: Mithril.Vnode[] = [];
if (dismissible || dismissible === undefined) { if (dismissible || dismissible === undefined) {
dismissControl.push( dismissControl.push(<Button icon="fas fa-times" className="Button Button--link Button--icon Alert-dismiss" onclick={ondismiss} />);
<Button
aria-label={app.translator.trans('core.lib.alert.dismiss_a11y_label')}
icon="fas fa-times"
class="Button Button--link Button--icon Alert-dismiss"
onclick={ondismiss}
/>
);
} }
return ( return (
<div {...attrs}> <div {...attrs}>
<span class="Alert-body">{content}</span> <span className="Alert-body">{content}</span>
<ul class="Alert-controls">{listItems(controls.concat(dismissControl))}</ul> <ul className="Alert-controls">{listItems(controls.concat(dismissControl))}</ul>
</div> </div>
); );
} }

View File

@@ -1,4 +1,5 @@
import Component from '../Component'; import Component from '../Component';
import Alert from './Alert';
/** /**
* The `AlertManager` component provides an area in which `Alert` components can * The `AlertManager` component provides an area in which `Alert` components can
@@ -13,18 +14,14 @@ export default class AlertManager extends Component {
view() { view() {
return ( return (
<div class="AlertManager"> <div className="AlertManager">
{Object.entries(this.state.getActiveAlerts()).map(([key, alert]) => { {Object.entries(this.state.getActiveAlerts()).map(([key, alert]) => (
const urgent = alert.attrs.type === 'error'; <div className="AlertManager-alert">
return (
<div class="AlertManager-alert" role="alert" aria-live={urgent ? 'assertive' : 'polite'}>
<alert.componentClass {...alert.attrs} ondismiss={this.state.dismiss.bind(this.state, key)}> <alert.componentClass {...alert.attrs} ondismiss={this.state.dismiss.bind(this.state, key)}>
{alert.children} {alert.children}
</alert.componentClass> </alert.componentClass>
</div> </div>
); ))}
})}
</div> </div>
); );
} }

View File

@@ -107,7 +107,7 @@ export default class Button<CustomAttrs extends IButtonAttrs = IButtonAttrs> ext
const { 'aria-label': ariaLabel } = this.attrs; const { 'aria-label': ariaLabel } = this.attrs;
if (this.view === Button.prototype.view && !ariaLabel && !extractText(vnode.children) && !this.element?.getAttribute?.('aria-label')) { if (!ariaLabel && !extractText(vnode.children) && !this.element?.getAttribute?.('aria-label')) {
fireDebugWarning( fireDebugWarning(
'[Flarum Accessibility Warning] Button has no content and no accessible label. This means that screen-readers will not be able to interpret its meaning and just read "Button". Consider providing accessible text via the `aria-label` attribute. https://web.dev/button-name', '[Flarum Accessibility Warning] Button has no content and no accessible label. This means that screen-readers will not be able to interpret its meaning and just read "Button". Consider providing accessible text via the `aria-label` attribute. https://web.dev/button-name',
this.element this.element

Some files were not shown because too many files have changed in this diff Show More