Class WikiConfiguration

Wiki-wide configuration. This is applied to all users of the wiki, and has the potential to break things for EVERYONE if not set to proper values.

As much as possible, the correct configuration location should be protected to avoid vandalism or bad-faith changes.

This configuration works if specific settings are set. In other words, some features of Deputy are disabled unless Deputy has been configured. This is to avoid messing with existing on-wiki processes.

Hierarchy (view full)

ConfigurationBase
- WikiConfiguration

Constructors

constructor

new WikiConfiguration(sourcePage, serializedData, editable?): WikiConfiguration
Parameters
- sourcePage: Title
- serializedData: any
- Optionaleditable: boolean
  Whether the configuration is editable by the current user or not.
Returns WikiConfiguration
Overrides ConfigurationBase.constructor
- Defined in src/config/WikiConfiguration.ts:378

Properties

`Readonly`all

all: {
    ante: {
        enabled: Setting<boolean, boolean>;
    };
    cci: {
        collapseBottom: Setting<string, string>;
        collapseTop: Setting<string, string>;
        earwigRoot: Setting<string, URL>;
        enabled: Setting<boolean, boolean>;
        headingMatch: Setting<string, string>;
        resortRows: Setting<boolean, boolean>;
        rootPage: Setting<string, Title>;
    };
    core: {
        changeTag: Setting<string, string>;
        configVersion: Setting<number, number>;
        dispatchRoot: Setting<string, URL>;
        lastEdited: Setting<number, number>;
    };
    ia: {
        allowPresumptive: Setting<boolean, boolean>;
        batchListingPageWikitext: Setting<string, string>;
        batchListingWikitext: Setting<string, string>;
        enabled: Setting<boolean, boolean>;
        entirePageAppendBottom: Setting<boolean, boolean>;
        hideTemplate: Setting<string, string>;
        hideTemplateBottom: Setting<string, string>;
        listingWikitext: Setting<string, string>;
        listingWikitextMatch: Setting<string, string>;
        preload: Setting<string, string>;
        responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>;
        rootPage: Setting<string, Title>;
        subpageFormat: Setting<string, string>;
    };
} = ...

Type declaration

ante: {
enabled: Setting<boolean, boolean>;
}
- enabled: Setting<boolean, boolean>
cci: {
    collapseBottom: Setting<string, string>;
    collapseTop: Setting<string, string>;
    earwigRoot: Setting<string, URL>;
    enabled: Setting<boolean, boolean>;
    headingMatch: Setting<string, string>;
    resortRows: Setting<boolean, boolean>;
    rootPage: Setting<string, Title>;
}
- collapseBottom: Setting<string, string>
- collapseTop: Setting<string, string>
- earwigRoot: Setting<string, URL>
- enabled: Setting<boolean, boolean>
- headingMatch: Setting<string, string>
- resortRows: Setting<boolean, boolean>
- rootPage: Setting<string, Title>
core: {
    changeTag: Setting<string, string>;
    configVersion: Setting<number, number>;
    dispatchRoot: Setting<string, URL>;
    lastEdited: Setting<number, number>;
}
- changeTag: Setting<string, string>
- configVersion: Setting<number, number>
  Numerical code that identifies this config version. Increments for every breaking configuration file change.
- dispatchRoot: Setting<string, URL>
- lastEdited: Setting<number, number>
ia: {
    allowPresumptive: Setting<boolean, boolean>;
    batchListingPageWikitext: Setting<string, string>;
    batchListingWikitext: Setting<string, string>;
    enabled: Setting<boolean, boolean>;
    entirePageAppendBottom: Setting<boolean, boolean>;
    hideTemplate: Setting<string, string>;
    hideTemplateBottom: Setting<string, string>;
    listingWikitext: Setting<string, string>;
    listingWikitextMatch: Setting<string, string>;
    preload: Setting<string, string>;
    responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>;
    rootPage: Setting<string, Title>;
    subpageFormat: Setting<string, string>;
}
- allowPresumptive: Setting<boolean, boolean>
- batchListingPageWikitext: Setting<string, string>
  $1 - Page to include
- batchListingWikitext: Setting<string, string>
  $1 - Title of the batch $2 - List of pages (newlines should be added in batchListingPageWikitext). $3 - User comment
- enabled: Setting<boolean, boolean>
- entirePageAppendBottom: Setting<boolean, boolean>
- hideTemplate: Setting<string, string>
- hideTemplateBottom: Setting<string, string>
- listingWikitext: Setting<string, string>
- listingWikitextMatch: Setting<string, string>
  See
  CopyrightProblemsListing#articleCvRegex
  
  This should match both normal and batch listings.
- preload: Setting<string, string>
- responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>
- rootPage: Setting<string, Title>
- subpageFormat: Setting<string, string>

`Readonly`ante

ante: {
enabled: Setting<boolean, boolean>;
} = ...

`Readonly`cci

cci: {
    collapseBottom: Setting<string, string>;
    collapseTop: Setting<string, string>;
    earwigRoot: Setting<string, URL>;
    enabled: Setting<boolean, boolean>;
    headingMatch: Setting<string, string>;
    resortRows: Setting<boolean, boolean>;
    rootPage: Setting<string, Title>;
} = ...

`Readonly`core

core: {
    changeTag: Setting<string, string>;
    configVersion: Setting<number, number>;
    dispatchRoot: Setting<string, URL>;
    lastEdited: Setting<number, number>;
} = ...

Type declaration

changeTag: Setting<string, string>
configVersion: Setting<number, number>
Numerical code that identifies this config version. Increments for every breaking configuration file change.
dispatchRoot: Setting<string, URL>
lastEdited: Setting<number, number>

`Optional` `Readonly`editable

editable?: boolean

Whether the configuration is editable by the current user or not.

`Readonly`ia

ia: {
    allowPresumptive: Setting<boolean, boolean>;
    batchListingPageWikitext: Setting<string, string>;
    batchListingWikitext: Setting<string, string>;
    enabled: Setting<boolean, boolean>;
    entirePageAppendBottom: Setting<boolean, boolean>;
    hideTemplate: Setting<string, string>;
    hideTemplateBottom: Setting<string, string>;
    listingWikitext: Setting<string, string>;
    listingWikitextMatch: Setting<string, string>;
    preload: Setting<string, string>;
    responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>;
    rootPage: Setting<string, Title>;
    subpageFormat: Setting<string, string>;
} = ...

Type declaration

allowPresumptive: Setting<boolean, boolean>
batchListingPageWikitext: Setting<string, string>
$1 - Page to include
batchListingWikitext: Setting<string, string>
$1 - Title of the batch $2 - List of pages (newlines should be added in batchListingPageWikitext). $3 - User comment
enabled: Setting<boolean, boolean>
entirePageAppendBottom: Setting<boolean, boolean>
hideTemplate: Setting<string, string>
hideTemplateBottom: Setting<string, string>
listingWikitext: Setting<string, string>
listingWikitextMatch: Setting<string, string>
See
CopyrightProblemsListing#articleCvRegex

This should match both normal and batch listings.
preload: Setting<string, string>
responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>
rootPage: Setting<string, Title>
subpageFormat: Setting<string, string>

outdated

outdated: boolean = false

Set to true when this configuration is outdated based on latest data. Usually adds banners to UI interfaces saying a new version of the configuration is available, and that it should be used whenever possible.

TODO: This doesn't do what the documentations says yet.

`Readonly`serializedData

serializedData: any

`Readonly`sourcePage

sourcePage: Title

static

static: typeof WikiConfiguration = WikiConfiguration

`Readonly`type

type: "wiki" = ...

`Static` `Readonly`configLocations

configLocations: string[] = WikiConfigurationLocations

`Static` `Readonly`configVersion

configVersion = 2

`Static` `Readonly`optionKey

optionKey: "userjs-deputy-wiki" = 'userjs-deputy-wiki'

Methods

deserialize

deserialize(serializedData): void
Deserializes a JSON configuration into this configuration. This WILL overwrite past settings.
Parameters
- serializedData: any
Returns void
Inherited from ConfigurationBase.deserialize
- Defined in src/config/ConfigurationBase.ts:37

displayEditBanner

displayEditBanner(): Promise<void>
Actually displays the banner which allows an editor to modify the configuration.

Returns Promise<void>
- Defined in src/config/WikiConfiguration.ts:546

onConfigurationPage

onConfigurationPage(page?): boolean
Check if the current page being viewed is the active configuration page.
Parameters
- Optionalpage: Title
Returns boolean
true if the current page is the active configuration page.
- Defined in src/config/WikiConfiguration.ts:539

prepareEditBanners

prepareEditBanners(): Promise<void>
Shows the configuration edit intro banner, if applicable on this page.

Returns Promise<void>
void
- Defined in src/config/WikiConfiguration.ts:563

save

save(): Promise<void>
Saves the configuration on-wiki. Does not automatically generate overrides.

Returns Promise<void>
Overrides ConfigurationBase.save
- Defined in src/config/WikiConfiguration.ts:522

serialize

serialize(): any
Returns any
the serialized version of the configuration. All undefined values are stripped from output. If a category remains unchanged from defaults, it is skipped. If the entire configuration remains unchanged, null is returned.
Inherited from ConfigurationBase.serialize
- Defined in src/config/ConfigurationBase.ts:58

update

update(sourceConfig?): Promise<void>
Check for local updates, and update the local configuration as needed.
Parameters
- OptionalsourceConfig: WikiPageConfiguration
  A serialized version of the configuration based on a wiki page configuration load.
Returns Promise<void>
- Defined in src/config/WikiConfiguration.ts:423

`Static`isConfigurationPage

isConfigurationPage(page?): boolean
Check if the current page being viewed is a valid configuration page.
Parameters
- Optionalpage: Title
Returns boolean
true if the current page is a valid configuration page.
- Defined in src/config/WikiConfiguration.ts:208

`Static`load

load(sourcePage?): Promise<WikiConfiguration>
Loads the configuration from a set of possible sources.
Parameters
- OptionalsourcePage: Title
  The specific page to load from
Returns Promise<WikiConfiguration>
A WikiConfiguration object
Overrides ConfigurationBase.load
- Defined in src/config/WikiConfiguration.ts:59

`Static`loadConfigurationWikitext

loadConfigurationWikitext(): Promise<WikiPageConfiguration>
Loads the wiki-wide configuration from a set of predefined locations. See WikiConfiguration#configLocations for a full list.

Returns Promise<WikiPageConfiguration>
The string text of the raw configuration, or null if a configuration was not found.
- Defined in src/config/WikiConfiguration.ts:168

`Static`loadFromLocal

loadFromLocal(): Promise<WikiConfiguration>
Loads the wiki configuration from localStorage and/or MediaWiki settings. This allows for faster loads at the expense of a (small) chance of outdated configuration.

The localStorage layer allows fast browser-based caching. If a user is logging in again on another device, the user configuration will automatically be sent to the client, lessening turnaround time. If all else fails, the configuration will be loaded from the wiki.

Returns Promise<WikiConfiguration>
A WikiConfiguration object.
- Defined in src/config/WikiConfiguration.ts:80

`Static`loadFromWiki

loadFromWiki(sourcePage?): Promise<WikiConfiguration>
Loads the configuration from the current wiki.
Parameters
- OptionalsourcePage: Title
  The specific page to load from
Returns Promise<WikiConfiguration>
A WikiConfiguration object
- Defined in src/config/WikiConfiguration.ts:121

Class WikiConfiguration

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WikiConfiguration

Properties

Readonlyall

Type declaration

ante: { enabled: Setting<boolean, boolean>; }

enabled: Setting<boolean, boolean>

cci: { collapseBottom: Setting<string, string>; collapseTop: Setting<string, string>; earwigRoot: Setting<string, URL>; enabled: Setting<boolean, boolean>; headingMatch: Setting<string, string>; resortRows: Setting<boolean, boolean>; rootPage: Setting<string, Title>; }

collapseBottom: Setting<string, string>

collapseTop: Setting<string, string>

earwigRoot: Setting<string, URL>

enabled: Setting<boolean, boolean>

headingMatch: Setting<string, string>

resortRows: Setting<boolean, boolean>

rootPage: Setting<string, Title>

core: { changeTag: Setting<string, string>; configVersion: Setting<number, number>; dispatchRoot: Setting<string, URL>; lastEdited: Setting<number, number>; }

changeTag: Setting<string, string>

configVersion: Setting<number, number>

dispatchRoot: Setting<string, URL>

lastEdited: Setting<number, number>

allowPresumptive: Setting<boolean, boolean>

batchListingPageWikitext: Setting<string, string>

batchListingWikitext: Setting<string, string>

enabled: Setting<boolean, boolean>

entirePageAppendBottom: Setting<boolean, boolean>

hideTemplate: Setting<string, string>

hideTemplateBottom: Setting<string, string>

listingWikitext: Setting<string, string>

listingWikitextMatch: Setting<string, string>

See

preload: Setting<string, string>

responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>

rootPage: Setting<string, Title>

subpageFormat: Setting<string, string>

Readonlyante

Readonlycci

Readonlycore

Type declaration

changeTag: Setting<string, string>

configVersion: Setting<number, number>

dispatchRoot: Setting<string, URL>

lastEdited: Setting<number, number>

Optional Readonlyeditable

Readonlyia

Type declaration

allowPresumptive: Setting<boolean, boolean>

batchListingPageWikitext: Setting<string, string>

batchListingWikitext: Setting<string, string>

enabled: Setting<boolean, boolean>

entirePageAppendBottom: Setting<boolean, boolean>

hideTemplate: Setting<string, string>

hideTemplateBottom: Setting<string, string>

listingWikitext: Setting<string, string>

listingWikitextMatch: Setting<string, string>

See

preload: Setting<string, string>

responses: Setting<CopyrightProblemsResponse[], CopyrightProblemsResponse[]>

rootPage: Setting<string, Title>

subpageFormat: Setting<string, string>

outdated

ReadonlyserializedData

ReadonlysourcePage

static

Readonlytype

Static ReadonlyconfigLocations

Static ReadonlyconfigVersion

Static ReadonlyoptionKey

Methods

deserialize

Parameters

Returns void

displayEditBanner

`Readonly`all

ante: {
enabled: Setting<boolean, boolean>;
}

cci: {
collapseBottom: Setting<string, string>;
collapseTop: Setting<string, string>;
earwigRoot: Setting<string, URL>;
enabled: Setting<boolean, boolean>;
headingMatch: Setting<string, string>;
resortRows: Setting<boolean, boolean>;
rootPage: Setting<string, Title>;
}

core: {
changeTag: Setting<string, string>;
configVersion: Setting<number, number>;
dispatchRoot: Setting<string, URL>;
lastEdited: Setting<number, number>;
}

`Readonly`ante

`Readonly`cci

`Readonly`core

`Optional` `Readonly`editable

`Readonly`ia

`Readonly`serializedData

`Readonly`sourcePage

`Readonly`type

`Static` `Readonly`configLocations

`Static` `Readonly`configVersion

`Static` `Readonly`optionKey

`Static`isConfigurationPage

`Static`load

`Static`loadConfigurationWikitext

`Static`loadFromLocal

`Static`loadFromWiki