wikimedia/mediawiki-extensions-Gadgets
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets synced 2024-11-13 17:53:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Gadgets/GadgetDefinition.schema.json

105 lines
2.5 KiB
JSON
Raw Permalink Normal View History

Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
{
"$schema": "http://json-schema.org/schema#",
"description": "Gadget definition schema",
"type": "object",
"additionalProperties": false,
"properties": {
"settings": {
"type": "object",
"additionalProperties": false,
"properties": {
"rights": {
"description": "The rights required to be able to enable/load this gadget",
"type": "array",
"items": {
"type": "string"
}
},
"default": {
"description": "Whether this gadget is enabled by default",
"type": "boolean",
"default": false
},
Support JSON files in gadgets The parsed content of JSON files in the gadget is made available from the gadget's JS files via require(). That is, MediaWiki:Gadget-data.json (or Gadget:data.json) is available as `require('./data.json')`. This is supported for both MediaWikiGadgetsDefinitionRepo and GadgetDefinitionNamespaceRepo. The JSON parsing is done server-side. JSON can only be used in "package" gadgets - in which the JS files can also be invoked via require(). Also added a test for GadgetResourceLoaderModule. Bug: T198758 Depends-On: Ib4556d09c4d393269e32771aab00f59a5f630e1b Depends-On: Id4589a597ccfc4266b3e63d10f75b146aa7a287a Change-Id: I21acb46cdd244a39b5cc6963aa763f0113bd1e38
2021-10-17 13:05:15 +00:00
"package": {
"description": "Whether this is gadget a packaged ResourceLoader module",
"type": "boolean",
"default": false
},
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
"hidden": {
"description": "Whether this gadget is hidden from preferences",
"type": "boolean",
"default": false
},
"skins": {
Expand pre-save validations for JSON definition pages * Validate that pages have .js, .css or .json suffixes. * Validate that namespaces are integers, disallowing doubles. * Validate that type is either general or styles. * Validate that targets are either desktop or mobile. * Fix validation of skins: stop allowing `true` as it isn't actually allowed - it causes an exception in Gadget::isSkinSupported(). Bug: T298334 Change-Id: Ic59c20172f496d281acd59419f5c760ad29ce317
2023-12-16 08:44:06 +00:00
"description": "Skins supported by this gadget; empty if all skins are supported",
"type": "array",
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
"items": {
"type": "string"
}
},
Allow specifying page actions in definitions Allow specifying page actions ('view', 'edit', 'history', etc) in gadget definitions. If specified, the gadget is run only on the given page action(s). This is especially useful for default gadgets like RefToolbar[1] and TextReactions[2] that only need to be loaded while editing. [1]: https://en.wikipedia.org/wiki/WP:RefToolbar [2]: https://en.wikipedia.org/wiki/WP:Text_reactions Bug: T204201 Bug: T63007 Change-Id: Idde71b3f1f6c36cd21539a2312be8f12217a9acc
2021-12-14 13:10:22 +00:00
"actions": {
Add support for namespaces in definitions Adds a "namespaces" option to the gadget definition, which takes a list of namespace IDs. Enabled gadgets will only load when the viewed page is in one of the required namespaces. Bug: T204201 Bug: T63007 Change-Id: I7f797e35352b242ad78704074e98c6569a1adf91
2020-09-04 03:42:31 +00:00
"description": "Page actions on which to load the gadget",
Allow specifying page actions in definitions Allow specifying page actions ('view', 'edit', 'history', etc) in gadget definitions. If specified, the gadget is run only on the given page action(s). This is especially useful for default gadgets like RefToolbar[1] and TextReactions[2] that only need to be loaded while editing. [1]: https://en.wikipedia.org/wiki/WP:RefToolbar [2]: https://en.wikipedia.org/wiki/WP:Text_reactions Bug: T204201 Bug: T63007 Change-Id: Idde71b3f1f6c36cd21539a2312be8f12217a9acc
2021-12-14 13:10:22 +00:00
"type": "array",
"items": {
"type": "string"
}
},
Add support for namespaces in definitions Adds a "namespaces" option to the gadget definition, which takes a list of namespace IDs. Enabled gadgets will only load when the viewed page is in one of the required namespaces. Bug: T204201 Bug: T63007 Change-Id: I7f797e35352b242ad78704074e98c6569a1adf91
2020-09-04 03:42:31 +00:00
"namespaces": {
"description": "Page namespaces in which to load the gadget",
"type": "array",
"items": {
"type": "number"
}
},
Add support for categories in definitions Adds a "categories" option to the gadget definition, which takes a list of category names. Enabled gadgets will only load when the viewed page is in one of the required categories. Bug: T204201 Bug: T63007 Change-Id: I0ced9507bdab6cacd0baf2a331859099f35b73e5
2024-02-20 13:55:52 +00:00
"categories": {
"description": "Categories in which to load the gadget",
"type": "array",
"items": {
"type": "string"
}
},
Add support for content models in definitions Adds a contentModels option to gadget definitions to restrict gadgets to run in pages of the given content models only. Use-cases include gadgets for tabular data[1] (for Tabular .JsonConfig model), for editing map data[2] (for Map.JsonConfig model), and for showing links in code pages[3] (restricted to javascript, css, json, and scribunto models), as well as common gadgets like ProveIt[4] which can be restricted to wikitext model. [1]: https://commons.wikimedia.org/wiki/MediaWiki:Gadget-TabularImportExport.js [2]: https://fr.wikipedia.org/wiki/MediaWiki:Gadget-KartoEditor.js [3]: https://en.wiktionary.org/wiki/MediaWiki:Gadget-CodeLinks.js [4]: https://commons.wikimedia.org/wiki/Help:Gadget-ProveIt Bug: T204201 Bug: T63007 Change-Id: I7dcfc21d674ead8d710e7f77d13bf18bcad15079
2023-05-22 08:41:15 +00:00
"contentModels": {
"description": "Content models on which the gadget is supported",
"type": "array",
"items": {
"type": "string"
}
},
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
"category": {
"description": "Key of the category this gadget belongs to",
"type": "string",
"default": ""
Restrict ?withgadget query parameter to opt-in gadgets. ?withgadget query parameters allows for ad-hoc loading of gadgets (after passing all other basic checks). This was recently added in I5b30d4e. In T29766#7611796 Gergo raised concerns about how this can be potentially abused. This patch aims to restrict the feature by giving gadgets latitude to either use it or not depending on the nature of the gadget. The patch does so by adding `supportsUrlLoad` option that gadgets (maybe those deemed safe) can use it to opt-in to the parameter. By default gadgets don't support it, so it can be enabled for each on a case-by-case basis. Bug: T29766 Change-Id: Ie64174085e650579d76cc862774a4fe1b3d08396
2022-01-11 09:03:44 +00:00
},
Fix field name in schema.json Change-Id: I7a89afe2876a1530cceb4884c8fdce348f8d6620
2023-07-08 15:43:26 +00:00
"supportsUrlLoad": {
Restrict ?withgadget query parameter to opt-in gadgets. ?withgadget query parameters allows for ad-hoc loading of gadgets (after passing all other basic checks). This was recently added in I5b30d4e. In T29766#7611796 Gergo raised concerns about how this can be potentially abused. This patch aims to restrict the feature by giving gadgets latitude to either use it or not depending on the nature of the gadget. The patch does so by adding `supportsUrlLoad` option that gadgets (maybe those deemed safe) can use it to opt-in to the parameter. By default gadgets don't support it, so it can be enabled for each on a case-by-case basis. Bug: T29766 Change-Id: Ie64174085e650579d76cc862774a4fe1b3d08396
2022-01-11 09:03:44 +00:00
"description": "Whether this gadget supports ?withgadget query parameter",
"type": "boolean",
"default": false
Add support for ES6 gadgets, but with validation disabled Gadgets can mark themselves as ES6-only by specifying the requiresES6 boolean attribute. Syntax validation is disabled for them (as the validator doesn't support ES6 yet), and they are loaded together in a separate request. The minifier doesn't reject syntax errors, and thus these would be passed through to web clients. Hence, communities using this feature are encouraged to use ESLint or another linter to make sure only valid ES <= 6 code is being used. Because of the above, this feature is only made available for non-default gadgets. Bug: T75714 Change-Id: Ib98ac0700471554d5721d7ab858d4660e1e0e980
2022-01-30 13:15:25 +00:00
},
"requiresES6": {
"description": "Whether this gadget requires ES6",
"type": "boolean",
"default": false
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
}
}
},
"module": {
"type": "object",
"additionalProperties": false,
"properties": {
Specify all source pages in a single array in JSON definitions As this repo is not used anywhere in production, there is no backward compatibility. Any scripts, styles, datas specified in existing definition pages will get ignored. Gadget::getJSON() no longer checks isPackaged() – that is now left for callers - only relevant one is in GadgetRLModule. That was done because validationWarnings() method needs the JSON page list even for non-package gadgets. Bug: T353174 Change-Id: Ic820bc4632981369c72f822fb8b9b7195930eaa6
2023-12-11 17:16:30 +00:00
"pages": {
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
"type": "array",
Specify all source pages in a single array in JSON definitions As this repo is not used anywhere in production, there is no backward compatibility. Any scripts, styles, datas specified in existing definition pages will get ignored. Gadget::getJSON() no longer checks isPackaged() – that is now left for callers - only relevant one is in GadgetRLModule. That was done because validationWarnings() method needs the JSON page list even for non-package gadgets. Bug: T353174 Change-Id: Ic820bc4632981369c72f822fb8b9b7195930eaa6
2023-12-11 17:16:30 +00:00
"description": "List of JS/CSS/JSON pages included in this gadget"
Support JSON files in gadgets The parsed content of JSON files in the gadget is made available from the gadget's JS files via require(). That is, MediaWiki:Gadget-data.json (or Gadget:data.json) is available as `require('./data.json')`. This is supported for both MediaWikiGadgetsDefinitionRepo and GadgetDefinitionNamespaceRepo. The JSON parsing is done server-side. JSON can only be used in "package" gadgets - in which the JS files can also be invoked via require(). Also added a test for GadgetResourceLoaderModule. Bug: T198758 Depends-On: Ib4556d09c4d393269e32771aab00f59a5f630e1b Depends-On: Id4589a597ccfc4266b3e63d10f75b146aa7a287a Change-Id: I21acb46cdd244a39b5cc6963aa763f0113bd1e38
2021-10-17 13:05:15 +00:00
},
Implement Gadgets definition namespace repo Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-08-03 06:37:32 +00:00
"dependencies": {
"type": "array",
"description": "ResourceLoader modules this gadget depends upon"
},
"messages": {
"type": "array",
"description": "Messages this gadget depends upon"
}
}
}
}
}
Reference in a new issue Copy permalink