mediawiki-projects-list 1.0.4 → 1.1.2

package/index.d.ts

@@ -0,0 +1,49 @@
+declare module 'mediawiki-projects-list' {
+
+	/** A MediaWiki project */
+	export type WikiProject = {
+		/** Hostname of the project */
+		name: string;
+		/** Regex to match the project url */
+		regex: string;
+		/** Article path of the project */
+		articlePath: string;
+		/** Script path of the project */
+		scriptPath: string;
+		/** Only exists when the hostname contains multiple wikis: How to handle the id string */
+		idString?: {
+			/** Separator to join or split the id string on */
+			separator: string;
+			/** Order in which the project regex additional group matches should be chained to gain the id string */
+			direction: "asc" | "desc";
+			/** Regex to match the id string */
+			regex: string;
+			/**  How to turn the group matches of the id string regex into an URL to the script path, index based on group matches */
+			scriptPaths: string[];
+		};
+		/** Whether the paths include matches of the regex */
+		regexPaths: boolean;
+		/** Wiki farm of the project */
+		wikiFarm: ("wikimedia" | "fandom" | "miraheze" | "wiki.gg" | "biligame" | "huijiwiki" | "shoutwiki") | null;
+		/** List of extensions providing useful API endpoints */
+		extensions: ("CentralAuth" | "Cargo")[];
+		/** Replacement for spaces in the article URL */
+		urlSpaceReplacement: string;
+		/** Note about the specific project */
+		note: string | null;
+	};
+
+	/** List of MediaWiki projects */
+	export const wikiProjects: WikiProject[];
+
+	export function inputToWikiProject(input: string): {
+		fullArticlePath: string;
+		fullScriptPath: string;
+		wikiProject: WikiProject;
+	} | null;
+
+	export function urlToIdString(url: URL): string | null;
+
+	export function idStringToUrl(idString: string, projectName: string): URL | null;
+
+}

package/index.js

@@ -13,7 +13,7 @@ const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = r
  * @property {string} idString.regex - Regex to match the id string
  * @property {string[]} idString.scriptPaths - How to turn the group matches of the id string regex into an URL to the script path, index based on group matches
  * @property {boolean} regexPaths - Whether the paths include matches of the regex
- * @property {?("wikimedia"|"fandom"|"miraheze"|"wiki.gg")} wikiFarm - Wiki farm of the project
+ * @property {?("wikimedia"|"fandom"|"miraheze"|"wiki.gg"|"biligame"|"huijiwiki"|"shoutwiki")} wikiFarm - Wiki farm of the project
  * @property {("CentralAuth"|"Cargo")[]} extensions - List of extensions providing useful API endpoints
  * @property {string} urlSpaceReplacement - Replacement for spaces in the article URL
  * @property {?string} note - Note about the specific project

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "mediawiki-projects-list",
-  "version": "1.0.4",
+  "version": "1.1.2",
   "type": "commonjs",
   "description": "List of MediaWiki projects for use in discord-wiki-bot",
   "main": "index.js",
   "files": [
     "index.js",
+    "index.d.ts",
     "projects.json",
     "projects-schema.json"
   ],

package/projects-schema.json

@@ -83,7 +83,10 @@
 							"wikimedia",
 							"fandom",
 							"miraheze",
-							"wiki.gg"
+							"wiki.gg",
+							"biligame",
+							"huijiwiki",
+							"shoutwiki"
 						],
 						"default": null
 					},
@@ -120,6 +123,7 @@
 				],
 				"additionalProperties": false
 			},
+			"uniqueItemProperties": ["name"],
 			"additionalItems": false
 		}
 	},

package/projects.json

@@ -261,7 +261,8 @@
 				"scriptPaths": [
 					"https://wiki.biligame.com/$1/"
 				]
-			}
+			},
+			"wikiFarm": "biligame"
 		},
 		{
 			"name": "metapedia.org",
@@ -285,7 +286,8 @@
 				"scriptPaths": [
 					"https://$1.brickimedia.org/w/"
 				]
-			}
+			},
+			"wikiFarm": "shoutwiki"
 		},
 		{
 			"name": "wiki.openstreetmap.org",
@@ -315,7 +317,10 @@
 			"name": "pcgamingwiki.com",
 			"regex": "((?:www\\.)?pcgamingwiki.com)",
 			"articlePath": "/wiki/",
-			"scriptPath": "/w/"
+			"scriptPath": "/w/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "metin2.gameforge.com",
@@ -394,7 +399,10 @@
 			"name": "gbf.wiki",
 			"regex": "((?:www\\.)?gbf\\.wiki)",
 			"articlePath": "/",
-			"scriptPath": "/"
+			"scriptPath": "/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "wiki.albiononline.com",
@@ -406,13 +414,16 @@
 			"name": "atitd.wiki",
 			"regex": "((?:www\\.)?atitd\\.wiki)",
 			"articlePath": "/tale10/",
-			"scriptPath": "/tale10/w/"
+			"scriptPath": "/tale10/w/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
-			"name": "atitd.wiki",
-			"regex": "((?:www\\.)?atitd\\.wiki)",
-			"articlePath": "/tale10/",
-			"scriptPath": "/tale10/w/"
+			"name": "consolegameswiki.com",
+			"regex": "((?:ffxiv\\.)?consolegameswiki\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/mediawiki/"
 		},
 		{
 			"name": "niwanetwork.org",
@@ -484,7 +495,10 @@
 			"name": "dragalialost.wiki",
 			"regex": "((?:www\\.)?dragalialost\\.wiki)",
 			"articlePath": "/w/",
-			"scriptPath": "/"
+			"scriptPath": "/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "dragon-quest.org",
@@ -502,7 +516,10 @@
 			"name": "fireemblemwiki.org",
 			"regex": "((?:www\\.)?fireemblemwiki\\.org)",
 			"articlePath": "/wiki/",
-			"scriptPath": "/w/"
+			"scriptPath": "/w/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "mutecity.org",
@@ -532,7 +549,10 @@
 				"scriptPaths": [
 					"https://$1.splatoonwiki.org/w/"
 				]
-			}
+			},
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "starfoxwiki.info",
@@ -550,7 +570,10 @@
 			"name": "nookipedia.com",
 			"regex": "((?:www\\.)?nookipedia\\.com)",
 			"articlePath": "/wiki/",
-			"scriptPath": "/w/"
+			"scriptPath": "/w/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "pikminwiki.com",
@@ -950,7 +973,10 @@
 			"name": "segaretro.org",
 			"regex": "((?:www\\.)?segaretro\\.org)",
 			"articlePath": "/",
-			"scriptPath": "/"
+			"scriptPath": "/",
+			"extensions": [
+				"Cargo"
+			]
 		},
 		{
 			"name": "necretro.org",
@@ -1186,6 +1212,193 @@
 			"articlePath": "/",
 			"scriptPath": "/w/"
 		},
+		{
+			"name": "developer.valvesoftware.com",
+			"regex": "(developer\\.valvesoftware\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/w/"
+		},
+		{
+			"name": "pixelmonmod.com",
+			"regex": "((?:www\\.)?pixelmonmod\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/w/"
+		},
+		{
+			"name": "dmowiki.com",
+			"regex": "((?:www\\.)?dmowiki\\.com)",
+			"articlePath": "/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "awoiaf.westeros.org",
+			"regex": "(awoiaf\\.westeros\\.org)",
+			"articlePath": "/index.php/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "westeros.ir",
+			"regex": "((?:www\\.)?westeros\\.ir)",
+			"articlePath": "/wiki/index.php?title=",
+			"scriptPath": "/wiki/"
+		},
+		{
+			"name": "lagardedenuit.com",
+			"regex": "((?:www\\.)?lagardedenuit\\.com)",
+			"articlePath": "/wiki/index.php?title=",
+			"scriptPath": "/wiki/"
+		},
+		{
+			"name": "7kingdoms.ru",
+			"regex": "((?:www\\.)?7kingdoms\\.ru)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/w/"
+		},
+		{
+			"name": "wiki.geloefogo.com",
+			"regex": "(wiki\\.geloefogo\\.com)",
+			"articlePath": "/index.php/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "huijiwiki.com",
+			"regex": "((?:([a-z\\d-]{1,50})\\.)?huijiwiki\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/",
+			"idString": {
+				"regex": "([a-z\\d-]{1,50})",
+				"scriptPaths": [
+					"https://$1.huijiwiki.com/"
+				]
+			},
+			"wikiFarm": "huijiwiki"
+		},
+		{
+			"name": "chocolate-doom.org",
+			"regex": "((?:www\\.)?chocolate-doom\\.org)",
+			"articlePath": "/wiki/index.php/",
+			"scriptPath": "/wiki/"
+		},
+		{
+			"name": "glitchcity.wiki",
+			"regex": "((?:www\\.)?glitchcity\\.wiki)",
+			"articlePath": "/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "playstationdev.wiki",
+			"regex": "((?:www\\.)?playstationdev\\.wiki/([a-z0-9]{1,50}))",
+			"articlePath": "/index.php/",
+			"scriptPath": "/",
+			"idString": {
+				"regex": "([a-z0-9]{1,50})",
+				"scriptPaths": [
+					"https://playstationdev.wiki/$1/"
+				]
+			}
+		},
+		{
+			"name": "psdevwiki.com",
+			"regex": "((?:www\\.)?psdevwiki\\.com/([a-z0-9]{1,50}))",
+			"articlePath": "/",
+			"scriptPath": "/",
+			"idString": {
+				"regex": "([a-z0-9]{1,50})",
+				"scriptPaths": [
+					"https://www.psdevwiki.com/$1/"
+				]
+			}
+		},
+		{
+			"name": "wiki.henkaku.xyz",
+			"regex": "(wiki\\.henkaku\\.xyz)",
+			"articlePath": "/vita/",
+			"scriptPath": "/vita/"
+		},
+		{
+			"name": "wiki.raregamingdump.ca",
+			"regex": "(wiki\\.raregamingdump\\.ca)",
+			"articlePath": "/index.php/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "sttwiki.org",
+			"regex": "((?:www\\.)?sttwiki\\.org)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "wavu.wiki",
+			"regex": "((?:www\\.)?wavu\\.wiki)",
+			"articlePath": "/t/",
+			"scriptPath": "/w/"
+		},
+		{
+			"name": "blazblue.wiki",
+			"regex": "((?:www\\.)?blazblue\\.wiki)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/",
+			"extensions": [
+				"Cargo"
+			]
+		},
+		{
+			"name": "archives.org.au",
+			"regex": "((?:www\\.)?archives\\.org\\.au)",
+			"articlePath": "/",
+			"scriptPath": "/",
+			"extensions": [
+				"Cargo"
+			]
+		},
+		{
+			"name": "dragon-mania-legends.wiki",
+			"regex": "((?:www\\.)?dragon-mania-legends\\.wiki)",
+			"articlePath": "/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "wiki.guildwars.com",
+			"regex": "(wiki\\.guildwars\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "guildwiki.de",
+			"regex": "((?:www\\.)?guildwiki\\.de)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/gwiki/"
+		},
+		{
+			"name": "gwiki.fr",
+			"regex": "((?:www\\.)?gwiki\\.fr)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/w/"
+		},
+		{
+			"name": "guildwars2.com",
+			"regex": "(wiki(?:-(en|de|es|fr))?\\.guildwars2\\.com)",
+			"articlePath": "/wiki/",
+			"scriptPath": "/",
+			"idString": {
+				"regex": "(en|de|es|fr)",
+				"scriptPaths": [
+					"https://wiki-$1.guildwars2.com/"
+				]
+			}
+		},
+		{
+			"name": "ashesofcreation.wiki",
+			"regex": "((?:www\\.)?ashesofcreation\\.wiki)",
+			"articlePath": "/",
+			"scriptPath": "/"
+		},
+		{
+			"name": "drawntolife.wiki",
+			"regex": "((?:www\\.)?drawntolife\\.wiki)",
+			"articlePath": "/en/",
+			"scriptPath": "/w/"
+		},
 		{
 			"name": "liquipedia.net",
 			"regex": "((?:www\\.)?liquipedia\\.net/([a-z\\d]{1,50}))",