@shushed/helpers 0.0.244 → 0.0.245

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/cjs/contracts/product.schema.json +117 -381
  2. package/dist/cjs/dist-dereferenced/messages/product.js +1 -1
  3. package/dist/cjs/dist-dereferenced/product.js +1 -1
  4. package/dist/types/dist-dereferenced/messages/product.d.ts +96 -290
  5. package/dist/types/dist-dereferenced/product.d.ts +96 -290
  6. package/dist/types/dist-types/messages/product.d.ts +28 -66
  7. package/dist/types/dist-types/product.d.ts +28 -66
  8. package/package.json +1 -1
package/dist/cjs/contracts/product.schema.json CHANGED
@@ -15,12 +15,6 @@
15
15
  ],
16
16
  "description": "URI of the product eg. leather-jack-barrel-trousers-chocolate-brown/013464-0533.html"
17
17
  },
18
- "style_slug": {
19
- "type": [
20
- "string"
21
- ],
22
- "description": "URI of the style eg. leather-jack-barrel-trousers/013464.html"
23
- },
24
18
  "style_id": {
25
19
  "type": [
26
20
  "string"
@@ -38,14 +32,9 @@
38
32
  "type": "string",
39
33
  "description": "Style Name - Example: Puff Sleeve Sweatshirt"
40
34
  },
41
- "product_name": {
42
- "type": "string",
43
- "description": "Product Name - Example: Puff Sleeve Sweatshirt (Blue)"
44
- },
45
35
  "display_name": {
46
36
  "type": [
47
- "string",
48
- "null"
37
+ "string"
49
38
  ],
50
39
  "description": "Centra Name - Example: Brown Puff Shirt"
51
40
  },
@@ -70,61 +59,6 @@
70
59
  "format": "date",
71
60
  "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"
72
61
  },
73
- "online_from": {
74
- "type": [
75
- "string",
76
- "null"
77
- ],
78
- "format": "date-time",
79
- "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"
80
- },
81
- "online_to": {
82
- "type": [
83
- "string",
84
- "null"
85
- ],
86
- "format": "date-time",
87
- "description": "The DateTime (inclusive) until which product should be shown (in any way / design / display type) on the website."
88
- },
89
- "first_online_at": {
90
- "type": [
91
- "string",
92
- "null"
93
- ],
94
- "format": "date-time",
95
- "description": "The DateTime of product last online in the direct channel"
96
- },
97
- "last_online_at": {
98
- "type": [
99
- "string",
100
- "null"
101
- ],
102
- "format": "date-time",
103
- "description": "The DateTime of product last online in the direct channel"
104
- },
105
- "first_purchased_at": {
106
- "type": "string",
107
- "format": "date-time",
108
- "faker": {
109
- "date.between": [
110
- "2024-01-01T00:00:00.000Z",
111
- "2025-04-30T00:00:00.000Z"
112
- ]
113
- }
114
- },
115
- "first_markdown_at": {
116
- "type": [
117
- "string",
118
- "null"
119
- ],
120
- "format": "date-time",
121
- "faker": {
122
- "date.between": [
123
- "2024-01-01T00:00:00.000Z",
124
- "2025-04-30T00:00:00.000Z"
125
- ]
126
- }
127
- },
128
62
  "created_at": {
129
63
  "type": "string",
130
64
  "format": "date-time",
@@ -152,10 +86,6 @@
152
86
  },
153
87
  "description": "New Tags To Add - Example: yellow"
154
88
  },
155
- "colour_code": {
156
- "type": "string",
157
- "description": "Colours as Text - Example: buttercup-yellow from initial input of Buttercup Yellow"
158
- },
159
89
  "colour_name": {
160
90
  "type": "string",
161
91
  "description": "Toffee Brown"
@@ -171,10 +101,6 @@
171
101
  "type": "string",
172
102
  "description": "Size range assigned to this product. Defines sizes to be created"
173
103
  },
174
- "sizerange_name": {
175
- "type": "string",
176
- "description": "Size range name for this product"
177
- },
178
104
  "variants": {
179
105
  "type": "array",
180
106
  "items": {
@@ -192,6 +118,13 @@
192
118
  "custom.size": []
193
119
  },
194
120
  "description": "Size label - Example: 10 becomes M"
121
+ },
122
+ "ean": {
123
+ "type": [
124
+ "string",
125
+ "null"
126
+ ],
127
+ "description": "EAN of the size"
195
128
  }
196
129
  },
197
130
  "required": [
@@ -200,38 +133,6 @@
200
133
  ]
201
134
  }
202
135
  },
203
- "images": {
204
- "type": "array",
205
- "items": {
206
- "type": "object",
207
- "properties": {
208
- "type": {
209
- "type": "string",
210
- "enum": [
211
- "Campaign",
212
- "Ecom",
213
- "Flatlay",
214
- "UGC",
215
- "AI"
216
- ],
217
- "description": "Image type for product - Example: Campaign"
218
- },
219
- "url": {
220
- "type": "string",
221
- "format": "uri",
222
- "description": "Image URl for product"
223
- },
224
- "description": {
225
- "type": "string",
226
- "description": "Style Title - Example: Puff Sleeve Sweatshirt"
227
- }
228
- },
229
- "required": [
230
- "type",
231
- "url"
232
- ]
233
- }
234
- },
235
136
  "vat_rate_uk": {
236
137
  "type": [
237
138
  "number",
@@ -262,20 +163,6 @@
262
163
  "type": "string",
263
164
  "description": "Port Of Origin - Example: MUMBAI"
264
165
  },
265
- "supplier_id": {
266
- "type": "string",
267
- "pattern": "^SUP\\d{5}$",
268
- "description": "Supplier ID in the format 'SUP00099', where 'SUP' is followed by exactly five digits - Example: SUP00045"
269
- },
270
- "supplier_name": {
271
- "type": "string",
272
- "description": "Supplier Name - Example: Binh Dinh Footwear Joint Stock Company"
273
- },
274
- "factory_id": {
275
- "type": "string",
276
- "pattern": "^FAC\\d{5}$",
277
- "description": "Factory ID in the format 'FAC00074', where 'FAC' is followed by exactly five digits"
278
- },
279
166
  "packing_method": {
280
167
  "type": [
281
168
  "string",
@@ -301,14 +188,6 @@
301
188
  "type": "string",
302
189
  "description": "Strategy Type - Example: Seasonal New"
303
190
  },
304
- "product_type": {
305
- "type": "string",
306
- "description": "Product Type - Example: Knit"
307
- },
308
- "stock_type": {
309
- "type": "string",
310
- "description": "Stock Type - Example: Knit"
311
- },
312
191
  "category": {
313
192
  "type": "string",
314
193
  "faker": {
@@ -323,43 +202,6 @@
323
202
  },
324
203
  "description": "Subcategory - Example: Parka Coat"
325
204
  },
326
- "range": {
327
- "type": [
328
- "string",
329
- "null"
330
- ],
331
- "enum": [
332
- "Main Collection",
333
- "Seasonal"
334
- ],
335
- "description": "Range - Example: Main Collection"
336
- },
337
- "channels_availability": {
338
- "type": [
339
- "array"
340
- ],
341
- "items": {
342
- "type": "string",
343
- "enum": [
344
- "DIRECT-UK",
345
- "DIRECT-INT",
346
- "DIRECT-US",
347
- "JL-STORES",
348
- "JL-WEB",
349
- "NEXT",
350
- "MS",
351
- "FENWICK",
352
- "MORLEYS"
353
- ]
354
- },
355
- "description": "List of channels the product is exclusive to - Example: [MS]"
356
- },
357
- "collections": {
358
- "type": [
359
- "string"
360
- ],
361
- "description": "Collections [Centra] - Example: Spring 2025"
362
- },
363
205
  "seasons": {
364
206
  "type": [
365
207
  "array"
@@ -377,31 +219,82 @@
377
219
  "type": "string"
378
220
  },
379
221
  "description": "Drop - Example: [SS26 - December, SS25 - April]"
380
- },
381
- "fashionability": {
382
- "type": [
383
- "string",
384
- "null"
385
- ],
386
- "description": "Fashionability - Example: Core"
387
222
  }
388
223
  },
389
224
  "required": []
390
225
  },
226
+ "category_assignments": {
227
+ "type": "array",
228
+ "items": {
229
+ "type": "object",
230
+ "properties": {
231
+ "display_path": {
232
+ "type": "array",
233
+ "items": {
234
+ "type": "string"
235
+ },
236
+ "description": "Example: ['Clothing', 'Dresses', 'Mini']"
237
+ },
238
+ "path": {
239
+ "type": "array",
240
+ "items": {
241
+ "type": "string"
242
+ },
243
+ "description": "Path based on categories ids. Example: ['clothing', 'dresses', 'mini']"
244
+ },
245
+ "name": {
246
+ "type": "string",
247
+ "description": "Mini"
248
+ },
249
+ "id": {
250
+ "type": "string",
251
+ "description": "fredhopper_id in centra, category/id in airtable). mini"
252
+ }
253
+ }
254
+ }
255
+ },
391
256
  "attributes": {
392
257
  "type": "object",
393
258
  "properties": {
394
- "seo_url_name": {
395
- "type": "string",
396
- "pattern": "^[a-z-]+$",
397
- "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"
259
+ "stock_quantity_score": {
260
+ "type": "number",
261
+ "description": "3 by default"
262
+ },
263
+ "stock_availability": {
264
+ "type": "number",
265
+ "description": "50 by default"
266
+ },
267
+ "measurement_chart": {
268
+ "type": [
269
+ "string",
270
+ "null"
271
+ ],
272
+ "description": "Shoes, Alpha, Numeric, Dual-Alpha"
273
+ },
274
+ "sizeguide_type": {
275
+ "type": [
276
+ "string",
277
+ "null"
278
+ ],
279
+ "description": "Alpha Conversions or null"
398
280
  },
399
- "embellishment": {
281
+ "brand": {
400
282
  "type": [
401
283
  "string",
402
284
  "null"
403
285
  ]
404
286
  },
287
+ "shoes_type": {
288
+ "type": [
289
+ "string",
290
+ "null"
291
+ ]
292
+ },
293
+ "seo_url_name": {
294
+ "type": "string",
295
+ "pattern": "^[a-z-]+$",
296
+ "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"
297
+ },
405
298
  "seo_title": {
406
299
  "type": [
407
300
  "string",
@@ -437,13 +330,6 @@
437
330
  ],
438
331
  "description": "Fabric and care accordion on the website"
439
332
  },
440
- "delivery_returns": {
441
- "type": [
442
- "string",
443
- "null"
444
- ],
445
- "description": "Delivery & Returns accordion on the website"
446
- },
447
333
  "weight": {
448
334
  "type": [
449
335
  "number",
@@ -451,13 +337,6 @@
451
337
  ],
452
338
  "description": "The average weight of the garmet (across sizes)"
453
339
  },
454
- "weight_statement": {
455
- "type": [
456
- "string",
457
- "null"
458
- ],
459
- "description": "The weight statement"
460
- },
461
340
  "main_fibre": {
462
341
  "type": [
463
342
  "string",
@@ -472,61 +351,6 @@
472
351
  ],
473
352
  "description": "Main Metal - Applicable to jewellery - Example: Silver"
474
353
  },
475
- "extra_selling_points": {
476
- "type": "array",
477
- "items": {
478
- "type": "string"
479
- },
480
- "description": "Extra Selling Points - Example: [Lovely Print, Recyclable Fabric]"
481
- },
482
- "length_measurement": {
483
- "type": [
484
- "string",
485
- "null"
486
- ],
487
- "description": "Length Measurement - Example: Sole height: 1.5 cm"
488
- },
489
- "measurement_table_code": {
490
- "type": [
491
- "string"
492
- ],
493
- "description": "Measurement Table Code"
494
- },
495
- "fit": {
496
- "type": [
497
- "string",
498
- "null"
499
- ],
500
- "description": "Fit of the garmet"
501
- },
502
- "pockets": {
503
- "type": [
504
- "string",
505
- "null"
506
- ],
507
- "description": "Pockets details"
508
- },
509
- "pleats_gathers": {
510
- "type": [
511
- "string",
512
- "null"
513
- ],
514
- "description": "Pleats & Gathers details"
515
- },
516
- "lining": {
517
- "type": [
518
- "string",
519
- "null"
520
- ],
521
- "description": "Lining details"
522
- },
523
- "bias_cut": {
524
- "type": [
525
- "string",
526
- "null"
527
- ],
528
- "description": "Bias cut details"
529
- },
530
354
  "designer": {
531
355
  "type": [
532
356
  "string",
@@ -534,58 +358,12 @@
534
358
  ],
535
359
  "description": "Designer of the garmet"
536
360
  },
537
- "fabric": {
538
- "type": [
539
- "string",
540
- "null"
541
- ],
542
- "description": "Main fabric of the garmet"
543
- },
544
- "fabric_composition": {
545
- "type": [
546
- "string",
547
- "null"
548
- ],
549
- "description": "Composition details"
550
- },
551
361
  "certificate_code": {
552
362
  "type": [
553
363
  "string",
554
364
  "null"
555
365
  ],
556
- "description": "Certificate of the fabric"
557
- },
558
- "shape": {
559
- "type": [
560
- "string",
561
- "null"
562
- ],
563
- "description": "Shape of the garmet"
564
- },
565
- "development_type": {
566
- "type": "string",
567
- "description": "Development Type - Example: Update"
568
- },
569
- "occasion": {
570
- "type": [
571
- "string",
572
- "null"
573
- ],
574
- "description": "Occasion - Example: Party"
575
- },
576
- "design": {
577
- "type": [
578
- "string",
579
- "null"
580
- ],
581
- "description": "Design type"
582
- },
583
- "block": {
584
- "type": [
585
- "string",
586
- "null"
587
- ],
588
- "description": "Block"
366
+ "description": "Certificate Type. Certificate of the fabric"
589
367
  },
590
368
  "pattern_name": {
591
369
  "type": [
@@ -601,101 +379,62 @@
601
379
  ],
602
380
  "description": "Fit Styling Description(ESP) - Example: Oversized"
603
381
  },
604
- "neckline": {
382
+ "trousers_fit": {
605
383
  "type": [
606
384
  "string",
607
385
  "null"
608
386
  ],
609
- "description": "Neckline - Example: Crew"
610
- },
611
- "sleeve_length": {
612
- "type": [
613
- "string",
614
- "null"
615
- ],
616
- "nullable": true,
617
- "description": "Sleeve Length - Example: Sleeveless"
618
- },
619
- "sleeve_type": {
620
- "type": [
621
- "string",
622
- "null"
623
- ],
624
- "nullable": true,
625
- "description": "Type of Sleeve i.e. "
626
- },
627
- "heel_height": {
628
- "type": [
629
- "string",
630
- "null"
631
- ],
632
- "description": "Heel Height - Example: 0.5CM"
387
+ "description": "Renamed from trouser_fit",
388
+ "nullable": true
633
389
  },
634
- "heel_shape": {
390
+ "trousers_length": {
635
391
  "type": [
636
392
  "string",
637
393
  "null"
638
394
  ],
639
- "description": "Heel Shape - Example: Flat"
395
+ "description": "Renamed from leg Length - Example: Long"
640
396
  },
641
- "toe_shape": {
397
+ "dresses_skirts_length": {
642
398
  "type": [
643
399
  "string",
644
400
  "null"
645
401
  ],
646
- "description": "Toe Shape - Example: Round"
402
+ "description": "Renamed from leg Length - Example: Mini"
647
403
  },
648
- "trouser_fit": {
404
+ "coats_jackets_type": {
649
405
  "type": [
650
406
  "string",
651
407
  "null"
652
408
  ],
653
- "nullable": true
409
+ "description": "Puffer / Raincoat etc"
654
410
  },
655
- "leg_length": {
411
+ "dresses_skirts_type": {
656
412
  "type": [
657
413
  "string",
658
414
  "null"
659
415
  ],
660
- "description": "Leg Length - Example: Long"
416
+ "description": "Shirt / Smock / Pleated"
661
417
  },
662
- "handle_straps": {
418
+ "bag_type": {
663
419
  "type": [
664
420
  "string",
665
421
  "null"
666
422
  ],
667
- "description": "Handle Straps - Example: XBody Strap"
423
+ "description": "Tote / Crossbody / Beach"
668
424
  },
669
- "straps_features": {
425
+ "product_category": {
670
426
  "type": [
671
427
  "string",
672
428
  "null"
673
429
  ],
674
- "description": "Features of the straps i.e. \"Detachable staps\""
430
+ "description": "Clothing / Accessories / Shoes"
675
431
  },
676
- "fastening": {
677
- "anyOf": [
678
- {
679
- "type": [
680
- "array",
681
- "null"
682
- ],
683
- "items": {
684
- "type": "string"
685
- }
686
- },
687
- {
688
- "type": "null"
689
- }
690
- ],
691
- "description": "Fastening - Example: Zip Front"
692
- },
693
- "sole_material": {
432
+ "product_type": {
694
433
  "type": [
695
434
  "string",
696
435
  "null"
697
436
  ],
698
- "description": "Sole Material - Example: Rubber"
437
+ "description": "Jackets / Coats / Dresses"
699
438
  },
700
439
  "care_instructions": {
701
440
  "type": "array",
@@ -707,9 +446,15 @@
707
446
  },
708
447
  "required": []
709
448
  },
710
- "presentations": {
449
+ "markets": {
450
+ "type": "array",
451
+ "items": {
452
+ "type": "string"
453
+ }
454
+ },
455
+ "markets_overrides": {
711
456
  "type": "object",
712
- "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.",
457
+ "description": "Market 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.",
713
458
  "additionalProperties": false,
714
459
  "patternProperties": {
715
460
  ".*": {
@@ -721,22 +466,18 @@
721
466
  "pattern": "^[a-z]{2}-[A-Z]{2}$",
722
467
  "description": "Locale for this presentation (e.g., en-GB, en-US)."
723
468
  },
724
- "presentation_type": {
469
+ "market": {
725
470
  "type": "string",
726
- "description": "Presentation type, e.g. website, email, default, website-US.",
471
+ "description": "Presentation type, e.g. UK, US, ROW",
727
472
  "examples": [
728
- "default",
729
- "website",
730
- "email",
731
- "website-US"
473
+ "UK",
474
+ "US",
475
+ "ROW"
732
476
  ]
733
477
  },
734
478
  "slug": {
735
479
  "$ref": "#/properties/slug"
736
480
  },
737
- "style_slug": {
738
- "$ref": "#/properties/style_slug"
739
- },
740
481
  "style_name": {
741
482
  "$ref": "#/properties/style_name"
742
483
  },
@@ -749,21 +490,6 @@
749
490
  "available_to_sell_from": {
750
491
  "$ref": "#/properties/available_to_sell_from"
751
492
  },
752
- "online_from": {
753
- "$ref": "#/properties/online_from"
754
- },
755
- "online_to": {
756
- "$ref": "#/properties/online_to"
757
- },
758
- "last_online_at": {
759
- "$ref": "#/properties/last_online_at"
760
- },
761
- "first_purchased_at": {
762
- "$ref": "#/properties/first_purchased_at"
763
- },
764
- "first_markdown_at": {
765
- "$ref": "#/properties/first_markdown_at"
766
- },
767
493
  "colour_family_name": {
768
494
  "$ref": "#/properties/colour_family_name"
769
495
  },
@@ -773,8 +499,18 @@
773
499
  "display_tags": {
774
500
  "$ref": "#/properties/display_tags"
775
501
  },
776
- "sizerange_name": {
777
- "$ref": "#/properties/sizerange_name"
502
+ "last_online_at": {
503
+ "type": [
504
+ "string",
505
+ "null"
506
+ ],
507
+ "format": "date-time",
508
+ "faker": {
509
+ "date.between": [
510
+ "2024-01-01T00:00:00.000Z",
511
+ "2025-04-30T00:00:00.000Z"
512
+ ]
513
+ }
778
514
  },
779
515
  "variants": {
780
516
  "type": "array",
@@ -801,7 +537,7 @@
801
537
  },
802
538
  "required": [
803
539
  "locale",
804
- "presentation_type"
540
+ "market"
805
541
  ]
806
542
  }
807
543
  }
@@ -810,7 +546,7 @@
810
546
  "required": [
811
547
  "product_id",
812
548
  "style_id",
813
- "product_name",
814
- "online_from"
549
+ "color_id",
550
+ "product_name"
815
551
  ]
816
552
  }