@pvh-afl/graphql 1.2.1 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pvh-afl/graphql",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "AFL GraphQL - Shared GraphQL modules for multi-brand commerce platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/graphql": "^12.0.0",
-    "@pvh-afl/core": "^1.2.1",
+    "@pvh-afl/core": "^1.2.2",
     "graphql": "^16.0.0"
   },
   "devDependencies": {
@@ -32,7 +32,7 @@
     "@nestjs/core": "^10.4.0",
     "@nestjs/graphql": "^12.2.0",
     "@nestjs/testing": "^10.4.0",
-    "@pvh-afl/core": "^1.2.1",
+    "@pvh-afl/core": "^1.2.2",
     "@types/jest": "^29.5.0",
     "graphql": "^16.9.0",
     "graphql-type-json": "^0.3.2",

package/dist/common/order-status.d.ts

@@ -1,84 +0,0 @@
-/**
- * Canonical order status
- *
- * Single source of truth for the customer-facing order status vocabulary.
- * The middleware collapses the raw, technical Shopify signals
- * (`displayFulfillmentStatus`, `displayFinancialStatus`, `cancelledAt`,
- * fulfillment `deliveredAt`, return `status`, …) into ONE small, stable set of
- * values that every client and every brand can rely on.
- *
- * Clients map these values to their own display copy / icons / localization —
- * they must never interpret the raw upstream status directly. Adding, removing,
- * or renaming a value here is a contract change: keep this list and the
- * `@Field` descriptions on `OrderDetails.orderStatus` and
- * `CustomerOrderSummary.status` in sync.
- */
-/** The canonical, customer-facing order statuses. */
-export declare const ORDER_STATUSES: readonly ["placed", "confirmed", "processing", "partially_shipped", "shipped", "delivered", "return_requested", "returned", "refunded", "cancelled"];
-export type OrderStatus = (typeof ORDER_STATUSES)[number];
-/**
- * Shopify return statuses that mean "a return is currently in progress".
- * (Return `status` values are UPPER_SNAKE on the Admin API.)
- */
-export declare const OPEN_RETURN_STATUSES: Set<string>;
-/**
- * Shopify return status that means "the return completed" (items received).
- * `CANCELED`/`DECLINED` returns are rejected/withdrawn and must NOT count.
- */
-export declare const COMPLETED_RETURN_STATUS = "CLOSED";
-/** One return on the order: its Shopify status and how many units it covers. */
-export interface ReturnSignal {
-    /** Shopify `Return.status` (e.g. OPEN, REQUESTED, CLOSED, CANCELED, DECLINED). */
-    status: string;
-    /** Total units across this return's line items. */
-    returnedQuantity: number;
-}
-/**
- * Raw Shopify signals needed to derive the canonical status. Every caller
- * passes what it has; missing fields simply don't fire their branch, so a
- * caller that can't see returns behaves exactly as before for those states.
- */
-export interface OrderStatusSignals {
-    /** `order.cancelledAt` — set once the order is cancelled. */
-    cancelledAt?: string | null;
-    /** `order.displayFinancialStatus` (e.g. PAID, REFUNDED, PENDING). */
-    displayFinancialStatus?: string | null;
-    /** `order.displayFulfillmentStatus` (e.g. FULFILLED, PARTIALLY_FULFILLED, IN_PROGRESS, UNFULFILLED). */
-    displayFulfillmentStatus?: string | null;
-    /** `order.confirmed` — Shopify's order-confirmed flag. */
-    confirmed?: boolean;
-    /** `deliveredAt` of the primary fulfillment, if the carrier confirmed delivery. */
-    deliveredAt?: string | null;
-    /** Whether the order has at least one fulfillment record. */
-    hasFulfillment?: boolean;
-    /** Every return on the order, with its status and unit count. */
-    returns?: ReturnSignal[];
-    /** Total units ordered across all line items (used to tell full vs partial returns). */
-    orderedQuantity?: number;
-}
-/**
- * The canonical, customer-facing status of a single parcel (fulfillment).
- * Tracks the shipment's journey; aligned with the tracking-timeline stages.
- * Clients map these to their own copy — do not surface the raw Shopify
- * `displayStatus`/`status` to customers.
- */
-export declare const FULFILLMENT_STATUSES: readonly ["preparing", "shipped", "in_transit", "out_for_delivery", "ready_for_pickup", "attempted", "delivered", "failed", "cancelled"];
-export type FulfillmentStatus = (typeof FULFILLMENT_STATUSES)[number];
-/**
- * Collapse a parcel's raw Shopify `displayStatus` into a canonical
- * {@link FulfillmentStatus}. A confirmed delivery date always wins; an
- * unrecognized status on an existing fulfillment falls back to `shipped`
- * (the parcel provably exists, so it has at least been handed off).
- */
-export declare function deriveFulfillmentStatus(displayStatus?: string | null, deliveredAt?: string | null): FulfillmentStatus;
-/**
- * Collapse the raw Shopify signals into a single canonical {@link OrderStatus}.
- *
- * Priority runs most-terminal / most-specific first so that, e.g., a cancelled
- * order that also has a fulfillment still reads as `cancelled`:
- *
- *   cancelled → returned → return_requested → refunded → delivered →
- *   shipped → partially_shipped → processing → confirmed → placed
- */
-export declare function deriveOrderStatus(signals: OrderStatusSignals): OrderStatus;
-//# sourceMappingURL=order-status.d.ts.map

package/dist/common/order-status.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"order-status.d.ts","sourceRoot":"","sources":["../../src/common/order-status.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,qDAAqD;AACrD,eAAO,MAAM,cAAc,sJAWjB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,aAAiC,CAAC;AAEnE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAEhD,gFAAgF;AAChF,MAAM,WAAW,YAAY;IAC3B,kFAAkF;IAClF,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,qEAAqE;IACrE,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,wGAAwG;IACxG,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,0DAA0D;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,6DAA6D;IAC7D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iEAAiE;IACjE,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,wFAAwF;IACxF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,0IAUvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAuBtE;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,EAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAC1B,iBAAiB,CAMnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAqE1E"}

package/dist/common/order-status.js

@@ -1,150 +0,0 @@
-"use strict";
-/**
- * Canonical order status
- *
- * Single source of truth for the customer-facing order status vocabulary.
- * The middleware collapses the raw, technical Shopify signals
- * (`displayFulfillmentStatus`, `displayFinancialStatus`, `cancelledAt`,
- * fulfillment `deliveredAt`, return `status`, …) into ONE small, stable set of
- * values that every client and every brand can rely on.
- *
- * Clients map these values to their own display copy / icons / localization —
- * they must never interpret the raw upstream status directly. Adding, removing,
- * or renaming a value here is a contract change: keep this list and the
- * `@Field` descriptions on `OrderDetails.orderStatus` and
- * `CustomerOrderSummary.status` in sync.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FULFILLMENT_STATUSES = exports.COMPLETED_RETURN_STATUS = exports.OPEN_RETURN_STATUSES = exports.ORDER_STATUSES = void 0;
-exports.deriveFulfillmentStatus = deriveFulfillmentStatus;
-exports.deriveOrderStatus = deriveOrderStatus;
-/** The canonical, customer-facing order statuses. */
-exports.ORDER_STATUSES = [
-    'placed', // order received, not yet confirmed by the brand
-    'confirmed', // brand confirmed the order, not yet in fulfillment
-    'processing', // fulfillment in progress (Shopify IN_PROGRESS)
-    'partially_shipped', // some — but not all — items have shipped
-    'shipped', // all items handed to the carrier, not yet delivered
-    'delivered', // carrier confirmed delivery
-    'return_requested', // an open/requested return is in progress
-    'returned', // a full return has completed (all items returned)
-    'refunded', // fully refunded
-    'cancelled', // order cancelled
-];
-/**
- * Shopify return statuses that mean "a return is currently in progress".
- * (Return `status` values are UPPER_SNAKE on the Admin API.)
- */
-exports.OPEN_RETURN_STATUSES = new Set(['OPEN', 'REQUESTED']);
-/**
- * Shopify return status that means "the return completed" (items received).
- * `CANCELED`/`DECLINED` returns are rejected/withdrawn and must NOT count.
- */
-exports.COMPLETED_RETURN_STATUS = 'CLOSED';
-/**
- * The canonical, customer-facing status of a single parcel (fulfillment).
- * Tracks the shipment's journey; aligned with the tracking-timeline stages.
- * Clients map these to their own copy — do not surface the raw Shopify
- * `displayStatus`/`status` to customers.
- */
-exports.FULFILLMENT_STATUSES = [
-    'preparing', // fulfillment created, not yet handed to the carrier
-    'shipped', // handed to the carrier
-    'in_transit', // moving through the carrier network
-    'out_for_delivery', // with the courier for final delivery
-    'ready_for_pickup', // waiting at a pickup point
-    'attempted', // delivery attempted but not completed
-    'delivered', // delivered / picked up
-    'failed', // fulfillment failed
-    'cancelled', // fulfillment cancelled / label voided
-];
-/** Shopify `FulfillmentDisplayStatus` (+ our synthetic pending) → canonical status. */
-const DISPLAY_STATUS_MAP = {
-    AWAITING_FULFILLMENT: 'preparing', // synthetic "pending" parcel
-    SUBMITTED: 'shipped',
-    CONFIRMED: 'shipped',
-    LABEL_PRINTED: 'shipped',
-    LABEL_PURCHASED: 'shipped',
-    MARKED_AS_FULFILLED: 'shipped',
-    FULFILLED: 'shipped',
-    IN_TRANSIT: 'in_transit',
-    OUT_FOR_DELIVERY: 'out_for_delivery',
-    READY_FOR_PICKUP: 'ready_for_pickup',
-    ATTEMPTED_DELIVERY: 'attempted',
-    NOT_DELIVERED: 'attempted',
-    DELIVERED: 'delivered',
-    PICKED_UP: 'delivered',
-    FAILURE: 'failed',
-    CANCELED: 'cancelled',
-    LABEL_VOIDED: 'cancelled',
-};
-/**
- * Collapse a parcel's raw Shopify `displayStatus` into a canonical
- * {@link FulfillmentStatus}. A confirmed delivery date always wins; an
- * unrecognized status on an existing fulfillment falls back to `shipped`
- * (the parcel provably exists, so it has at least been handed off).
- */
-function deriveFulfillmentStatus(displayStatus, deliveredAt) {
-    if (deliveredAt) {
-        return 'delivered';
-    }
-    const mapped = DISPLAY_STATUS_MAP[(displayStatus ?? '').toUpperCase()];
-    return mapped ?? 'shipped';
-}
-/**
- * Collapse the raw Shopify signals into a single canonical {@link OrderStatus}.
- *
- * Priority runs most-terminal / most-specific first so that, e.g., a cancelled
- * order that also has a fulfillment still reads as `cancelled`:
- *
- *   cancelled → returned → return_requested → refunded → delivered →
- *   shipped → partially_shipped → processing → confirmed → placed
- */
-function deriveOrderStatus(signals) {
-    const { cancelledAt, displayFinancialStatus, displayFulfillmentStatus, confirmed, deliveredAt, hasFulfillment, returns, orderedQuantity, } = signals;
-    if (cancelledAt) {
-        return 'cancelled';
-    }
-    const returnList = returns ?? [];
-    // Full return completed: units returned across CLOSED returns cover the
-    // whole order. Keyed off the return object's own status (not Shopify's
-    // financial status, which is unreliable when refunds settle off-Shopify),
-    // and only when the FULL order was returned — a partial return leaves the
-    // headline as delivered. Requires a known, positive ordered quantity.
-    const completedReturnedQty = returnList
-        .filter((r) => r.status === exports.COMPLETED_RETURN_STATUS)
-        .reduce((sum, r) => sum + (r.returnedQuantity || 0), 0);
-    if (orderedQuantity != null &&
-        orderedQuantity > 0 &&
-        completedReturnedQty >= orderedQuantity) {
-        return 'returned';
-    }
-    if (returnList.some((r) => exports.OPEN_RETURN_STATUSES.has(r.status))) {
-        return 'return_requested';
-    }
-    if (displayFinancialStatus === 'REFUNDED') {
-        return 'refunded';
-    }
-    if (deliveredAt) {
-        return 'delivered';
-    }
-    if (displayFulfillmentStatus === 'FULFILLED') {
-        return 'shipped';
-    }
-    if (displayFulfillmentStatus === 'PARTIALLY_FULFILLED') {
-        return 'partially_shipped';
-    }
-    if (displayFulfillmentStatus === 'IN_PROGRESS') {
-        return 'processing';
-    }
-    // A fulfillment exists but Shopify hasn't given it a more specific state —
-    // treat it as shipped (preserves the customer-orders list behaviour).
-    if (hasFulfillment) {
-        return 'shipped';
-    }
-    if (confirmed) {
-        return 'confirmed';
-    }
-    return 'placed';
-}
-//# sourceMappingURL=order-status.js.map

package/dist/common/order-status.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"order-status.js","sourceRoot":"","sources":["../../src/common/order-status.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AA6GH,0DASC;AAWD,8CAqEC;AApMD,qDAAqD;AACxC,QAAA,cAAc,GAAG;IAC5B,QAAQ,EAAE,iDAAiD;IAC3D,WAAW,EAAE,oDAAoD;IACjE,YAAY,EAAE,gDAAgD;IAC9D,mBAAmB,EAAE,0CAA0C;IAC/D,SAAS,EAAE,qDAAqD;IAChE,WAAW,EAAE,6BAA6B;IAC1C,kBAAkB,EAAE,0CAA0C;IAC9D,UAAU,EAAE,mDAAmD;IAC/D,UAAU,EAAE,iBAAiB;IAC7B,WAAW,EAAE,kBAAkB;CACvB,CAAC;AAIX;;;GAGG;AACU,QAAA,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAEnE;;;GAGG;AACU,QAAA,uBAAuB,GAAG,QAAQ,CAAC;AAkChD;;;;;GAKG;AACU,QAAA,oBAAoB,GAAG;IAClC,WAAW,EAAE,qDAAqD;IAClE,SAAS,EAAE,wBAAwB;IACnC,YAAY,EAAE,qCAAqC;IACnD,kBAAkB,EAAE,sCAAsC;IAC1D,kBAAkB,EAAE,4BAA4B;IAChD,WAAW,EAAE,uCAAuC;IACpD,WAAW,EAAE,wBAAwB;IACrC,QAAQ,EAAE,qBAAqB;IAC/B,WAAW,EAAE,uCAAuC;CAC5C,CAAC;AAIX,uFAAuF;AACvF,MAAM,kBAAkB,GAAsC;IAC5D,oBAAoB,EAAE,WAAW,EAAE,6BAA6B;IAChE,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,SAAS;IACpB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,SAAS;IAC1B,mBAAmB,EAAE,SAAS;IAC9B,SAAS,EAAE,SAAS;IACpB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,kBAAkB,EAAE,WAAW;IAC/B,aAAa,EAAE,WAAW;IAC1B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,WAAW;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,aAA6B,EAC7B,WAA2B;IAE3B,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IACvE,OAAO,MAAM,IAAI,SAAS,CAAC;AAC7B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAC,OAA2B;IAC3D,MAAM,EACJ,WAAW,EACX,sBAAsB,EACtB,wBAAwB,EACxB,SAAS,EACT,WAAW,EACX,cAAc,EACd,OAAO,EACP,eAAe,GAChB,GAAG,OAAO,CAAC;IAEZ,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,IAAI,EAAE,CAAC;IAEjC,wEAAwE;IACxE,uEAAuE;IACvE,0EAA0E;IAC1E,0EAA0E;IAC1E,sEAAsE;IACtE,MAAM,oBAAoB,GAAG,UAAU;SACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,+BAAuB,CAAC;SACnD,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,IACE,eAAe,IAAI,IAAI;QACvB,eAAe,GAAG,CAAC;QACnB,oBAAoB,IAAI,eAAe,EACvC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,4BAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,IAAI,sBAAsB,KAAK,UAAU,EAAE,CAAC;QAC1C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,wBAAwB,KAAK,WAAW,EAAE,CAAC;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,wBAAwB,KAAK,qBAAqB,EAAE,CAAC;QACvD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,IAAI,wBAAwB,KAAK,aAAa,EAAE,CAAC;QAC/C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,2EAA2E;IAC3E,sEAAsE;IACtE,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}