mediawiki-skins-Citizen/resources/skins.citizen.search/gateway/gateway.js
github-actions ee90992a89 ci: 👷 lint code to MediaWiki standards
Check commit and GitHub actions for more details
2023-05-01 06:06:54 +00:00

55 lines
1.3 KiB
JavaScript

/**
* @typedef {Object} Results
* @property {string} id The page ID of the page
* @property {string} title The title of the page.
* @property {string} desc The description of the page.
* @property {string} thumbnail The url of the thumbnail of the page.
*
* @global
*/
const gatewayConfig = require( '../config.json' ).wgCitizenSearchGateway;
/**
* Setup the gateway based on wiki configuration
*
* @return {module}
*/
function getGateway() {
switch ( gatewayConfig ) {
case 'mwActionApi':
return require( './mwActionApi.js' );
case 'mwRestApi':
return require( './mwRestApi.js' );
default:
throw new Error( 'Unknown search gateway' );
}
}
/**
* Fetch suggestion from gateway and return the results object
*
* @param {string} searchQuery
* @param {AbortController} controller
* @return {Object} Results
*/
async function getResults( searchQuery, controller ) {
const gateway = getGateway();
const signal = controller.signal;
const response = await fetch( gateway.getUrl( searchQuery ), { signal } );
if ( !response.ok ) {
const message = 'Uh oh, a wild error appears! ' + response.status;
throw new Error( message );
}
const data = await response.json();
return gateway.convertDataToResults( data );
}
module.exports = {
getResults: getResults
};