@shushed/helpers 0.0.202-bug-erp-770-20251203154745 → 0.0.202-main-20251208111718

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

@@ -0,0 +1,816 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Product",
+    "$id": "https://shushed.example.com/product.schema.json",
+    "additionalProperties": false,
+    "type": "object",
+    "properties": {
+        "product_id": {
+            "type": "string",
+            "description": "Colour & Style ID combination seperated by a dash - Example: 000004-2763 "
+        },
+        "slug": {
+            "type": [
+                "string"
+            ],
+            "description": "URI of the product eg. leather-jack-barrel-trousers-chocolate-brown/013464-0533.html"
+        },
+        "style_slug": {
+            "type": [
+                "string"
+            ],
+            "description": "URI of the style eg. leather-jack-barrel-trousers/013464.html"
+        },
+        "style_id": {
+            "type": [
+                "string"
+            ],
+            "faker": {
+                "custom.style": []
+            },
+            "description": "Parent style_id - Example: 000697"
+        },
+        "colour_id": {
+            "type": "string",
+            "description": "ID of the colour inside the colour library. Part of the product ID (for the 000697-3203 it would be 3203). Warning! The id dos not link to a single generally-understood colour. I.e. leopard print has ~40 different colour ids. Instead it links to SPECIFIC leopard print ordered for this specific material (specific shared of Navy Dusk Blue etc.)"
+        },
+        "style_name": {
+            "type": "string",
+            "description": "Style Name - Example: Puff Sleeve Sweatshirt"
+        },
+        "product_name": {
+            "type": "string",
+            "description": "Product Name - Example: Puff Sleeve Sweatshirt (Blue)"
+        },
+        "display_name": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Centra Name - Example: Brown Puff Shirt"
+        },
+        "buffer_quantity": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Quantity of product we keep on hand to guard against unforseen fluctuations in demand/supply"
+        },
+        "display_type": {
+            "description": "Change of how product is represented in the website. Example [{ channel: \"DIRECT-UK\", display_type: \"Out-of-stock\" }]. By default all products will have default display_type available",
+            "type": "string",
+            "enum": [
+                "Out-of-stock",
+                "Permanently-unavailable"
+            ]
+        },
+        "available_to_sell_from": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date",
+            "description": "The Date (inclusive) from which the product should be available to sell. The string should be used for pre-orders, or product release dates. For the latter, the date should be coordinated with online_from"
+        },
+        "online_from": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date-time",
+            "description": "The DateTime (inclusive) from which the product should be shown (in any way / design / display type) on the website (direct channel). Every online product should have a date, default to 1970-01-01T00:00:00.000Z"
+        },
+        "online_to": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date-time",
+            "description": "The DateTime (inclusive) until which product should be shown (in any way / design / display type) on the website."
+        },
+        "first_online_at": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date-time",
+            "description": "The DateTime of product last online in the direct channel"
+        },
+        "last_online_at": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date-time",
+            "description": "The DateTime of product last online in the direct channel"
+        },
+        "first_purchased_at": {
+            "type": "string",
+            "format": "date-time",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "first_markdown_at": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "format": "date-time",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "last_modified_at": {
+            "type": "string",
+            "format": "date-time",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "colour_family_name": {
+            "type": "string",
+            "faker": {
+                "color.human": []
+            },
+            "description": "New Tags To Add - Example: yellow"
+        },
+        "colour_code": {
+            "type": "string",
+            "description": "Colours as Text - Example: buttercup-yellow from initial input of Buttercup Yellow"
+        },
+        "colour_name": {
+            "type": "string",
+            "description": "Toffee Brown"
+        },
+        "display_tags": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "Example - [20% Off, Summer Sale])"
+        },
+        "sizerange_code": {
+            "type": "string",
+            "description": "Size range assigned to this product. Defines sizes to be created"
+        },
+        "sizerange_name": {
+            "type": "string",
+            "description": "Size range name for this product"
+        },
+        "variants": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "code": {
+                        "type": "string",
+                        "description": "Size code - Example: 10"
+                    },
+                    "name": {
+                        "type": [
+                            "string"
+                        ],
+                        "faker": {
+                            "custom.size": []
+                        },
+                        "description": "Size label - Example: 10 becomes M"
+                    }
+                },
+                "required": [
+                    "code",
+                    "name"
+                ]
+            }
+        },
+        "images": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "type": {
+                        "type": "string",
+                        "enum": [
+                            "Campaign",
+                            "Ecom",
+                            "Flatlay",
+                            "UGC",
+                            "AI"
+                        ],
+                        "description": "Image type for product - Example: Campaign"
+                    },
+                    "url": {
+                        "type": "string",
+                        "format": "uri",
+                        "description": "Image URl for product"
+                    },
+                    "description": {
+                        "type": "string",
+                        "description": "Style Title - Example: Puff Sleeve Sweatshirt"
+                    }
+                },
+                "required": [
+                    "type",
+                    "url"
+                ]
+            }
+        },
+        "vat_rate_uk": {
+            "type": [
+                "number",
+                "null"
+            ],
+            "minimum": 0,
+            "description": "VAT represented as integer (percentage), 0.2 becomes 20 (as 20%)"
+        },
+        "supply_chain": {
+            "type": "object",
+            "properties": {
+                "hs_code": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "HS Code"
+                },
+                "commodity_code_ref": {
+                    "type": "string",
+                    "description": "Harmonized Commodity Code - Example: C0/101888|DutyRate"
+                },
+                "country_of_origin": {
+                    "$ref": "https://shushed.example.com/country.schema.json",
+                    "description": "Country Of Origin - Example: RO"
+                },
+                "port_of_origin": {
+                    "type": "string",
+                    "description": "Port Of Origin - Example: MUMBAI"
+                },
+                "supplier_id": {
+                    "type": "string",
+                    "pattern": "^SUP\\d{5}$",
+                    "description": "Supplier ID in the format 'SUP00099', where 'SUP' is followed by exactly five digits -  Example: SUP00045"
+                },
+                "supplier_name": {
+                    "type": "string",
+                    "description": "Supplier Name - Example: Binh Dinh Footwear Joint Stock Company"
+                },
+                "factory_id": {
+                    "type": "string",
+                    "pattern": "^FAC\\d{5}$",
+                    "description": "Factory ID in the format 'FAC00074', where 'FAC' is followed by exactly five digits"
+                },
+                "packing_method": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "enum": [
+                        "Standard",
+                        "Hanging"
+                    ],
+                    "description": "Packing Method; must be 'Standard', 'Hanging' or null"
+                },
+                "is_bought_in_product": {
+                    "type": "boolean",
+                    "description": "Bought In Product - Example: true or false"
+                }
+            },
+            "required": []
+        },
+        "merch": {
+            "type": "object",
+            "properties": {
+                "strategy_type": {
+                    "type": "string",
+                    "description": "Strategy Type - Example: Seasonal New"
+                },
+                "product_type": {
+                    "type": "string",
+                    "description": "Product Type - Example: Knit"
+                },
+                "stock_type": {
+                    "type": "string",
+                    "description": "Stock Type - Example: Knit"
+                },
+                "category": {
+                    "type": "string",
+                    "faker": {
+                        "commerce.department": []
+                    },
+                    "description": "Category - Example: Knitwear"
+                },
+                "subcategory": {
+                    "type": "string",
+                    "faker": {
+                        "commerce.product": []
+                    },
+                    "description": "Subcategory - Example: Parka Coat"
+                },
+                "range": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "enum": [
+                        "Main Collection",
+                        "Seasonal"
+                    ],
+                    "description": "Range - Example: Main Collection"
+                },
+                "channels_availability": {
+                    "type": [
+                        "array"
+                    ],
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "DIRECT-UK",
+                            "DIRECT-INT",
+                            "DIRECT-US",
+                            "JL-STORES",
+                            "JL-WEB",
+                            "NEXT",
+                            "MS",
+                            "FENWICK",
+                            "MORLEYS"
+                        ]
+                    },
+                    "description": "List of channels the product is exclusive to - Example: [MS]"
+                },
+                "collections": {
+                    "type": [
+                        "string"
+                    ],
+                    "description": "Collections [Centra] - Example: Spring 2025"
+                },
+                "seasons": {
+                    "type": [
+                        "array"
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Seasons ordered in cronological order - Example: [AW20, SS25]"
+                },
+                "drops": {
+                    "type": [
+                        "array"
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Drop - Example: [SS26 - December, SS25 - April]"
+                },
+                "fashionability": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Fashionability - Example: Core"
+                }
+            },
+            "required": []
+        },
+        "attributes": {
+            "type": "object",
+            "properties": {
+                "seo_url_name": {
+                    "type": "string",
+                    "pattern": "^[a-z-]+$",
+                    "description": "Part of the URL with the SEO-friendly product name (/${url_name}/${product_id}.html) - Example: for url_name: \"square-neck-texture-bikini-top-sage-green\" the final url will be /square-neck-texture-bikini-top-sage-green/013234-2274.html . Remember that this field will be filled in even before the product is published"
+                },
+                "embellishment": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "seo_title": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "SEO Title - Example: Puff Sleeve Sweatshirt. null if the root.product_name should be used"
+                },
+                "seo_description": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "SEO Description - Example: Puff Sleeve Sweatshirt. null if root.description should be used"
+                },
+                "fit_description": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Accordion product fit"
+                },
+                "description": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Product description"
+                },
+                "fabric_care": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Fabric and care accordion on the website"
+                },
+                "delivery_returns": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Delivery & Returns accordion on the website"
+                },
+                "weight": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "The average weight of the garmet (across sizes)"
+                },
+                "weight_statement": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "The weight statement"
+                },
+                "main_fibre": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Main Fibre - Applicable to garmets - Example: Cotton"
+                },
+                "main_metal": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Main Metal - Applicable to jewellery - Example: Silver"
+                },
+                "extra_selling_points": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Extra Selling Points - Example: [Lovely Print, Recyclable Fabric]"
+                },
+                "length_measurement": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Length Measurement - Example: Sole height: 1.5 cm"
+                },
+                "measurement_table_code": {
+                    "type": [
+                        "string"
+                    ],
+                    "description": "Measurement Table Code"
+                },
+                "fit": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Fit of the garmet"
+                },
+                "pockets": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Pockets details"
+                },
+                "pleats_gathers": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Pleats & Gathers details"
+                },
+                "lining": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Lining details"
+                },
+                "bias_cut": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Bias cut details"
+                },
+                "designer": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Designer of the garmet"
+                },
+                "fabric": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Main fabric of the garmet"
+                },
+                "fabric_composition": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Composition details"
+                },
+                "certificate_code": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Certificate of the fabric"
+                },
+                "shape": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Shape of the garmet"
+                },
+                "development_type": {
+                    "type": "string",
+                    "description": "Development Type - Example: Update"
+                },
+                "occasion": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Occasion - Example: Party"
+                },
+                "design": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Design type"
+                },
+                "block": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Block"
+                },
+                "pattern_name": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Pattern Name - Example: Interest"
+                },
+                "fit_type": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Fit Styling Description(ESP) - Example: Oversized"
+                },
+                "neckline": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Neckline - Example: Crew"
+                },
+                "sleeve_length": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "nullable": true,
+                    "description": "Sleeve Length - Example: Sleeveless"
+                },
+                "sleeve_type": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "nullable": true,
+                    "description": "Type of Sleeve i.e. "
+                },
+                "heel_height": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Heel Height - Example: 0.5CM"
+                },
+                "heel_shape": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Heel Shape - Example: Flat"
+                },
+                "toe_shape": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Toe Shape - Example: Round"
+                },
+                "trouser_fit": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "nullable": true
+                },
+                "leg_length": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Leg Length - Example: Long"
+                },
+                "handle_straps": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Handle Straps - Example: XBody Strap"
+                },
+                "straps_features": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Features of the straps i.e. \"Detachable staps\""
+                },
+                "fastening": {
+                    "anyOf": [
+                        {
+                            "type": [
+                                "array",
+                                "null"
+                            ],
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Fastening - Example: Zip Front"
+                },
+                "sole_material": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Sole Material - Example: Rubber"
+                },
+                "care_instructions": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": " - Example: Fabric unlined / do not tumble dry"
+                }
+            },
+            "required": []
+        },
+        "presentations": {
+            "type": "object",
+            "description": "Presentation-specific overrides by key (e.g., default, website, email, website-US). Each key maps to an object containing a locale and presentation_type plus optional overrides of selected root fields.",
+            "additionalProperties": false,
+            "patternProperties": {
+                ".*": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "locale": {
+                            "type": "string",
+                            "pattern": "^[a-z]{2}-[A-Z]{2}$",
+                            "description": "Locale for this presentation (e.g., en-GB, en-US)."
+                        },
+                        "presentation_type": {
+                            "type": "string",
+                            "description": "Presentation type, e.g. website, email, default, website-US.",
+                            "examples": [
+                                "default",
+                                "website",
+                                "email",
+                                "website-US"
+                            ]
+                        },
+                        "slug": {
+                            "$ref": "#/properties/slug"
+                        },
+                        "style_slug": {
+                            "$ref": "#/properties/style_slug"
+                        },
+                        "style_name": {
+                            "$ref": "#/properties/style_name"
+                        },
+                        "display_name": {
+                            "$ref": "#/properties/display_name"
+                        },
+                        "display_type": {
+                            "$ref": "#/properties/display_type"
+                        },
+                        "available_to_sell_from": {
+                            "$ref": "#/properties/available_to_sell_from"
+                        },
+                        "online_from": {
+                            "$ref": "#/properties/online_from"
+                        },
+                        "online_to": {
+                            "$ref": "#/properties/online_to"
+                        },
+                        "last_online_at": {
+                            "$ref": "#/properties/last_online_at"
+                        },
+                        "first_purchased_at": {
+                            "$ref": "#/properties/first_purchased_at"
+                        },
+                        "first_markdown_at": {
+                            "$ref": "#/properties/first_markdown_at"
+                        },
+                        "colour_family_name": {
+                            "$ref": "#/properties/colour_family_name"
+                        },
+                        "colour_name": {
+                            "$ref": "#/properties/colour_name"
+                        },
+                        "display_tags": {
+                            "$ref": "#/properties/display_tags"
+                        },
+                        "sizerange_name": {
+                            "$ref": "#/properties/sizerange_name"
+                        },
+                        "variants": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "properties": {
+                                    "code": {
+                                        "$ref": "#/properties/variants/items/properties/code"
+                                    },
+                                    "name": {
+                                        "$ref": "#/properties/variants/items/properties/name"
+                                    }
+                                },
+                                "required": [
+                                    "code",
+                                    "name"
+                                ]
+                            },
+                            "description": "Per-variant display overrides. Include entries only for variants that differ."
+                        },
+                        "attributes": {
+                            "$ref": "#/properties/attributes"
+                        }
+                    },
+                    "required": [
+                        "locale",
+                        "presentation_type"
+                    ]
+                }
+            }
+        }
+    },
+    "required": [
+        "product_id",
+        "style_id",
+        "product_name",
+        "online_from"
+    ]
+}