mediawiki-projects-list 2.1.0 → 2.3.0

package/index.d.ts

@@ -47,6 +47,19 @@ declare module 'mediawiki-projects-list' {
 		articlePath: string;
 		/** Script path of the proxy */
 		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

@@ -29,6 +29,12 @@ const PROJECTS = require('./projects.json');
  * @property {string} namePath - Name path of the proxy
  * @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
  */
 
@@ -71,6 +77,11 @@ 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;
 } );
@@ -141,11 +152,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 idString = wikiProjects.find( wikiProject => wikiProject.idString && wikiProject.name === projectName )?.idString;
+	if ( !idString ) idString = frontendProxies.find( frontendProxy => frontendProxy.idString && frontendProxy.name === projectName )?.idString;
+	if ( idString ) {
+		let regex = idString.match( new RegExp( '^' + idString.regex + '$' ) )?.[1].split(idString.separator);
+		if ( regex && regex.length <= idString.scriptPaths.length ) {
+			result = idString.scriptPaths[regex.length - 1].replace( /\$(\d)/g, (match, n) => regex[n - 1] );
 		}
 	}
 	functionCache.idStringToUrl.set(cacheKey, result);
@@ -192,8 +204,19 @@ function urlToFix(url) {
 	let frontendProxy = frontendProxies.find( frontendProxy => hostname.endsWith( frontendProxy.name ) );
 	if ( frontendProxy ) {
 		let splitLength = frontendProxy.namePath.split('/').length;
-		let querykeys = frontendProxy.namePath.split('?').slice(1).join('?').split('&').flatMap( query => query.split('=', 1) );
-		if ( splitLength > 4 && querykeys.length ) {
+		let querykeys = frontendProxy.namePath.split('?').slice(1).join('?').split('&').flatMap( query => {
+			if ( !query ) return [];
+			return query.split('=', 1);
+		} );
+		if ( splitLength > 4 && querykeys.length && frontendProxy.relativeFix ) {
+			result = (href, pagelink) => {
+				let prepend = '/' + pagelink.split('/', splitLength).slice(3, -1).join('/');
+				let querystring = pagelink.split('?').slice(1).join('?').split('&').filter( query => querykeys.includes( query.split('=', 1)[0] ) );
+				let append = ( href.includes('?') ? '&' : '?' ) + querystring.join('&');
+				return prepend + href.replace( new RegExp( frontendProxy.relativeFix ), '' ) + append;
+			};
+		}
+		else if ( splitLength > 4 && querykeys.length ) {
 			result = (href, pagelink) => {
 				let prepend = '/' + pagelink.split('/', splitLength).slice(3, -1).join('/');
 				let querystring = pagelink.split('?').slice(1).join('?').split('&').filter( query => querykeys.includes( query.split('=', 1)[0] ) );
@@ -201,15 +224,30 @@ function urlToFix(url) {
 				return prepend + href + append;
 			};
 		}
+		else if ( splitLength > 4 && frontendProxy.relativeFix ) {
+			result = (href, pagelink) => {
+				let prepend = '/' + pagelink.split('/', splitLength).slice(3, -1).join('/');
+				return prepend + href.replace( new RegExp( frontendProxy.relativeFix ), '' );
+			}
+		}
 		else if ( splitLength > 4 ) {
 			result = (href, pagelink) => '/' + pagelink.split('/', splitLength).slice(3, -1).join('/') + href;
 		}
+		else if ( querykeys.length && frontendProxy.relativeFix ) {
+			result = (href, pagelink) => {
+				let querystring = pagelink.split('?').slice(1).join('?').split('&').filter( query => querykeys.includes( query.split('=', 1)[0] ) );
+				return href.replace( new RegExp( frontendProxy.relativeFix ), '' ) + ( href.includes('?') ? '&' : '?' ) + querystring.join('&');
+			}
+		}
 		else if ( querykeys.length ) {
 			result = (href, pagelink) => {
 				let querystring = pagelink.split('?').slice(1).join('?').split('&').filter( query => querykeys.includes( query.split('=', 1)[0] ) );
 				return href + ( href.includes('?') ? '&' : '?' ) + querystring.join('&');
 			}
 		}
+		else if ( frontendProxy.relativeFix ) {
+			result = (href, pagelink) => href.replace( new RegExp( frontendProxy.relativeFix ), '' );
+		}
 	}
 	functionCache.urlToFix.set(hostname, result);
 	return result;

package/package.json

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

package/projects-schema.json

@@ -36,6 +36,50 @@
 						"type": "string",
 						"description": "Script path of the proxy"
 					},
+					"relativeFix": {
+						"type": "string",
+						"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,18 +3,30 @@
 	"frontendProxies": [
 		{
 			"name": "wikiless.org",
-			"regex": "wikiless\\.org/.*?\\?(?:.*?&)?lang=([a-z\\d-]{1,50})(?:&|$)",
+			"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/"
+			"scriptPath": "https://$1.wikipedia.org/w/",
+			"idString": {
+				"regex": "([a-z\\d-]{1,50})",
+				"scriptPaths": [
+					"https://wikiless.org/?lang=$1"
+				]
+			}
 		},
 		{
-			"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."
+			"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(?=/)",
+			"idString": {
+				"regex": "([a-z\\d-]{1,50})",
+				"scriptPaths": [
+					"https://www.wikiwand.com/$1/"
+				]
+			}
 		},
 		{
 			"name": "breezewiki.com",