mediawiki-projects-list 1.2.10 → 2.0.0

package/index.js

@@ -1,4 +1,5 @@
 const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = require('./projects-schema.json');
+const PROJECTS = require('./projects.json');
 
 /**
  * A MediaWiki project
@@ -20,24 +21,38 @@ const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = r
  * @property {?string} note - Note about the specific project
  */
 
+/**
+ * A frontend proxy
+ * @typedef {object} FrontendProxy
+ * @property {string} name - Hostname of the proxy
+ * @property {string} regex - Regex to match the proxy url
+ * @property {string} namePath - Name path of the proxy
+ * @property {string} articlePath - Article path of the proxy
+ * @property {string} scriptPath - Script path of the proxy
+ */
+
 /**
  * @type {{
  *     inputToWikiProject: Map<string, ?{fullArticlePath: string, fullScriptPath: string, wikiProject: WikiProject}>,
  *     urlToIdString: Map<string, ?string>,
- *     idStringToUrl: Map<string, ?string>
+ *     idStringToUrl: Map<string, ?string>,
+ *     inputToFrontendProxy: Map<string, ?{fullNamePath: string, fullArticlePath: string, fullScriptPath: string, frontendProxy: FrontendProxy}>,
+ *     urlToFix: Map<string, ?((href:String,pagelink:String)=>String)>
  * }}
  */
 const functionCache = {
 	inputToWikiProject: new Map(),
 	urlToIdString: new Map(),
-	idStringToUrl: new Map()
+	idStringToUrl: new Map(),
+	inputToFrontendProxy: new Map(),
+	urlToFix: new Map()
 };
 
 /**
  * List of MediaWiki projects
  * @type {WikiProject[]}
  */
-const wikiProjects = require('./projects.json').wikiProjects.map( wikiProject => {
+const wikiProjects = PROJECTS.wikiProjects.map( wikiProject => {
 	if ( wikiProject.idString ) {
 		wikiProject.idString.separator ??= wikiProjectSchema.idString.properties.separator.default;
 		wikiProject.idString.direction ??= wikiProjectSchema.idString.properties.direction.default;
@@ -50,6 +65,12 @@ const wikiProjects = require('./projects.json').wikiProjects.map( wikiProject =>
 	return wikiProject;
 } );
 
+/**
+ * List of frontend proxies
+ * @type {FrontendProxy[]}
+ */
+const frontendProxies = PROJECTS.frontendProxies;
+
 /**
  * 
  * @param {string} input 
@@ -73,6 +94,10 @@ function inputToWikiProject(input) {
 				fullScriptPath: 'https://' + regex[1] + scriptPath,
 				wikiProject: wikiProject
 			};
+			if ( result.fullArticlePath.includes('?') && !result.fullArticlePath.endsWith('=') ) {
+				result.fullArticlePath = result.fullArticlePath.replace( '?', '$1?' );
+			}
+			else result.fullArticlePath += '$1';
 		}
 	}
 	functionCache.inputToWikiProject.set(input, result);
@@ -123,9 +148,75 @@ function idStringToUrl(idString, projectName) {
 	return ( result ? new URL(result) : result );
 }
 
+/**
+ * 
+ * @param {string} input 
+ * @returns {?{fullNamePath: string, fullArticlePath: string, fullScriptPath: string, frontendProxy: FrontendProxy}}
+ */
+function inputToFrontendProxy(input) {
+	if ( functionCache.inputToFrontendProxy.has(input) ) return structuredClone(functionCache.inputToFrontendProxy.get(input));
+	let result = null;
+	let frontendProxy = frontendProxies.find( frontendProxy => input.split('/').slice(0, 3).some( part => part.endsWith( frontendProxy.name ) ) );
+	if ( frontendProxy ) {
+		let regex = input.match( new RegExp( frontendProxy.regex ) );
+		if ( regex ) {
+			result = {
+				fullNamePath: frontendProxy.namePath.replace( /\$(\d)/g, (match, n) => regex[n] ),
+				fullArticlePath: frontendProxy.articlePath.replace( /\$(\d)/g, (match, n) => regex[n] ),
+				fullScriptPath: frontendProxy.scriptPath.replace( /\$(\d)/g, (match, n) => regex[n] ),
+				frontendProxy: frontendProxy
+			};
+			if ( result.fullArticlePath.includes('?') && !result.fullArticlePath.endsWith('=') ) {
+				result.fullArticlePath = result.fullArticlePath.replace( '?', '$1?' );
+			}
+			else result.fullArticlePath += '$1';
+		}
+	}
+	functionCache.inputToFrontendProxy.set(input, result);
+	return structuredClone(result);
+}
+
+/**
+ * 
+ * @param {string} url 
+ * @returns {?((href:String,pagelink:String)=>String)}
+ */
+function urlToFix(url) {
+	let hostname = url.split('/')[2];
+	if ( functionCache.urlToFix.has(hostname) ) return functionCache.urlToFix.get(hostname);
+	let result = null;
+	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 ) {
+			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 + append;
+			};
+		}
+		else if ( splitLength > 4 ) {
+			result = (href, pagelink) => '/' + pagelink.split('/', splitLength).slice(3, -1).join('/') + href;
+		}
+		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('&');
+			}
+		}
+	}
+	functionCache.urlToFix.set(hostname, result);
+	return result;
+}
+
 module.exports = {
 	wikiProjects,
+	frontendProxies,
 	inputToWikiProject,
 	urlToIdString,
-	idStringToUrl
+	idStringToUrl,
+	inputToFrontendProxy,
+	urlToFix
 };

package/package.json

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

package/projects-schema.json

@@ -9,6 +9,46 @@
 			"type": "string",
 			"format": "path"
 		},
+		"frontendProxies": {
+			"type": "array",
+			"description": "List of frontend proxies",
+			"items": {
+				"type": "object",
+				"description": "A frontend proxy",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "Hostname of the proxy"
+					},
+					"regex": {
+						"type": "string",
+						"description": "Regex to match the proxy url"
+					},
+					"namePath": {
+						"type": "string",
+						"description": "Name path of the proxy"
+					},
+					"articlePath": {
+						"type": "string",
+						"description": "Article path of the proxy"
+					},
+					"scriptPath": {
+						"type": "string",
+						"description": "Script path of the project"
+					}
+				},
+				"required": [
+					"name",
+					"regex",
+					"namePath",
+					"articlePath",
+					"scriptPath"
+				],
+				"additionalProperties": false
+			},
+			"uniqueItemProperties": ["name"],
+			"additionalItems": false
+		},
 		"wikiProjects": {
 			"type": "array",
 			"description": "List of MediaWiki projects",

package/projects.json

@@ -1,5 +1,35 @@
 {
 	"$schema": "./projects-schema.json",
+	"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/"
+		},
+		{
+			"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/"
+		},
+		{
+			"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/"
+		},
+		{
+			"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/"
+		}
+	],
 	"wikiProjects": [
 		{
 			"name": "fandom.com",