refactor: improve build_url

EdJoPaTo · EdJoPaTo · commit e0bb72ee5bcb · 2023-06-16T14:00:54.000+02:00
Improved typings of the BuildUrlFunction and
move the Url type to the build_url file
diff --git a/src/helpers/helpers.ts b/src/helpers/helpers.ts
@@ -16,7 +16,7 @@ import type {
   RevisionId,
   SenseId,
 } from '../types/entity.js'
-import type { Url } from '../types/options.js'
+import type { Url } from '../utils/build_url.js'
 
 function isIdBuilder<T extends string> (regex: { readonly source: string, readonly flags: string }) {
   return (id: string): id is T => typeof id === 'string' && new RegExp(regex.source, regex.flags).test(id)
diff --git a/src/helpers/sitelinks.ts b/src/helpers/sitelinks.ts
@@ -1,8 +1,9 @@
 import { fixedEncodeURIComponent, isAKey, isOfType, rejectObsoleteInterface, replaceSpaceByUnderscores } from '../utils/utils.js'
 import { languages } from './sitelinks_languages.js'
 import { specialSites } from './special_sites.js'
-import type { Url, WmLanguageCode } from '../types/options.js'
+import type { WmLanguageCode } from '../types/options.js'
 import type { Site } from '../types/sitelinks.js'
+import type { Url } from '../utils/build_url.js'
 
 const wikidataBase = 'https://www.wikidata.org/wiki/'
 
diff --git a/src/queries/cirrus_search.ts b/src/queries/cirrus_search.ts
@@ -1,8 +1,8 @@
 // See https://www.wikidata.org/w/api.php?action=help&modules=query%2Bsearch
 
 import { isAKey, rejectObsoleteInterface } from '../utils/utils.js'
-import type { Url, UrlResultFormat } from '../types/options.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { UrlResultFormat } from '../types/options.js'
+import type { BuildUrlFunction, Url } from '../utils/build_url.js'
 
 const namespacePattern = /^\d+[|\d]*$/
 
diff --git a/src/queries/get_entities.ts b/src/queries/get_entities.ts
@@ -1,9 +1,9 @@
 import * as validate from '../helpers/validate.js'
 import { forceArray, rejectObsoleteInterface, shortLang } from '../utils/utils.js'
 import type { EntityId } from '../types/entity.js'
-import type { Props, Url, UrlResultFormat, WmLanguageCode } from '../types/options.js'
+import type { Props, UrlResultFormat, WmLanguageCode } from '../types/options.js'
 import type { WbGetEntities } from '../types/wbgetentities.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { BuildUrlFunction, Url } from '../utils/build_url.js'
 
 export interface GetEntitiesOptions {
   ids: EntityId | EntityId[]
diff --git a/src/queries/get_entities_from_sitelinks.ts b/src/queries/get_entities_from_sitelinks.ts
@@ -1,9 +1,9 @@
 import { languages } from '../helpers/sitelinks_languages.js'
 import { forceArray, shortLang, rejectObsoleteInterface, isOfType } from '../utils/utils.js'
-import type { Props, Url, UrlResultFormat, WmLanguageCode } from '../types/options.js'
+import type { Props, UrlResultFormat, WmLanguageCode } from '../types/options.js'
 import type { Site } from '../types/sitelinks.js'
 import type { WbGetEntities } from '../types/wbgetentities.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { BuildUrlFunction, Url } from '../utils/build_url.js'
 
 export interface GetEntitiesFromSitelinksOptions {
   titles: string | string[]
diff --git a/src/queries/get_entity_revision.ts b/src/queries/get_entity_revision.ts
@@ -1,7 +1,7 @@
 import * as validate from '../helpers/validate.js'
 import { rejectObsoleteInterface } from '../utils/utils.js'
 import type { EntityId, RevisionId } from '../types/entity.js'
-import type { Url } from '../types/options.js'
+import type { Url } from '../utils/build_url.js'
 
 export interface GetEntityRevisionOptions {
   id: EntityId
diff --git a/src/queries/get_many_entities.ts b/src/queries/get_many_entities.ts
@@ -2,8 +2,7 @@ import { rejectObsoleteInterface } from '../utils/utils.js'
 import { getEntitiesFactory } from './get_entities.js'
 import type { GetEntitiesOptions } from './get_entities.js'
 import type { EntityId } from '../types/entity.js'
-import type { Url } from '../types/options.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { BuildUrlFunction, Url } from '../utils/build_url.js'
 
 export interface GetManyEntitiesOptions extends GetEntitiesOptions {
   ids: EntityId[]
diff --git a/src/queries/get_reverse_claims.ts b/src/queries/get_reverse_claims.ts
@@ -3,7 +3,7 @@ import * as validate from '../helpers/validate.js'
 import { forceArray } from '../utils/utils.js'
 import { sparqlQueryFactory } from './sparql_query.js'
 import type { PropertyId } from '../types/entity.js'
-import type { Url } from '../types/options.js'
+import type { Url } from '../utils/build_url.js'
 
 // Fiter-out properties. Can't be filtered by
 // `?subject a wikibase:Item`, as those triples are omitted
diff --git a/src/queries/get_revisions.ts b/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
 
diff --git a/src/queries/search_entities.ts b/src/queries/search_entities.ts
@@ -1,8 +1,8 @@
 import { EntityTypes } from '../types/entity.js'
 import { isOfType, rejectObsoleteInterface } from '../utils/utils.js'
 import type { EntityType } from '../types/entity.js'
-import type { Url, UrlResultFormat } from '../types/options.js'
-import type { BuildUrlFunction } from '../utils/build_url.js'
+import type { UrlResultFormat } from '../types/options.js'
+import type { BuildUrlFunction, Url } from '../utils/build_url.js'
 
 export interface SearchEntitiesOptions {
   search: string
diff --git a/src/queries/sparql_query.ts b/src/queries/sparql_query.ts
@@ -1,5 +1,5 @@
 import { fixedEncodeURIComponent } from '../utils/utils.js'
-import type { Url } from '../types/options.js'
+import type { Url } from '../utils/build_url.js'
 
 export function sparqlQueryFactory (sparqlEndpoint: Url) {
   return function sparqlQuery (sparql: string): Url {
diff --git a/src/types/options.ts b/src/types/options.ts
@@ -11,11 +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
-
 export interface SimplifyEntityOptions extends SimplifySnaksOptions, SimplifySitelinkOptions {}
 
 export interface SimplifySitelinkOptions {
diff --git a/src/types/sitelinks.ts b/src/types/sitelinks.ts
@@ -1,7 +1,7 @@
 import type { ItemId } from './entity.js'
-import type { Url } from './options.js'
 import type { sites } from '../helpers/sitelinks_sites.js'
 import type { specialSites } from '../helpers/special_sites.js'
+import type { Url } from '../utils/build_url.js'
 
 type ValueOf<T> = T[keyof T]
 type SpecialSiteName = ValueOf<typeof specialSites>
diff --git a/src/utils/build_url.ts b/src/utils/build_url.ts
@@ -1,12 +1,18 @@
-import type { ApiQueryParameters, 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 Url = `http${string}`
+export type Url = string
+
+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 +22,3 @@ export function buildUrlFactory (instanceApiEndpoint: Url): BuildUrlFunction {
     return instanceApiEndpoint + '?' + query
   }
 }
-
-export type BuildUrlFunction = (options: ApiQueryParameters) => Url
diff --git a/src/wikibase-sdk.ts b/src/wikibase-sdk.ts
@@ -13,9 +13,9 @@ import { getReverseClaimsFactory } from './queries/get_reverse_claims.js'
 import { getRevisionsFactory } from './queries/get_revisions.js'
 import { searchEntitiesFactory } from './queries/search_entities.js'
 import { sparqlQueryFactory } from './queries/sparql_query.js'
-import { buildUrlFactory } from './utils/build_url.js'
+import { buildUrlFactory, type Url } from './utils/build_url.js'
 import { isPlainObject } from './utils/utils.js'
-import type { InstanceConfig, Url } from './types/options.js'
+import type { InstanceConfig } from './types/options.js'
 
 const tip = `Tip: if you just want to access functions that don't need an instance or a sparqlEndpoint,
 those are also exposed directly on the module object. Exemple:
diff --git a/tests/lib/utils.ts b/tests/lib/utils.ts
@@ -1,5 +1,5 @@
 import { readFileSync } from 'fs'
-import type { Url } from '../../src/types/options.js'
+import type { Url } from '../../src/utils/build_url.js'
 
 export function readJsonFile (jsonFilePath: string) {
   return JSON.parse(readFileSync(jsonFilePath, 'utf-8'))
