mediawiki-projects-list 2.0.0 → 2.2.0

package/index.d.ts

@@ -35,9 +35,30 @@ declare module 'mediawiki-projects-list' {
 		note: string | null;
 	};
 
+	/** A frontend proxy */
+	export type FrontendProxy = {
+		/** Hostname of the proxy */
+		name: string;
+		/** Regex to match the proxy url */
+		regex: string;
+		/** Name path of the proxy */
+		namePath: string;
+		/** Article path of the proxy */
+		articlePath: string;
+		/** Script path of the proxy */
+		scriptPath: string;
+		/** Regex to remove from the relative url */
+		relativeFix: string;
+		/** Note about the specific proxy */
+		note: string | null;
+	};
+
 	/** List of MediaWiki projects */
 	export const wikiProjects: WikiProject[];
 
+	/** List of frontend proxies */
+	export const frontendProxies: FrontendProxy[];
+
 	export function inputToWikiProject(input: string): {
 		fullArticlePath: string;
 		fullScriptPath: string;
@@ -48,4 +69,13 @@ declare module 'mediawiki-projects-list' {
 
 	export function idStringToUrl(idString: string, projectName: string): URL | null;
 
+	export function inputToWikiProject(input: string): {
+		fullNamePath: string;
+		fullArticlePath: string;
+		fullScriptPath: string;
+		frontendProxy: FrontendProxy;
+	} | null;
+
+	export function urlToFix(url: string): ((href: string, pagelink: string) => string) | null;
+
 }

package/index.js

@@ -1,4 +1,4 @@
-const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = require('./projects-schema.json');
+const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}, frontendProxies: {items: {properties: frontendProxySchema}}}} = require('./projects-schema.json');
 const PROJECTS = require('./projects.json');
 
 /**
@@ -29,6 +29,8 @@ 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 {?string} note - Note about the specific proxy
  */
 
 /**
@@ -69,7 +71,11 @@ const wikiProjects = PROJECTS.wikiProjects.map( wikiProject => {
  * List of frontend proxies
  * @type {FrontendProxy[]}
  */
-const frontendProxies = PROJECTS.frontendProxies;
+const frontendProxies = PROJECTS.frontendProxies.map( frontendProxy => {
+	frontendProxy.relativeFix ??= frontendProxySchema.relativeFix.default;
+	frontendProxy.note ??= frontendProxySchema.note.default;
+	return frontendProxy;
+} );
 
 /**
  * 
@@ -188,8 +194,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] ) );
@@ -197,15 +214,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.0.0",
+  "version": "2.2.0",
   "type": "commonjs",
   "description": "List of MediaWiki projects for use in discord-wiki-bot",
   "main": "index.js",

package/projects-schema.json

@@ -34,7 +34,17 @@
 					},
 					"scriptPath": {
 						"type": "string",
-						"description": "Script path of the project"
+						"description": "Script path of the proxy"
+					},
+					"relativeFix": {
+						"type": "string",
+						"description": "Regex to remove from the relative url",
+						"default": null
+					},
+					"note": {
+						"type": "string",
+						"description": "Note about the specific proxy",
+						"default": null
 					}
 				},
 				"required": [

package/projects.json

@@ -3,31 +3,42 @@
 	"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/"
 		},
+		{
+			"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/"
+			"scriptPath": "https://$1.fandom.com/",
+			"note": "Missing language support."
 		},
 		{
 			"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/"
+			"scriptPath": "https://$1.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/"
+			"scriptPath": "https://$1.fandom.com/",
+			"note": "Missing language support."
 		}
 	],
 	"wikiProjects": [