universal-parcel-scraper 0.0.0-stage → 0.2.1-main.296

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,15 @@
+Universal Parcel Scraper contains code extracted from plhery/delivery-tracker.
+Core code is distributed under Apache-2.0; see LICENSE.
+
+The optional trawl/ derivative and image are distributed under AGPL-3.0,
+including modifications to germondai/trawl. See trawl/LICENSE and trawl/SOURCE.md.
+
+The Correios CAPTCHA model is derived from opastorello/correios-rastreamento
+and retains its MIT license in dist/carriers/correios-br/model/LICENSE and
+carriers/correios-br/model/LICENSE. See that folder's README for provenance.
+
+The places gazetteer includes GeoNames data (https://www.geonames.org),
+licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
+Facility coordinates include OpenStreetMap data (https://www.openstreetmap.org/copyright),
+licensed under the Open Database License. Natural Earth country label points
+(https://www.naturalearthdata.com) are public domain.

package/README.md

@@ -1,3 +1,257 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<img src="docs/assets/logo.svg" width="88" alt="">
+
+# Universal Parcel Scraper
+
+**Parcel tracking that asks the carrier directly, from your own machine.**
+
+[![npm](https://img.shields.io/npm/v/universal-parcel-scraper)](https://www.npmjs.com/package/universal-parcel-scraper)
+[![CI](https://github.com/plhery/universal-parcel-scraper/actions/workflows/ci.yml/badge.svg)](https://github.com/plhery/universal-parcel-scraper/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/core-Apache--2.0-blue.svg)](LICENSE)
+
+<!-- GENERATED:summary -->
+**105 carriers · 85 active dedicated adapters · 58 countries represented**
+<!-- /GENERATED:summary -->
+
+[Try it](#try-it) · [Ways to run it](#ways-to-run-it) · [Coverage](#how-much-can-it-track) · [Carriers](carriers/) · [Add a carrier](CONTRIBUTING.md)
+
+<img src="docs/assets/demo.svg" width="840" alt="The track command printing a parcel's history as JSON, next to a timeline drawn from it">
+
+</div>
+
+Give it a tracking number. It works out which carrier the number belongs to and fetches the
+history from that carrier's own website. What comes back has one shape, so a UPS parcel and
+a Poczta Polska parcel look the same to your code.
+
+There is no account to open and no API key. Every carrier publishes tracking in its own way,
+and hosted tracking APIs smooth that over for a fee while seeing every number you look up.
+Here the same work is open code: one adapter per carrier, each in [its own folder](carriers/)
+with a README on how that site is read.
+
+## Try it
+
+You need Node.js 24 or newer.
+
+```sh
+npx universal-parcel-scraper detect 1Z999AA10123456784
+```
+
+Detection is offline. It checks the number against each carrier's formats and checksums and
+answers `ups` without sending anything anywhere.
+
+```sh
+npx universal-parcel-scraper track YOUR_TRACKING_NUMBER
+```
+
+Tracking does go out, to the carrier that owns the number. If a number fits several carriers,
+name one with `--carrier dhl`. A few carriers also want the delivery postcode (`--postcode`)
+or the link from the shipping email (`--tracking-url`).
+
+## Ways to run it
+
+### Command line
+
+```sh
+npm install -g universal-parcel-scraper
+```
+
+The command is `parcel-scraper`:
+
+```sh
+parcel-scraper detect <number, link or text>   # which carrier is this? no network
+parcel-scraper track <number>                  # the parcel's history
+parcel-scraper recognize <number>              # ask the possible carriers which one knows it
+parcel-scraper carriers                        # the catalog, with the ids --carrier accepts
+parcel-scraper serve                           # the HTTP API described below
+```
+
+Everything prints JSON, so it pipes:
+
+```sh
+parcel-scraper track "$NUMBER" | jq -r '.result.current_stage'
+```
+
+`parcel-scraper --help` lists the environment variables.
+
+### Node
+
+```js
+import { createTracker } from 'universal-parcel-scraper/node';
+
+const tracker = createTracker();
+const { carrier, source, result } = await tracker.track({ number: process.env.PARCEL_NUMBER });
+
+console.log(carrier, result.current_stage);
+for (const scan of result.events) {
+  console.log(scan.time, scan.location, scan.description, scan.stage);
+}
+```
+
+Each scan keeps the carrier's wording and gains a `stage` from [one shared list](data/stages.json).
+`source` names who answered, and `attempts` lists everything that was tried. When nothing
+returns a history, `track()` throws a `TrackingError` carrying those attempts and a hint about
+the cause. [examples/node.mjs](examples/node.mjs) is a runnable version.
+
+### Browser
+
+```js
+import { parseTrackingInput } from 'universal-parcel-scraper';
+
+parseTrackingInput('1Z999AA10123456784');
+// { carrier: 'ups', confidence: 'high', candidates: ['ups'], … }
+```
+
+The root import has no Node imports and makes no requests, so it can sit behind a form field
+and name the carrier as someone types.
+
+### HTTP
+
+For anything that is not JavaScript:
+
+```sh
+parcel-scraper serve --port 8080
+```
+
+```sh
+curl http://127.0.0.1:8080/v1/track \
+  -H 'Content-Type: application/json' \
+  -d '{"number":"1Z999AA10123456784","carrier":"ups"}'
+```
+
+`/v1/detect`, `/v1/recognize` and `/v1/carriers` sit next to it, and the
+[OpenAPI file](server/openapi.json) describes them all. The server caches recent answers in
+memory and rate-limits callers. It has no database and never polls on its own.
+
+Set `SCRAPER_TOKEN` to require a bearer token. `SCRAPER_DEMO_PAGE=true` serves a small page
+at `/` for trying numbers by hand. The other settings are in [.env.example](.env.example).
+
+### Docker
+
+```sh
+docker run --rm -p 127.0.0.1:8080:8080 ghcr.io/plhery/universal-parcel-scraper:0.2.0
+```
+
+The image runs `serve` and ships Chromium, for the carriers that only answer a real browser.
+
+## What you can build with it
+
+- **A tracking screen in your own app.** [Delivery Tracker](https://github.com/plhery/delivery-tracker),
+  an open-source iPhone app and PWA, runs on this package.
+- **A Home Assistant sensor** for the parcel you are waiting on.
+  [The config is in examples](examples/home-assistant.yaml).
+- **Order status inside a shop or help desk**, so customers are not sent off to the carrier's
+  site. Any backend that speaks HTTP can call the server.
+- **Tracking numbers pulled out of shipping emails.** `detect` takes pasted text and carrier
+  links as well as bare numbers.
+- **A carrier field that fills itself in**, with the browser import.
+- **A cron job** that pings you when `current_stage` turns `delivered`.
+
+The library answers one lookup at a time. Storing parcels and deciding when to check again
+are yours to do.
+
+## How it works
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/how-it-works-dark.svg">
+  <img src="docs/assets/how-it-works-light.svg" width="840" alt="An input is detected offline and tracked by the carrier's dedicated adapter. With no history, the lookup moves to the fallbacks you enabled. Either way the result is one timeline.">
+</picture>
+
+Each adapter uses plain HTTP wherever the carrier's site allows it. Some sites only answer a
+real browser and others need image processing, so those adapters can drive a local Chromium
+or the optional [TRAWL browser service](trawl/README.md). Install what your carriers need:
+
+```sh
+npm install playwright-core sharp onnxruntime-web
+```
+
+Then pass `chromiumPath` or `trawlUrl` to `createTracker()`. The CLI and the server read
+`TRACKING_CHROMIUM_PATH` and `FLARESOLVERR_URL`.
+
+When the adapter finds no history, the lookup can move on to an aggregator. Only UPU is on
+by default, for the postal numbers it can serve. The commercial ones are opt-in, and each
+one you enable receives the tracking number:
+
+```js
+createTracker({ providers: ['ParcelsApp', 'Ship24', '17TRACK', 'Postal Ninja', 'UPU'] });
+```
+
+[ARCHITECTURE.md](ARCHITECTURE.md) has the rest.
+
+## How much can it track?
+
+A carrier count says what the catalog knows about. Whether a real parcel comes back with its
+history is a different question, so each source was run on its own against the same
+**100-carrier reference set**. The top bar counts a carrier when any source below it returned
+a history.
+
+<!-- GENERATED:coverage -->
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/coverage-dark.svg">
+  <img src="docs/assets/coverage-light.svg" alt="Carriers with tracking history: This project, all fallbacks enabled 70, This project, dedicated adapters alone 51, ParcelsApp 50, Postal Ninja 41, 17TRACK 40, Ship24 38, UPU 11." width="760">
+</picture>
+
+<details>
+<summary>The same numbers as a table</summary>
+
+| Source | Carriers with history |
+| --- | ---: |
+| **Universal Parcel Scraper, all fallbacks enabled** | **70 / 100** |
+| Dedicated adapters alone | 51 / 100 |
+| ParcelsApp | 50 / 100 |
+| Postal Ninja | 41 / 100 |
+| 17TRACK | 40 / 100 |
+| Ship24 | 38 / 100 |
+| UPU | 11 / 100 |
+
+</details>
+<!-- /GENERATED:coverage -->
+
+The numbers come from [coverage.json](providers/coverage.json): the recorded outcome for each
+carrier's comparison reference, partial histories included and alternate samples left out.
+The set is curated. Read it as a comparison between sources, not as a market-share ranking
+or a promise about today, because parcels expire and carrier sites change.
+[Carrier-by-carrier results and limitations](providers/COVERAGE.md).
+
+## Next to a hosted tracking API
+
+| | Universal Parcel Scraper | Hosted tracking API |
+| --- | --- | --- |
+| Account | None | Sign-up and an API key |
+| Cost | Your own compute | A plan or a per-shipment price |
+| Who sees the tracking number | The carrier, plus any fallback you enable | The vendor, then the carrier |
+| Carriers | The [catalog](carriers/) in this repository | A much larger catalog |
+| Updates | You poll | Webhooks |
+| When a carrier changes its site | The adapter breaks until it is fixed here | The vendor deals with it |
+| Hosting | Yours | Theirs |
+
+If you want the widest catalog and nothing to run, a hosted API is the better choice. This
+project is for when the numbers should stay on your side, or when a price per parcel makes
+no sense for what you are building. Vendor catalog totals are not comparable with the
+reference test above.
+
+## Privacy and limits
+
+A lookup sends the tracking number to the carrier, along with the postcode or tracking link
+when that carrier requires one. Fallbacks you enabled receive the number too, and ParcelsApp
+also gets a postcode if you supplied it. Pages opened in a browser, locally or through TRAWL,
+can load the carrier's or provider's challenge scripts. The library has no telemetry, and
+the server's logs hold route names and outcomes, never parcel inputs.
+
+This is scraping, so things break. Carriers redesign their sites and turn away automated
+requests. A few need more than the number, such as a postcode or the link from the shipping
+email, and the ones that require an account stay limited. Keep to the catalog's refresh
+limits and to the retry advice that comes with an error. A scan time with no known UTC offset
+is returned as the carrier wrote it, with no zone guessed.
+
+## Contributing
+
+Adapters break when carriers change their sites. Each carrier lives in its own folder with
+synthetic fixtures and offline tests, so a fix stays local to that folder. For a new carrier,
+`npm run carrier:new` scaffolds the folder and [CONTRIBUTING.md](CONTRIBUTING.md) covers the
+rest. Report security issues through [SECURITY.md](SECURITY.md).
+
+## License
+
+The core is [Apache-2.0](LICENSE). The optional TRAWL image is a derivative under
+[AGPL-3.0](trawl/LICENSE). Data and model credits are in [NOTICE](NOTICE).

package/data/carrier-order.json

@@ -0,0 +1,107 @@
+[
+  "swiss-post",
+  "swiss-post-cargo",
+  "quickpac",
+  "planzer",
+  "aliexpress",
+  "sunyou",
+  "hermes",
+  "spring-gds",
+  "postlogistics",
+  "dachser",
+  "dhl",
+  "dhl-ecommerce",
+  "ups",
+  "amazon-logistics",
+  "amazon-shipping",
+  "fedex",
+  "gls-ch",
+  "dpd",
+  "dpd-fr",
+  "mondial-relay",
+  "relais-colis",
+  "la-poste",
+  "chronopost",
+  "gls-fr",
+  "colis-prive",
+  "geodis",
+  "colisweb",
+  "c-chez-vous",
+  "heppner",
+  "ciblex",
+  "paack",
+  "asendia",
+  "shipup",
+  "india-post",
+  "hermes-de",
+  "gls-de",
+  "delivengo",
+  "intl-post",
+  "unknown",
+  "royal-mail",
+  "parcelforce",
+  "evri",
+  "inpost",
+  "an-post",
+  "bpost",
+  "austrian-post",
+  "postnord",
+  "posti",
+  "correos-express",
+  "seur",
+  "mrw",
+  "nacex",
+  "ctt",
+  "ctt-express",
+  "poste-italiane",
+  "brt",
+  "ecoscooting",
+  "tipsa",
+  "ukrposhta",
+  "usps",
+  "canada-post",
+  "purolator",
+  "canpar",
+  "ontrac",
+  "speedx",
+  "uniuni",
+  "landmark-global",
+  "old-dominion",
+  "spee-dee",
+  "gofo",
+  "estafeta",
+  "correios-br",
+  "correos-chile",
+  "yunexpress",
+  "four-px",
+  "blue-dart",
+  "delhivery",
+  "nz-post",
+  "singapore-post",
+  "japan-post",
+  "sf-express",
+  "sto",
+  "yunda",
+  "yto",
+  "zto",
+  "jd-logistics",
+  "yamato",
+  "korea-post",
+  "thailand-post",
+  "dtdc",
+  "australia-post",
+  "hongkong-post",
+  "pos-malaysia",
+  "ninja-van",
+  "china-post",
+  "packeta",
+  "poczta-polska",
+  "bring-posten",
+  "aramex",
+  "tnt",
+  "correos-spain",
+  "yanwen",
+  "the-courier-guy",
+  "j-and-t",
+  "ems"
+]