mediawiki-projects-list 2.2.0 → 2.3.1

package/index.d.ts

@@ -49,6 +49,17 @@ declare module 'mediawiki-projects-list' {
 		scriptPath: string;
 		/** Regex to remove from the relative url */
 		relativeFix: 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[];
+		};
 		/** Note about the specific proxy */
 		note: string | null;
 	};

package/index.js

@@ -30,6 +30,11 @@ const PROJECTS = require('./projects.json');
  * @property {string} articlePath - Article path of the proxy
  * @property {string} scriptPath - Script path of the proxy
  * @property {?string} relativeFix - Regex to remove from the relative url
+ * @property {object} [idString] - Only exists when the hostname contains multiple wikis: How to handle the id string
+ * @property {string} idString.separator - Separator to join or split the id string on
+ * @property {"asc"|"desc"} idString.direction - Order in which the project regex additional group matches should be chained to gain the id string
+ * @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 {?string} note - Note about the specific proxy
  */
 
@@ -72,6 +77,10 @@ const wikiProjects = PROJECTS.wikiProjects.map( wikiProject => {
  * @type {FrontendProxy[]}
  */
 const frontendProxies = PROJECTS.frontendProxies.map( frontendProxy => {
+	if ( frontendProxy.idString ) {
+		frontendProxy.idString.separator ??= frontendProxySchema.idString.properties.separator.default;
+		frontendProxy.idString.direction ??= frontendProxySchema.idString.properties.direction.default;
+	}
 	frontendProxy.relativeFix ??= frontendProxySchema.relativeFix.default;
 	frontendProxy.note ??= frontendProxySchema.note.default;
 	return frontendProxy;
@@ -118,12 +127,14 @@ function inputToWikiProject(input) {
 function urlToIdString(url) {
 	if ( functionCache.urlToIdString.has(url.href) ) return functionCache.urlToIdString.get(url.href);
 	let result = null;
-	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && url.hostname.endsWith( wikiProject.name ) );
-	if ( wikiProject ) {
-		let regex = url.href.match( new RegExp( wikiProject.regex ) )?.slice(2);
+	/** @type {WikiProject|FrontendProxy|undefined} */
+	let project = wikiProjects.find( wikiProject => wikiProject.idString && url.hostname.endsWith( wikiProject.name ) );
+	if ( !project ) project = frontendProxies.find( frontendProxy => frontendProxy.idString && url.hostname.endsWith( frontendProxy.name ) );
+	if ( project ) {
+		let regex = url.href.match( new RegExp( project.regex ) )?.slice(2);
 		if ( regex?.length ) {
-			if ( wikiProject.idString.direction === 'desc' ) regex.reverse();
-			result = regex.join(wikiProject.idString.separator);
+			if ( project.idString.direction === 'desc' ) regex.reverse();
+			result = regex.join(project.idString.separator);
 		}
 	}
 	functionCache.urlToIdString.set(url.href, result);
@@ -143,11 +154,12 @@ function idStringToUrl(idString, projectName) {
 		return ( result ? new URL(result) : result );
 	}
 	let result = null;
-	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && wikiProject.name === projectName )?.idString;
-	if ( wikiProject ) {
-		let regex = idString.match( new RegExp( '^' + wikiProject.regex + '$' ) )?.[1].split(wikiProject.separator);
-		if ( regex && regex.length <= wikiProject.scriptPaths.length ) {
-			result = wikiProject.scriptPaths[regex.length - 1].replace( /\$(\d)/g, (match, n) => regex[n - 1] );
+	let project = wikiProjects.find( wikiProject => wikiProject.idString && wikiProject.name === projectName )?.idString;
+	if ( !project ) project = frontendProxies.find( frontendProxy => frontendProxy.idString && frontendProxy.name === projectName )?.idString;
+	if ( project ) {
+		let regex = idString.match( new RegExp( '^' + project.regex + '$' ) )?.[1].split(project.separator);
+		if ( regex && regex.length <= project.scriptPaths.length ) {
+			result = project.scriptPaths[regex.length - 1].replace( /\$(\d)/g, (match, n) => regex[n - 1] );
 		}
 	}
 	functionCache.idStringToUrl.set(cacheKey, result);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediawiki-projects-list",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "type": "commonjs",
   "description": "List of MediaWiki projects for use in discord-wiki-bot",
   "main": "index.js",

package/projects-schema.json

@@ -41,6 +41,45 @@
 						"description": "Regex to remove from the relative url",
 						"default": null
 					},
+					"idString": {
+						"type": "object",
+						"description": "Only exists when the hostname contains multiple wikis: How to handle the id string",
+						"properties": {
+							"separator": {
+								"type": "string",
+								"description": "Separator to join or split the id string on",
+								"default": "."
+							},
+							"direction": {
+								"type": "string",
+								"description": "Order in which the project regex additional group matches should be chained to gain the id string",
+								"enum": [
+									"asc",
+									"desc"
+								],
+								"default": "desc"
+							},
+							"regex": {
+								"type": "string",
+								"description": "Regex to match the id string"
+							},
+							"scriptPaths": {
+								"type": "array",
+								"description": "How to turn the group matches of the id string regex into an URL to the script path, index based on group matches",
+								"items": {
+									"type": "string",
+									"description": "Replacement for the id string regex match."
+								},
+								"contains": true,
+								"additionalItems": false
+							}
+						},
+						"required": [
+							"regex",
+							"scriptPaths"
+						],
+						"additionalProperties": false
+					},
 					"note": {
 						"type": "string",
 						"description": "Note about the specific proxy",

package/projects.json

@@ -3,41 +3,45 @@
 	"frontendProxies": [
 		{
 			"name": "wikiless.org",
-			"regex": "wikiless\\.org/.*?\\?(?:.*?&)?lang=([a-z\\d-]{1,50})(?:&|/?$)",
-			"namePath": "https://wikiless.org/?lang=$1",
-			"articlePath": "https://wikiless.org/wiki/?lang=$1",
-			"scriptPath": "https://$1.wikipedia.org/w/"
+			"regex": "(wikiless\\.org/.*?\\?(?:.*?&)?lang=([a-z\\d-]{1,50}))(?:&|/?$)",
+			"namePath": "https://wikiless.org/?lang=$2",
+			"articlePath": "https://wikiless.org/wiki/?lang=$2",
+			"scriptPath": "https://$2.wikipedia.org/w/",
+			"idString": {
+				"regex": "([a-z\\d-]{1,50})",
+				"scriptPaths": [
+					"https://wikiless.org/?lang=$1"
+				]
+			}
 		},
 		{
 			"name": "wikiwand.com",
-			"regex": "(?:www\\.)?wikiwand\\.com/([a-z\\d-]{1,50})/?",
-			"namePath": "https://www.wikiwand.com/$1/",
-			"articlePath": "https://www.wikiwand.com/$1/",
-			"scriptPath": "https://$1.wikipedia.org/w/",
-			"relativeFix": "^/wiki(?=/)"
-		},
-		{
-			"name": ".breezewiki.com",
-			"regex": "([a-z\\d-]{1,50})\\.breezewiki\\.com(?:/wiki/|/?$)",
-			"namePath": "https://breezewiki.com/$1/",
-			"articlePath": "https://breezewiki.com/$1/wiki/",
-			"scriptPath": "https://$1.fandom.com/",
-			"note": "Missing language support."
+			"regex": "((?:www\\.)?wikiwand\\.com/([a-z\\d-]{1,50}))/?",
+			"namePath": "https://www.wikiwand.com/$2/",
+			"articlePath": "https://www.wikiwand.com/$2/",
+			"scriptPath": "https://$2.wikipedia.org/w/",
+			"relativeFix": "^/wiki(?=/)",
+			"idString": {
+				"regex": "([a-z\\d-]{1,50})",
+				"scriptPaths": [
+					"https://www.wikiwand.com/$1/"
+				]
+			}
 		},
 		{
 			"name": "breezewiki.com",
-			"regex": "breezewiki\\.com/([a-z\\d-]{1,50})(?:/wiki/|/?$)",
-			"namePath": "https://breezewiki.com/$1/",
-			"articlePath": "https://breezewiki.com/$1/wiki/",
-			"scriptPath": "https://$1.fandom.com/",
+			"regex": "(breezewiki\\.com/([a-z\\d-]{1,50}))(?:/wiki/|/?$)",
+			"namePath": "https://breezewiki.com/$2/",
+			"articlePath": "https://breezewiki.com/$2/wiki/",
+			"scriptPath": "https://$2.fandom.com/",
 			"note": "Missing language support."
 		},
 		{
 			"name": "breezewiki.pussthecat.org",
-			"regex": "breezewiki\\.pussthecat\\.org/([a-z\\d-]{1,50})(?:/wiki/|/?$)",
-			"namePath": "https://breezewiki.pussthecat.org/$1/",
-			"articlePath": "https://breezewiki.pussthecat.org/$1/wiki/",
-			"scriptPath": "https://$1.fandom.com/",
+			"regex": "(breezewiki\\.pussthecat\\.org/([a-z\\d-]{1,50}))(?:/wiki/|/?$)",
+			"namePath": "https://breezewiki.pussthecat.org/$2/",
+			"articlePath": "https://breezewiki.pussthecat.org/$2/wiki/",
+			"scriptPath": "https://$2.fandom.com/",
 			"note": "Missing language support."
 		}
 	],