@shushed/helpers 0.0.202-v2-20251208085030 → 0.0.202

package/dist/cjs/contracts/development-colour.schema.json

@@ -0,0 +1,97 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Development Colour",
+    "type": "object",
+    "description": "Represents a colour / pattern of the material. Managed by the PLM (design team)",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/development-colour.schema.json",
+    "properties": {
+        "colour_id": {
+            "type": "string",
+            "description": "The colour id (example: 3684). Becomes part of the product id"
+        },
+        "name": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "The development name of the colour (example: Absinthe Green 14-6329 TCX). Always lowercase, spaces, dashes"
+        },
+        "rgb": {
+            "anyOf": [
+                {
+                    "type": "null"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "number"
+                    },
+                    "description": "The RGB value of the colour (0-255) (example: [240, 100, 0])"
+                }
+            ]
+        },
+        "cmyk": {
+            "anyOf": [
+                {
+                    "type": "null"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "number"
+                    },
+                    "description": "The CMYK value of the colour (%) (example: [0, 100, 0, 0])"
+                }
+            ]
+        },
+        "pantone": {
+            "anyOf": [
+                {
+                    "type": "null"
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "name": {
+                            "type": "string",
+                            "description": "Pantone colour name"
+                        },
+                        "system": {
+                            "type": "string",
+                            "pattern": "^[A-Z0-9-]+$",
+                            "description": "Pantone system (example: TCX). Always uppercase, dashes, numbers"
+                        },
+                        "id": {
+                            "type": "string",
+                            "pattern": "^[A-Z0-9-]+$",
+                            "description": "The pantone id (example: 14-6329). Always uppercase, dashes, numbers"
+                        }
+                    }
+                }
+            ]
+        },
+        "display_name": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "pattern": "^[ a-z-]+$",
+            "description": "The display name of the colour (example: star blue). Always lowercase, spaces, dashes"
+        },
+        "family_display_name": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "pattern": "^[ a-z]+$",
+            "description": "The display name of the colour family (example blue). Always lowercase, spaces"
+        },
+        "source_asset": {
+            "$ref": "https://shushed.example.com/asset.schema.json"
+        }
+    },
+    "required": [
+        "colour_id"
+    ]
+}

package/dist/cjs/contracts/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Order = exports.MarketingPref = exports.CustomerSegment = exports.Asset = exports.DevelopmentColour = exports.Category = exports.ProductCategory = exports.Product = exports.ProductDraft = exports.Total = exports.Money = exports.Country = exports.Currency = void 0;
+var currency_schema_json_1 = require("./currency.schema.json");
+Object.defineProperty(exports, "Currency", { enumerable: true, get: function () { return __importDefault(currency_schema_json_1).default; } });
+var country_schema_json_1 = require("./country.schema.json");
+Object.defineProperty(exports, "Country", { enumerable: true, get: function () { return __importDefault(country_schema_json_1).default; } });
+var money_schema_json_1 = require("./money.schema.json");
+Object.defineProperty(exports, "Money", { enumerable: true, get: function () { return __importDefault(money_schema_json_1).default; } });
+var total_schema_json_1 = require("./total.schema.json");
+Object.defineProperty(exports, "Total", { enumerable: true, get: function () { return __importDefault(total_schema_json_1).default; } });
+var product_draft_schema_json_1 = require("./product-draft.schema.json");
+Object.defineProperty(exports, "ProductDraft", { enumerable: true, get: function () { return __importDefault(product_draft_schema_json_1).default; } });
+var product_schema_json_1 = require("./product.schema.json");
+Object.defineProperty(exports, "Product", { enumerable: true, get: function () { return __importDefault(product_schema_json_1).default; } });
+var product_category_schema_json_1 = require("./product-category.schema.json");
+Object.defineProperty(exports, "ProductCategory", { enumerable: true, get: function () { return __importDefault(product_category_schema_json_1).default; } });
+var category_schema_json_1 = require("./category.schema.json");
+Object.defineProperty(exports, "Category", { enumerable: true, get: function () { return __importDefault(category_schema_json_1).default; } });
+var development_colour_schema_json_1 = require("./development-colour.schema.json");
+Object.defineProperty(exports, "DevelopmentColour", { enumerable: true, get: function () { return __importDefault(development_colour_schema_json_1).default; } });
+var asset_schema_json_1 = require("./asset.schema.json");
+Object.defineProperty(exports, "Asset", { enumerable: true, get: function () { return __importDefault(asset_schema_json_1).default; } });
+var customer_segment_schema_json_1 = require("./customer-segment.schema.json");
+Object.defineProperty(exports, "CustomerSegment", { enumerable: true, get: function () { return __importDefault(customer_segment_schema_json_1).default; } });
+var marketing_preferences_schema_json_1 = require("./marketing-preferences.schema.json");
+Object.defineProperty(exports, "MarketingPref", { enumerable: true, get: function () { return __importDefault(marketing_preferences_schema_json_1).default; } });
+__exportStar(require("./order"), exports);
+var order_schema_json_1 = require("./order.schema.json");
+Object.defineProperty(exports, "Order", { enumerable: true, get: function () { return __importDefault(order_schema_json_1).default; } });
+__exportStar(require("./messages"), exports);

package/dist/cjs/contracts/marketing-preferences.schema.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "MarketingPref",
+    "$id": "https://shushed.example.com/order/marketing-preferences.schema.json",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "email_consent": {
+            "type": "boolean",
+            "description": "If the user has given consent to receive email marketing - Example: true or false"
+        },
+        "catalogue_consent": {
+            "type": "boolean",
+            "description": "If the user has given catalogue consent - Example: true or false"
+        },
+        "phone_consent": {
+            "type": "boolean",
+            "description": "If the user has given consent to receive phone marketing - Example: true or false"
+        },
+        "3rdparty_consent": {
+            "type": "boolean",
+            "description": "If the user has given consent to receive 3rd party marketing - Example: true or false"
+        },
+        "svc_customer_id": {
+            "type": "string",
+            "description": "Customer id"
+        },
+        "email": {
+            "type": ["string", "null"],
+            "format": "email",
+            "description": "Normalized and lowercased email. Null if invalid.",
+            "example": "alice.johnson@example.com"
+        }
+    },
+    "required": [
+        "email_consent",
+        "email",
+        "phone_consent",
+        "svc_customer_id"
+    ]
+}

package/dist/cjs/contracts/messages/ean-change.schema.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "EANChange",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/messages/ean-change.schema.json",
+    "type": "object",
+    "required": [
+        "sku",
+        "ean"
+    ],
+    "properties": {
+        "sku": {
+            "type": "string",
+            "faker": {
+                "custom.sku": []
+            }
+        },
+        "ean": {
+            "type": "string"
+        }
+    }
+}

package/dist/cjs/contracts/messages/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageProductCategory = exports.MessageProductChange = exports.MessageEanChange = exports.MessageProductDraft = void 0;
+var product_draft_schema_json_1 = require("./product-draft.schema.json");
+Object.defineProperty(exports, "MessageProductDraft", { enumerable: true, get: function () { return __importDefault(product_draft_schema_json_1).default; } });
+var ean_change_schema_json_1 = require("./ean-change.schema.json");
+Object.defineProperty(exports, "MessageEanChange", { enumerable: true, get: function () { return __importDefault(ean_change_schema_json_1).default; } });
+var product_schema_json_1 = require("./product.schema.json");
+Object.defineProperty(exports, "MessageProductChange", { enumerable: true, get: function () { return __importDefault(product_schema_json_1).default; } });
+var product_category_schema_json_1 = require("./product-category.schema.json");
+Object.defineProperty(exports, "MessageProductCategory", { enumerable: true, get: function () { return __importDefault(product_category_schema_json_1).default; } });
+__exportStar(require("./order"), exports);

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

@@ -0,0 +1,26 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderDelivered",
+    "$id": "https://shushed.example.com/messages/order/delivered.schema.json",
+    "additionalProperties": false,
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "status": {
+                    "type": ["string"],
+                    "enum": [
+                        "SHIPPED",
+                        "PARTIALLY-SHIPPED",
+                        "RETURNED",
+                        "PARTIALLY-RETURNED",
+                        "CANCELLED"
+                    ]
+                }
+            },
+            "required": ["erp_order_id", "shipments", "items", "total"]
+        }
+    ]
+}

package/dist/cjs/contracts/messages/order/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageOrderShipped = exports.MessageOrderReturned = exports.MessageOrderReturnInitiated = exports.MessageOrderProcessed = exports.MessageOrderNew = exports.MessageOrderDelivered = void 0;
+var delivered_schema_json_1 = require("./delivered.schema.json");
+Object.defineProperty(exports, "MessageOrderDelivered", { enumerable: true, get: function () { return __importDefault(delivered_schema_json_1).default; } });
+var new_schema_json_1 = require("./new.schema.json");
+Object.defineProperty(exports, "MessageOrderNew", { enumerable: true, get: function () { return __importDefault(new_schema_json_1).default; } });
+var processed_schema_json_1 = require("./processed.schema.json");
+Object.defineProperty(exports, "MessageOrderProcessed", { enumerable: true, get: function () { return __importDefault(processed_schema_json_1).default; } });
+var return_initiated_schema_json_1 = require("./return-initiated.schema.json");
+Object.defineProperty(exports, "MessageOrderReturnInitiated", { enumerable: true, get: function () { return __importDefault(return_initiated_schema_json_1).default; } });
+var returned_schema_json_1 = require("./returned.schema.json");
+Object.defineProperty(exports, "MessageOrderReturned", { enumerable: true, get: function () { return __importDefault(returned_schema_json_1).default; } });
+var shipped_schema_json_1 = require("./shipped.schema.json");
+Object.defineProperty(exports, "MessageOrderShipped", { enumerable: true, get: function () { return __importDefault(shipped_schema_json_1).default; } });

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

@@ -0,0 +1,32 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderNew",
+    "$id": "https://shushed.example.com/messages/order/new.schema.json",
+    "additionalProperties": false,
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "status": {
+                    "type": ["string"],
+                    "enum": ["NEW", "PENDING"],
+                    "description": "Initial status of the newly created order. 'NEW' indicates it's freshly created; 'PENDING' may be used when awaiting payment capture or confirmation."
+                }
+            },
+            "required": [
+                "payments",
+                "customer",
+                "is_pos",
+                "is_anonymous",
+                "is_gift",
+                "shipping_address",
+                "billing_address",
+                "shipments",
+                "items",
+                "total"
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderProcessed",
+    "$id": "https://shushed.example.com/messages/order/processed.schema.json",
+    "description": "Represents an order that has been successfully processed in the ERP system.",
+    "additionalProperties": true,
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "additionalProperties": true,
+            "required": ["erp_order_id", "customer", "total"]
+        }
+    ]
+}

package/dist/cjs/contracts/messages/order/return-initiated.schema.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderReturnInitiated",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/messages/order/return-initiated.schema.json",
+    "description": "Event message triggered when a customer initiates a return, starting the refund process.",
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "status": {
+                    "type": ["string"],
+                    "enum": [
+                        "RETURN-INITIATED",
+                        "RETURN-REQUESTED",
+                        "AWAITING-RETURN"
+                    ],
+                    "description": "Status indicating the early stage of the return process."
+                }
+            },
+            "required": ["erp_order_id", "shipments", "items", "total"]
+        }
+    ]
+}

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

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderReturnInitiated",
+    "$id": "https://shushed.example.com/messages/order/returned.schema.json",
+    "description": "Event triggered when an order has been fully or partially returned.",
+    "type": "object",
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "properties": {
+                "status": {
+                    "type": ["string"],
+                    "enum": [
+                        "RETURNED",
+                        "PARTIALLY-RETURNED",
+                        "CANCELLED"
+                    ],
+                    "description": "Final status of the order after return processing. 'RETURNED' means all items were returned and 'PARTIALLY-RETURNED' means some were. 'CANCELLED': Order or items cancelled before return or shipment"
+                }
+            },
+            "required": ["shipments"]
+        }
+    ]
+}

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

@@ -0,0 +1,26 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderShipped",
+    "description": "Represents the state of an order after shipment activities, including shipment, partial shipment, returns, partial returns, and cancellations.",
+    "$id": "https://shushed.example.com/messages/order/shipped.schema.json",
+    "allOf": [
+        { "$ref": "https://shushed.example.com/order.schema.json" },
+        {
+            "type": "object",
+            "properties": {
+                "status": {
+                    "type": ["string"],
+                    "enum": [
+                        "SHIPPED",
+                        "PARTIALLY-SHIPPED",
+                        "RETURNED",
+                        "PARTIALLY-RETURNED",
+                        "CANCELLED"
+                    ],
+                    "description": "Current shipment or return status of the order."
+                }
+            },
+            "required": ["erp_order_id", "shipments", "items", "total"]
+        }
+    ]
+}

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

@@ -0,0 +1,21 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "ProductCategory",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/messages/product-category.schema.json",
+    "description": "Pub/Sub message schema for product-category assignments, wrapping the core ProductCategory payload.",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/product-category.schema.json"
+        },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "product_id",
+                "site_id",
+                "categories"
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,66 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "OrderReturnInitiated",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/messages/product-draft.schema.json",
+    "allOf": [
+        { "$ref": "https://shushed.example.com/product-draft.schema.json" },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "product_name",
+                "colour_label",
+                "developement_colourway_id",
+                "colour_id",
+                "style_id",
+                "season_id",
+                "drop_name",
+                "stock_type",
+                "block",
+                "packing_method",
+                "is_bought_in_product",
+                "is_carry_over",
+                "image_url",
+                "product_type",
+                "product_category",
+                "division",
+                "care_instructions",
+                "range",
+                "main_fibre",
+                "size_range",
+                "sizes",
+                "occasion",
+                "strategy_type",
+                "pattern_name",
+                "neckline",
+                "sleeve_length",
+                "leg_length",
+                "heel_height",
+                "heel_shape",
+                "toe_shape",
+                "handle_straps",
+                "fastening",
+                "sole_code",
+                "fashionability",
+                "weight",
+                "average_weight_grams",
+                "length_measurement",
+                "fabric_composition_footwear",
+                "retail_price",
+                "current_cost",
+                "currency",
+                "moq",
+                "finishing_cost",
+                "other_costs",
+                "freight_rate",
+                "duty_rate",
+                "commodity_code_ref",
+                "country_of_origin",
+                "port_of_origin",
+                "supplier_id",
+                "factory_id"
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,29 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "ProductChange",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/messages/product-change.schema.json",
+    "allOf": [
+        {
+            "$ref": "https://shushed.example.com/product.schema.json"
+        },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "product_id",
+                "style_id",
+                "product_name",
+                "variants",
+                "images",
+                "attributes",
+                "is_available_to_order",
+                "created_at",
+                "last_modified_at",
+                "colour_family_name",
+                "colour_label",
+                "vat_amount"
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,54 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Money",
+    "type": "object",
+    "description": "Represents a monetary value with associated currency and formatting details.",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/money.schema.json",
+    "$comment": "LCY stands for local currency. GBP for all purposes",
+    "properties": {
+        "value": {
+            "type": "integer",
+            "minimum": 0,
+            "faker": { "commerce.price": [1000, 20000, 0] },
+            "description": "Amount in the smallest currency unit."
+        },
+        "decimal_places": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 4,
+            "faker": { "number.between": [2, 2] },
+            "description": "Number of decimal places used by the currency."
+        },
+        "currency": {
+            "$ref": "https://shushed.example.com/currency.schema.json",
+            "title": "Currency"
+        },
+        "lcy_value": {
+            "type": "integer",
+            "minimum": 0,
+            "faker": { "commerce.price": [1000, 20000, 0] },
+            "description": "Local currency value (example: GBP) in smallest units."
+        },
+        "lcy_currency": {
+            "$ref": "https://shushed.example.com/currency.schema.json",
+            "faker": { "helpers.arrayElement": [["GBP"]] },
+            "title": "LCY Currency"
+        },
+        "lcy_decimal_places": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 4,
+            "faker": { "number.between": [2, 2] },
+            "description": "Decimal precision for the local currency."
+        }
+    },
+    "required": [
+        "value",
+        "currency",
+        "lcy_value",
+        "lcy_currency",
+        "decimal_places",
+        "lcy_decimal_places"
+    ]
+}