forked from florianchrometz/german-metadata
-
Notifications
You must be signed in to change notification settings - Fork 0
/
german-metadata.js
324 lines (295 loc) · 10.5 KB
/
german-metadata.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
'use strict';
/**
* Cities data
*/
const ALL_CITIES = require('./data/cities.json');
/**
* All city names based on all joint city.name, ordered by city name
* @type {array<string>}
*/
const ALL_CITY_NAMES = [...new Set(ALL_CITIES.map((city) => city.name))].sort();
/**
* All postal codes based on all joint city.postalCodes, ordered by postal code
* @type {array<string>}
*/
const ALL_POSTAL_CODES = [...new Set(ALL_CITIES.map((city) => city.postalCodes))].flat().sort();
/**
* All states based on all distinct joint city.state, ordered by state
* @type {array<string>}
*/
const ALL_STATES = [...new Set(ALL_CITIES.map((city) => city.state))].sort();
/**
* All phone prefixes based on all distinct joint city.phonePrefix, ordered by phone prefix
* @type {array<number>}
* */
const ALL_PHONE_PREFIXES = [...new Set(ALL_CITIES.map((city) => city.phonePrefix))].sort();
/**
* Function to get city object by city name
* @param {string} cityName - Any german city name, will be made identifiable for comparison
* @returns {object} - City object or null if not found
*/
function cityByName(cityName) {
const identifiableCityName = createIdentifiableCityOrStateName(cityName);
return ALL_CITIES.find((city) => createIdentifiableCityOrStateName(city.name) === identifiableCityName) || null;
}
/**
* Function to get city objects by postal code
* @param {string} postalCode - Postal code in any german format
* @returns {array<object>} - Array if matching city objects or null if not found
*/
function citiesByPostalCode(postalCode) {
return ALL_CITIES.filter((city) => city.postalCodes.includes(postalCode)) || null;
}
/**
* Function to get city objects by state
* @param {string} state - Any german state name, will be made identifiable for comparison
* @returns {array<object>} - Array if matching city objects or null if not found
*/
function citiesByState(state) {
const identifiableState = createIdentifiableCityOrStateName(state);
return ALL_CITIES.filter((city) => createIdentifiableCityOrStateName(city.state) === identifiableState) || null;
}
/**
* Function to get a city objects by phone prefix
* @param {number} phonePrefix - Phone prefix with no trailing 0
* @returns {array<object>} - Array if matching city objects or null if not found
*/
function citiesByPhonePrefix(phonePrefix) {
return ALL_CITIES.filter((city) => city.phonePrefix === phonePrefix) || null;
}
/**
* Function to get a city objects by phone number
* @param {string} phoneNumber - Phonenumber in any german format, will be made identifiable for comparison
* @returns {array<object>} - Array if matching city objects or null if not found
*/
function citiesByPhoneNumber(phoneNumber) {
const prefixForPhoneNumber = phonePrefixByPhoneNumber(phoneNumber);
return citiesByPhonePrefix(prefixForPhoneNumber);
}
/**
* Function to get postal codes by city name
* @param {string} cityName - Any german city name, will be made identifiable for comparison
* @returns {array<string>} - Postal codes or null if not found
*/
function postalCodesByCityName(cityName) {
const city = cityByName(cityName);
return city ? city.postalCodes : null;
}
/**
* Function to get postal codes by state
* @param {string} state - Any german state name, will be made identifiable for comparison
* @returns {array<string>} - Postal codes or null if not found
*/
function postalCodesByState(state) {
const cities = citiesByState(state);
return cities ? cities.map((city) => city.postalCodes).flat() : null;
}
/**
* Function to get postal codes by phone prefix
* @param {number} phonePrefix - Phone prefix with no trailing 0
* @returns {array<string>} - Postal codes or null if not found
*/
function postalCodesByPhonePrefix(phonePrefix) {
const cities = citiesByPhonePrefix(phonePrefix);
return cities ? cities.map((city) => city.postalCodes).flat() : null;
}
/**
* Function to get postal codes by phone number
* @param {string} phoneNumber - Phonenumber in any german format, will be made identifiable for comparison
* @returns {array<string>} - Postal codes or null if not found
*/
function postalCodesByPhoneNumber(phoneNumber) {
const prefixForPhoneNumber = phonePrefixByPhoneNumber(phoneNumber);
return postalCodesByPhonePrefix(prefixForPhoneNumber);
}
/**
* Function to get state by city name
* @param {string} cityName - Any german city name, will be made identifiable for comparison
* @returns {string} - State name or null if not found
*/
function stateByCityName(cityName) {
const city = cityByName(cityName);
return city ? city.state : null;
}
/**
* Function to get state by postal code
* @param {string} postalCode - Postal code in any german format
* @returns {string} - State name or null if not found
*/
function stateByPostalCode(postalCode) {
const cities = citiesByPostalCode(postalCode);
return cities[0] ? cities[0].state : null;
}
/**
* Function to get state by phone prefix
* @param {number} phonePrefix - Phone prefix with no trailing 0
* @returns {string} - State name or null if not found
*/
function stateByPhonePrefix(phonePrefix) {
const cities = citiesByPhonePrefix(phonePrefix);
return cities[0] ? cities[0].state : null;
}
/**
* Function to get state by phone number
* @param {string} phoneNumber - Phonenumber in any german format, will be made identifiable for comparison
* @returns {string} - State name or null if not found
*/
function stateByPhoneNumber(phoneNumber) {
const prefixForPhoneNumber = phonePrefixByPhoneNumber(phoneNumber);
return stateByPhonePrefix(prefixForPhoneNumber);
}
/**
* Function to get phone prefix by city name
* @param {string} cityName - Any german city name, will be made identifiable for comparison
* @returns {number} - Phone prefix or 0 if not found
*/
function phonePrefixByCityName(cityName) {
const city = cityByName(cityName);
return city ? city.phonePrefix : null;
}
/**
* Function to get phone prefixes by postal code
* @param {string} postalCode - Postal code in any german format
* @returns {array<number>} - Phone prefixes or null if not found
*/
function phonePrefixesByPostalCode(postalCode) {
const cities = citiesByPostalCode(postalCode);
return cities ? cities.map((city) => city.phonePrefix) : null;
}
/**
* Function to get phone prefixes by state
* @param {string} state - Any german state name, will be made identifiable for comparison
* @returns {array<number>} - Phone prefixes or empty if not found
*/
function phonePrefixesByState(state) {
const cities = citiesByState(state);
return cities ? cities.map((city) => city.phonePrefix) : null;
}
/**
* Function to get phone prefix by phone number
* @param {string} phoneNumber - Phonenumber in any german format, will be made identifiable for comparison
* @returns {number} - Phone prefix or -1 if not found
*/
function phonePrefixByPhoneNumber(phoneNumber) {
const identifiablePhoneNumber = createIdentifiablePhoneNumber(phoneNumber);
const prefixLengths = [5, 4, 3, 2];
for (const length of prefixLengths) {
const possiblePrefix = Number(identifiablePhoneNumber.substring(0, length));
const city = ALL_CITIES.find((p) => p.phonePrefix === possiblePrefix);
if (city) {
return city.phonePrefix;
}
}
return -1;
}
/**
* Function to validate if city name exists
* @param {string} cityName - Any german city name, will be made identifiable for comparison
* @returns {boolean} - true if city name exists, false if not
*/
function isCityNameValid(cityName) {
const allCityIdentifiableNames = ALL_CITY_NAMES.map((city) => createIdentifiableCityOrStateName(city));
const identifiableCity = createIdentifiableCityOrStateName(cityName);
return allCityIdentifiableNames.includes(identifiableCity);
}
/**
* Function to validate if postal code exists
* @param {string} postalCode - Postal code in any german format
* @returns {boolean} - true if postal code exists, false if not
*/
function isPostalCodeValid(postalCode) {
return ALL_POSTAL_CODES.includes(postalCode);
}
/**
* Function to validate if state exists
* @param {string} state - Any german state name, will be made identifiable for comparison
* @returns {boolean} - true if state exists, false if not
*/
function isStateValid(state) {
// compare identifiable state name to all identifiable state names
const allStateIdentifiableNames = ALL_STATES.map((state) => createIdentifiableCityOrStateName(state));
const identifiableState = createIdentifiableCityOrStateName(state);
return allStateIdentifiableNames.includes(identifiableState);
}
/**
* Function to validate if phone prefix exists
* @param {number} phonePrefix - Phone prefix with no trailing 0
* @returns {boolean} - true if phone prefix exists, false if not
*/
function isPhonePrefixValid(phonePrefix) {
return ALL_PHONE_PREFIXES.includes(phonePrefix);
}
/**
* INTERNAL Function to create identifiable city or state name
* @param {string} cityOrStateName - Any german city or state name
* @returns {string} Identifiable city or state name
*/
function createIdentifiableCityOrStateName(cityOrStateName) {
return cityOrStateName
.toLowerCase()
.replaceAll(/ä/g, 'ae')
.replaceAll(/ö/g, 'oe')
.replaceAll(/ü/g, 'ue')
.replaceAll(/ß/g, 'ss')
.replaceAll(/ /g, '1')
.replaceAll(/\//g, '2')
.replaceAll(/\(/g, '3')
.replaceAll(/\)/g, '4')
.replaceAll(/\./g, '5')
.replaceAll(/\,/g, '6')
.replaceAll(/-/g, '7');
}
/**
* INTERNAL Function to create identifiable phone number
* @param {string} phoneNumber - Any german phone number
* @returns {string} Identifiable phonenumber
*/
function createIdentifiablePhoneNumber(phoneNumber) {
// return -1 if phoneNumber is not a string
if (typeof phoneNumber !== 'string') {
return '-1';
}
return phoneNumber
.replace(/\D/g, '')
.replace(/^0/, '')
.replace(/^00/, '')
.replace(/^\+/, '')
.replace(/^\(/, '')
.replace(/^\)/, '')
.replace(/^0049/, '')
.replace(/^049/, '')
.replace(/^49/, '')
.replace(/^0/, '')
.replace(/^00/, '');
}
/**
* Export constants and functions to be consumable
*/
module.exports = {
ALL_CITIES,
ALL_CITY_NAMES,
ALL_POSTAL_CODES,
ALL_STATES,
ALL_PHONE_PREFIXES,
cityByName,
citiesByPostalCode,
citiesByState,
citiesByPhonePrefix,
citiesByPhoneNumber,
postalCodesByCityName,
postalCodesByState,
postalCodesByPhonePrefix,
postalCodesByPhoneNumber,
stateByCityName,
stateByPostalCode,
stateByPhonePrefix,
stateByPhoneNumber,
phonePrefixByCityName,
phonePrefixesByPostalCode,
phonePrefixesByState,
phonePrefixByPhoneNumber,
isCityNameValid,
isPostalCodeValid,
isStateValid,
isPhonePrefixValid,
};