mediawiki-skins-Vector/resources/skins.vector.search/urlGenerator.js
Jon Robson 2499e834bb Remove Eslint disable and TypeScript ignore rules, bump coverage
Follow up to 87dd101a
* bump coverage to reflect improved test state
* remove ts-ignore statements
* Drop eslint-disable-next-line compat/compat rules in ES6 code
* Drop TypeScript checking on Jest files
* Identifies an existing usage of ES7 includes method in place
where ES6 browsers need to be supported.
* Update App.vue booleans to default to false. Note this doesn't
impact our usage of the search app as we always pass these values
in.
* Drop unused eslintEs6.json configuration file

Change-Id: Ib6f1ef77bf4e27ecdcc54b5fb963818437f8195c
2023-04-13 00:20:44 +00:00

61 lines
1.5 KiB
JavaScript

/**
* @typedef {Object} UrlParams
* @param {string} title
* @param {string} fulltext
*/
/**
* @callback generateUrl
* @param {RestResult|SearchResult|string} searchResult
* @param {UrlParams} [params]
* @param {string} [articlePath]
* @return {string}
*/
/**
* @typedef {Object} UrlGenerator
* @property {generateUrl} generateUrl
*/
/**
* Generates URLs for suggestions like those in MediaWiki's mediawiki.searchSuggest implementation.
*
* @param {MwMap} config
* @return {UrlGenerator}
*/
function urlGenerator( config ) {
// TODO: This is a placeholder for enabling customization of the URL generator.
// wgVectorSearchUrlGenerator has not been defined as a config variable yet.
return config.get( 'wgVectorSearchUrlGenerator', {
/**
* @param {RestResult|SearchResult|string} suggestion
* @param {UrlParams} params
* @param {string} articlePath
* @return {string}
*/
generateUrl(
suggestion,
params = {
title: 'Special:Search'
},
articlePath = config.get( 'wgScript' )
) {
if ( typeof suggestion !== 'string' ) {
suggestion = suggestion.title;
} else {
// Add `fulltext` query param to search within pages and for navigation
// to the search results page (prevents being redirected to a certain
// article).
params = Object.assign( {}, params, {
fulltext: '1'
} );
}
return articlePath + '?' + $.param( Object.assign( {}, params, { search: suggestion } ) );
}
} );
}
/** @module urlGenerator */
module.exports = urlGenerator;