@shushed/helpers 0.0.202-v2-20251208085030 → 0.0.202

package/dist/cjs/contracts/order/shipment/pos/return.schema.json

@@ -0,0 +1,31 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order Shipment POS Return",
+    "type": "object",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/order/shipment/pos/return.schema.json",
+    "description": "Represents a return shipment processed at a Point of Sale (POS) location, containing items being returned by the customer.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/order/shipment/pos.schema.json"
+        },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "type": {
+                    "type": ["string"],
+                    "enum": ["POS-RETURN"],
+                    "description": "Shipment type indicating a return processed at POS."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://shushed.example.com/order/shipment/item/returned.schema.json"
+                    },
+                    "description": "List of returned items included in the POS return shipment."
+                }
+            }
+        }
+    ]
+}

package/dist/cjs/contracts/order/shipment/pos.schema.json

@@ -0,0 +1,48 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order Shipment Outbound",
+    "type": "object",
+    "$id": "https://shushed.example.com/order/shipment/pos.schema.json",
+    "description": "Represents a shipment that originates from a Point of Sale (POS) location, including outbound or return types, associated with a store and a store associate.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/order/shipment.schema.json"
+        },
+        {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "type": ["string"],
+                    "enum": ["POS-OUTBOUND", "POS-RETURN"],
+                    "description": "Indicates whether the shipment is an outbound POS shipment or a return."
+                },
+                "status": {
+                    "type": ["string"],
+                    "enum": ["RECEIVED"],
+                    "description": "Current status of the POS shipment."
+                },
+                "store_id": {
+                    "type": ["string", "null"],
+                    "faker": { "custom.documentid": ["S", 3] },
+                    "description": "Unique identifier of the store from which the POS shipment originated."
+                },
+                "store_name": {
+                    "type": ["string", "null"],
+                    "faker": { "address.city": [] },
+                    "description": "Name of the store associated with the shipment."
+                },
+                "associate_id": {
+                    "type": ["string", "null"],
+                    "faker": { "custom.documentid": ["A", 3] },
+                    "description": "Unique identifier of the store associate processing the shipment."
+                },
+                "associate_name": {
+                    "type": ["string", "null"],
+                    "faker": { "name.fullName": [] },
+                    "description": "Full name of the store associate handling the transaction."
+                }
+            },
+            "required": ["store_id", "store_name", "associate_id", "associate_name"]
+        }
+    ]
+}

package/dist/cjs/contracts/order/shipment/shipped/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderShipmentShippedReturn = exports.OrderShipmentShippedOutbound = void 0;
+var outbound_schema_json_1 = require("./outbound.schema.json");
+Object.defineProperty(exports, "OrderShipmentShippedOutbound", { enumerable: true, get: function () { return __importDefault(outbound_schema_json_1).default; } });
+var return_schema_json_1 = require("./return.schema.json");
+Object.defineProperty(exports, "OrderShipmentShippedReturn", { enumerable: true, get: function () { return __importDefault(return_schema_json_1).default; } });

package/dist/cjs/contracts/order/shipment/shipped/outbound.schema.json

@@ -0,0 +1,34 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order Shipment Shipped Outbound",
+    "type": "object",
+    "$id": "https://shushed.example.com/order/shipment/shipped/outbound.schema.json",
+    "description": "Represents an outbound shipment that has been dispatched from a fulfillment center to the customer. Includes the fulfillment provider and list of items shipped.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/order/shipment.schema.json"
+        },
+        {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "type": ["string"],
+                    "enum": ["SHIPPED-OUTBOUND"],
+                    "description": "Identifies this shipment as an outbound shipment to the customer."
+                },
+                "shipped_by": {
+                    "type": ["string"],
+                    "enum": ["TORQUE", "GLOBALE"],
+                    "description": "The fulfillment provider responsible for shipping the order."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://shushed.example.com/order/shipment/item.schema.json"
+                    },
+                    "description": "List of items included in the outbound shipment."
+                }
+            }
+        }
+    ]
+}

package/dist/cjs/contracts/order/shipment/shipped/return.schema.json

@@ -0,0 +1,43 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order Shipment Shipped Return",
+    "type": "object",
+    "$id": "https://shushed.example.com/order/shipment/shipped/return.schema.json",
+    "description": "Represents a shipment that has been returned by the customer, including the items that were sent back.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/order/shipment.schema.json"
+        },
+        {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "type": [
+                        "string"
+                    ],
+                    "enum": [
+                        "SHIPPED-RETURN"
+                    ],
+                    "description": "Indicates this shipment is a returned shipment."
+                },
+                "shipped_by": {
+                    "type": [
+                        "string"
+                    ],
+                    "enum": [
+                        "CUSTOMER"
+                    ],
+                    "description": "Specifies that the return was initiated by the customer."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://shushed.example.com/order/shipment/item.schema.json"
+                    },
+                    "description": "List of items returned in the shipment."
+                }
+            },
+            "required": ["type", "shipped_by", "items"]
+        }
+    ]
+}

package/dist/cjs/contracts/order/shipment/shipped.schema.json

@@ -0,0 +1,52 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order Shipment Outbound",
+    "type": "object",
+    "$id": "https://shushed.example.com/order/shipment/shipped.schema.json",
+    "description": "Represents a shipment event for an order, either outbound or return, including courier, tracking, and class details.",
+    "additionalProperties": false,
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/order/shipment.schema.json"
+        },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "type": {
+                    "type": ["string"],
+                    "enum": ["SHIPPED-OUTBOUND", "SHIPPED-RETURN"],
+                    "description": "Indicates the direction of the shipment: outbound to customer or return from customer.",
+                    "example": "SHIPPED-OUTBOUND"
+                },
+                "shipped_by": {
+                    "type": ["string"],
+                    "enum": ["TORQUE", "GLOBALE", "CUSTOMER"],
+                    "description": "Party responsible for shipping: a warehouse partner (e.g., TORQUE), logistics partner (e.g., GLOBALE), or the customer themselves.",
+                    "example": "TORQUE"
+                },
+                "courier_name": {
+                    "type": ["string", "null"],
+                    "enum": ["GLOBALE", "ROYALMAIL", "EVRI", "WAITROSE"],
+                    "description": "Courier company used for shipping. May be null for customer-initiated returns.",
+                    "example": "ROYALMAIL"
+                },
+                "tracking_code": {
+                    "type": ["string", "null"],
+                    "faker": {
+                        "format": "uuid"
+                    },
+                    "description": "Tracking number provided by the courier. May be null if unavailable.",
+                    "example": "PZ448969282GB"
+                },
+                "class_name": {
+                    "type": ["string"],
+                    "enum": ["STANDARD", "PRIORITY"],
+                    "description": "Delivery service class used for the shipment.",
+                    "example": "STANDARD"
+                }
+            },
+            "required": ["shipped_by", "courier_name", "tracking_code", "class_name"]
+        }
+    ]
+}

package/dist/cjs/contracts/order/shipment.schema.json

@@ -0,0 +1,58 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Shipment",
+    "type": "object",
+    "$id": "https://shushed.example.com/order/shipment.schema.json",
+    "description": "Represents a shipment record which could be outbound or return, either from a warehouse or a point of sale (POS). Includes status, items, and ERP identifiers.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/total.schema.json"
+        },
+        {
+            "type": "object",
+            "properties": {
+                "erp_id": {
+                    "type": ["string"],
+                    "faker": { "custom.documentid": ["SP", 9] },
+                    "description": "Unique identifier for the shipment from the ERP system."
+                },
+                "type": {
+                    "type": ["string"],
+                    "enum": [
+                        "SHIPPED-OUTBOUND",
+                        "SHIPPED-RETURN",
+                        "POS-OUTBOUND",
+                        "POS-RETURN"
+                    ],
+                    "description": "Type of shipment. Can be shipped or returned from warehouse or POS."
+                },
+                "shipped_at": {
+                    "type": ["string"],
+                    "format": "date-time",
+                    "description": "Date and time the shipment was shipped."
+                },
+                "status": {
+                    "type": ["string"],
+                    "enum": ["PENDING", "SHIPPED", "RECEIVED", "CANCELLED"],
+                    "description": "Current status of the shipment."
+                },
+                "items": {
+                    "type": ["array"],
+                    "items": {
+                        "type": "object",
+                        "anyOf": [
+                            {
+                                "$ref": "https://shushed.example.com/order/shipment/item.schema.json"
+                            },
+                            {
+                                "$ref": "https://shushed.example.com/order/shipment/item/returned.schema.json"
+                            }
+                        ]
+                    },
+                    "description": "List of items included in the shipment."
+                }
+            }
+        }
+    ],
+    "required": ["erp_id", "shipped_at", "status", "items"]
+}

package/dist/cjs/contracts/order.schema.json

@@ -0,0 +1,231 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Order",
+    "type": "object",
+    "$id": "https://shushed.example.com/order.schema.json",
+    "properties": {
+        "status": {
+            "type": ["string"],
+            "enum": [
+                "NEW",
+                "PENDING",
+                "CONFIRMED",
+                "PROCESSING",
+                "PROCESSED",
+                "PACKED",
+                "SHIPPED",
+                "DELIVERED",
+                "PARTIALLY-SHIPPED",
+                "RETURNED",
+                "PARTIALLY-RETURNED",
+                "CANCELLED",
+                "ARCHIVED",
+                "FAILED"
+            ],
+            "description": "Current status of the order in the order lifecycle - Example: PENDING"
+        },
+        "erp_order_id": {
+            "type": "string",
+            "faker": { "custom.documentid": ["MOCK", "8"] },
+            "description": "Unique order identifier assigned by the ERP system - Example: XX12345678"
+        },
+        "centra_order_id": {
+            "type": ["integer", "null"],
+            "description": "Unique order number assigned by the Centra system (integer format) - Example: 23"
+        },
+        "sfcc_order_id": {
+            "type": ["string", "null"],
+            "description": "Salesforce Commerce Cloud order identifier, nullable if not applicable - Example: XX123456789 or null"
+        },
+        "globale_order_id": {
+            "type": ["string", "null"],
+            "faker": { "custom.documentid": ["GEMOCK", "16"] },
+            "description": "Identifier for Globale orders, nullable if not applicable - Example: GE00025734 or null"
+        },
+        "sitoo_order_id": {
+            "type": ["string", "null"],
+            "format": "uuid",
+            "description": "Sitoo POS system order identifier, nullable if not applicable - Example: XX10008732 or null"
+        },
+        "system_created_by": {
+            "type": "string",
+            "enum": ["POS", "ECOMMERCE", "SYSTEM"],
+            "description": "Origin system or actor that created the order record - Example: POS"
+        },
+        "ordered_at": {
+            "type": "string",
+            "format": "date-time",
+            "faker": {
+                "date.between": ["2024-01-01T00:00:00.000Z", "2025-04-30T00:00:00.000Z"]
+            },
+            "description": "Timestamp when the order was placed - Example: 2024-12-25T15:30:00Z"
+        },
+        "payments": {
+            "type": "array",
+            "items": { "$ref": "https://shushed.example.com/order/payment.schema.json" },
+            "faker": {
+                "minItems": 1,
+                "maxItems": 2,
+                "uniqueItems": true
+            },
+            "description": "List of payment transactions related to this order.",
+            "example": [
+                {
+                    "type": "CHARGE",
+                    "created_at": "2024-12-25T15:35:00Z",
+                    "payment_method": "CREDIT-CARD",
+                    "transaction_id": "TR123456789",
+                    "card_number": "4111111111111111",
+                    "journey_label": "CHECKOUT",
+                    "psp_reference": "PSP987654321",
+                    "card_brand": "VISA",
+                    "status": "CAPTURED",
+                    "amount": { "currency": "USD", "value": 15000 },
+                    "created_by": "CUSTOMER"
+                }
+            ]
+        },
+        "is_anonymous": {
+            "type": ["boolean"],
+            "description": "Indicates if the order was placed by an anonymous user - Example: true or false"
+        },
+        "is_gift": {
+            "type": ["boolean"],
+            "description": "Indicates if the order is marked as a gift - Example: true or false"
+        },
+        "customer": {
+            "$ref": "https://shushed.example.com/order/customer.schema.json",
+            "description": "Customer details related to this order - Example: {}"
+        },
+        "billing_address": {
+            "anyOf": [
+                { "$ref": "https://shushed.example.com/order/address.schema.json" },
+                { "type": ["null"] }
+            ],
+            "description": "Billing address for the order, nullable if unavailable.",
+            "example": {
+                "first_name": "Alice",
+                "last_name": "Johnson",
+                "address1": "123 Main St",
+                "address2": "Apt 4B",
+                "city": "New York",
+                "region": "NY",
+                "post_code": "10001",
+                "country_code": "US",
+                "phone": "+1-202-555-0143"
+            }
+        },
+        "shipping_address": {
+            "anyOf": [
+                { "$ref": "https://shushed.example.com/order/address.schema.json" },
+                { "type": ["null"] }
+            ],
+            "description": "Shipping address for the order, nullable if unavailable.",
+            "example": {
+                "first_name": "Alice",
+                "last_name": "Johnson",
+                "address1": "123 Main St",
+                "address2": "Apt 4B",
+                "city": "New York",
+                "region": "NY",
+                "post_code": "10001",
+                "country_code": "US",
+                "phone": "+1-202-555-0143"
+            }
+        },
+        "collection_point_id": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Collection point ID reference if applicable - Example: EVRI-S41902"
+        },
+        "is_pos": { "type": ["boolean"], "description": "Flag indicating if the order was placed via a POS system example: true or false" },
+        "shipments": {
+            "type": "array",
+            "minItems": 1,
+            "prefixItems": [
+                {
+                    "anyOf": [
+                        {
+                            "$ref": "https://shushed.example.com/order/shipment/shipped/outbound.schema.json"
+                        },
+                        {
+                            "$ref": "https://shushed.example.com/order/shipment/pos/outbound.schema.json"
+                        }
+                    ]
+                }
+            ],
+            "items": {
+                "anyOf": [
+                    {
+                        "$ref": "https://shushed.example.com/order/shipment/shipped/outbound.schema.json"
+                    },
+                    {
+                        "$ref": "https://shushed.example.com/order/shipment/shipped/return.schema.json"
+                    },
+                    {
+                        "$ref": "https://shushed.example.com/order/shipment/pos/outbound.schema.json"
+                    },
+                    {
+                        "$ref": "https://shushed.example.com/order/shipment/pos/return.schema.json"
+                    }
+                ]
+            },
+            "faker": {
+                "minItems": 1,
+                "maxItems": 2,
+                "uniqueItems": true
+            },
+            "description": "List of shipments related to the order, including outbound and return shipments",
+            "example": [
+                {
+                    "erp_id": "SP123456789",
+                    "type": "SHIPPED-OUTBOUND",
+                    "shipped_at": "2024-12-26T10:00:00Z",
+                    "status": "SHIPPED",
+                    "items": [
+                        {
+                            "sku": "SKU123",
+                            "quantity": 1,
+                            "unit_price_net": { "currency": "USD", "value": 10000 },
+                            "unit_price_gross": { "currency": "USD", "value": 12000 }
+                        }
+                    ]
+                }
+            ]
+        },
+        "items": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "https://shushed.example.com/order/item.schema.json" },
+            "faker": {
+                "minItems": 1,
+                "maxItems": 2,
+                "uniqueItems": true
+            },
+            "description": "List of items included in the order.",
+            "example": [
+                {
+                    "sku": "SKU123",
+                    "colour_id": "RED",
+                    "style_id": "STYLE1",
+                    "quantity": 1,
+                    "unit_price_net": { "currency": "USD", "value": 10000 },
+                    "unit_price_gross": { "currency": "USD", "value": 12000 },
+                    "unit_price_status": "rrp",
+                    "discount_amount_net": { "currency": "USD", "value": 0 },
+                    "discount_amount_gross": { "currency": "USD", "value": 0 }
+                }
+            ]
+        },
+        "total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of the order." },
+        "return_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of returned items." },
+        "net_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Net total amount after discounts and returns." },
+        "shipping_method": {
+            "type": ["string", "null"],
+            "description": "Shipping method used for the order, nullable if not applicable - Example: EMAILDELIVERY, GLOBALE_HUB, GLOBALE_EXPRESS"
+        }
+    },
+    "required": ["erp_order_id", "status", "ordered_at", "items", "total"]
+}

package/dist/cjs/contracts/product-category.schema.json

@@ -0,0 +1,34 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://shushed.example.com/product-category.schema.json",
+    "title": "ProductCategory",
+    "description": "Schema representing all categories assigned to a product for a specific site.",
+    "additionalProperties": false,
+    "type": "object",
+    "properties": {
+        "product_id": {
+            "type": "string",
+            "description": "Unique identifier of the product."
+        },
+        "site_id": {
+            "type": "string",
+            "description": "Identifier or display name of the site/storefront where this category assignment applies."
+        },
+        "categories": {
+            "type": "array",
+            "description": "Array of category identifiers assigned to this product.",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 0
+        }
+    },
+    "required": ["product_id", "site_id", "categories"],
+    "examples": [
+        {
+            "product_id": "prod123",
+            "site_id": "Linen Blend Petunia Wide Leg Trousers",
+            "categories": ["Shop", "Trousers"]
+        }
+    ]
+}