shipflow 0.1.0 → 0.1.1

package/dist/carriers/aramex/adapter.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Aramex Carrier Adapter
+ * Implementation of the CarrierAdapter interface for the Aramex JSON Shipping
+ * Services API v2.
+ *
+ * Key differences from the other carriers:
+ * - Auth is a `ClientInfo` object sent in EVERY request body (not headers).
+ * - The four Aramex services (Shipping, Tracking, RateCalculator, Location)
+ *   live on different base URLs, so the adapter holds one HttpClient per service.
+ * - Errors use the "Fake 200 OK" pattern (HTTP 200 + `HasErrors`/`Notifications`),
+ *   surfaced via the shared HttpClient's `errorExtractor` hook on every call.
+ */
+import type { CarrierConfig, City, CreateShipmentInput, Location, Pickup, PickupRequest, Rate, Shipment, TrackingResult } from "../../core/types.js";
+import { BaseCarrierAdapter } from "../base.js";
+export interface AramexConfig extends CarrierConfig {
+    credentials: {
+        userName: string;
+        password: string;
+        accountNumber: string;
+        accountPin: string;
+        accountEntity: string;
+        accountCountryCode: string;
+    };
+    /** API source channel (default 24). */
+    source?: number;
+    /** ClientInfo version (default "v1.0"). */
+    version?: string;
+    /** Company name used when an address has no company set. */
+    companyName?: string;
+    /**
+     * Optional override for the Location service base URL. Live Aramex WSDLs
+     * disagree on the production Location host (ws.aramex.net vs anfe02.aramex.com);
+     * set this if your account is provisioned on a different host.
+     */
+    locationBaseUrl?: string;
+}
+export declare class AramexAdapter extends BaseCarrierAdapter {
+    readonly name = "aramex";
+    readonly supportedCountries: string[];
+    private shippingHttp;
+    private trackingHttp;
+    private rateHttp;
+    private locationHttp;
+    constructor(config: AramexConfig);
+    protected getBaseUrl(): string;
+    /** Derive a sibling service base URL by swapping the `/Shipping/` segment. */
+    private serviceBase;
+    private get aramexConfig();
+    private buildClientInfo;
+    /**
+     * Extracts the Aramex "Fake 200 OK" error (envelope-level `HasErrors` +
+     * `Notifications`). Passed to every request so the HttpClient raises APIError.
+     */
+    private static aramexErrorExtractor;
+    private static notificationsToErrors;
+    protected executeCreateShipment(input: CreateShipmentInput): Promise<Shipment>;
+    /**
+     * Create multiple shipments in a single request. Aramex's `CreateShipments`
+     * operation is natively batch — it takes a `Shipments` array and returns one
+     * processed result per shipment, in request order.
+     *
+     * Fails loud: if ANY shipment in the batch errors, an `APIError` is thrown
+     * whose `raw` holds the full response, so already-created AWBs remain
+     * recoverable (the unified `Shipment` type has no per-item error channel).
+     */
+    createBulkShipments(inputs: CreateShipmentInput[]): Promise<Shipment[]>;
+    /**
+     * Aramex's classic Shipping Services API has no shipment-cancellation
+     * endpoint, so this is unsupported. (Pickups can be cancelled via cancelPickup.)
+     */
+    cancelShipment(_trackingNumber: string): Promise<boolean>;
+    getLabel(trackingNumber: string, _format?: "PDF" | "ZPL" | "PNG"): Promise<string>;
+    track(trackingNumber: string): Promise<TrackingResult>;
+    trackMultiple(trackingNumbers: string[]): Promise<TrackingResult[]>;
+    trackByReference(reference: string): Promise<TrackingResult>;
+    getRates(input: CreateShipmentInput): Promise<Rate[]>;
+    createPickup(input: PickupRequest): Promise<Pickup>;
+    cancelPickup(pickupId: string | number): Promise<boolean>;
+    getCities(countryCode?: string): Promise<City[]>;
+    getDropoffLocations(countryCode?: string): Promise<Location[]>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/carriers/aramex/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/carriers/aramex/adapter.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;GAWG;AAYH,OAAO,KAAK,EACV,aAAa,EACb,IAAI,EACJ,mBAAmB,EACnB,QAAQ,EACR,MAAM,EACN,aAAa,EACb,IAAI,EACJ,QAAQ,EACR,cAAc,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAqD7C,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,WAAW,EAAE;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,aAAc,SAAQ,kBAAkB;IACnD,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,kBAAkB,WAWzB;IAEF,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,QAAQ,CAAa;IAC7B,OAAO,CAAC,YAAY,CAAa;gBAErB,MAAM,EAAE,YAAY;IAuBhC,SAAS,CAAC,UAAU,IAAI,MAAM;IAM9B,8EAA8E;IAC9E,OAAO,CAAC,WAAW;IAInB,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,CAAC,eAAe;IAQvB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAyBnC,OAAO,CAAC,MAAM,CAAC,qBAAqB;cAcpB,qBAAqB,CACnC,KAAK,EAAE,mBAAmB,GACzB,OAAO,CAAC,QAAQ,CAAC;IA6CpB;;;;;;;;OAQG;IACG,mBAAmB,CACvB,MAAM,EAAE,mBAAmB,EAAE,GAC5B,OAAO,CAAC,QAAQ,EAAE,CAAC;IAwDtB;;;OAGG;IACH,cAAc,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQnD,QAAQ,CACZ,cAAc,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAC9B,OAAO,CAAC,MAAM,CAAC;IA4BZ,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAYtD,aAAa,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAkBnE,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAU5D,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IA4BrD,YAAY,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAgCnD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBzD,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAehD,mBAAmB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAcrE"}

package/dist/carriers/aramex/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Aramex Carrier Exports
+ * Import from 'shipflow/carriers/aramex' for tree-shaking.
+ */
+export { AramexAdapter, type AramexConfig } from "./adapter.js";
+export { AramexProductGroup, AramexProductType, AramexPaymentType, AramexService, AramexStatusCodes, type AramexProductGroupType, type AramexProductTypeCode, type AramexPaymentTypeCode, } from "./services.js";
+export { buildClientInfo, mapAramexStatus, statusFromDescription, parseAramexDate, type AramexCredentials, } from "./mappers.js";
+export type { AramexClientInfo, AramexCreateShipmentsRequest, AramexCreateShipmentsResponse, AramexProcessedShipment, AramexShipmentLabel, AramexPrintLabelResponse, AramexTrackShipmentsRequest, AramexTrackShipmentsResponse, AramexTrackingResult, AramexCalculateRateRequest, AramexCalculateRateResponse, AramexCreatePickupRequest, AramexCreatePickupResponse, AramexCancelPickupRequest, AramexFetchCitiesResponse, AramexFetchOfficesResponse, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/carriers/aramex/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/carriers/aramex/index.ts"],"names":[],"mappings":"AACA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAG7D,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC;AAGnB,YAAY,EACV,gBAAgB,EAChB,4BAA4B,EAC5B,6BAA6B,EAC7B,uBAAuB,EACvB,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,SAAS,CAAC"}