@shushed/helpers 0.0.295 → 0.0.297-main-20260320145035

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

@@ -14,11 +14,6 @@
             "type": "string",
             "description": "Dash ID"
         },
-        "md5": {
-            "type": "string",
-            "pattern": "^[a-f0-9]{32}$",
-            "description": "MD5 hash of the asset"
-        },
         "dash_folder_path": {
             "type": "string",
             "description": "Dash folder path"
@@ -71,12 +66,8 @@
         },
         "file_name": {
             "type": "string",
-            "pattern": "^[A-Za-z0-9-_.]+$",
-            "description": "The filename of the asset. Upper/Lowercase, underscores, dashes, no spaces"
-        },
-        "is_product": {
-            "type": "boolean",
-            "description": "Whether the asset is a product image or not"
+            "pattern": "^[a-z0-9-.]+$",
+            "description": "The content type of the asset. Lowercase, dashes, no spaces"
         }
     },
     "required": [

package/dist/cjs/contracts/gift-voucher.schema.json

@@ -39,14 +39,8 @@
                 ]
             }
         },
-        "is_expired": {
-            "type": "boolean"
-        },
         "customer_email": {
-            "type": [
-                "string",
-                "null"
-            ],
+            "type": ["string", "null"],
             "format": "email",
             "description": "Normalized and lowercased email. Null if invalid.",
             "example": "alice.johnson@example.com"
@@ -61,10 +55,6 @@
                 ]
             }
         },
-        "original_amount": {
-            "$ref": "https://shushed.example.com/money.schema.json",
-            "description": "Original Gift Voucher Amount"
-        },
         "balance": {
             "$ref": "https://shushed.example.com/money.schema.json",
             "description": "Balance currently on the voucher - Example: 25.50"
@@ -85,6 +75,8 @@
         "valid_until",
         "customer_email",
         "purchased_at",
-        "balance"
+        "balance",
+        "is_physical",
+        "has_been_emailed"
     ]
 }

package/dist/cjs/contracts/messages/product.schema.json

@@ -13,12 +13,16 @@
             "required": [
                 "product_id",
                 "style_id",
+                "product_name",
                 "variants",
                 "images",
                 "attributes",
+                "is_available_to_order",
                 "created_at",
                 "last_modified_at",
-                "colour_family_name"
+                "colour_family_name",
+                "colour_label",
+                "vat_amount"
             ]
         }
     ]

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

@@ -45,50 +45,54 @@
         },
         "company_name": {
             "type": "string",
-            "maxLength": 100
+            "maxLength": 30
         },
         "first_name": {
-            "type": ["string", "null"],
-            "maxLength": 50,
+            "type": "string",
+            "maxLength": 30,
+            "minLength": 1,
             "faker": { "name.firstName": [] },
-            "description": "Recipient's first name. Null for company/press orders without individual names."
+            "description": "Recipient's first name."
         },
         "last_name": {
-            "type": ["string", "null"],
-            "maxLength": 50,
+            "type": "string",
+            "maxLength": 30,
+            "minLength": 1,
             "faker": { "name.lastName": [] },
-            "description": "Recipient's last name. Null for company/press orders without individual names."
+            "description": "Recipient's last name."
         },
         "address1": {
             "type": ["string"],
             "minLength": 1,
-            "maxLength": 100,
+            "maxLength": 30,
             "faker": { "address.streetAddress": [] },
             "description": "Primary street address."
         },
         "address2": {
             "type": ["string", "null"],
-            "maxLength": 100,
+            "maxLength": 30,
             "faker": { "address.secondaryAddress": [] },
             "description": "Additional address line (e.g., apartment or suite number)."
         },
         "city": {
-            "type": ["string", "null"],
-            "maxLength": 50,
+            "type": ["string"],
+            "maxLength": 30,
+            "minLength": 1,
             "faker": { "address.city": [] },
-            "description": "City or locality of the address. Null when not provided in BC source data."
+            "description": "City or locality of the address."
         },
         "region": {
             "type": ["string", "null"],
-            "maxLength": 50,
+            "maxLength": 30,
             "faker": { "address.state": [] },
             "description": "State, province, or region of the address."
         },
         "post_code": {
             "type": ["string", "null"],
             "maxLength": 20,
+            "pattern": "^[A-Z0-9 ]*$",
             "faker": { "address.zipCode": [] },
-            "description": "Postal code (optional for countries without postal codes).",
+            "description": "Postal code (uppercase letters and numbers with spaces; optional for countries without postal codes).",
             "examples": ["SW1A 1AA", "90210", null]
         },
         "country_code": {

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

@@ -12,105 +12,59 @@
             "type": "object",
             "properties": {
                 "sku": {
-                    "type": [
-                        "string"
-                    ],
-                    "faker": {
-                        "custom.sku": []
-                    },
+                    "type": ["string"],
+                    "faker": { "custom.sku": [] },
                     "description": "Stock Keeping Unit identifier for the item.Combination of style code and colour code and "
                 },
                 "linked_style_id": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "faker": {
-                        "custom.style": []
-                    },
+                    "type": ["string", "null"],
+                    "faker": { "custom.style": [] },
                     "description": "Style ID of the parent item if this is a variation."
                 },
                 "colour_id": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "faker": {
-                        "custom.color": []
-                    },
+                    "type": ["string", "null"],
+                    "faker": { "custom.color": [] },
                     "description": "Code from Object Colorway - Example: 3203, null if not applicable (e.g., non-product items like NEWSLETTER)"
                 },
                 "style_id": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "faker": {
-                        "custom.style": []
-                    },
+                    "type": ["string", "null"],
+                    "faker": { "custom.style": [] },
                     "description": "Code from Object style - Example: 000697, null if not applicable (e.g., non-product items like NEWSLETTER)"
                 },
                 "product_id": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
+                    "type": ["string", "null"],
                     "description": "Code from Object style and colour - Example: 000697-3203"
                 },
                 "colour_name": {
-                    "type": [
-                        "string"
-                    ],
-                    "faker": {
-                        "color.human": []
-                    },
+                    "type": ["string"],
+                    "faker": { "color.human": [] },
                     "description": "Node Name from Object Colorway - Example: Toffee Brown"
                 },
                 "size_name": {
-                    "type": [
-                        "string"
-                    ],
-                    "faker": {
-                        "custom.size": []
-                    },
+                    "type": ["string"],
+                    "faker": { "custom.size": [] },
                     "description": "HS_ColorwayAttr_SizeRangeNodeName from Object ColorwayAttributes - Example: 10-16"
                 },
                 "preorder_date": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
+                    "type": ["string", "null"],
                     "format": "date",
                     "description": "Expected availability date if the item is on preorder."
                 },
                 "quantity": {
-                    "type": [
-                        "integer"
-                    ],
+                    "type": ["integer"],
                     "minimum": 0,
-                    "faker": {
-                        "minimum": 0,
-                        "maximum": 10
-                    },
+                    "faker": { "minimum": 0, "maximum": 10 },
                     "description": "Number of units ordered. Represented as integer."
                 },
                 "unit_price_status": {
                     "type": "string",
-                    "enum": [
-                        "rrp",
-                        "perm",
-                        "pos"
-                    ],
+                    "enum": ["rrp", "perm", "pos"],
                     "description": "Pricing status: rrp (Full Price), perm (Markdown), pos (Promotional)."
                 },
                 "returned_quantity": {
-                    "type": [
-                        "integer"
-                    ],
+                    "type": ["integer"],
                     "minimum": 0,
-                    "faker": {
-                        "maximum": 1
-                    },
+                    "faker": { "maximum": 1 },
                     "description": "Number of units returned. Represented as integer."
                 },
                 "unit_price_net": {
@@ -122,29 +76,12 @@
                     "description": "Gross unit price in smallest currency unit. Represented as integer."
                 },
                 "discount_code": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "faker": {
-                        "format": "uuid"
-                    },
+                    "type": ["string", "null"],
+                    "faker": { "format": "uuid" },
                     "description": "Code applied to trigger a discount, if any."
                 },
-                "discount_campaign": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "description": "Voucher code or campaign name for the purchase"
-                },
                 "cost_net": {
-                    "$ref": "https://shushed.example.com/money.schema.json",
-                    "description": "Net cost per unit in smallest currency unit (from unit_cost_lcy)."
-                },
-                "order_line_no": {
-                    "type": ["integer", "null"],
-                    "description": "Original order line number from BC sales/invoice line. Used for cross-document tracing."
+                    "$ref": "https://shushed.example.com/money.schema.json"
                 }
             },
             "required": [

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

@@ -35,9 +35,9 @@
             "description": "The method used for the transaction."
         },
         "transaction_id": {
-            "type": ["string", "null"],
+            "type": ["string"],
             "faker": { "custom.documentid": ["TR", 10] },
-            "description": "Internal transaction reference ID. Derived from card_payment.transaction_id, payment.payment_gateway_token, or null if unavailable."
+            "description": "Internal transaction reference ID."
         },
         "card_number": {
             "type": ["string", "null"],
@@ -70,9 +70,9 @@
             "description": "Channel through which the payment was initiated."
         },
         "psp_reference": {
-            "type": ["string", "null"],
+            "type": "string",
             "faker": { "custom.documentid": ["PSP", 10] },
-            "description": "Reference provided by the Payment Service Provider (PSP). Same as transaction_id."
+            "description": "Reference provided by the Payment Service Provider (PSP)."
         },
         "card_brand": {
             "type": ["string", "null"],

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

@@ -11,11 +11,6 @@
             "faker": { "datatype.number": [1, 1] },
             "description": "Line number of the item in the order. Used for item referencing and tracking."
         },
-        "sku": {
-            "type": ["string"],
-            "faker": { "custom.sku": [] },
-            "description": "Stock Keeping Unit identifier matching the order item SKU (item_no-variant_code)."
-        },
         "quantity": {
             "type": ["integer"],
             "minimum": 1,
@@ -23,5 +18,5 @@
             "description": "The number of units of the item shipped."
         }
     },
-    "required": ["lineNumber", "sku", "quantity"]
+    "required": ["lineNumber", "quantity"]
 }

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

@@ -12,21 +12,12 @@
             "type": "object",
             "properties": {
                 "erp_id": {
-                    "type": [
-                        "string"
-                    ],
-                    "faker": {
-                        "custom.documentid": [
-                            "SP",
-                            9
-                        ]
-                    },
+                    "type": ["string"],
+                    "faker": { "custom.documentid": ["SP", 9] },
                     "description": "Unique identifier for the shipment from the ERP system."
                 },
                 "type": {
-                    "type": [
-                        "string"
-                    ],
+                    "type": ["string"],
                     "enum": [
                         "SHIPPED-OUTBOUND",
                         "SHIPPED-RETURN",
@@ -36,59 +27,17 @@
                     "description": "Type of shipment. Can be shipped or returned from warehouse or POS."
                 },
                 "shipped_at": {
-                    "type": [
-                        "string"
-                    ],
+                    "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."
-                },
-                "discount_code": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "faker": {
-                        "format": "uuid"
-                    },
-                    "description": "Code applied to trigger a discount, if any."
-                },
-                "discount_campaign": {
-                    "type": [
-                        "string",
-                        "null"
-                    ],
-                    "description": "Voucher code or campaign name for the purchase"
-                },
-                "courier_name": {
-                    "type": ["string", "null"],
-                    "enum": ["GLOBALE", "ROYALMAIL", "EVRI", "WAITROSE", null],
-                    "description": "Name of the courier/shipping carrier handling the shipment."
-                },
-                "tracking_code": {
-                    "type": ["string", "null"],
-                    "description": "Tracking code or reference number provided by the courier."
-                },
-                "class_name": {
                     "type": ["string"],
-                    "enum": ["STANDARD", "PRIORITY"],
-                    "description": "Shipping service class. PRIORITY for express/24-hour, STANDARD for economy/48-hour."
+                    "enum": ["PENDING", "SHIPPED", "RECEIVED", "CANCELLED"],
+                    "description": "Current status of the shipment."
                 },
                 "items": {
-                    "type": [
-                        "array"
-                    ],
+                    "type": ["array"],
                     "items": {
                         "type": "object",
                         "anyOf": [
@@ -105,10 +54,5 @@
             }
         }
     ],
-    "required": [
-        "erp_id",
-        "shipped_at",
-        "status",
-        "items"
-    ]
+    "required": ["erp_id", "shipped_at", "status", "items"]
 }