universal-parcel-scraper 0.3.0 → 0.3.1-main.311

package/README.md

@@ -6,7 +6,7 @@
 
 **Parcel tracking that asks the carrier directly, from your own machine.**
 
-The engine behind [Peek](https://github.com/plhery/delivery-tracker), the open-source parcel tracker for iPhone and the web.
+The engine behind [Peek](https://peektracker.com) ([GitHub](https://github.com/plhery/peek-delivery-tracker)), the open-source parcel tracker for iPhone and the web.
 
 [![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)
@@ -27,7 +27,7 @@ The engine behind [Peek](https://github.com/plhery/delivery-tracker), the open-s
 Give it a tracking number. It finds the carrier, fetches the history from the carrier's own
 site and returns the same JSON for every carrier. No account, no API key.
 
-It is the tracking engine of [Peek](https://github.com/plhery/delivery-tracker), usable on
+It is the tracking engine of [Peek](https://github.com/plhery/peek-delivery-tracker), usable on
 its own as a command, a Node library or an HTTP server.
 
 ## Benchmark
@@ -120,7 +120,7 @@ settings, such as `SCRAPER_TOKEN` and `SCRAPER_TRUSTED_PROXIES`, in [.env.exampl
 
 ## What you can build with it
 
-- A parcel-tracking app, like [Peek](https://github.com/plhery/delivery-tracker).
+- A parcel-tracking app, like [Peek](https://github.com/plhery/peek-delivery-tracker).
 - A [Home Assistant sensor](examples/home-assistant.yaml) for the parcel you are waiting on.
 - Order status inside a shop or help desk, from any backend that speaks HTTP.
 - Tracking numbers pulled out of shipping emails: `detect` reads pasted text and links.

package/dist/app.d.ts

@@ -8,7 +8,7 @@
 export * from './core/catalog/parcel.js';
 export * from './core/catalog/hints.js';
 export * from './core/time/result.js';
-export { sameInstantIdentityPolicy, type SameInstantIdentityPolicy } from './core/catalog/eventIdentity.js';
+export { sameInstantIdentityPolicy, type SameInstantIdentityPolicy, type SameInstantScan } from './core/catalog/eventIdentity.js';
 export { universalCarrierHints } from './providers/shared/hints.js';
 export { recognitionAskedCarriers } from './core/catalog/recognition.js';
 export { countryFlag, countryName, trackingLocationCountry, trackingPlace, type TrackingPlace } from './places/trackingLocation.js';

package/dist/carriers/ups/app.d.ts

@@ -0,0 +1,2 @@
+import type { SameInstantIdentityPolicy } from '../../core/catalog/eventIdentity.js';
+export declare const sameInstantIdentityPolicy: SameInstantIdentityPolicy;

package/dist/carriers/ups/app.js

@@ -0,0 +1,15 @@
+function normalized(value) {
+    return value.replace(/\s+/g, ' ').trim().toLocaleLowerCase('en-US');
+}
+// UPS can add a location later. Its wording distinguishes scans sharing a clock.
+export const sameInstantIdentityPolicy = {
+    sourceCarrierId: 'ups', storedSources: ['ups'], requireProviderCode: false,
+    matches(incoming, stored) {
+        const wording = normalized(incoming.description);
+        const location = normalized(incoming.location);
+        const savedLocation = normalized(stored.location);
+        return incoming.stage !== '' && incoming.stage !== 'unknown' && incoming.stage === stored.stage
+            && wording !== '' && wording === normalized(stored.description)
+            && (!location || !savedLocation || location === savedLocation);
+    },
+};

package/dist/core/catalog/eventIdentity.d.ts

@@ -1,8 +1,18 @@
+/** Scan evidence available to the app before it reuses a stored identity. */
+export interface SameInstantScan {
+    readonly stage: string;
+    readonly description: string;
+    readonly location: string;
+    readonly providerCode: string;
+}
 /** Carrier evidence the parcel app uses when updating a stored scan in place. */
 export interface SameInstantIdentityPolicy {
     readonly sourceCarrierId: string;
     readonly storedSources: readonly string[];
     readonly requireProviderCode: boolean;
+    readonly matches?: (incoming: SameInstantScan, stored: SameInstantScan) => boolean;
 }
 /** Unlisted sources cannot identify a reworded scan by its instant alone. */
-export declare function sameInstantIdentityPolicy(sourceCarrierId: string): SameInstantIdentityPolicy | undefined;
+export declare function sameInstantIdentityPolicy(sourceCarrierId: string, options?: {
+    supportsScanMatching?: boolean;
+}): SameInstantIdentityPolicy | undefined;

package/dist/core/catalog/eventIdentity.js

@@ -1,7 +1,10 @@
 import { sameInstantIdentityPolicy as dpd } from '../../carriers/dpd/app.js';
 import { sameInstantIdentityPolicy as indiaPost } from '../../carriers/india-post/app.js';
-const policies = new Map([dpd, indiaPost].map((policy) => [policy.sourceCarrierId, policy]));
+import { sameInstantIdentityPolicy as ups } from '../../carriers/ups/app.js';
+const policies = new Map([dpd, indiaPost, ups].map((policy) => [policy.sourceCarrierId, policy]));
 /** Unlisted sources cannot identify a reworded scan by its instant alone. */
-export function sameInstantIdentityPolicy(sourceCarrierId) {
-    return policies.get(sourceCarrierId);
+export function sameInstantIdentityPolicy(sourceCarrierId, options = {}) {
+    const policy = policies.get(sourceCarrierId);
+    // Older app versions only check the clock and provider code.
+    return policy?.matches && !options.supportsScanMatching ? undefined : policy;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "universal-parcel-scraper",
-  "version": "0.3.0",
+  "version": "0.3.1-main.311",
   "description": "Self-hosted parcel tracking: carrier detection, dedicated scrapers and optional universal providers.",
   "type": "module",
   "license": "Apache-2.0",