├── .env.template ├── .eslintrc.js ├── .github └── workflows │ └── lint.yml ├── .gitignore ├── LICENSE ├── dist └── static │ └── index.html ├── index.d.ts ├── package-lock.json ├── package.json ├── readme.md ├── src ├── classes │ ├── server.ts │ └── sources │ │ ├── Position.d.ts │ │ ├── Source.ts │ │ ├── adsb │ │ └── adsbe.ts │ │ └── ais │ │ ├── mst.ts │ │ └── mt.ts ├── index.ts ├── legacy │ ├── api.ts │ ├── area.ts │ └── lib │ │ └── puppeteer.ts └── static │ └── index.html └── tsconfig.json /.env.template: -------------------------------------------------------------------------------- 1 | PORT=5001 -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | es2021: true, 4 | node: true, 5 | }, 6 | extends: "standard-with-typescript", 7 | overrides: [ 8 | { 9 | env: { 10 | node: true, 11 | }, 12 | files: [".eslintrc.{js,cjs}"], 13 | parserOptions: { 14 | sourceType: "script", 15 | }, 16 | }, 17 | ], 18 | parserOptions: { 19 | ecmaVersion: "latest", 20 | sourceType: "module", 21 | }, 22 | rules: { 23 | 'n/no-callback-literal': 'off', 24 | '@typescript-eslint/explicit-function-return-type': 'off', 25 | '@typescript-eslint/no-floating-promises': 'off', 26 | '@typescript-eslint/strict-boolean-expressions': 'off', 27 | '@typescript-eslint/no-var-requires': 'off', 28 | 'no-constant-condition': 'off', 29 | 'no-callback-literal': 'off', 30 | '@typescript-eslint/ban-types': 'off', 31 | '@typescript-eslint/no-extraneous-class': 'off', 32 | '@typescript-eslint/naming-convention': [ 33 | 'error', 34 | { 35 | selector: 'variable', 36 | format: ['camelCase', 'UPPER_CASE', 'UPPER_CASE', 'snake_case'], 37 | }, 38 | ] 39 | }, 40 | }; 41 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint and Format 2 | on: 3 | push: 4 | pull_request: 5 | jobs: 6 | format: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | with: 11 | ref: ${{ github.head_ref }} 12 | - uses: actions/setup-node@v2 13 | with: 14 | node-version: "18.x" 15 | - run: npm install 16 | - run: npm run lint 17 | - run: npm run prettier 18 | - name: Commit changes 19 | uses: stefanzweifel/git-auto-commit-action@v4 20 | with: 21 | commit_message: Apply linting and formatting changes 22 | branch: ${{ github.head_ref }} 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /node_modules/ 2 | /dist/ 3 | .env 4 | .DS_Store 5 | *.log -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /dist/static/index.html: -------------------------------------------------------------------------------- 1 |

locationsource

2 |

Solution to access machine readable AIS Data. This solution uses the free web solutions to crawl the data and returns them in json.

3 |

As this repo is a successor to the ais-api, lecacy parts are added (see legacy) Those will be removed in future versions.

4 |

Install on local machine

5 |

Requirements: npm & nodejs.

6 |
    7 |
  1. clone this repo

    8 |
  2. 9 |
  3. run npm install

    10 |
  4. 11 |
  5. run npm run dev

    12 |
  6. 13 |
14 |

Location Format

15 |

All locations are returned in this format: 16 | { 17 | timestamp: ISO 8601 18 | latitude: 19 | longitude: 20 | course: in deg 21 | speed: in kn 22 | source: 23 | source_type: e.g. ais 24 | raw_data: (contains all the raw data) 25 | }

26 |

Legacy Paths

27 |

As this repo is a successor to the ais-api, some legacy paths are added. Those will be removed in future versions

28 |

/legacy/getLastPosition/:mmsi

29 |

Takes position from MT and from VT and returns the newest 30 | example: http://localhost:5000/legacy/getLastPosition/211879870

31 |

/legacy/getLastPositionFromVF/:mmsi

32 |

Returns position from VF 33 | example: http://localhost:5000/legacy/getLastPositionFromVF/211281610

34 |

/legacy/getLastPositionFromMT/:mmsi

35 |

Returns position from MT 36 | example: http://localhost:5000/legacy/getLastPositionFromMT/211281610

37 |

/legacy/getVesselsInArea/:area

38 |

Returns all vessels in area, defined by a list of area keywords 39 | example: http://localhost:5000/legacy/getVesselsInArea/WMED,EMED

40 |

/legacy/getVesselsNearMe/:lat/:lng/:distance

41 |

Returns all vessels near me, defined by a location in latitude, longitude, and distance 42 | example: http://localhost:5000/legacy/getVesselsNearMe/51.74190/3.89773/2

43 |
[{
44 |   name: vessel.SHIPNAME,
45 |   id: vessel.SHIP_ID,
46 |   lat: Number(vessel.LAT),
47 |   lon: Number(vessel.LON),
48 |   timestamp: vessel.LAST_POS,
49 |   mmsi: vessel.MMSI,
50 |   imo: vessel.IMO,
51 |   callsign: vessel.CALLSIGN,
52 |   speed: Number(vessel.SPEED),
53 |   area: vessel.AREA_CODE,
54 |   type: vessel.TYPE_SUMMARY,
55 |   country: vessel.COUNTRY,
56 |   destination: vessel.DESTINATION,
57 |   port_current_id: vessel.PORT_ID,
58 |   port_current: vessel.CURRENT_PORT,
59 |   port_next_id: vessel.NEXT_PORT_ID,
60 |   port_next: vessel.NEXT_PORT_NAME,
61 | },…]
62 | 
63 |

/legacy/getVesselsInPort/:shipPort

64 |

Returns all vessels in a port, named after the MT nomenclature 65 | example: http://localhost:5000/legacy/getVesselsInPort/piraeus

66 |

Output format identical to getVesselsInArea

67 |

Paths

68 |

/:sourcetype/:source/:vehicleidentifier/location/latest

69 |

find latest position for vehicle for specified sourcetype and source 70 | example: http://localhost:5000/ais/mt/211281610/location/latest

71 |

/:source/:placeidentifier/vehicles/

72 |

/:source/area/vehicles

73 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | declare module "position-api" { 2 | // Define the exported types and interfaces here 3 | } 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "position-api", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.ts", 6 | "types": "index.d.ts", 7 | "bin": { 8 | "position-api": "src/index.ts" 9 | }, 10 | "scripts": { 11 | "build": "npx tsc", 12 | "start": "ts-node src/index.ts", 13 | "dev": "concurrently \"npx tsc --watch\" \"nodemon -q dist/index.js\"", 14 | "lint": "eslint --ext .ts .", 15 | "lint:fix": "eslint --ext .ts . --fix", 16 | "prettier": "prettier --ignore-path .gitignore --write \"**/*.+(ts|json)\"", 17 | "test": "echo \"Error: no test specified\" && exit 1", 18 | "postinstall": "copyfiles -n .env.template .env" 19 | }, 20 | "author": "", 21 | "license": "ISC", 22 | "devDependencies": { 23 | "@types/node": "^18.19.9", 24 | "@types/node-fetch": "^2.6.4", 25 | "@typescript-eslint/eslint-plugin": "^6.13.2", 26 | "concurrently": "^7.6.0", 27 | "copyfiles": "^2.4.1", 28 | "eslint": "^8.55.0", 29 | "eslint-config-standard-with-typescript": "^40.0.0", 30 | "eslint-plugin-import": "^2.29.0", 31 | "eslint-plugin-n": "^16.3.1", 32 | "eslint-plugin-promise": "^6.1.1", 33 | "moment": "^2.30.1", 34 | "nodemon": "^2.0.20", 35 | "prettier": "^3.1.0", 36 | "typescript": "^5.3.3" 37 | }, 38 | "dependencies": { 39 | "@types/cors": "^2.8.17", 40 | "@types/express": "^4.17.17", 41 | "@types/node": "^18.19.9", 42 | "brotli": "^1.3.3", 43 | "cheerio": "^1.0.0-rc.12", 44 | "cors": "^2.8.5", 45 | "dotenv": "^16.4.1", 46 | "express": "^4.19.2", 47 | "moment": "^2.30.1", 48 | "path": "^0.12.7", 49 | "puppeteer": "^19.11.1", 50 | "request": "^2.88.2" 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | this repo is discontinued for now 2 | 3 | # locationsource 4 | 5 | Solution to access machine readable AIS Data. This solution uses the free web solutions to crawl the data and returns them in json. 6 | 7 | As this repo is a successor to the ais-api, lecacy parts are added (see legacy) Those will be removed in future versions. 8 | 9 | 10 | ## Install on local machine 11 | 12 | Requirements: npm & nodejs. 13 | 14 | 1. clone this repo 15 | 16 | 2. run `npm install` 17 | 18 | 3. run `npm run dev` 19 | 20 | ### Location Format 21 | All locations are returned in this format: 22 | { 23 | timestamp: ISO 8601 24 | latitude: 25 | longitude: 26 | course: in deg 27 | speed: in kn 28 | source: 29 | source_type: e.g. ais 30 | raw_data: (contains all the raw data) 31 | } 32 | 33 | ### Legacy Paths 34 | 35 | As this repo is a successor to the ais-api, some legacy paths are added. Those will be removed in future versions 36 | 37 | 38 | #### /legacy/getLastPosition/:mmsi 39 | 40 | Takes position from MT and from VT and returns the newest 41 | example: http://localhost:5000/legacy/getLastPosition/211879870 42 | 43 | #### /legacy/getLastPositionFromVF/:mmsi 44 | 45 | Returns position from VF 46 | example: http://localhost:5000/legacy/getLastPositionFromVF/211281610 47 | 48 | #### /legacy/getLastPositionFromMT/:mmsi 49 | 50 | Returns position from MT 51 | example: http://localhost:5000/legacy/getLastPositionFromMT/211281610 52 | 53 | #### /legacy/getVesselsInArea/:area 54 | 55 | Returns all vessels in area, defined by a list of area keywords 56 | example: http://localhost:5000/legacy/getVesselsInArea/WMED,EMED 57 | 58 | #### /legacy/getVesselsNearMe/:lat/:lng/:distance 59 | 60 | Returns all vessels near me, defined by a location in latitude, longitude, and distance 61 | example: http://localhost:5000/legacy/getVesselsNearMe/51.74190/3.89773/2 62 | 63 | ```Javascript 64 | [{ 65 | name: vessel.SHIPNAME, 66 | id: vessel.SHIP_ID, 67 | lat: Number(vessel.LAT), 68 | lon: Number(vessel.LON), 69 | timestamp: vessel.LAST_POS, 70 | mmsi: vessel.MMSI, 71 | imo: vessel.IMO, 72 | callsign: vessel.CALLSIGN, 73 | speed: Number(vessel.SPEED), 74 | area: vessel.AREA_CODE, 75 | type: vessel.TYPE_SUMMARY, 76 | country: vessel.COUNTRY, 77 | destination: vessel.DESTINATION, 78 | port_current_id: vessel.PORT_ID, 79 | port_current: vessel.CURRENT_PORT, 80 | port_next_id: vessel.NEXT_PORT_ID, 81 | port_next: vessel.NEXT_PORT_NAME, 82 | },…] 83 | ``` 84 | 85 | #### /legacy/getVesselsInPort/:shipPort 86 | 87 | Returns all vessels in a port, named after the MT nomenclature 88 | example: http://localhost:5000/legacy/getVesselsInPort/piraeus 89 | 90 | Output format identical to **getVesselsInArea** 91 | 92 | 93 | ### Paths 94 | 95 | #### /:sourcetype/:source/:vehicleidentifier/location/latest 96 | find latest position for vehicle for specified sourcetype and source 97 | example: http://localhost:5000/ais/mt/211281610/location/latest 98 | 99 | #### /:source/:placeidentifier/vehicles/ 100 | 101 | #### /:source/area/vehicles 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /src/classes/server.ts: -------------------------------------------------------------------------------- 1 | import express from "express"; 2 | import cors from "cors"; 3 | import path from "path"; 4 | import { api } from "../legacy/api"; 5 | import { areaApi } from "../legacy/area"; 6 | import ADSBexchange from "./sources/adsb/adsbe"; 7 | class Server { 8 | app: any; 9 | constructor(port) { 10 | this.init(port); 11 | } 12 | 13 | init(port: number) { 14 | this.app = express(); 15 | this.app.set("port", port); 16 | this.app.use( 17 | cors({ 18 | origin: "*", 19 | }), 20 | ); 21 | this.app.get("/", (_request: any, response: any) => { 22 | response.sendFile(path.join(__dirname, "/../static/index.html")); 23 | }); 24 | this.loadLegacyRoutes(); 25 | this.loadRoutes(); 26 | this.app.listen(this.app.get("port"), () => { 27 | console.log("Node this.app is running on port", this.app.get("port")); 28 | }); 29 | } 30 | 31 | loadRoutes() { 32 | // /:sourcetype/:source/:vehicleidentifier/location/latest 33 | this.app.get( 34 | "/adsb/adsbe/:icao/location/latest", 35 | async (req: any, res: any) => { 36 | console.log(req.params.icao); 37 | const adsbe = new ADSBexchange(); 38 | const location = await adsbe.getLocation(req.params.icao); 39 | console.log(location); 40 | res.send({ 41 | error: null, 42 | data: location, 43 | }); 44 | }, 45 | ); 46 | } 47 | 48 | loadLegacyRoutes() { 49 | // this route is wrongly named on purpose for legacy reasons. 50 | // AS VF is not as easy to reverse as the other ones, it is replaced by MST 51 | this.app.get( 52 | "/legacy/getLastPositionFromVF/:mmsi", 53 | (req: any, res: any) => { 54 | api.getLocationFromMST(req.params.mmsi, (result) => { 55 | res.send(result); 56 | }); 57 | }, 58 | ); 59 | this.app.get( 60 | "/legacy/getLastPositionFromMT/:mmsi", 61 | (req: any, res: any) => { 62 | api.getLocationFromMT(req.params.mmsi, (result) => { 63 | res.send(result); 64 | }); 65 | }, 66 | ); 67 | this.app.get("/legacy/getLastPosition/:mmsi", (req: any, res: any) => { 68 | api.getLocation(req.params.mmsi, (result) => { 69 | res.send(result); 70 | }); 71 | }); 72 | // e.g. /getVesselsInArea/WMED,EMED 73 | this.app.get( 74 | "/legacy/getVesselsInArea/:area", 75 | async (req: any, res: any) => { 76 | await areaApi.fetchVesselsInArea( 77 | req.params.area.split(","), 78 | (result) => { 79 | res.json(result); 80 | }, 81 | ); 82 | }, 83 | ); 84 | this.app.get( 85 | "/legacy/getVesselsNearMe/:lat/:lng/:distance", 86 | async (req: any, res: any) => { 87 | await areaApi.fetchVesselsNearMe( 88 | req.params.lat, 89 | req.params.lng, 90 | req.params.distance, 91 | (result) => { 92 | res.json(result); 93 | }, 94 | ); 95 | }, 96 | ); 97 | this.app.get("/legacy/getVesselsInPort/:shipPort", (req: any, res: any) => { 98 | api.getVesselsInPort(req.params.shipPort, (result) => { 99 | res.send(result); 100 | }); 101 | }); 102 | } 103 | } 104 | 105 | export default Server; 106 | -------------------------------------------------------------------------------- /src/classes/sources/Position.d.ts: -------------------------------------------------------------------------------- 1 | declare module "PositionTypes" { 2 | export interface Position { 3 | timestamp: string; 4 | latitude: number; 5 | longitude: number; 6 | course: number; 7 | speed: number; 8 | source: string; 9 | source_type: string; 10 | altitude?: number; 11 | raw?: any; 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/classes/sources/Source.ts: -------------------------------------------------------------------------------- 1 | import fetch from "node-fetch"; 2 | import puppeteer from "puppeteer"; 3 | 4 | class Source { 5 | browser: any; 6 | constructor() { 7 | this.browser = false; 8 | } 9 | 10 | getBrowser: any = async () => { 11 | if (this.browser) { 12 | return this.browser; 13 | } 14 | this.browser = await puppeteer.launch({ 15 | headless: true, 16 | defaultViewport: { 17 | width: 1280, // Width of a MacBook screen 18 | height: 1400, // Height of a MacBook screen 19 | }, 20 | // waitUntil: "domcontentloaded", 21 | args: [ 22 | "--user-agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36", 23 | ], 24 | }); 25 | return this.browser; 26 | }; 27 | 28 | convertRawCoordinatesIntoDecimal(input): number { 29 | const grade = parseInt(input.substring(0, input.indexOf("°"))); 30 | const rest = input.substring(input.indexOf("°") + 1); 31 | const minutes = parseInt(rest.substring(0, rest.indexOf("'"))); 32 | const seconds = parseInt( 33 | rest.substring(rest.indexOf("'") + 1).split('"')[0], 34 | ); 35 | return grade + (minutes + seconds / 60) / 60; 36 | } 37 | 38 | fetch = async function (url: string, headers: any, method: string) { 39 | const response = await fetch(url, { 40 | headers, 41 | body: undefined, 42 | method, 43 | }); 44 | const text = await response.text(); 45 | return text; 46 | }; 47 | } 48 | 49 | export default Source; 50 | -------------------------------------------------------------------------------- /src/classes/sources/adsb/adsbe.ts: -------------------------------------------------------------------------------- 1 | import Source from "../Source"; 2 | import fetch from "node-fetch"; 3 | 4 | class ADSBExchange extends Source { 5 | parseLocation = async function (result: any) { 6 | const location = { 7 | timestamp: result.timestamp, 8 | latitude: result.latitude, 9 | longitude: result.longitude, 10 | course: result.course, 11 | speed: result.speed, 12 | raw: result.raw, 13 | source: "adsbExchange", 14 | source_type: "adsb", 15 | }; 16 | return location; 17 | }; 18 | 19 | getLocation = async (icao: string) => { 20 | /// 21 | const response = await fetch( 22 | `https://globe.adsbexchange.com/data/traces/${icao.slice( 23 | -2, 24 | )}/trace_recent_${icao}.json`, 25 | { 26 | headers: { 27 | accept: "application/json, text/javascript, */*; q=0.01", 28 | "accept-language": "de-DE,de;q=0.9", 29 | "sec-ch-ua": 30 | '"Chromium";v="116", "Not)A;Brand";v="24", "Brave";v="116"', 31 | "sec-ch-ua-mobile": "?0", 32 | "sec-ch-ua-platform": '"macOS"', 33 | "sec-fetch-dest": "empty", 34 | "sec-fetch-mode": "cors", 35 | "sec-fetch-site": "same-origin", 36 | "sec-gpc": "1", 37 | "x-requested-with": "XMLHttpRequest", 38 | Referer: "https://globe.adsbexchange.com/?icao=39e68b", 39 | "Referrer-Policy": "strict-origin-when-cross-origin", 40 | }, 41 | body: undefined, 42 | method: "GET", 43 | }, 44 | ); 45 | const bodyjson = await response.json(); 46 | const timestamp = bodyjson.timestamp; 47 | const trace = bodyjson.trace; 48 | const last_trace = trace[trace.length - 1]; 49 | const [time_offset, lat, lon, alt_baro, ground_speed, ground_track] = 50 | last_trace; 51 | const last_trace_timestamp = timestamp + time_offset; 52 | const location = this.parseLocation({ 53 | timestamp: last_trace_timestamp, 54 | latitude: lat, 55 | longitude: lon, 56 | course: ground_track, 57 | speed: ground_speed, // knots 58 | altitude: alt_baro, 59 | raw: bodyjson, 60 | }); 61 | return await location; 62 | }; 63 | 64 | getLocationFull = async (icao: string) => { 65 | /// 66 | const response = await fetch( 67 | `https://globe.adsbexchange.com/data/traces/${icao.slice( 68 | -2, 69 | )}/trace_full_${icao}.json`, 70 | { 71 | headers: { 72 | accept: "application/json, text/javascript, */*; q=0.01", 73 | "accept-language": "de-DE,de;q=0.9", 74 | "sec-ch-ua": 75 | '"Chromium";v="116", "Not)A;Brand";v="24", "Brave";v="116"', 76 | "sec-ch-ua-mobile": "?0", 77 | "sec-ch-ua-platform": '"macOS"', 78 | "sec-fetch-dest": "empty", 79 | "sec-fetch-mode": "cors", 80 | "sec-fetch-site": "same-origin", 81 | "sec-gpc": "1", 82 | "x-requested-with": "XMLHttpRequest", 83 | Referer: "https://globe.adsbexchange.com/?icao=39e68b", 84 | "Referrer-Policy": "strict-origin-when-cross-origin", 85 | }, 86 | body: undefined, 87 | method: "GET", 88 | }, 89 | ); 90 | const bodyjson = await response.json(); 91 | const timestamp = bodyjson.timestamp; 92 | const trace = bodyjson.trace; 93 | 94 | console.log(trace); 95 | const last_trace = trace[trace.length - 1]; 96 | const [ 97 | time_offset, 98 | lat, 99 | lon, 100 | alt_baro, 101 | ground_speed, 102 | unknown2, 103 | unknown3, 104 | unknown4, 105 | unknown5, 106 | ] = last_trace; 107 | console.log("check that lat and lon in correct order!!"); 108 | console.log("last trace"); 109 | console.log(last_trace); 110 | console.log("========="); 111 | const last_trace_timestamp = timestamp + time_offset; 112 | console.log(last_trace_timestamp); 113 | console.log(new Date(last_trace_timestamp * 1000)); 114 | console.log( 115 | time_offset, 116 | lat, 117 | lon, 118 | alt_baro, 119 | ground_speed, 120 | unknown2, 121 | unknown3, 122 | unknown4, 123 | unknown5, 124 | ); 125 | }; 126 | } 127 | 128 | export default ADSBExchange; 129 | -------------------------------------------------------------------------------- /src/classes/sources/ais/mst.ts: -------------------------------------------------------------------------------- 1 | import Source from "../Source"; 2 | class MyShipTracking extends Source { 3 | parseLocation = async function (result: any) { 4 | const location = { 5 | timestamp: result.timestamp, 6 | latitude: result.latitude, 7 | longitude: result.longitude, 8 | course: result.course, 9 | speed: result.speed, 10 | source: "myshiptracking.com", 11 | source_type: "AIS", 12 | }; 13 | return location; 14 | }; 15 | 16 | // the method in the sources class does not work if no seconds are in the string 17 | dmsToDecimalDegreesMST = function (dms) { 18 | console.log(dms); 19 | return parseFloat(dms); 20 | }; 21 | 22 | getLocation = async (mmsi: number) => { 23 | const result = await this.fetch( 24 | "https://www.myshiptracking.com/vessels/mmsi-" + mmsi, 25 | { 26 | accept: 27 | "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8", 28 | "accept-language": "de-DE,de;q=0.6", 29 | "cache-control": "max-age=0", 30 | "sec-ch-ua": 31 | '"Chromium";v="116", "Not)A;Brand";v="24", "Brave";v="116"', 32 | "sec-ch-ua-mobile": "?0", 33 | "sec-ch-ua-platform": '"macOS"', 34 | "sec-fetch-dest": "document", 35 | "sec-fetch-mode": "navigate", 36 | "sec-fetch-site": "none", 37 | "sec-fetch-user": "?1", 38 | "sec-gpc": "1", 39 | "upgrade-insecure-requests": "1", 40 | cookie: 41 | "usr_lang_exist=1; port_tz=LT; user_tz=MT; user_df=1; session_id_sp_trk=fd1i0pb2mt6i4nra9c1mejsmvk; offset=Europe%2FBerlin; usr_lang_exist=1; io=ilOBwd-Xh9Z1fGzpFaM0", 42 | }, 43 | "GET", 44 | ); 45 | const pattern = 46 | /(Longitude|Latitude|Course|Speed|Position Received)<\/th>\s*(.*?)<\/td>/g; 47 | const extractedData: any = {}; 48 | let match, parsedDate; 49 | 50 | while ((match = pattern.exec(result)) !== null) { 51 | const key = match[1]; 52 | const value = match[2]; 53 | extractedData[key] = value; 54 | } 55 | 56 | console.log(extractedData["Position Received"]); 57 | console.log(123); 58 | 59 | // Extract the date and time string using regular expression 60 | const regex = /title="([^"]+)"/; 61 | const matchd = extractedData["Position Received"].match(regex); 62 | 63 | if (matchd?.[1]) { 64 | const dateTimeString = matchd[1]; 65 | 66 | // Parse the extracted date and time string 67 | const [datePart, timePart] = dateTimeString.split(" "); 68 | const [year, month, day] = datePart.split("-"); 69 | const [hour, minute] = timePart.split(":"); 70 | 71 | // JavaScript months are 0-based, so subtract 1 from the month 72 | parsedDate = new Date(year, month - 1, day, hour, minute); 73 | 74 | console.log(parsedDate); // This will log the parsed date object 75 | } else { 76 | console.log("Date not found in the input string."); 77 | } 78 | 79 | const position = { 80 | latitude: this.dmsToDecimalDegreesMST(extractedData.Latitude), 81 | longitude: this.dmsToDecimalDegreesMST(extractedData.Longitude), 82 | course: 10, 83 | speed: parseFloat(extractedData.Speed), 84 | timestamp: new Date(parsedDate).toISOString(), 85 | }; 86 | console.log(position); 87 | return position; 88 | }; 89 | } 90 | 91 | export default MyShipTracking; 92 | -------------------------------------------------------------------------------- /src/classes/sources/ais/mt.ts: -------------------------------------------------------------------------------- 1 | import Source from "../Source"; 2 | class Marinetraffic extends Source { 3 | parseLocation = async function (result: any) { 4 | const location = { 5 | timestamp: result.timestamp, 6 | latitude: result.latitude, 7 | longitude: result.longitude, 8 | course: result.course, 9 | speed: result.speed, 10 | source: "Marinetraffic", 11 | source_type: "AIS", 12 | }; 13 | return location; 14 | }; 15 | 16 | getLocation = async (mmsi: number) => { 17 | const browser = await this.getBrowser(); 18 | const page = await browser.newPage(); 19 | 20 | const url = 21 | "https://www.marinetraffic.com/en/ais/details/ships/mmsi:" + mmsi; 22 | await page.goto(url); 23 | // let parsedData = null; 24 | 25 | const waitForResponse = new Promise((resolve) => { 26 | page.on("response", async (response) => { 27 | const request = response.request(); 28 | if (request.url().includes("latestPosition")) { 29 | const jsonresult = await response.text(); 30 | const parsedData = JSON.parse(jsonresult); 31 | resolve(parsedData); 32 | } 33 | }); 34 | }); 35 | 36 | const parsedData: any = await waitForResponse; 37 | browser.close(); 38 | const result = { 39 | course: parseFloat(parsedData.course), 40 | speed: parseFloat(parsedData.speed), 41 | latitude: parseFloat(parsedData.lat), 42 | longitude: parseFloat(parsedData.lon), 43 | timestamp: new Date(parsedData.lastPos * 1000).toISOString(), // assuming lastPos is in seconds 44 | }; 45 | return await this.parseLocation(result); 46 | }; 47 | } 48 | 49 | export default Marinetraffic; 50 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ts-node 2 | import dotenv from "dotenv"; 3 | import Server from "./classes/server"; 4 | 5 | dotenv.config(); 6 | 7 | const port = process.env.PORT ?? 5000; 8 | // eslint-disable-next-line no-new 9 | new Server(port); 10 | -------------------------------------------------------------------------------- /src/legacy/api.ts: -------------------------------------------------------------------------------- 1 | import Marinetraffic from "../classes/sources/ais/mt"; 2 | import MyShipTracking from "../classes/sources/ais/mst"; 3 | 4 | const moment = require("moment"); 5 | const request = require("request"); 6 | 7 | const debug = (...args) => { 8 | if (true) { 9 | console.log.apply(console, args); 10 | } 11 | }; 12 | 13 | async function getLocationFromVF(mmsi, cb) { 14 | await getLocationFromMST(mmsi, cb); 15 | } 16 | 17 | async function getLocationFromMST(mmsi, cb) { 18 | const mst = new MyShipTracking(); 19 | try { 20 | const location = await mst.getLocation(mmsi); 21 | console.log(location); 22 | cb({ 23 | error: null, 24 | data: location, 25 | }); 26 | } catch (e) { 27 | cb({ 28 | error: e, 29 | data: null, 30 | }); 31 | } 32 | } 33 | 34 | async function getLocationFromMT(mmsi, cb) { 35 | const mt = new Marinetraffic(); 36 | 37 | try { 38 | const location = await mt.getLocation(mmsi); 39 | console.log(location); 40 | cb({ 41 | error: null, 42 | data: location, 43 | }); 44 | } catch (e) { 45 | cb({ 46 | error: e, 47 | data: null, 48 | }); 49 | } 50 | } 51 | 52 | function getLocation(mmsi, cb) { 53 | debug("getting location for vessel: ", mmsi); 54 | getLocationFromVF(mmsi, function (VFResult) { 55 | debug("got location from vf", VFResult); 56 | 57 | getLocationFromMT(mmsi, function (MTResult) { 58 | if (MTResult.error) { 59 | cb(VFResult); 60 | } else { 61 | debug("got location from mt", MTResult); 62 | if (!VFResult.data) { 63 | return cb(MTResult); 64 | } 65 | const vfDate = moment(VFResult.data.timestamp); 66 | const mtDate = moment(MTResult.data.timestamp); 67 | const secondsDiff = mtDate.diff(vfDate, "seconds"); 68 | debug("time diff in seconds: ", secondsDiff); 69 | 70 | cb(secondsDiff > 0 ? MTResult : VFResult); 71 | } 72 | }); 73 | }); 74 | } 75 | 76 | function getVesselsInPort(shipPort, cb) { 77 | const url = `https://www.marinetraffic.com/en/reports?asset_type=vessels&columns=flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,time_of_latest_position,lat_of_latest_position,lon_of_latest_position,current_port_country,notes¤t_port_in_name=${shipPort}`; 78 | debug("getVesselsInPort", url); 79 | 80 | const headers = { 81 | accept: "*/*", 82 | "Accept-Language": "en-US,en;q=0.5", 83 | "Accept-Encoding": "gzip, deflate, brotli", 84 | "Vessel-Image": "0053e92efe9e7772299d24de2d0985adea14", 85 | "X-Requested-With": "XMLHttpRequest", 86 | }; 87 | const options = { 88 | url, 89 | headers, 90 | json: true, 91 | gzip: true, 92 | deflate: true, 93 | brotli: true, 94 | }; 95 | request(options, function (error, response, html) { 96 | if ( 97 | (!error && response.statusCode === 200) || 98 | (typeof response !== "undefined" && response.statusCode === 403) 99 | ) { 100 | return cb( 101 | response.body.data.map((vessel) => ({ 102 | name: vessel.SHIPNAME, 103 | id: vessel.SHIP_ID, 104 | lat: Number(vessel.LAT), 105 | lon: Number(vessel.LON), 106 | timestamp: vessel.LAST_POS, 107 | mmsi: vessel.MMSI, 108 | imo: vessel.IMO, 109 | callsign: vessel.CALLSIGN, 110 | speed: Number(vessel.SPEED), 111 | area: vessel.AREA_CODE, 112 | type: vessel.TYPE_SUMMARY, 113 | country: vessel.COUNTRY, 114 | destination: vessel.DESTINATION, 115 | port_current_id: vessel.PORT_ID, 116 | port_current: vessel.CURRENT_PORT, 117 | port_next_id: vessel.NEXT_PORT_ID, 118 | port_next: vessel.NEXT_PORT_NAME, 119 | })), 120 | ); 121 | } else { 122 | debug("error in getVesselsInPort"); 123 | cb({ error: "an unknown error occured" }); 124 | return false; 125 | } 126 | }); 127 | } 128 | 129 | export class api { 130 | static getLocationFromVF = getLocationFromVF; 131 | static getLocationFromMT = getLocationFromMT; 132 | static getLocationFromMST = getLocationFromMST; 133 | static getLocation = getLocation; 134 | static getVesselsInPort = getVesselsInPort; 135 | } 136 | -------------------------------------------------------------------------------- /src/legacy/area.ts: -------------------------------------------------------------------------------- 1 | const scraper = require("./lib/puppeteer"); 2 | 3 | const fetchResultByArea = async (area, time, cb) => { 4 | await scraper.fetch( 5 | { 6 | url: `https://www.marinetraffic.com/en/reports?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position&area_in=${area}&time_of_latest_position_between=${time}`, 7 | referer: 8 | "https://www.marinetraffic.com/en/data/?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position&area_in|in|West%20Mediterranean,East%20Mediterranean|area_in=WMED,EMED&time_of_latest_position_between|gte|time_of_latest_position_between=60,525600", 9 | responseSelector: "/en/reports?", 10 | extraHeaders: { 11 | "vessel-image": "0053e92efe9e7772299d24de2d0985adea14", 12 | }, 13 | }, 14 | cb, 15 | ); 16 | }; 17 | 18 | const mapResult = (result) => { 19 | return result.data.map((vessel) => ({ 20 | name: vessel.SHIPNAME, 21 | id: vessel.SHIP_ID, 22 | lat: Number(vessel.LAT), 23 | lon: Number(vessel.LON), 24 | timestamp: vessel.LAST_POS, 25 | mmsi: vessel.MMSI, 26 | imo: vessel.IMO, 27 | callsign: vessel.CALLSIGN, 28 | speed: Number(vessel.SPEED), 29 | area: vessel.AREA_CODE, 30 | type: vessel.TYPE_SUMMARY, 31 | country: vessel.COUNTRY, 32 | destination: vessel.DESTINATION, 33 | port_current_id: vessel.PORT_ID, 34 | port_current: vessel.CURRENT_PORT, 35 | port_next_id: vessel.NEXT_PORT_ID, 36 | port_next: vessel.NEXT_PORT_NAME, 37 | })); 38 | }; 39 | 40 | const fetchVesselsInArea: Function = (regions = ["WMED", "EMED"], cb) => { 41 | const timeframe = [60, 525600]; 42 | fetchResultByArea(regions.join(","), timeframe.join(","), (result) => { 43 | if (!result?.data.length) { 44 | return cb(null); 45 | } 46 | return cb(mapResult(result)); 47 | }); 48 | }; 49 | 50 | const fetchResultNearMe = async (lat, lng, distance, time, cb) => { 51 | await scraper.fetch( 52 | { 53 | url: `https://www.marinetraffic.com/en/reports?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position&time_of_latest_position_between=${time}&near_me=${lat},${lng},${distance}`, 54 | referer: 55 | "https://www.marinetraffic.com/en/data/?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position&area_in|in|West%20Mediterranean,East%20Mediterranean|area_in=WMED,EMED&time_of_latest_position_between|gte|time_of_latest_position_between=60,525600", 56 | responseSelector: "/en/reports?", 57 | extraHeaders: { 58 | "vessel-image": "0053e92efe9e7772299d24de2d0985adea14", 59 | }, 60 | }, 61 | cb, 62 | ); 63 | }; 64 | 65 | const fetchVesselsNearMe: Function = ( 66 | lat = 51.7419, 67 | lng = 3.89773, 68 | distance = 2, 69 | cb, 70 | ) => { 71 | const timeframe = [60, 525600]; 72 | fetchResultNearMe(lat, lng, distance, timeframe.join(","), (result: any) => { 73 | if (!result?.data.length) { 74 | return cb(null); 75 | } 76 | return cb(mapResult(result)); 77 | }); 78 | }; 79 | 80 | export class areaApi { 81 | static fetchVesselsInArea = fetchVesselsInArea; 82 | static fetchVesselsNearMe = fetchVesselsNearMe; 83 | } 84 | -------------------------------------------------------------------------------- /src/legacy/lib/puppeteer.ts: -------------------------------------------------------------------------------- 1 | const puppeteer = require("puppeteer"); 2 | const scrapeJsonFromResponse = async (options, cb) => { 3 | const browser = await puppeteer.launch({ 4 | args: [ 5 | // Required for Docker version of Puppeteer 6 | "--no-sandbox", 7 | "--disable-setuid-sandbox", 8 | // This will write shared memory files into /tmp instead of /dev/shm, 9 | // because Docker’s default for /dev/shm is 64MB 10 | "--disable-dev-shm-usage", 11 | ], 12 | }); 13 | const page = await browser.newPage(); 14 | await page.setExtraHTTPHeaders({ 15 | "x-requested-with": "XMLHttpRequest", 16 | referer: options.referer, 17 | ...options.extraHeaders, 18 | }); 19 | page.on("request", (interceptedRequest) => { 20 | const reqUrl = interceptedRequest.url(); 21 | console.log("A request was started: ", reqUrl); 22 | }); 23 | page.on("requestfinished", async (request) => { 24 | const resUrl = request.url(); 25 | if (resUrl.indexOf(options.responseSelector) !== -1) { 26 | const response = request.response(); 27 | const json = await response.json(); 28 | console.log("A response was received: ", await response.url()); 29 | cb(json); 30 | } 31 | }); 32 | // Mock real desktop chrome 33 | page.setViewport({ 34 | height: 1302, 35 | width: 2458, 36 | }); 37 | page.setUserAgent( 38 | "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36", 39 | ); 40 | await page.evaluateOnNewDocument(() => { 41 | Object.defineProperty(navigator, "languages", { 42 | get: function () { 43 | return ["en-US", "en", "de-DE"]; 44 | }, 45 | }); 46 | Object.defineProperty(navigator, "plugins", { 47 | get: function () { 48 | // this just needs to have `length > 0`, but we could mock the plugins too 49 | return [1, 2, 3, 4, 5]; 50 | }, 51 | }); 52 | }); 53 | 54 | await page.goto(options.url, { waitUntil: "networkidle0" }); 55 | 56 | await browser.close(); 57 | }; 58 | 59 | module.exports = { 60 | fetch: scrapeJsonFromResponse, 61 | }; 62 | -------------------------------------------------------------------------------- /src/static/index.html: -------------------------------------------------------------------------------- 1 |

locationsource

2 |

Solution to access machine readable AIS Data. This solution uses the free web solutions to crawl the data and returns them in json.

3 |

How to use

4 |

Paths

5 |

/:sourcetype/:source/:vehicleidentifier/location/latest

6 |

find latest position for vehicle for specified sourcetype and source 7 | example: http://localhost:5000/ais/mt/211281610/location/latest

8 |

/:source/:placeidentifier/vehicles/

9 |

/:source/area/vehicles

10 |

Legacy Paths

11 |

As this repo is a successor to the ais-api, some legacy paths are added. Those will be removed in future versions

12 |

/legacy/getLastPosition/:mmsi

13 |

Takes position from MT and from VT and returns the newest 14 | example: http://localhost:5000/legacy/getLastPosition/211281610

15 |

/legacy/getLastPositionFromVF/:mmsi

16 |

Returns position from VF 17 | example: http://localhost:5000/legacy/getLastPositionFromVF/211281610

18 |

/legacy/getLastPositionFromMT/:mmsi

19 |

Returns position from MT 20 | example: http://localhost:5000/legacy/getLastPositionFromMT/211281610

21 |

/legacy/getVesselsInArea/:area

22 |

Returns all vessels in area, defined by a list of area keywords 23 | example: http://localhost:5000/legacy/getVesselsInArea/WMED,EMED

24 |

/legacy/getVesselsNearMe/:lat/:lng/:distance

25 |

Returns all vessels near me, defined by a location in latitude, longitude, and distance 26 | example: http://localhost:5000/legacy/getVesselsNearMe/51.74190/3.89773/2

27 |
[{
28 |   name: vessel.SHIPNAME,
29 |   id: vessel.SHIP_ID,
30 |   lat: Number(vessel.LAT),
31 |   lon: Number(vessel.LON),
32 |   timestamp: vessel.LAST_POS,
33 |   mmsi: vessel.MMSI,
34 |   imo: vessel.IMO,
35 |   callsign: vessel.CALLSIGN,
36 |   speed: Number(vessel.SPEED),
37 |   area: vessel.AREA_CODE,
38 |   type: vessel.TYPE_SUMMARY,
39 |   country: vessel.COUNTRY,
40 |   destination: vessel.DESTINATION,
41 |   port_current_id: vessel.PORT_ID,
42 |   port_current: vessel.CURRENT_PORT,
43 |   port_next_id: vessel.NEXT_PORT_ID,
44 |   port_next: vessel.NEXT_PORT_NAME,
45 | },…]
46 | 
47 |

/legacy/getVesselsInPort/:shipPort

48 |

Returns all vessels in a port, named after the MT nomenclature 49 | example: http://localhost:5000/legacy/getVesselsInPort/piraeus

50 |

Output format identical to getVesselsInArea

51 |

Install on local machine

52 |

Requirements: npm & nodejs.

53 |
    54 |
  1. clone this repo

    55 |
  2. 56 |
  3. run npm install

    57 |
  4. 58 |
  5. run npm run dev

    59 |
  6. 60 |
61 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig to read more about this file */ 4 | 5 | /* Projects */ 6 | // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ 7 | // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ 8 | // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ 9 | // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ 10 | // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ 11 | // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ 12 | /* Language and Environment */ 13 | "target": "es2017" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, 14 | // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ 15 | // "jsx": "preserve", /* Specify what JSX code is generated. */ 16 | // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ 17 | // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ 18 | // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ 19 | // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ 20 | // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ 21 | // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ 22 | // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ 23 | // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ 24 | // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ 25 | 26 | /* Modules */ 27 | "module": "commonjs" /* Specify what module code is generated. */, 28 | "rootDir": "src" /* Specify the root folder within your source files. */, 29 | // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ 30 | // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ 31 | // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ 32 | // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ 33 | // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ 34 | // "types": [], /* Specify type package names to be included without being referenced in a source file. */ 35 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 36 | // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ 37 | // "resolveJsonModule": true, /* Enable importing .json files. */ 38 | // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ 39 | 40 | /* JavaScript Support */ 41 | // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ 42 | // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ 43 | // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ 44 | 45 | /* Emit */ 46 | // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ 47 | // "declarationMap": true, /* Create sourcemaps for d.ts files. */ 48 | // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ 49 | // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ 50 | // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ 51 | "outDir": "./dist" /* Specify an output folder for all emitted files. */, 52 | // "removeComments": true, /* Disable emitting comments. */ 53 | // "noEmit": true, /* Disable emitting files from a compilation. */ 54 | // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ 55 | // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ 56 | // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ 57 | // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ 58 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 59 | // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ 60 | // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ 61 | // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ 62 | // "newLine": "crlf", /* Set the newline character for emitting files. */ 63 | // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ 64 | // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ 65 | // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ 66 | // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ 67 | // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ 68 | // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ 69 | 70 | /* Interop Constraints */ 71 | // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ 72 | // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ 73 | "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, 74 | // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ 75 | "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, 76 | 77 | /* Type Checking */ 78 | "strict": true /* Enable all strict type-checking options. */, 79 | "noImplicitAny": false /* Enable error reporting for expressions and declarations with an implied 'any' type. */, 80 | // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ 81 | // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ 82 | // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ 83 | // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ 84 | // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ 85 | // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ 86 | // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ 87 | // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ 88 | // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ 89 | // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ 90 | // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ 91 | // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ 92 | // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ 93 | // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ 94 | // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ 95 | // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ 96 | // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ 97 | 98 | /* Completeness */ 99 | // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ 100 | "skipLibCheck": true /* Skip type checking all .d.ts files. */, 101 | "lib": ["dom"] 102 | } 103 | } 104 | --------------------------------------------------------------------------------