├── .eslintrc.js
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── jest.config.js
├── package.json
├── pnpm-lock.yaml
├── prisma
├── migrations
│ ├── 20250411175910_cleanup
│ │ └── migration.sql
│ ├── init
│ │ └── migration.sql
│ └── migration_lock.toml
└── schema.prisma
├── server.ts
├── src
├── app.ts
├── config.ts
├── docs
│ └── swagger.ts
├── middleware
│ ├── errorHandler.ts
│ └── validation.ts
├── routes.ts
└── types.ts
├── tests
└── locations-api.test.ts
└── tsconfig.json
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | parser: '@typescript-eslint/parser',
3 | parserOptions: {
4 | project: 'tsconfig.json',
5 | sourceType: 'module',
6 | },
7 | plugins: ['@typescript-eslint/eslint-plugin'],
8 | extends: [
9 | 'plugin:@typescript-eslint/recommended',
10 | 'plugin:prettier/recommended',
11 | ],
12 | root: true,
13 | env: {
14 | node: true,
15 | jest: true,
16 | },
17 | ignorePatterns: ['.eslintrc.js'],
18 | rules: {
19 | '@typescript-eslint/interface-name-prefix': 'off',
20 | '@typescript-eslint/explicit-function-return-type': 'off',
21 | '@typescript-eslint/explicit-module-boundary-types': 'off',
22 | '@typescript-eslint/no-explicit-any': 'off',
23 | },
24 | };
25 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # compiled output
2 | /dist
3 | /node_modules
4 | /prisma/node_modules
5 |
6 | # Logs
7 | logs
8 | *.log
9 | npm-debug.log*
10 | yarn-debug.log*
11 | yarn-error.log*
12 | lerna-debug.log*
13 |
14 | # OS
15 | .DS_Store
16 |
17 | # Tests
18 | /coverage
19 | /.nyc_output
20 |
21 | # IDEs and editors
22 | /.idea
23 | .project
24 | .classpath
25 | .c9/
26 | *.launch
27 | .settings/
28 | *.sublime-workspace
29 |
30 | # IDE - VSCode
31 | .vscode/*
32 | !.vscode/settings.json
33 | !.vscode/tasks.json
34 | !.vscode/launch.json
35 | !.vscode/extensions.json
36 |
37 | .env
38 | /.env
39 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "singleQuote": true,
3 | "trailingComma": "all"
4 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Location Data API
2 |
3 | A RESTful API for Tanzania location data including countries, regions, districts, wards, and places.
4 |
5 | ## Features
6 |
7 | - Hierarchical location data with proper relationships
8 | - RESTful API with clean structure
9 | - Input validation and error handling
10 | - Pagination and search support
11 |
12 | ## Tech Stack
13 |
14 | - Node.js / Express
15 | - PostgreSQL
16 | - Prisma ORM
17 | - Jest & Supertest for testing
18 |
19 | ## Getting Started
20 |
21 | ### Prerequisites
22 |
23 | - Node.js LTS
24 | - [Tanzania Locations Database](https://github.com/HackEAC/tanzania-locations-db) running 🏃🏿♂️🏃🏿♀️
25 | - npm or yarn
26 |
27 | ### Installation
28 |
29 | 1. Clone the repository
30 |
31 | ```bash
32 | git clone https://github.com/yourusername/locations-API.git
33 | cd locations-API
34 | ```
35 |
36 | 2. Install dependencies
37 |
38 | ```bash
39 | npm install
40 | ```
41 |
42 | 3. Create `.env` for your environment
43 |
44 | ```bash
45 | echo DATABASE_URL="postgresql://postgres:password@localhost:5433/locations" > .env
46 | ```
47 |
48 | The above `DATABASE_URL` is for the [Tanzania-locations-database](https://github.com/HackEAC/tanzania-locations-db) Docker container provision.
49 |
50 | 4. Sync up your API with the locations database:
51 |
52 | - **a.** Pull existing DB schema into your Prisma schema
53 |
54 | ```bash
55 | pnpx prisma db pull
56 | ```
57 |
58 | - **b.** Create migration init files
59 |
60 | ```bash
61 | mkdir prisma/migrations/init
62 | ```
63 |
64 | - **c.** Mark the current schema as baseline
65 |
66 | ```bash
67 | pnpx prisma migrate diff \
68 | --from-empty \
69 | --to-schema-datamodel prisma/schema.prisma \
70 | --script > prisma/migrations/init/migration.sql
71 | ```
72 |
73 | - **d.** Create migration history manually
74 |
75 | ```bash
76 | pnpx prisma migrate resolve --applied init
77 | ```
78 |
79 | ✅ Now you're synced! Future `prisma migrate dev` or `migrate deploy` will work cleanly.
80 |
81 | 5. Start development server
82 |
83 | ```bash
84 | npm run dev
85 | ```
86 |
87 | 6. Build application
88 |
89 | ```bash
90 | npm run build
91 | ```
92 |
93 | 7. Start production server
94 |
95 | ```bash
96 | npm run start
97 | ```
98 |
99 | ## API Endpoints
100 |
101 | ### Countries
102 | - `GET /v1/countries` - Get all countries
103 | - `GET /v1/countries/:id` - Get country by ID
104 |
105 | ### Regions
106 | - `GET /v1/regions` - Get all regions
107 | - `GET /v1/regions/:regionCode` - Get region by code
108 | - `GET /v1/regions/:regionCode/districts` - Get districts in a region
109 |
110 | ### Districts
111 | - `GET /v1/districts` - Get all districts
112 | - `GET /v1/districts/:districtCode` - Get district by code
113 | - `GET /v1/districts/:districtCode/wards` - Get wards in a district
114 |
115 | ### Wards
116 | - `GET /v1/wards` - Get all wards
117 | - `GET /v1/wards/:wardCode` - Get ward by code
118 | - `GET /v1/wards/:wardCode/places` - Get places in a ward
119 |
120 | ### Places
121 | - `GET /v1/places` - Get all places
122 | - `GET /v1/places/:id` - Get place by ID
123 |
124 | ### Search
125 | - `GET /v1/search?q=nzuguni` - Fulltext search for locations by name
126 |
127 | ## Running Tests
128 |
129 | ```bash
130 | npm test
131 | ```
132 |
133 | ## License
134 |
135 | This project is licensed under the CopyLeft License – see the LICENSE file for details.
136 |
--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('ts-jest').JestConfigWithTsJest} **/
2 | module.exports = {
3 | testEnvironment: "node",
4 | transform: {
5 | "^.+\.tsx?$": ["ts-jest",{}],
6 | },
7 | };
8 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "locations_api",
3 | "version": "2.0.0",
4 | "description": "Tanzania Locations API is a gateway that provides information about various locations in Tanzania, including regions, districts, wards, and places.",
5 | "main": "./dist/server.js",
6 | "engines": {
7 | "node": ">=18.0.0"
8 | },
9 | "scripts": {
10 | "dev": "node --experimental-strip-types --watch ./server.ts",
11 | "generate": "prisma generate --no-engine",
12 | "generate:ci": "prisma generate",
13 | "build:ci": "npm run generate:ci && tsc --noEmit",
14 | "build": "npm run generate && tsc",
15 | "start": "node ./dist/server.js",
16 | "test": "jest",
17 | "test:watch": "jest --watch"
18 | },
19 | "keywords": [
20 | "Tanzania",
21 | "locations",
22 | "API",
23 | "regions",
24 | "districts",
25 | "wards",
26 | "places"
27 | ],
28 | "author": "HackEAC",
29 | "license": "copyleft",
30 | "packageManager": "pnpm@10.7.0",
31 | "dependencies": {
32 | "@prisma/client": "^6.6.0",
33 | "body-parser": "^2.2.0",
34 | "cors": "^2.8.5",
35 | "dotenv": "^16.5.0",
36 | "express": "^5.1.0",
37 | "helmet": "^8.1.0",
38 | "morgan": "^1.10.0",
39 | "swagger-jsdoc": "^6.2.8",
40 | "swagger-ui-express": "^5.0.1",
41 | "zod": "^3.24.2"
42 | },
43 | "devDependencies": {
44 | "@types/cors": "^2.8.17",
45 | "@types/express": "^5.0.1",
46 | "@types/jest": "^29.5.14",
47 | "@types/morgan": "^1.9.9",
48 | "@types/node": "^22.14.0",
49 | "@types/supertest": "^6.0.3",
50 | "@types/swagger-jsdoc": "^6.0.4",
51 | "@types/swagger-ui-express": "^4.1.8",
52 | "jest": "^29.7.0",
53 | "prisma": "^6.6.0",
54 | "supertest": "^7.1.0",
55 | "ts-jest": "^29.3.1",
56 | "typescript": "^5.8.3"
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/prisma/migrations/20250411175910_cleanup/migration.sql:
--------------------------------------------------------------------------------
1 | /*
2 | Warnings:
3 |
4 | - You are about to drop the column `properties_count` on the `districts` table. All the data in the column will be lost.
5 | - You are about to drop the column `view_count` on the `districts` table. All the data in the column will be lost.
6 | - You are about to drop the column `watcher_count` on the `districts` table. All the data in the column will be lost.
7 | - You are about to drop the column `properties_count` on the `places` table. All the data in the column will be lost.
8 | - You are about to drop the column `view_count` on the `places` table. All the data in the column will be lost.
9 | - You are about to drop the column `properties_count` on the `regions` table. All the data in the column will be lost.
10 | - You are about to drop the column `view_count` on the `regions` table. All the data in the column will be lost.
11 | - You are about to drop the column `watcher_count` on the `regions` table. All the data in the column will be lost.
12 | - You are about to drop the column `properties_count` on the `wards` table. All the data in the column will be lost.
13 | - You are about to drop the column `view_count` on the `wards` table. All the data in the column will be lost.
14 |
15 | */
16 | -- AlterTable
17 | ALTER TABLE "districts" DROP COLUMN "properties_count",
18 | DROP COLUMN "view_count",
19 | DROP COLUMN "watcher_count";
20 |
21 | -- AlterTable
22 | ALTER TABLE "places" DROP COLUMN "properties_count",
23 | DROP COLUMN "view_count";
24 |
25 | -- AlterTable
26 | ALTER TABLE "regions" DROP COLUMN "properties_count",
27 | DROP COLUMN "view_count",
28 | DROP COLUMN "watcher_count";
29 |
30 | -- AlterTable
31 | ALTER TABLE "wards" DROP COLUMN "properties_count",
32 | DROP COLUMN "view_count";
33 |
--------------------------------------------------------------------------------
/prisma/migrations/init/migration.sql:
--------------------------------------------------------------------------------
1 | -- CreateTable
2 | CREATE TABLE "countries" (
3 | "id" SERIAL NOT NULL,
4 | "iso" CHAR(2) NOT NULL,
5 | "name" TEXT NOT NULL,
6 | "nicename" TEXT NOT NULL,
7 | "iso3" CHAR(3),
8 | "numcode" INTEGER,
9 | "phonecode" INTEGER NOT NULL,
10 |
11 | CONSTRAINT "countries_pkey" PRIMARY KEY ("id")
12 | );
13 |
14 | -- CreateTable
15 | CREATE TABLE "districts" (
16 | "district_name" TEXT,
17 | "district_code" INTEGER NOT NULL,
18 | "watcher_count" INTEGER,
19 | "view_count" INTEGER,
20 | "general_locations_id" INTEGER,
21 | "properties_count" INTEGER,
22 | "region_id" INTEGER,
23 | "country_id" INTEGER,
24 |
25 | CONSTRAINT "districts_pkey" PRIMARY KEY ("district_code")
26 | );
27 |
28 | -- CreateTable
29 | CREATE TABLE "places" (
30 | "id" SERIAL NOT NULL,
31 | "place_name" TEXT,
32 | "view_count" INTEGER,
33 | "properties_count" INTEGER,
34 | "ward_id" INTEGER,
35 | "district_id" INTEGER,
36 | "region_id" INTEGER,
37 | "country_id" INTEGER,
38 | "general_locations_id" INTEGER,
39 |
40 | CONSTRAINT "places_pkey" PRIMARY KEY ("id")
41 | );
42 |
43 | -- CreateTable
44 | CREATE TABLE "regions" (
45 | "region_name" TEXT,
46 | "region_code" INTEGER NOT NULL,
47 | "watcher_count" INTEGER,
48 | "view_count" INTEGER,
49 | "general_locations_id" INTEGER,
50 | "properties_count" INTEGER,
51 | "country_id" INTEGER,
52 |
53 | CONSTRAINT "regions_pkey" PRIMARY KEY ("region_code")
54 | );
55 |
56 | -- CreateTable
57 | CREATE TABLE "wards" (
58 | "ward_name" TEXT,
59 | "ward_code" INTEGER NOT NULL,
60 | "district_id" INTEGER,
61 | "region_id" INTEGER,
62 | "country_id" INTEGER,
63 | "view_count" INTEGER,
64 | "properties_count" INTEGER,
65 | "general_locations_id" INTEGER,
66 |
67 | CONSTRAINT "wards_pkey" PRIMARY KEY ("ward_code")
68 | );
69 |
70 | -- CreateTable
71 | CREATE TABLE "general" (
72 | "id" SERIAL NOT NULL,
73 | "country_id" INTEGER,
74 | "region" VARCHAR NOT NULL,
75 | "regioncode" INTEGER NOT NULL,
76 | "district" VARCHAR NOT NULL,
77 | "districtcode" INTEGER NOT NULL,
78 | "ward" VARCHAR NOT NULL,
79 | "wardcode" INTEGER NOT NULL,
80 | "street" VARCHAR,
81 | "places" VARCHAR,
82 |
83 | CONSTRAINT "general_pkey" PRIMARY KEY ("id")
84 | );
85 |
86 | -- AddForeignKey
87 | ALTER TABLE "districts" ADD CONSTRAINT "districts_country_id_fkey" FOREIGN KEY ("country_id") REFERENCES "countries"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
88 |
89 | -- AddForeignKey
90 | ALTER TABLE "districts" ADD CONSTRAINT "districts_general_locations_id_fkey" FOREIGN KEY ("general_locations_id") REFERENCES "general"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
91 |
92 | -- AddForeignKey
93 | ALTER TABLE "districts" ADD CONSTRAINT "districts_region_id_fkey" FOREIGN KEY ("region_id") REFERENCES "regions"("region_code") ON DELETE NO ACTION ON UPDATE NO ACTION;
94 |
95 | -- AddForeignKey
96 | ALTER TABLE "places" ADD CONSTRAINT "places_general_locations_id_fkey" FOREIGN KEY ("general_locations_id") REFERENCES "general"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
97 |
98 | -- AddForeignKey
99 | ALTER TABLE "regions" ADD CONSTRAINT "regions_country_id_fkey" FOREIGN KEY ("country_id") REFERENCES "countries"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
100 |
101 | -- AddForeignKey
102 | ALTER TABLE "regions" ADD CONSTRAINT "regions_general_locations_id_fkey" FOREIGN KEY ("general_locations_id") REFERENCES "general"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
103 |
104 | -- AddForeignKey
105 | ALTER TABLE "wards" ADD CONSTRAINT "wards_country_id_fkey" FOREIGN KEY ("country_id") REFERENCES "countries"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
106 |
107 | -- AddForeignKey
108 | ALTER TABLE "wards" ADD CONSTRAINT "wards_district_id_fkey" FOREIGN KEY ("district_id") REFERENCES "districts"("district_code") ON DELETE NO ACTION ON UPDATE NO ACTION;
109 |
110 | -- AddForeignKey
111 | ALTER TABLE "wards" ADD CONSTRAINT "wards_general_locations_id_fkey" FOREIGN KEY ("general_locations_id") REFERENCES "general"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
112 |
113 | -- AddForeignKey
114 | ALTER TABLE "wards" ADD CONSTRAINT "wards_region_id_fkey" FOREIGN KEY ("region_id") REFERENCES "regions"("region_code") ON DELETE NO ACTION ON UPDATE NO ACTION;
115 |
116 |
--------------------------------------------------------------------------------
/prisma/migrations/migration_lock.toml:
--------------------------------------------------------------------------------
1 | # Please do not edit this file manually
2 | # It should be added in your version-control system (e.g., Git)
3 | provider = "postgresql"
4 |
--------------------------------------------------------------------------------
/prisma/schema.prisma:
--------------------------------------------------------------------------------
1 | generator client {
2 | provider = "prisma-client-js"
3 | previewFeatures = ["fullTextSearchPostgres"]
4 | }
5 |
6 | datasource db {
7 | provider = "postgresql"
8 | url = env("DATABASE_URL")
9 | }
10 |
11 | model Countries {
12 | id Int @id @default(autoincrement())
13 | iso String @unique(map: "idx_countries_iso") @db.Char(2)
14 | name String
15 | nicename String
16 | iso3 String? @db.Char(3)
17 | numcode Int?
18 | phonecode Int
19 | districts Districts[] @relation("countriesTodistricts")
20 | regions Regions[]
21 | wards Wards[] @relation("countriesTowards")
22 |
23 | @@map("countries")
24 | }
25 |
26 | model Districts {
27 | districtName String? @map("district_name")
28 | districtCode Int @id @map("district_code")
29 | general_locations_id Int?
30 | regionId Int? @map("region_id")
31 | country_id Int?
32 | countries Countries? @relation("countriesTodistricts", fields: [country_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
33 | general General? @relation("districtsTogeneral", fields: [general_locations_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
34 | regions Regions? @relation(fields: [regionId], references: [regionCode], onDelete: NoAction, onUpdate: NoAction)
35 | wards Wards[]
36 |
37 | @@index([country_id], map: "idx_districts_country_id")
38 | @@index([general_locations_id], map: "idx_districts_general_id")
39 | @@index([regionId], map: "idx_districts_region_id")
40 | @@map("districts")
41 | }
42 |
43 | model Places {
44 | id Int @id @default(autoincrement())
45 | placeName String? @map("place_name")
46 | wardId Int? @map("ward_id")
47 | district_id Int?
48 | region_id Int?
49 | country_id Int?
50 | general_locations_id Int?
51 | general General? @relation("generalToplaces", fields: [general_locations_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
52 |
53 | @@index([country_id], map: "idx_places_country_id")
54 | @@index([district_id], map: "idx_places_district_id")
55 | @@index([general_locations_id], map: "idx_places_general_id")
56 | @@index([region_id], map: "idx_places_region_id")
57 | @@index([wardId], map: "idx_places_ward_id")
58 | @@map("places")
59 | }
60 |
61 | model Regions {
62 | regionName String? @map("region_name")
63 | regionCode Int @id @map("region_code")
64 | general_locations_id Int? @map("general_locations_id")
65 | countryId Int? @map("country_id")
66 | districts Districts[]
67 | countries Countries? @relation(fields: [countryId], references: [id], onDelete: NoAction, onUpdate: NoAction)
68 | general General? @relation("generalToregions", fields: [general_locations_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
69 | wards Wards[]
70 |
71 | @@index([countryId], map: "idx_regions_country_id")
72 | @@index([general_locations_id], map: "idx_regions_general_id")
73 | @@map("regions")
74 | }
75 |
76 | model Wards {
77 | wardName String? @map("ward_name")
78 | wardCode Int @id @map("ward_code")
79 | districtId Int? @map("district_id")
80 | region_id Int?
81 | country_id Int?
82 | general_locations_id Int?
83 | countries Countries? @relation("countriesTowards", fields: [country_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
84 | districts Districts? @relation(fields: [districtId], references: [districtCode], onDelete: NoAction, onUpdate: NoAction)
85 | general General? @relation("generalTowards", fields: [general_locations_id], references: [id], onDelete: NoAction, onUpdate: NoAction)
86 | regions Regions? @relation(fields: [region_id], references: [regionCode], onDelete: NoAction, onUpdate: NoAction)
87 |
88 | @@index([country_id], map: "idx_wards_country_id")
89 | @@index([districtId], map: "idx_wards_district_id")
90 | @@index([general_locations_id], map: "idx_wards_general_id")
91 | @@index([region_id], map: "idx_wards_region_id")
92 | @@map("wards")
93 | }
94 |
95 | model General {
96 | id Int @id @default(autoincrement())
97 | countryId Int? @map("country_id")
98 | region String @db.VarChar
99 | regioncode Int
100 | district String @db.VarChar
101 | districtcode Int
102 | ward String @db.VarChar
103 | wardcode Int
104 | street String? @db.VarChar
105 | places String? @db.VarChar
106 | search_vector Unsupported("tsvector")? @default(dbgenerated("to_tsvector('simple'::regconfig, (((((((((COALESCE(region, ''::character varying))::text || ' '::text) || (COALESCE(district, ''::character varying))::text) || ' '::text) || (COALESCE(ward, ''::character varying))::text) || ' '::text) || (COALESCE(street, ''::character varying))::text) || ' '::text) || (COALESCE(places, ''::character varying))::text))"))
107 | districts Districts[] @relation("districtsTogeneral")
108 | places_generalToplaces Places[] @relation("generalToplaces")
109 | regions Regions[] @relation("generalToregions")
110 | wards Wards[] @relation("generalTowards")
111 |
112 | @@index([search_vector], map: "idx_general_search_vector", type: Gin)
113 | @@map("general")
114 | }
115 |
--------------------------------------------------------------------------------
/server.ts:
--------------------------------------------------------------------------------
1 | import { PrismaClient } from '@prisma/client';
2 | import app from './src/app';
3 |
4 | const PORT = process.env.PORT || 8080;
5 | const prisma = new PrismaClient();
6 |
7 | process.on('SIGINT', async () => {
8 | console.log('SIGINT received. Shutting down gracefully');
9 | await prisma.$disconnect();
10 | process.exit(0);
11 | });
12 |
13 | process.on('SIGTERM', async () => {
14 | console.log('SIGTERM received. Shutting down gracefully');
15 | await prisma.$disconnect();
16 | process.exit(0);
17 | });
18 |
19 | app.listen(PORT, () => {
20 | console.log(`Server running on port ${PORT} in ${process.env.NODE_ENV || 'development'} mode`);
21 | console.log(`API Documentation available at http://localhost:${PORT}/api-docs`);
22 | });
23 |
--------------------------------------------------------------------------------
/src/app.ts:
--------------------------------------------------------------------------------
1 | import express, { Request, Response, NextFunction } from 'express';
2 | import cors from 'cors';
3 | import helmet from 'helmet';
4 | import morgan from 'morgan';
5 | import { PrismaClient } from '@prisma/client';
6 | import { errorHandler } from './middleware/errorHandler';
7 | import { setupSwagger } from './docs/swagger';
8 | import routes from './routes';
9 |
10 | const app = express();
11 | export const prisma = new PrismaClient();
12 |
13 | app.use(helmet());
14 | app.use(cors());
15 | app.use(morgan('dev'));
16 |
17 | if (process.env.NODE_ENV !== 'production') {
18 | app.use((req: Request, _: Response, next: NextFunction) => {
19 | console.log(`[${new Date().toISOString()}] ${req.method} ${req.url}`);
20 | next();
21 | });
22 | }
23 |
24 | app.use(express.json());
25 | app.use(express.urlencoded({ extended: true }));
26 |
27 | app.get('/health', (_: Request, res: Response) => {
28 | res.status(200).json({
29 | status: 'UP',
30 | timestamp: new Date().toISOString(),
31 | environment: process.env.NODE_ENV || 'development',
32 | version: process.env.npm_package_version || '1.0.0'
33 | });
34 | });
35 |
36 | app.get('/', (_: Request, res: Response) => {
37 | res.send('Its alive!');
38 | });
39 |
40 | app.use('/v1', routes);
41 |
42 | app.use((req, res) => {
43 | res.status(404).json({
44 | error: {
45 | message: 'Resource not found',
46 | path: req.originalUrl,
47 | },
48 | });
49 | });
50 |
51 | app.use(errorHandler);
52 |
53 | setupSwagger(app);
54 | export default app;
55 |
--------------------------------------------------------------------------------
/src/config.ts:
--------------------------------------------------------------------------------
1 | import dotenv from 'dotenv';
2 | dotenv.config();
3 |
4 | const config = {
5 | nodeEnv: process.env.NODE_ENV || 'development',
6 | port: process.env.PORT || 8080,
7 | databaseUrl: process.env.DATABASE_URL,
8 | pageSize: parseInt(process.env.PAGE_SIZE || '10', 10)
9 | };
10 |
11 | export default config;
12 |
--------------------------------------------------------------------------------
/src/docs/swagger.ts:
--------------------------------------------------------------------------------
1 | import swaggerJsdoc from 'swagger-jsdoc';
2 | import swaggerUi from 'swagger-ui-express';
3 | import { Express } from 'express';
4 |
5 | const options = {
6 | definition: {
7 | openapi: '3.0.0',
8 | info: {
9 | title: 'Tanzania Location API',
10 | version: '2.0.0',
11 | description: 'API for retrieving location data in Tanzania including countries, regions, districts, and wards.',
12 | contact: {
13 | name: 'HackEAC',
14 | url: 'https://maotora.com',
15 | email: 'maotoramm@gmail.com'
16 | },
17 | license: {
18 | name: 'copyleft',
19 | url: 'https://opensource.org/licenses/GNU'
20 | }
21 | },
22 | servers: [
23 | {
24 | url: 'http://localhost:8080/api',
25 | description: 'Local development server'
26 | }
27 | ]
28 | },
29 | apis: ['./src/routes.ts'],
30 | };
31 |
32 | const swaggerSpec = swaggerJsdoc(options);
33 |
34 | export const setupSwagger = (app: Express) => {
35 | app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
36 | };
37 |
--------------------------------------------------------------------------------
/src/middleware/errorHandler.ts:
--------------------------------------------------------------------------------
1 | import { Request, Response } from 'express';
2 | import { ZodError } from 'zod';
3 | import { ErrorResponse } from '../types';
4 |
5 | export class ApiError extends Error {
6 | statusCode: number;
7 | isOperational: boolean;
8 |
9 | constructor(statusCode: number, message: string, isOperational: boolean = true) {
10 | super(message);
11 | this.statusCode = statusCode;
12 | this.isOperational = isOperational;
13 | Error.captureStackTrace(this, this.constructor);
14 | }
15 | }
16 |
17 | export const errorHandler = (
18 | err: Error | ApiError | ZodError,
19 | _: Request,
20 | res: Response,
21 | ) => {
22 | console.error(`[${new Date().toISOString()}] Error:`, err);
23 |
24 | let statusCode = 500;
25 | let message = 'Something went wrong';
26 |
27 | if (err instanceof ApiError) {
28 | statusCode = err.statusCode;
29 | message = err.message;
30 | }
31 |
32 | if (err instanceof ZodError) {
33 | statusCode = 400;
34 | message = `Validation error: ${err.errors.map(e => e.message).join(', ')}`;
35 | }
36 |
37 | if ('code' in err && err.code === 'P2025') {
38 | statusCode = 404;
39 | message = 'Requested resource not found';
40 | }
41 |
42 | if (err instanceof SyntaxError || err instanceof TypeError) {
43 | statusCode = 400;
44 | message = 'Invalid request data';
45 | }
46 |
47 | const isProduction = process.env.NODE_ENV === 'production';
48 |
49 | res.status(statusCode).json({
50 | error: {
51 | message,
52 | ...(isProduction ? {} : {
53 | stack: err.stack,
54 | details: err instanceof ZodError ? err.errors : err
55 | })
56 | }
57 | });
58 | };
59 |
--------------------------------------------------------------------------------
/src/middleware/validation.ts:
--------------------------------------------------------------------------------
1 | import { RequestHandler } from 'express';
2 | import { ZodSchema, ZodError } from 'zod';
3 |
4 | export const validate = (schemas: {
5 | body?: ZodSchema;
6 | query?: ZodSchema;
7 | params?: ZodSchema;
8 | }): RequestHandler => {
9 | return (req, res, next) => {
10 | try {
11 | if (schemas.body) req.validatedBody = schemas.body.parse(req.body);
12 | if (schemas.query) req.validatedQuery = schemas.query.parse(req.query);
13 | if (schemas.params) req.validatedParams = schemas.params.parse(req.params);
14 |
15 | next();
16 | } catch (err) {
17 | if (err instanceof ZodError) {
18 | res.status(400).json({
19 | error: {
20 | message: 'Validation error',
21 | validationErrors: err.errors,
22 | },
23 | });
24 | return;
25 | }
26 |
27 | res.status(500).json({
28 | error: {
29 | message: 'Unexpected error',
30 | stack: err instanceof Error ? err.stack : undefined,
31 | },
32 | });
33 | return;
34 | }
35 | };
36 | };
37 |
--------------------------------------------------------------------------------
/src/routes.ts:
--------------------------------------------------------------------------------
1 | import { Router } from 'express';
2 | import { validate } from './middleware/validation';
3 | import { prisma } from './app';
4 | import { ApiError } from './middleware/errorHandler';
5 | import {
6 | codeParamSchema,
7 | idParamSchema,
8 | paginationSchema,
9 | } from './types';
10 |
11 | const router = Router();
12 |
13 | // ==================== COUNTRIES ROUTES ====================
14 |
15 | /**
16 | * @route GET /api/countries
17 | * @description Get all countries with optional pagination and search
18 | */
19 | router.get('/countries', validate({ query: paginationSchema }), async (req, res, next) => {
20 | try {
21 | const { page, limit, search } = req.validatedQuery;
22 | const skip = (page - 1) * limit;
23 | const whereClause = search ? { name: { contains: search } } : {};
24 |
25 | const total = await prisma.countries.count({ where: whereClause });
26 |
27 | const countries = await prisma.countries.findMany({
28 | skip,
29 | take: limit,
30 | where: whereClause,
31 | select: {
32 | id: true,
33 | name: true,
34 | iso: true,
35 | nicename: true,
36 | phonecode: true,
37 | numcode: true,
38 | },
39 | orderBy: { name: 'asc' }
40 | });
41 |
42 | res.json({
43 | data: countries,
44 | pagination: {
45 | page,
46 | limit,
47 | total,
48 | pages: Math.ceil(total / limit)
49 | }
50 | });
51 | } catch (error) {
52 | next(error);
53 | }
54 | });
55 |
56 | /**
57 | * @route GET /api/countries/:id
58 | * @description Get country by ID
59 | */
60 | router.get('/countries/:id', validate({ params: idParamSchema }), async (req, res, next) => {
61 | try {
62 | const countryId = req.params.id;
63 |
64 | const country = await prisma.countries.findUnique({
65 | where: { id: +countryId },
66 | select: {
67 | id: true,
68 | name: true,
69 | iso: true,
70 | nicename: true,
71 | phonecode: true,
72 | numcode: true
73 | }
74 | });
75 |
76 | if (!country) {
77 | throw new ApiError(404, 'Country not found');
78 | }
79 |
80 | res.json({ data: country });
81 | } catch (error) {
82 | next(error);
83 | }
84 | });
85 |
86 | // ==================== REGIONS ROUTES ====================
87 |
88 | /**
89 | * @route GET /api/regions
90 | * @description Get all regions with pagination and optional filtering
91 | */
92 | router.get('/regions', validate({ query: paginationSchema }), async (req, res, next) => {
93 | try {
94 | const { page, limit, search } = req.validatedQuery;
95 | const skip = (page - 1) * limit;
96 |
97 | // Handle search query if present
98 | const whereClause = search ? { regionName: { contains: search } } : {};
99 |
100 | const total = await prisma.regions.count({ where: whereClause });
101 |
102 | const regions = await prisma.regions.findMany({
103 | skip,
104 | take: limit,
105 | where: whereClause,
106 | select: {
107 | regionCode: true,
108 | regionName: true,
109 | countryId: true,
110 | countries: {
111 | select: {
112 | name: true
113 | }
114 | }
115 | },
116 | orderBy: { regionName: 'asc' }
117 | });
118 |
119 | res.json({
120 | data: regions,
121 | pagination: {
122 | page,
123 | limit,
124 | total,
125 | pages: Math.ceil(total / limit)
126 | }
127 | });
128 | } catch (error) {
129 | next(error);
130 | }
131 | });
132 |
133 | /**
134 | * @route GET /api/regions/:regionCode
135 | * @description Get a specific region by code
136 | */
137 | router.get('/regions/:regionCode', validate({ params: codeParamSchema.pick({ regionCode: true }) }), async (req, res, next) => {
138 | try {
139 | const regionCode = +req.params.regionCode;
140 |
141 | const region = await prisma.regions.findUnique({
142 | where: { regionCode },
143 | select: {
144 | regionCode: true,
145 | regionName: true,
146 | countryId: true,
147 | countries: {
148 | select: {
149 | name: true,
150 | nicename: true
151 | }
152 | }
153 | }
154 | });
155 |
156 | if (!region || Object.keys(region).length === 0) {
157 | throw new ApiError(404, 'Region not found');
158 | }
159 |
160 | res.json({ data: region });
161 | } catch (error) {
162 | next(error);
163 | }
164 | });
165 |
166 | /**
167 | * @route GET /api/regions/:regionCode/districts
168 | * @description Get all districts in a region
169 | */
170 | router.get('/regions/:regionCode/districts',
171 | validate({ params: codeParamSchema.pick({ regionCode: true }) }),
172 | validate({ query: paginationSchema }),
173 | async (req, res, next) => {
174 | try {
175 | const regionCode = +req.params.regionCode;
176 | const { page, limit } = req.validatedQuery;
177 | const skip = (page - 1) * limit;
178 |
179 | // Verify region exists
180 | const regionExists = await prisma.regions.findUnique({
181 | where: { regionCode },
182 | select: { regionCode: true }
183 | });
184 |
185 | if (!regionExists) {
186 | throw new ApiError(404, 'Region not found');
187 | }
188 |
189 | // Get districts count
190 | const total = await prisma.districts.count({
191 | where: { regionId: regionCode }
192 | });
193 |
194 | // Get districts
195 | const districts = await prisma.districts.findMany({
196 | where: { regionId: regionCode },
197 | skip,
198 | take: limit,
199 | select: {
200 | districtCode: true,
201 | districtName: true,
202 | regionId: true
203 | },
204 | orderBy: { districtName: 'asc' }
205 | });
206 |
207 | res.json({
208 | data: districts,
209 | pagination: {
210 | page,
211 | limit,
212 | total,
213 | pages: Math.ceil(total / limit)
214 | }
215 | });
216 | } catch (error) {
217 | next(error);
218 | }
219 | }
220 | );
221 |
222 | // ==================== DISTRICTS ROUTES ====================
223 |
224 | /**
225 | * @route GET /api/districts
226 | * @description Get all districts with pagination and optional search
227 | */
228 | router.get('/districts', validate({ query: paginationSchema }), async (req, res, next) => {
229 | try {
230 | const { page, limit, search } = req.validatedQuery;
231 | const skip = (page - 1) * limit;
232 |
233 | // Handle search if present
234 | const whereClause = search ? { districtName: { contains: search } } : {};
235 |
236 | const total = await prisma.districts.count({ where: whereClause });
237 |
238 | const districts = await prisma.districts.findMany({
239 | skip,
240 | take: limit,
241 | where: whereClause,
242 | select: {
243 | districtCode: true,
244 | districtName: true,
245 | regionId: true,
246 | country_id: true,
247 | regions: {
248 | select: {
249 | regionName: true
250 | }
251 | }
252 | },
253 | orderBy: { districtName: 'asc' }
254 | });
255 |
256 | res.json({
257 | data: districts,
258 | pagination: {
259 | page,
260 | limit,
261 | total,
262 | pages: Math.ceil(total / limit)
263 | }
264 | });
265 | } catch (error) {
266 | next(error);
267 | }
268 | });
269 |
270 | /**
271 | * @route GET /api/districts/:districtCode
272 | * @description Get district by code
273 | */
274 | router.get('/districts/:districtCode', validate({ params: codeParamSchema.pick({ districtCode: true }) }), async (req, res, next) => {
275 | try {
276 | const districtCode = +req.params.districtCode;
277 |
278 | const district = await prisma.districts.findUnique({
279 | where: { districtCode },
280 | select: {
281 | districtCode: true,
282 | districtName: true,
283 | regionId: true,
284 | country_id: true,
285 | regions: {
286 | select: {
287 | regionName: true
288 | }
289 | },
290 | countries: {
291 | select: {
292 | name: true
293 | }
294 | }
295 | }
296 | });
297 |
298 | if (!district) {
299 | throw new ApiError(404, 'District not found');
300 | }
301 |
302 | res.json({ data: district });
303 | } catch (error) {
304 | next(error);
305 | }
306 | });
307 |
308 | // ==================== WARDS ROUTES ====================
309 |
310 | /**
311 | * @route GET /api/wards
312 | * @description Get all wards with pagination and search
313 | */
314 | router.get('/wards', validate({ query: paginationSchema }), async (req, res, next) => {
315 | try {
316 | const { page, limit, search } = req.validatedQuery;
317 | const skip = (page - 1) * limit;
318 |
319 | // Handle search if present
320 | const whereClause = search ? { wardName: { contains: search } } : {};
321 |
322 | const total = await prisma.wards.count({ where: whereClause });
323 |
324 | const wards = await prisma.wards.findMany({
325 | skip,
326 | take: limit,
327 | where: whereClause,
328 | select: {
329 | wardCode: true,
330 | wardName: true,
331 | districtId: true,
332 | region_id: true,
333 | country_id: true,
334 | districts: {
335 | select: {
336 | districtName: true
337 | }
338 | }
339 | },
340 | orderBy: { wardName: 'asc' }
341 | });
342 |
343 | res.json({
344 | data: wards,
345 | pagination: {
346 | page,
347 | limit,
348 | total,
349 | pages: Math.ceil(total / limit)
350 | }
351 | });
352 | } catch (error) {
353 | next(error);
354 | }
355 | });
356 |
357 | /**
358 | * @route GET /api/wards/:wardCode
359 | * @description Get ward by code
360 | */
361 | router.get('/wards/:wardCode', validate({ params: codeParamSchema.pick({ wardCode: true }) }), async (req, res, next) => {
362 | try {
363 | const wardCode = +req.params.wardCode;
364 |
365 | const ward = await prisma.wards.findUnique({
366 | where: { wardCode },
367 | select: {
368 | wardCode: true,
369 | wardName: true,
370 | districtId: true,
371 | region_id: true,
372 | country_id: true,
373 | districts: {
374 | select: {
375 | districtName: true
376 | }
377 | },
378 | regions: {
379 | select: {
380 | regionName: true
381 | }
382 | },
383 | countries: {
384 | select: {
385 | name: true
386 | }
387 | }
388 | }
389 | });
390 |
391 | if (!ward) {
392 | throw new ApiError(404, 'Ward not found');
393 | }
394 |
395 | res.json({ data: ward });
396 | } catch (error) {
397 | next(error);
398 | }
399 | });
400 |
401 | // ==================== PLACES ROUTES ====================
402 |
403 | /**
404 | * @route GET /api/places
405 | * @description Get all places with pagination and search
406 | */
407 | router.get('/places', validate({ query: paginationSchema }), async (req, res, next) => {
408 | try {
409 | const { page, limit, search } = req.validatedQuery;
410 | const skip = (page - 1) * limit;
411 |
412 | // Handle search if present
413 | const whereClause = search ? { placeName: { contains: search } } : {};
414 |
415 | const total = await prisma.places.count({ where: whereClause });
416 |
417 | const places = await prisma.places.findMany({
418 | skip,
419 | take: limit,
420 | where: whereClause,
421 | select: {
422 | id: true,
423 | placeName: true,
424 | wardId: true,
425 | district_id: true,
426 | region_id: true,
427 | country_id: true
428 | },
429 | orderBy: { placeName: 'asc' }
430 | });
431 |
432 | res.json({
433 | data: places,
434 | pagination: {
435 | page,
436 | limit,
437 | total,
438 | pages: Math.ceil(total / limit)
439 | }
440 | });
441 | } catch (error) {
442 | next(error);
443 | }
444 | });
445 |
446 | /**
447 | * @route GET /api/places/:id
448 | * @description Get place by ID
449 | */
450 | router.get('/places/:id', validate({ params: idParamSchema }), async (req, res, next) => {
451 | try {
452 | const placeId = +req.params.id;
453 |
454 | const place = await prisma.places.findUnique({
455 | where: { id: placeId },
456 | select: {
457 | id: true,
458 | placeName: true,
459 | wardId: true,
460 | district_id: true,
461 | region_id: true,
462 | country_id: true
463 | }
464 | });
465 |
466 | if (!place) {
467 | throw new ApiError(404, 'Place not found');
468 | }
469 |
470 | res.json({ data: place });
471 | } catch (error) {
472 | next(error);
473 | }
474 | });
475 |
476 | // ==================== NESTED ROUTES ====================
477 |
478 | /**
479 | * @route GET /api/countries/:countryCode/regions
480 | * @description Get all regions in a given country
481 | */
482 | router.get('/countries/:countryCode/regions', async (req, res, next) => {
483 | try {
484 | const countryCode = Number(req.params.countryCode);
485 | const regions = await prisma.regions.findMany({
486 | where: { countryId: countryCode },
487 | orderBy: { regionName: 'asc' }
488 | });
489 |
490 | if(!regions || regions.length === 0) {
491 | throw new ApiError(404, 'No regions found for this country');
492 | }
493 | res.json({ data: regions });
494 | } catch (error) {
495 | next(error);
496 | }
497 | });
498 |
499 | /**
500 | * @route GET /api/regions/:regionCode/districts
501 | * @description Get all districts in a given region
502 | */
503 | router.get('/regions/:regionCode/districts', async (req, res, next) => {
504 | try {
505 | const regionCode = Number(req.params.regionCode);
506 | const districts = await prisma.districts.findMany({
507 | where: { regionId: regionCode },
508 | orderBy: { districtName: 'asc' }
509 | });
510 |
511 | if(!districts || districts.length === 0) {
512 | throw new ApiError(404, 'No districts found for this region');
513 | }
514 | res.json({ data: districts });
515 | } catch (error) {
516 | next(error);
517 | }
518 | });
519 |
520 | /**
521 | * @route GET /api/districts/:districtCode/wards
522 | * @description Get all wards in a given district
523 | */
524 | router.get('/districts/:districtCode/wards', async (req, res, next) => {
525 | try {
526 | const districtCode = Number(req.params.districtCode);
527 | const wards = await prisma.wards.findMany({
528 | where: { districtId: districtCode },
529 | orderBy: { wardName: 'asc' }
530 | });
531 |
532 | if(!wards || wards.length === 0) {
533 | throw new ApiError(404, 'No wards found for this district');
534 | }
535 | res.json({ data: wards });
536 | } catch (error) {
537 | next(error);
538 | }
539 | });
540 |
541 |
542 | /**
543 | * @route GET /api/wards/:wardCode/places
544 | * @description Get all places in a given ward
545 | */
546 | router.get('/wards/:wardCode/places', async (req, res, next) => {
547 | try {
548 | const wardCode = Number(req.params.wardCode);
549 | const places = await prisma.places.findMany({
550 | where: { wardId: wardCode },
551 | orderBy: { placeName: 'asc' }
552 | });
553 |
554 | if(!places || places.length === 0) {
555 | throw new ApiError(404, 'No places found for this ward');
556 | }
557 | res.json({ data: places });
558 | } catch (error) {
559 | next(error);
560 | }
561 | });
562 |
563 | /**
564 | * @route GET /api/search
565 | * @description Search for places, wards, districts, regions, or countries
566 | */
567 |
568 | router.get('/search', async (req, res: any, next) => {
569 | try {
570 | const q = req.query.q?.toString().trim();
571 | if (!q || q.length < 2) {
572 | return res.status(400).json({ error: 'Query too short' });
573 | }
574 |
575 | const escapedQuery = q.replace(/'/g, "''"); //- Escapes single quotes
576 | const sql = `
577 | SELECT id, region, district, ward, street, places, regioncode, districtcode, wardcode
578 | FROM "general"
579 | WHERE "search_vector" @@ plainto_tsquery('simple', $1)
580 | ORDER BY ts_rank("search_vector", plainto_tsquery('simple', $1)) DESC
581 | LIMIT 15;
582 | `;
583 |
584 | const results = await prisma.$queryRawUnsafe(sql, escapedQuery);
585 |
586 | res.json({ data: results });
587 | } catch (err) {
588 | next(err);
589 | }
590 | });
591 |
592 |
593 | export default router;
594 |
--------------------------------------------------------------------------------
/src/types.ts:
--------------------------------------------------------------------------------
1 | import { z, ZodIssue } from 'zod';
2 |
3 | export const paginationSchema = z.object({
4 | page: z.coerce.number().int().positive().optional().default(1),
5 | limit: z.coerce.number().int().positive().max(100).optional().default(10),
6 | search: z.string().optional(),
7 | });
8 |
9 | export const idParamSchema = z.object({
10 | id: z.coerce.number().int().positive(),
11 | });
12 |
13 | export const codeParamSchema = z.object({
14 | regionCode: z.coerce.number().int().positive(),
15 | districtCode: z.coerce.number().int().positive(),
16 | wardCode: z.coerce.number().int().positive(),
17 | });
18 |
19 | export type IdParam = z.infer;
20 | export type CodeParam = z.infer;
21 | export type PaginationQuery = z.infer;
22 |
23 | export interface PaginatedResponse {
24 | data: T[];
25 | pagination: {
26 | page: number;
27 | limit: number;
28 | total: number;
29 | pages: number;
30 | };
31 | }
32 |
33 | export interface SingleResponse {
34 | data: T;
35 | }
36 |
37 | export interface ErrorResponse {
38 | error: {
39 | message: string;
40 | stack?: string;
41 | details?: any;
42 | validationErrors?: ZodIssue[];
43 | };
44 | }
45 |
46 | declare global {
47 | namespace Express {
48 | interface Request<
49 | Params = any,
50 | ReqBody = any,
51 | ReqQuery = any
52 | > {
53 | validatedQuery?: ReqQuery;
54 | validatedParams?: Params;
55 | validatedBody?: ReqBody;
56 | }
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/tests/locations-api.test.ts:
--------------------------------------------------------------------------------
1 | import request from 'supertest';
2 | import app from '../src/app';
3 |
4 | describe('Tanzania Locations API', () => {
5 | // Countries
6 | describe('GET /api/countries', () => {
7 | it('should return a list of countries', async () => {
8 | const res = await request(app).get('/api/countries');
9 | expect(res.statusCode).toEqual(200);
10 | expect(res.body).toHaveProperty('data');
11 | expect(Array.isArray(res.body.data)).toBeTruthy();
12 | });
13 |
14 | it('should support pagination', async () => {
15 | const res = await request(app).get('/api/countries?page=1&limit=5');
16 | expect(res.statusCode).toEqual(200);
17 | expect(res.body.pagination).toMatchObject({ page: 1, limit: 5 });
18 | expect(res.body.data.length).toBeLessThanOrEqual(5);
19 | });
20 | });
21 |
22 | // Regions
23 | describe('GET /api/regions/:code', () => {
24 | it('should return a specific region', async () => {
25 | const res = await request(app).get('/api/regions/41');
26 | expect(res.statusCode).toBe(200);
27 | expect(res.body.data).toHaveProperty('regionCode', 41);
28 | });
29 |
30 | it('should return 404 for non-existent region', async () => {
31 | const res = await request(app).get('/api/regions/40');
32 | expect(res.statusCode).toBe(404);
33 | });
34 |
35 | it('should return 400 for invalid region code', async () => {
36 | const res = await request(app).get('/api/regions/invalid');
37 | expect(res.statusCode).toBe(400);
38 | expect(res.body).toHaveProperty('error');
39 | });
40 | });
41 |
42 | // Regions → Districts
43 | describe('GET /api/regions/:code/districts', () => {
44 | it('should return districts of a specific region', async () => {
45 | const res = await request(app).get('/api/regions/41/districts');
46 | expect(res.statusCode).toBe(200);
47 | expect(Array.isArray(res.body.data)).toBeTruthy();
48 | });
49 |
50 | it('should return 404 for region that doesn’t exist', async () => {
51 | const res = await request(app).get('/api/regions/40/districts');
52 | expect(res.statusCode).toBe(404);
53 | });
54 | });
55 |
56 | // Districts → Wards
57 | describe('GET /api/districts/:code/wards', () => {
58 | it('should return wards for a district', async () => {
59 | const res = await request(app).get('/api/districts/411/wards');
60 | expect(res.statusCode).toBe(200);
61 | expect(Array.isArray(res.body.data)).toBe(true);
62 | });
63 |
64 | it('should return 404 if district not found', async () => {
65 | const res = await request(app).get('/api/districts/00000/wards');
66 | expect(res.statusCode).toBe(404);
67 | });
68 | });
69 |
70 | // Ward Details
71 | describe('GET /api/wards/:code', () => {
72 | it('should return a specific ward', async () => {
73 | const res = await request(app).get('/api/wards/40000');
74 | if (res.statusCode === 200) {
75 | expect(res.body.data).toHaveProperty('wardCode', 41115);
76 | } else {
77 | expect([404, 400]).toContain(res.statusCode);
78 | }
79 | });
80 | });
81 |
82 | // 404 NOT FOUND
83 | describe('Fallback Route', () => {
84 | it('should return 404 for unknown route', async () => {
85 | const res = await request(app).get('/api/unknown/route');
86 | expect(res.statusCode).toBe(404);
87 | expect(res.body).toHaveProperty('error');
88 | });
89 | });
90 | });
91 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es2016",
4 | "lib": ["es2020", "dom"],
5 | "module": "commonjs",
6 | "moduleResolution": "node",
7 | "outDir": "./dist",
8 | "sourceMap": true,
9 | "esModuleInterop": true,
10 | "allowSyntheticDefaultImports": true,
11 | "forceConsistentCasingInFileNames": true,
12 | "strict": true,
13 | "skipLibCheck": true,
14 | "useDefineForClassFields": true
15 | },
16 | "include": ["src/**/*.ts", "server.ts"],
17 | "exclude": ["node_modules"]
18 | }
19 |
--------------------------------------------------------------------------------