Skip to content

convert taginfo to typescript #12777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
k-yle wants to merge 1 commit into from
Open

convert taginfo to typescript #12777

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 105 additions & 60 deletions modules/services/taginfo.js → modules/services/taginfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,67 @@ import { allowUpperCaseTagValues } from '../osm/tags';
import { taginfoApiUrl } from '../../config/id.js';

var apibase = taginfoApiUrl;
var _inflight = {};
var _popularKeys = {};
let _inflight: { [url: string]: AbortController } = {};
let _popularKeys: { [key: TagKey]: boolean } = {};

// manually exclude some additional keys – #5377, #7485, #10287, #11733
// these will be returned by keys(), but taginfo will not be queried for values() requests
var _extraExcludedKeys = /^(addr:.+|postal_code|via|((int_|loc_|nat_|official_|old_|ref_|reg_|short_|full_|sorting_|alt_|artist_|long_|bridge:|tunnel:)?name(:left|:right)?(:[a-z]+)?))$/;

var _extraExcludedKeyNames = /^(hashtags?|created_by)$/;

var _taginfoCache = {};
let _taginfoCache: { [url: string]: unknown[] } = {};

export interface TaginfoKey {
key: TagKey;
description?: string;

count_all: number;
count_all_fraction: number;
count_nodes: number;
count_nodes_fraction: number;
count_ways: number;
count_ways_fraction: number;
count_relations: number;
count_relations_fraction: number;

values_all: number;
users_all: number;
in_wiki: boolean,
projects: number;
}
export interface TaginfoTag {
value: TagValue,
count: number,
fraction: number;
in_wiki: boolean;
description?: string;
desclang?: string;
descdir?: string;
}
export interface TaginfoRole {
role: string;
count_node_members_fraction: number;
count_way_members_fraction: number;
count_relation_members_fraction: number;
}

export type Params = {
debounce?: boolean;
rp?: number;
query?: string;
geometry?: Geometry
filter?: Filter;
sortname?: string;
sortorder?: 'asc' | 'desc';
page?: number;
lang?: string;
}

interface ValueTitle {
value: string;
title: string;
}

var tag_sorts = {
point: 'count_nodes',
Expand All @@ -37,54 +89,57 @@ var tag_filters = {
vertex: 'nodes',
area: 'ways',
line: 'ways'
};
} as const;
type Filter = typeof tag_filters[keyof typeof tag_filters];

var tag_members_fractions = {
point: 'count_node_members_fraction',
vertex: 'count_node_members_fraction',
area: 'count_way_members_fraction',
line: 'count_way_members_fraction',
relation: 'count_relation_members_fraction'
};
} as const;
type Geometry = keyof typeof tag_members_fractions;


function sets(params, n, o) {
function sets<T extends Params>(params: T, n: keyof T, o: Partial<Record<Geometry, string>>): T {
if (params.geometry && o[params.geometry]) {
params[n] = o[params.geometry];
params[n] = o[params.geometry] as never;
}
return params;
}


function setFilter(params) {
function setFilter<T extends Params>(params: T): T {
return sets(params, 'filter', tag_filters);
}


function setSort(params) {
function setSort<T extends Params>(params: T): T {
return sets(params, 'sortname', tag_sorts);
}


function setSortMembers(params) {
function setSortMembers<T extends Params>(params: T): T {
return sets(params, 'sortname', tag_sort_members);
}


function clean(params) {
return utilObjectOmit(params, ['geometry', 'debounce']);
function clean<T extends Params>(params: T): T {
return utilObjectOmit(params, ['geometry', 'debounce']) as T;
}


function filterKeys(type) {
var count_type = type ? 'count_' + type : 'count_all';
return function(d) {
function filterKeys(type: Filter | undefined) {
const count_type = type ? `count_${type}` as const : 'count_all';
return function(d: TaginfoKey) {
return Number(d[count_type]) > 2500 || d.in_wiki;
};
}


function filterMultikeys(prefix) {
return function(d) {
function filterMultikeys(prefix: string) {
return function(d: TaginfoKey) {
// d.key begins with prefix, and d.key contains no additional ':'s
var re = new RegExp('^' + prefix + '(.*)$', 'i');
var matches = d.key.match(re) || [];
Expand All @@ -93,8 +148,8 @@ function filterMultikeys(prefix) {
}


function filterValues(allowUpperCase, key) {
return function(d) {
function filterValues(allowUpperCase: boolean, key: TagKey) {
return function(d: TaginfoTag) {
if (d.value.match(/[;,]/) !== null) return false; // exclude some punctuation
if (!allowUpperCase &&
!(key === 'type' && d.value === 'associatedStreet') &&
Expand All @@ -104,24 +159,23 @@ function filterValues(allowUpperCase, key) {
}


function filterRoles(geometry) {
return function(d) {
function filterRoles(geometry: Geometry) {
return function(d: TaginfoRole) {
if (d.role === '') return false; // exclude empty role
if (d.role.match(/[A-Z*;,]/) !== null) return false; // exclude uppercase letters and some punctuation
return Number(d[tag_members_fractions[geometry]]) > 0.0;
};
}


function valKey(d) {
function valKey(d: TaginfoKey): ValueTitle {
return {
value: d.key,
title: d.key
};
}


function valKeyDescription(d) {
function valKeyDescription(d: TaginfoTag): ValueTitle {
var obj = {
value: d.value,
title: d.description || d.value
Expand All @@ -130,7 +184,7 @@ function valKeyDescription(d) {
}


function roleKey(d) {
function roleKey(d: TaginfoRole): ValueTitle {
return {
value: d.role,
title: d.role
Expand All @@ -139,16 +193,16 @@ function roleKey(d) {


// sort keys with ':' lower than keys without ':'
function sortKeys(a, b) {
function sortKeys(a: TaginfoKey, b: TaginfoKey) {
return (a.key.indexOf(':') === -1 && b.key.indexOf(':') !== -1) ? -1
: (a.key.indexOf(':') !== -1 && b.key.indexOf(':') === -1) ? 1
: 0;
}


var debouncedRequest = debounce(request, 300, { edges: ['trailing'] });
var debouncedRequest = debounce(request, 300, { edges: ['trailing'] }) as typeof request;

function request(url, params, exactMatch, callback, loaded) {
function request<T, C>(url: string, params: Params, exactMatch: boolean, callback: Callback<C>, loaded?: Callback<T>) {
if (_inflight[url]) return;

if (checkCache(url, params, exactMatch, callback)) return;
Expand All @@ -159,17 +213,16 @@ function request(url, params, exactMatch, callback, loaded) {
d3_json(url, { signal: controller.signal })
.then(function(result) {
delete _inflight[url];
if (loaded) loaded(null, result);
if (loaded) loaded(null, result as T);
})
.catch(function(err) {
delete _inflight[url];
if (err.name === 'AbortError') return;
if (loaded) loaded(err.message);
if (loaded) loaded(err);

@k-yle k-yle Aug 24, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was missed in #12684

});
}


function checkCache(url, params, exactMatch, callback) {
function checkCache(url: string, params: Params, exactMatch: boolean, callback: Callback<any>) {
var rp = params.rp || 25;
var testQuery = params.query || '';
var testUrl = url;
Expand Down Expand Up @@ -201,12 +254,12 @@ export default {
init: function() {
_inflight = {};
_taginfoCache = {};
_popularKeys = [];
_popularKeys = {};

// Fetch popular keys. We'll exclude these from `values`
// lookups because they stress taginfo, and they aren't likely
// to yield meaningful autocomplete results.. see #3955
var params = {
var params: Params = {
rp: 100,
sortname: 'values_all',
sortorder: 'desc',
Expand All @@ -216,7 +269,7 @@ export default {
};
this.keys(params, function(err, data) {
if (err) return;
data.forEach(function(d) {
data!.forEach(function(d) {
if (d.value === 'opening_hours') return; // exception
_popularKeys[d.value] = true;
});
Expand All @@ -230,7 +283,7 @@ export default {
},


keys: function(params, callback) {
keys: function(params: Params, callback: Callback<ValueTitle[]>) {
var doRequest = params.debounce ? debouncedRequest : request;
params = clean(setSort(params));
params = Object.assign({
Expand All @@ -242,20 +295,20 @@ export default {
}, params);

var url = apibase + 'keys/all?' + utilQsString(params);
doRequest(url, params, false, callback, function(err, d) {
doRequest<{ data: TaginfoKey[] }, ValueTitle[]>(url, params, false, callback, function(err, d) {
if (err) {
callback(err);
} else {
var f = filterKeys(params.filter);
var result = d.data.filter(f).filter(d => !_extraExcludedKeyNames.test(d.key)).sort(sortKeys).map(valKey);
var result = d!.data.filter(f).filter(d => !_extraExcludedKeyNames.test(d.key)).sort(sortKeys).map(valKey);
_taginfoCache[url] = result;
callback(null, result);
}
});
},


multikeys: function(params, callback) {
multikeys: function(params: Params & { query: string; key?: TagKey }, callback: Callback<ValueTitle[]>) {
var doRequest = params.debounce ? debouncedRequest : request;
params = clean(setSort(params));
params = Object.assign({
Expand All @@ -268,20 +321,20 @@ export default {

var prefix = params.query;
var url = apibase + 'keys/all?' + utilQsString(params);
doRequest(url, params, true, callback, function(err, d) {
doRequest<{ data: TaginfoKey[] }, ValueTitle[]>(url, params, true, callback, function(err, d) {
if (err) {
callback(err);
} else {
var f = filterMultikeys(prefix);
var result = d.data.filter(f).map(valKey);
var result = d!.data.filter(f).map(valKey);
_taginfoCache[url] = result;
callback(null, result);
}
});
},


values: function(params, callback) {
values: function(params: Params & { key: TagKey }, callback: Callback<ValueTitle[]>) {
// Exclude popular keys from values lookups.. see #3955
var key = params.key;
if (key && _popularKeys[key] === true || _extraExcludedKeys.test(key)) {
Expand All @@ -300,7 +353,7 @@ export default {
}, params);

var url = apibase + 'key/values?' + utilQsString(params);
doRequest(url, params, false, callback, function(err, d) {
doRequest<{ data: TaginfoTag[] }, ValueTitle[]>(url, params, false, callback, function(err, d) {
if (err) {
callback(err);
} else {
Expand All @@ -311,17 +364,17 @@ export default {
var allowUpperCase = allowUpperCaseTagValues.test(params.key);
var f = filterValues(allowUpperCase, params.key);

var result = d.data.filter(f).map(valKeyDescription);
var result = d!.data.filter(f).map(valKeyDescription);
_taginfoCache[url] = result;
callback(null, result);
}
});
},


roles: function(params, callback) {
roles: function(params: Params & { geometry: Geometry; rtype?: string }, callback: Callback<ValueTitle[]>) {
var doRequest = params.debounce ? debouncedRequest : request;
var geometry = params.geometry;
var geometry = params.geometry!;
params = clean(setSortMembers(params));
params = Object.assign({
rp: 25,
Expand All @@ -332,20 +385,20 @@ export default {
}, params);

var url = apibase + 'relation/roles?' + utilQsString(params);
doRequest(url, params, true, callback, function(err, d) {
doRequest<{ data: TaginfoRole[] }, ValueTitle[]>(url, params, true, callback, function(err, d) {
if (err) {
callback(err);
} else {
var f = filterRoles(geometry);
var result = d.data.filter(f).map(roleKey);
var result = d!.data.filter(f).map(roleKey);
_taginfoCache[url] = result;
callback(null, result);
}
});
},


docs: function(params, callback) {
docs: function(params: Params & { key?: TagKey; value?: string; rtype?: string }, callback: Callback<unknown[]>) {
var doRequest = params.debounce ? debouncedRequest : request;
params = clean(setSort(params));

Expand All @@ -357,21 +410,13 @@ export default {
}

var url = apibase + path + utilQsString(params);
doRequest(url, params, true, callback, function(err, d) {
doRequest<{ data: unknown[] }, unknown[]>(url, params, true, callback, function(err, d) {
if (err) {
callback(err);
} else {
_taginfoCache[url] = d.data;
callback(null, d.data);
_taginfoCache[url] = d!.data;
callback(null, d!.data);
}
});
},


apibase: function(_) {

@k-yle k-yle Aug 24, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not used

if (!arguments.length) return apibase;
apibase = _;
return this;
}

};
Loading