@shushed/helpers 0.0.202 → 0.0.203-bug-erp-770-20251208112219

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

@@ -1,127 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Address",
-    "type": "object",
-    "$id": "https://shushed.example.com/order/address.schema.json",
-    "description": "Represents a postal address for billing or shipping purposes.",
-    "additionalProperties": false,
-    "properties": {
-        "address_id": {
-            "type": "string",
-            "description": "Internal address ID"
-        },
-        "sfcc_customer_id": {
-            "type": "string"
-        },
-        "sitoo_customer_id": {
-            "type": "string"
-        },
-        "bc_customer_id": {
-            "type": "string"
-        },
-        "centra_customer_id": {
-            "type": "string"
-        },
-        "is_default_billing": {
-            "type": "boolean"
-        },
-        "is_default_shipping": {
-            "type": "boolean"
-        },
-        "scv_household_id": {
-            "type": [
-                "string",
-                "null"
-            ]
-        },
-        "is_last_used_shipping": {
-            "type": "boolean"
-        },
-        "is_retrieved_from_payment_method": {
-            "type": "boolean"
-        },
-        "opt_in_mail": {
-            "type": "boolean"
-        },
-        "company_name": {
-            "type": "string",
-            "maxLength": 30
-        },
-        "first_name": {
-            "type": "string",
-            "maxLength": 30,
-            "minLength": 1,
-            "faker": { "name.firstName": [] },
-            "description": "Recipient's first name."
-        },
-        "last_name": {
-            "type": "string",
-            "maxLength": 30,
-            "minLength": 1,
-            "faker": { "name.lastName": [] },
-            "description": "Recipient's last name."
-        },
-        "address1": {
-            "type": ["string"],
-            "minLength": 1,
-            "maxLength": 30,
-            "faker": { "address.streetAddress": [] },
-            "description": "Primary street address."
-        },
-        "address2": {
-            "type": ["string", "null"],
-            "maxLength": 30,
-            "faker": { "address.secondaryAddress": [] },
-            "description": "Additional address line (e.g., apartment or suite number)."
-        },
-        "city": {
-            "type": ["string"],
-            "maxLength": 30,
-            "minLength": 1,
-            "faker": { "address.city": [] },
-            "description": "City or locality of the address."
-        },
-        "post_code": {
-            "type": ["string", "null"],
-            "maxLength": 20,
-            "pattern": "^[A-Z0-9 ]*$",
-            "faker": { "address.zipCode": [] },
-            "description": "Postal code (uppercase letters and numbers with spaces; optional for countries without postal codes).",
-            "examples": ["SW1A 1AA", "90210", null]
-        },
-        "country_code": {
-            "$ref": "https://shushed.example.com/country.schema.json",
-            "faker": {
-                "helpers.arrayElement": ["GB", "US", "IR"]
-            }
-        },
-        "phone": {
-            "type": ["string", "null"],
-            "maxLength": 30,
-            "faker": { "phone.phone.number": [] },
-            "description": "Phone number associated with the address."
-        },
-        "click_collect_id": {
-            "type": [
-                "string",
-                "null"
-            ],
-            "description": "Click & Collect reference if applicable"
-        },
-        "created_at": {
-            "type": "string",
-            "format": "date-time"
-        },
-        "last_modified_at": {
-            "type": "string",
-            "format": "date-time"
-        }
-    },
-    "required": [
-        "first_name",
-        "last_name",
-        "address1",
-        "city",
-        "country_code"
-    ]
-}

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

@@ -1,149 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Customer",
-    "$id": "https://shushed.example.com/order/customer.schema.json",
-    "type": "object",
-    "additionalProperties": false,
-    "properties": {
-        "first_name": {
-            "type": "string",
-            "maxLength": 30,
-            "description": "Customer first name - Example: Alice. Business Central field: First Name HU (ID 50054, Text[30])"
-        },
-        "last_name": {
-            "type": "string",
-            "maxLength": 30,
-            "description": "Customer last name - Example: Johnson. Business Central field: Last Name HU (ID 50056, Text[30])"
-        },
-        "sfcc_id": {
-            "type": "string",
-            "description": "Salesforce Commerce Cloud customer identifier - Example: SFCC123456"
-        },
-        "bc_customer_id": {
-            "type": "string",
-            "maxLength": 20,
-            "description": "Business Central customer id - Example: CUST00012345"
-        },
-        "merged_bc_customer_ids": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "description": "Business Central customer ids that were result of merge",
-            "example": ["CUST00011111", "CUST00022222"]
-        },
-        "centra_id": {
-            "type": "string",
-            "description": "Centra system customer ID"
-        },
-        "sitoo_id": {
-            "type": "string",
-            "description": "Sitoo POS system customer ID"
-        },
-        "scv_customer_id": {
-            "type": "string",
-            "description": "Single customer view customer id - Example: SCV123456789"
-        },
-        "addresses": {
-            "type": "array",
-            "items": { "$ref": "https://shushed.example.com/order/address.schema.json" },
-            "description": "Array of addresses related to the customer"
-        },
-        "default_shipping_address": {
-            "$ref": "https://shushed.example.com/order/address.schema.json",
-            "description": "Preferred shipping address"
-        },
-        "phone": {
-            "type": ["string", "null"],
-            "description": "Primary customer phone (root-level), may be null when unknown"
-        },
-        "email": {
-            "type": ["string", "null"],
-            "format": "email",
-            "description": "Normalized and lowercased email. Null if invalid.",
-            "example": "alice.johnson@example.com"
-        },
-        "opt_in_email": {
-            "type": "boolean",
-            "description": "Marketing email opt_in_email - Example: true"
-        },
-        "opt_in_phone": {
-            "type": "boolean",
-            "description": "Marketing phone (SMS) opt_in_phone - Example: false"
-        },
-        "opt_in_3rdparty": {
-            "type": "boolean",
-            "description": "Marketing 3rd party rentals opt_in_3rdparty - Example: true"
-        },
-        "segments": {
-            "type": "array",
-            "items": { "type": "string" },
-            "description": "Customer segmentation tags",
-            "example": ["VIP", "NewsletterSubscriber"]
-        },
-        "registered_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Customer registration timestamp - Example: 2024-01-15T10:30:00Z"
-        },
-        "scv_first_purchase_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Single customer view first purchase at - Example: 2024-03-20T14:00:00Z"
-        },
-        "scv_last_purchase_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Single customer view last purchase at - Example: 2025-06-01T11:15:00Z"
-        },
-        "scv_linked_customer_ids": {
-            "type": "array",
-            "items": { "type": "string" },
-            "description": "Single customer view linked customer ids",
-            "example": ["SCV987654321", "SCV123987654"]
-        },
-        "scv_total_transactions": {
-            "type": "integer",
-            "minimum": 0,
-            "description": "Single customer view total number of transactions - Example: 42"
-        },
-        "scv_total_demand": {
-            "type": "integer",
-            "minimum": 0,
-            "description": "Single customer view total demand count - Example: 35"
-        },
-        "scv_total_demand_cost": {
-            "type": "number",
-            "minimum": 0,
-            "description": "Single customer view total cost of demand - Example: 15000.75"
-        },
-        "scv_total_returns": {
-            "type": "integer",
-            "minimum": 0,
-            "description": "Single customer view total number of returned items - Example: 3"
-        },
-        "scv_total_returns_cost": {
-            "type": "number",
-            "minimum": 0,
-            "description": "Single customer view total cost of returned items - Example: 1200.50"
-        },
-        "last_modified_by": {
-            "type": "string",
-            "description": "Indicates the source of the last modification. Example: 'Integrations'"
-        },
-        "is_deleted": {
-            "type": "boolean",
-            "description": "Soft delete marker for the customer. If true, the customer is considered deleted but their data remains stored."
-        },
-        "other_bc_ids": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "description": "IDs of customer records in BC that share this customer's email"
-        }
-    },
-    "required": [
-        "email"
-    ]
-}

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

@@ -1,31 +0,0 @@
-"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.OrderShipment = exports.OrderPayment = exports.OrderItem = exports.OrderCustomer = exports.OrderAddress = void 0;
-var address_schema_json_1 = require("./address.schema.json");
-Object.defineProperty(exports, "OrderAddress", { enumerable: true, get: function () { return __importDefault(address_schema_json_1).default; } });
-var customer_schema_json_1 = require("./customer.schema.json");
-Object.defineProperty(exports, "OrderCustomer", { enumerable: true, get: function () { return __importDefault(customer_schema_json_1).default; } });
-var item_schema_json_1 = require("./item.schema.json");
-Object.defineProperty(exports, "OrderItem", { enumerable: true, get: function () { return __importDefault(item_schema_json_1).default; } });
-var payment_schema_json_1 = require("./payment.schema.json");
-Object.defineProperty(exports, "OrderPayment", { enumerable: true, get: function () { return __importDefault(payment_schema_json_1).default; } });
-var shipment_schema_json_1 = require("./shipment.schema.json");
-Object.defineProperty(exports, "OrderShipment", { enumerable: true, get: function () { return __importDefault(shipment_schema_json_1).default; } });
-__exportStar(require("./shipment"), exports);

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

@@ -1,98 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Item",
-    "$id": "https://shushed.example.com/order/item.schema.json",
-    "type": "object",
-    "description": "Represents a single purchasable item in an order, including style, quantity, pricing, and applicable discounts.",
-    "allOf": [
-        {
-            "$ref": "https://shushed.example.com/total.schema.json"
-        },
-        {
-            "type": "object",
-            "properties": {
-                "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": [] },
-                    "description": "Style ID of the parent item if this is a variation."
-                },
-                "colour_id": {
-                    "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": [] },
-                    "description": "Code from Object style - Example: 000697, null if not applicable (e.g., non-product items like NEWSLETTER)"
-                },
-                "product_id": {
-                    "type": ["string", "null"],
-                    "description": "Code from Object style and colour - Example: 000697-3203"
-                },
-                "colour_name": {
-                    "type": ["string"],
-                    "faker": { "color.human": [] },
-                    "description": "Node Name from Object Colorway - Example: Toffee Brown"
-                },
-                "size_name": {
-                    "type": ["string"],
-                    "faker": { "custom.size": [] },
-                    "description": "HS_ColorwayAttr_SizeRangeNodeName from Object ColorwayAttributes - Example: 10-16"
-                },
-                "preorder_date": {
-                    "type": ["string", "null"],
-                    "format": "date",
-                    "description": "Expected availability date if the item is on preorder."
-                },
-                "quantity": {
-                    "type": ["integer"],
-                    "minimum": 0,
-                    "faker": { "minimum": 0, "maximum": 10 },
-                    "description": "Number of units ordered. Represented as integer."
-                },
-                "unit_price_status": {
-                    "type": "string",
-                    "enum": ["rrp", "perm", "pos"],
-                    "description": "Pricing status: rrp (Full Price), perm (Markdown), pos (Promotional)."
-                },
-                "returned_quantity": {
-                    "type": ["integer"],
-                    "minimum": 0,
-                    "faker": { "maximum": 1 },
-                    "description": "Number of units returned. Represented as integer."
-                },
-                "unit_price_net": {
-                    "$ref": "https://shushed.example.com/money.schema.json",
-                    "description": "Net unit price before tax. Represented as integer."
-                },
-                "unit_price_gross": {
-                    "$ref": "https://shushed.example.com/money.schema.json",
-                    "description": "Gross unit price in smallest currency unit. Represented as integer."
-                },
-                "discount_code": {
-                    "type": ["string", "null"],
-                    "faker": { "format": "uuid" },
-                    "description": "Code applied to trigger a discount, if any."
-                },
-                "cost_net": {
-                    "$ref": "https://shushed.example.com/money.schema.json"
-                }
-            },
-            "required": [
-                "sku",
-                "colour_id",
-                "style_id",
-                "quantity",
-                "unit_price_net",
-                "unit_price_gross",
-                "unit_price_status"
-            ]
-        }
-    ]
-}

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

@@ -1,115 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Payment",
-    "type": "object",
-    "$id": "https://shushed.example.com/order/payment.schema.json",
-    "description": "Details of a payment or refund transaction, including amount, method, and status.",
-    "additionalProperties": true,
-    "properties": {
-        "type": {
-            "type": "string",
-            "enum": ["REFUND", "CHARGE"],
-            "description": "Indicates whether the transaction is a customer charge or a refund."
-        },
-        "additionalProperties": false,
-        "created_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 payment was placed (ISO 8601).",
-            "example": "2024-07-09T14:30:00Z",
-            "nullable": true
-        },
-        "payment_method": {
-            "type": "string",
-            "enum": [
-                "MOTO",
-                "CREDIT-CARD",
-                "GIFT-CARD",
-                "PAYPAL",
-                "APPLE-PAY",
-                "OTHER"
-            ],
-            "description": "The method used for the transaction."
-        },
-        "transaction_id": {
-            "type": ["string"],
-            "faker": { "custom.documentid": ["TR", 10] },
-            "description": "Internal transaction reference ID."
-        },
-        "card_number": {
-            "type": ["string", "null"],
-            "faker": { "finance.creditCardNumber": [] },
-            "description": "Masked card number used for payment, if applicable."
-        },
-        "card_holder": {
-            "type": ["string", "null"],
-            "description": "Name on the card. Examples: '' (empty for test), 'John Doe' (real-world)"
-        },
-        "card_token": {
-            "type": ["string", "null"],
-            "description": "Token representing the card. Examples: '' (empty for test), 'tok_1234567890' (real-world)"
-        },
-        "expiration_month": {
-            "type": ["integer", "null"],
-            "minimum": 1,
-            "maximum": 12,
-            "description": "Card expiration month. Null indicates empty for test purpose. Real-world example: 10."
-        },
-        "expiration_year": {
-            "type": ["integer", "null"],
-            "minimum": 2023,
-            "maximum": 2085,
-            "description": "Card expiration year. Null indicates empty for test purpose. Real-world example: 2026."
-        },
-        "journey_label": {
-            "type": ["string"],
-            "enum": ["CHECKOUT", "POS", "EXPRESS", "MOTO", "SYSTEM"],
-            "description": "Channel through which the payment was initiated."
-        },
-        "psp_reference": {
-            "type": ["string"],
-            "faker": { "custom.documentid": ["PSP", 10] },
-            "description": "Reference provided by the Payment Service Provider (PSP)."
-        },
-        "card_brand": {
-            "type": ["string", "null"],
-            "faker": { "finance.creditCardIssuer": [] },
-            "description": "Brand of the card used (e.g., Visa, Mastercard), if applicable."
-        },
-        "status": {
-            "type": ["string"],
-            "enum": ["CAPTURED", "FAILED", "FAILED-3DS", "CANCELLED"],
-            "description": "Current status of the transaction."
-        },
-        "amount": {
-            "$ref": "https://shushed.example.com/money.schema.json",
-            "description": "Monetary value of the transaction."
-        },
-        "created_by": {
-            "anyOf": [
-                {
-                    "type": "string",
-                    "enum": ["CUSTOMER", "SYSTEM"]
-                },
-                {
-                    "type": "string",
-                    "format": "email"
-                }
-            ],
-            "description": "Originator of the transaction: 'CUSTOMER', 'SYSTEM', or email address for refunds."
-        }
-    },
-    "required": [
-        "created_at",
-        "payment_method",
-        "transaction_id",
-        "psp_reference",
-        "status",
-        "amount",
-        "created_by",
-        "journey_label"
-    ]
-}

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

@@ -1,29 +0,0 @@
-"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.OrderShipmentShipped = exports.OrderShipmentPOS = exports.OrderShipmentItem = void 0;
-var item_schema_json_1 = require("./item.schema.json");
-Object.defineProperty(exports, "OrderShipmentItem", { enumerable: true, get: function () { return __importDefault(item_schema_json_1).default; } });
-var pos_schema_json_1 = require("./pos.schema.json");
-Object.defineProperty(exports, "OrderShipmentPOS", { enumerable: true, get: function () { return __importDefault(pos_schema_json_1).default; } });
-var shipped_schema_json_1 = require("./shipped.schema.json");
-Object.defineProperty(exports, "OrderShipmentShipped", { enumerable: true, get: function () { return __importDefault(shipped_schema_json_1).default; } });
-__exportStar(require("./item"), exports);
-__exportStar(require("./pos"), exports);
-__exportStar(require("./shipped"), exports);

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

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

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

@@ -1,30 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Order Shipment Item Returned",
-    "type": "object",
-    "description": "Represents a returned item within a shipment, including the return reason and its code. Extends the basic shipment item schema.",
-    "$id": "https://shushed.example.com/order/shipment/item/returned.schema.json",
-    "allOf": [
-        {
-            "$ref": "https://shushed.example.com/order/shipment/item.schema.json"
-        },
-        {
-            "type": "object",
-            "properties": {
-                "returnReasonCode": {
-                    "type": ["string"],
-                    "faker": { "custom.documentid": ["R", 2] },
-                    "description": "Internal return reason code used for processing and analytics."
-                },
-                "returnReason": {
-                    "type": ["string", "null"],
-                    "faker": {
-                        "helpers.arrayElement": [["Too Large", "Defect", "Not my colour"]]
-                    },
-                    "description": "Human-readable explanation for the return, such as defect or sizing issue."
-                }
-            },
-            "required": ["returnReasonCode", "returnReason"]
-        }
-    ]
-}

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

@@ -1,22 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Order Shipment Item",
-    "type": "object",
-    "description": "Represents a single line item included in a shipment, typically corresponding to a specific product and quantity.",
-    "$id": "https://shushed.example.com/order/shipment/item.schema.json",
-    "properties": {
-        "lineNumber": {
-            "type": ["integer"],
-            "minimum": 0,
-            "faker": { "datatype.number": [1, 1] },
-            "description": "Line number of the item in the order. Used for item referencing and tracking."
-        },
-        "quantity": {
-            "type": ["integer"],
-            "minimum": 1,
-            "faker": { "datatype.number": [2, 1] },
-            "description": "The number of units of the item shipped."
-        }
-    },
-    "required": ["lineNumber", "quantity"]
-}

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

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