refactor: allow for custom ApiQueryParameters

Author: EdJoPaTo

src/queries/get_revisions.ts

@@ -1,8 +1,8 @@
 import * as validate from '../helpers/validate.js'
 import { forceArray, rejectObsoleteInterface } from '../utils/utils.js'
 import type { EntityPageTitle } from '../types/entity.js'
-import type { ApiQueryParameters, UrlResultFormat } from '../types/options.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { UrlResultFormat } from '../types/options.js'
+import type { ApiQueryParameters, BuildUrlFunction } from '../utils/build_url.js'
 
 // See https://www.wikidata.org/w/api.php?action=help&modules=query+revisions
 

src/types/options.ts

@@ -11,8 +11,6 @@ export type Props = 'info' | 'sitelinks' | 'sitelinks/urls' | 'aliases' | 'label
 export type UrlResultFormat = 'xml' | 'json'
 export type WmLanguageCode = typeof languages[number]
 
-export type ApiQueryParameters = Record<string, string | number | true>
-
 // export type Url = `http${string}`
 export type Url = string
 

src/types/wbgetentities.ts

@@ -1,8 +1,6 @@
 import type { UrlResultFormat } from './options.js'
 
-// TODO: not sure why this fails as an interface
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type WbGetEntities = {
+export interface WbGetEntities {
   action: 'wbgetentities'
   titles?: string
   sites?: string

src/utils/build_url.ts

@@ -1,12 +1,17 @@
-import type { ApiQueryParameters, Url } from '../types/options.js'
+import type { Url } from '../types/options.js'
 
 const isBrowser = typeof location !== 'undefined' && typeof document !== 'undefined'
 
+type ApiQueryValue = string | number | true
+export type ApiQueryParameters = Record<string, ApiQueryValue>
+
+export type BuildUrlFunction = <T extends string>(options: Readonly<Partial<Record<T, ApiQueryValue>>>) => Url
+
 export function buildUrlFactory (instanceApiEndpoint: Url): BuildUrlFunction {
-  return function (queryObj: ApiQueryParameters): Url {
+  return queryObj => {
     // Request CORS headers if the request is made from a browser
     // See https://www.wikidata.org/w/api.php ('origin' parameter)
-    if (isBrowser) queryObj.origin = '*'
+    if (isBrowser) queryObj = { ...queryObj, origin: '*' }
 
     const queryEntries = Object.entries(queryObj)
       // Remove null or undefined parameters
@@ -16,5 +21,3 @@ export function buildUrlFactory (instanceApiEndpoint: Url): BuildUrlFunction {
     return instanceApiEndpoint + '?' + query
   }
 }
-
-export type BuildUrlFunction = (options: ApiQueryParameters) => Url