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

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

@@ -0,0 +1,78 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Asset",
+    "type": "object",
+    "description": "Represents an asset (image / file)",
+    "additionalProperties": false,
+    "$id": "https://shushed.example.com/asset.json",
+    "properties": {
+        "product_id": {
+            "type": "string",
+            "description": "Product ID"
+        },
+        "dash_id": {
+            "type": "string",
+            "description": "Dash ID"
+        },
+        "dash_folder_path": {
+            "type": "string",
+            "description": "Dash folder path"
+        },
+        "source_url": {
+            "type": "string",
+            "description": "Source URL of the asset"
+        },
+        "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Created date",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "last_modified_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Last modified date",
+            "faker": {
+                "date.between": [
+                    "2024-01-01T00:00:00.000Z",
+                    "2025-04-30T00:00:00.000Z"
+                ]
+            }
+        },
+        "width": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The width of the asset"
+        },
+        "height": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The height of the asset"
+        },
+        "meta": {
+            "type": "object",
+            "description": "Metadata associated with the asset",
+            "additionalProperties": true
+        },
+        "content_type": {
+            "type": "string",
+            "pattern": "^[a-z0-9-/]+$",
+            "description": "The content type of the asset. Lowercase, dashes, no spaces"
+        },
+        "file_name": {
+            "type": "string",
+            "pattern": "^[a-z0-9-.]+$",
+            "description": "The content type of the asset. Lowercase, dashes, no spaces"
+        }
+    },
+    "required": [
+        "source_url",
+        "content_type",
+        "last_modified_at"
+    ]
+}

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

@@ -0,0 +1,86 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://shushed.example.com/category.schema.json",
+    "title": "Category",
+    "description": "Schema representing single category",
+    "additionalProperties": false,
+    "type": "object",
+    "properties": {
+        "centra_id": {
+            "type": "string",
+            "description": "Unique identifier of the category in the Centra. This property should be used only if category_code is not available"
+        },
+        "category_code": {
+            "type": "string",
+            "description": "This is system generated property. Unique code of the category. if the category occurs more than one in the tree i.e. women > trousers and sale > trousers, the latter category id should be sale-trousers"
+        },
+        "parent_category_code": {
+            "type": "string",
+            "description": "Parent category code. Check the description of the category_code first"
+        },
+        "parent_centra_id": {
+            "type": "string",
+            "description": "Parent category entra id. Check the description of the centra_id first"
+        },
+        "categorisation_rules": {
+            "type": "array",
+            "description": "List of rules that determines the category assignments for the product. Contain list of fredhopper expressions/locations",
+            "items": {
+                "type": "string"
+            }
+        },
+        "translations": {
+            "type": "array",
+            "description": "Translations of the category object",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "language_code": {
+                        "type": "string",
+                        "description": "Language code of the translation"
+                    },
+                    "name": {
+                        "type": "string",
+                        "description": "Name of the category in the language. This property is taken from the Centra translations"
+                    }
+                }
+            }
+        },
+        "uri": {
+            "type": "string",
+            "description": "The URL path / URI of the category"
+        },
+        "name": {
+            "type": "string",
+            "description": "The human readable name of the category"
+        },
+        "status": {
+            "type": "string",
+            "enum": [
+                "ACTIVE",
+                "INACTIVE",
+                "DISABLED"
+            ],
+            "description": "Disabled categories will be deleted / not imported to the other systems (i.e. fredhopper). Inactive categories will be available in the other systems but never displayed to the end user in Centra. <br>This property should not be used to coordinate launches. As for example if the team prepares EOSS: <br>* the category Sale should be active <br>* Fredhopper facet should have time based rule to hide the category from displaying in facets <br>*Fredhopper redirection rule should have time based rule to redirect the category."
+        }
+    },
+    "required": [
+        "name",
+        "status",
+        "translations"
+    ],
+    "anyOf": [
+        {
+            "required": [
+                "centra_id",
+                "parent_centra_id"
+            ]
+        },
+        {
+            "required": [
+                "category_code",
+                "parent_category_code"
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,258 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Country",
+    "$id": "https://shushed.example.com/country.schema.json",
+    "faker": { "helpers.arrayElement": [["US", "GB", "IR"]] },
+    "type": "string",
+    "enum": [
+        "AF",
+        "AX",
+        "AL",
+        "DZ",
+        "AS",
+        "AD",
+        "AO",
+        "AI",
+        "AQ",
+        "AG",
+        "AR",
+        "AM",
+        "AW",
+        "AU",
+        "AT",
+        "AZ",
+        "BS",
+        "BH",
+        "BD",
+        "BB",
+        "BY",
+        "BE",
+        "BZ",
+        "BJ",
+        "BM",
+        "BT",
+        "BO",
+        "BQ",
+        "BA",
+        "BW",
+        "BV",
+        "BR",
+        "IO",
+        "BN",
+        "BG",
+        "BF",
+        "BI",
+        "CV",
+        "KH",
+        "CM",
+        "CA",
+        "KY",
+        "CF",
+        "TD",
+        "CL",
+        "CN",
+        "CX",
+        "CC",
+        "CO",
+        "KM",
+        "CD",
+        "CG",
+        "CK",
+        "CR",
+        "CI",
+        "HR",
+        "CU",
+        "CW",
+        "CY",
+        "CZ",
+        "DK",
+        "DJ",
+        "DM",
+        "DO",
+        "EC",
+        "EG",
+        "SV",
+        "GQ",
+        "ER",
+        "EE",
+        "SZ",
+        "ET",
+        "FK",
+        "FO",
+        "FJ",
+        "FI",
+        "FR",
+        "GF",
+        "PF",
+        "TF",
+        "GA",
+        "GM",
+        "GE",
+        "DE",
+        "GH",
+        "GI",
+        "GR",
+        "GL",
+        "GD",
+        "GP",
+        "GU",
+        "GT",
+        "GG",
+        "GN",
+        "GW",
+        "GY",
+        "HT",
+        "HM",
+        "VA",
+        "HN",
+        "HK",
+        "HU",
+        "IS",
+        "IN",
+        "ID",
+        "IR",
+        "IQ",
+        "IE",
+        "IM",
+        "IL",
+        "IT",
+        "JM",
+        "JP",
+        "JE",
+        "JO",
+        "KZ",
+        "KE",
+        "KI",
+        "KP",
+        "KR",
+        "KW",
+        "KG",
+        "LA",
+        "LV",
+        "LB",
+        "LS",
+        "LR",
+        "LY",
+        "LI",
+        "LT",
+        "LU",
+        "MO",
+        "MG",
+        "MW",
+        "MY",
+        "MV",
+        "ML",
+        "MT",
+        "MH",
+        "MQ",
+        "MR",
+        "MU",
+        "YT",
+        "MX",
+        "FM",
+        "MD",
+        "MC",
+        "MN",
+        "ME",
+        "MS",
+        "MA",
+        "MZ",
+        "MM",
+        "NA",
+        "NR",
+        "NP",
+        "NL",
+        "NC",
+        "NZ",
+        "NI",
+        "NE",
+        "NG",
+        "NU",
+        "NF",
+        "MK",
+        "MP",
+        "NO",
+        "OM",
+        "PK",
+        "PW",
+        "PS",
+        "PA",
+        "PG",
+        "PY",
+        "PE",
+        "PH",
+        "PN",
+        "PL",
+        "PT",
+        "PR",
+        "QA",
+        "RE",
+        "RO",
+        "RU",
+        "RW",
+        "BL",
+        "SH",
+        "KN",
+        "LC",
+        "MF",
+        "PM",
+        "VC",
+        "WS",
+        "SM",
+        "ST",
+        "SA",
+        "SN",
+        "RS",
+        "SC",
+        "SL",
+        "SG",
+        "SX",
+        "SK",
+        "SI",
+        "SB",
+        "SO",
+        "ZA",
+        "GS",
+        "SS",
+        "ES",
+        "LK",
+        "SD",
+        "SR",
+        "SJ",
+        "SE",
+        "CH",
+        "SY",
+        "TW",
+        "TJ",
+        "TZ",
+        "TH",
+        "TL",
+        "TG",
+        "TK",
+        "TO",
+        "TT",
+        "TN",
+        "TR",
+        "TM",
+        "TC",
+        "TV",
+        "UG",
+        "UA",
+        "AE",
+        "GB",
+        "UM",
+        "US",
+        "UY",
+        "UZ",
+        "VU",
+        "VE",
+        "VN",
+        "VG",
+        "VI",
+        "WF",
+        "EH",
+        "YE",
+        "ZM",
+        "ZW"
+    ]
+}

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

@@ -0,0 +1,177 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Currency",
+    "$id": "https://shushed.example.com/currency.schema.json",
+    "type": "string",
+    "enum": [
+        "AFN",
+        "ALL",
+        "DZD",
+        "USD",
+        "EUR",
+        "AOA",
+        "XCD",
+        "ARS",
+        "AMD",
+        "AWG",
+        "AUD",
+        "AZN",
+        "BSD",
+        "BHD",
+        "BDT",
+        "BBD",
+        "BYN",
+        "BZD",
+        "XOF",
+        "BMD",
+        "BTN",
+        "INR",
+        "BOB",
+        "BOV",
+        "BAM",
+        "BWP",
+        "NOK",
+        "BRL",
+        "BND",
+        "BGN",
+        "BIF",
+        "CVE",
+        "KHR",
+        "XAF",
+        "CAD",
+        "KYD",
+        "CLF",
+        "CLP",
+        "CNY",
+        "COP",
+        "COU",
+        "KMF",
+        "CDF",
+        "NZD",
+        "CRC",
+        "CUC",
+        "CUP",
+        "ANG",
+        "CZK",
+        "DKK",
+        "DJF",
+        "DOP",
+        "EGP",
+        "SVC",
+        "ERN",
+        "ETB",
+        "FKP",
+        "FJD",
+        "XPF",
+        "GMD",
+        "GEL",
+        "GHS",
+        "GIP",
+        "GTQ",
+        "GBP",
+        "GNF",
+        "GYD",
+        "HTG",
+        "HNL",
+        "HKD",
+        "HUF",
+        "ISK",
+        "IDR",
+        "XDR",
+        "IRR",
+        "IQD",
+        "ILS",
+        "JMD",
+        "JPY",
+        "JOD",
+        "KZT",
+        "KES",
+        "KPW",
+        "KRW",
+        "KWD",
+        "KGS",
+        "LAK",
+        "LBP",
+        "LSL",
+        "ZAR",
+        "LRD",
+        "LYD",
+        "CHF",
+        "MOP",
+        "MGA",
+        "MWK",
+        "MYR",
+        "MVR",
+        "MRU",
+        "MUR",
+        "XUA",
+        "MXN",
+        "MXV",
+        "MDL",
+        "MNT",
+        "MAD",
+        "MZN",
+        "MMK",
+        "NAD",
+        "NPR",
+        "NIO",
+        "NGN",
+        "OMR",
+        "PKR",
+        "PAB",
+        "PGK",
+        "PYG",
+        "PEN",
+        "PHP",
+        "PLN",
+        "QAR",
+        "MKD",
+        "RON",
+        "RUB",
+        "RWF",
+        "SHP",
+        "WST",
+        "STN",
+        "SAR",
+        "RSD",
+        "SCR",
+        "SLE",
+        "SGD",
+        "XSU",
+        "SBD",
+        "SOS",
+        "SSP",
+        "LKR",
+        "SDG",
+        "SRD",
+        "SZL",
+        "SEK",
+        "CHE",
+        "CHW",
+        "SYP",
+        "TWD",
+        "TJS",
+        "TZS",
+        "THB",
+        "TOP",
+        "TTD",
+        "TND",
+        "TRY",
+        "TMT",
+        "UGX",
+        "UAH",
+        "AED",
+        "USN",
+        "UYI",
+        "UYU",
+        "UZS",
+        "VUV",
+        "VEF",
+        "VED",
+        "VND",
+        "YER",
+        "ZMW",
+        "ZWL"
+    ],
+    "description": "Three-letter ISO 4217 currency code used to specify monetary units - Example: GBP"
+}

package/dist/cjs/contracts/customer-segment.schema.json

@@ -0,0 +1,32 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "CustomerSegment",
+    "$id": "https://shushed.example.com/order/customer-segment.schema.json",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "bc_id": {
+            "type": "string",
+            "maxLength": 20,
+            "description": "Business Central customer id - Example: CUST00012345"
+        },
+        "email": {
+            "type": "string",
+            "format": "email",
+            "description": "Normalized and lowercased email",
+            "example": "alice.johnson@example.com"
+        },
+        "segments": {
+            "type": ["array", "null"],
+            "items": {
+                "type": "string"
+            },
+            "description": "The segments the customer belongs to - Example: [\"sfcc_seg_friends\"] or null"
+        }
+    },
+    "required": [
+        "bc_id",
+        "email",
+        "segments"
+    ]
+}