Changelog
All notable changes to @terminaldz/zrexpress-sdk. The format follows Keep a Changelog and the project adheres to Semantic Versioning. The canonical file is CHANGELOG.md in the repository.
[0.1.1] — 2026-09-25
First public release on the npm registry.
Changed
- Published publicly to npm with provenance (previously GitHub Packages only). Install with
npm install @terminaldz/zrexpress-sdk— no.npmrcor token needed. - Licensed under MIT (previously unlicensed).
Fixed
- Label-PDF
formattype widened (API Quirks §9.12).formatnow also accepts a bare string ('A4'/'A6', or omit for the server default); the object shape stays assignable.
0.1.0 — 2026-07-17
Initial release — complete coverage of the ZR Express Suppliers API (117 operations) with typed, ergonomic methods.
Added
- Transport core: single
request()pipeline over nativefetchwith per-attemptAbortSignal.timeout, retries on429/5xx/network for idempotent methods and searchPOSTs (honouringRetry-After, exponential backoff with full jitter), and the full error taxonomy underZrExpressError. API-key redaction is proven — errors, logs, and serialization never leak it. - Configuration with fail-fast validation (
ZrExpressConfigError). - Pagination:
PagedList<T>and apaginate()async iterator (advance guard,maxItems); every search method exposes asearchAlliterator. - Resources — all 117 operations across
parcels,customers,products,categories,receipts,stockMovements,claims,treasury,reports,documents,labels,pickupBags,modificationRequests,territories,rates,hubs,workflows,users,roles,notifications,supplier, andwebhookEndpoints. Bulk operations return the shared envelope and never throw on207/400;assertBulkOkprovides opt-in throw-semantics. - Webhooks (
/webhookssubpath):WebhookVerifieroversvix(raw-body signature verification), typed event union,ParcelWebhookEventenvelope, and narrowing type guards. - NestJS (
/nestjssubpath):ZrExpressModule.forRoot/forRootAsync,ZrExpressWebhookGuard, and the@ZrWebhookEvent()decorator. - Types generated from the verified
openapi.json; drift fixes (nameArabic, supplier-balance union, webhook phone shape) applied insrc/types.ts.