@reactionary/core 0.10.54 → 0.10.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.10.54",
+  "version": "0.10.56",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",

package/schemas/models/product-search.model.js

@@ -7,6 +7,9 @@ const ProductSearchResultItemComplianceDataSchema = z.looseObject({
   weee_symbol: z.boolean().default(false).meta({ description: "Indicates whether the WEEE symbol can be shown on the product" }),
   energy_class: z.string().optional().meta({ description: "The energy class of the product, as required by EU regulations. A,B,C,D,E,F,G, etc" }),
   garan_duration: z.number().optional().meta({ description: "The duration of the guarantee in months as by the EU Garan scheme. Only set if above 24." }),
+  energy_class_range: z.string().optional().meta({ description: 'The scale the energy class belongs to, e.g. "A-G", "A++-G" or "A+++-D". Needed to render the EU class arrow, because the same class letter is drawn differently on different scales.' }),
+  eprel_registration_number: z.string().optional().meta({ description: "The EPREL registration number of the product model (digits only, up to 19). Together with eprel_product_group it identifies the official EU energy label and class arrow." }),
+  eprel_product_group: z.string().optional().meta({ description: 'The EPREL product group URL code the model is registered under, e.g. "spaceheaters" or "localspaceheaters".' }),
   is_organic: z.boolean().optional().meta({ description: "Indicates whether the product is organic" }),
   organic_certification_type: z.string().optional().meta({ description: "The type of organic certification, e.g., EU_ORGANIC_LEAF, GOTS, ECOCERT." })
 });

package/schemas/models/product.model.js

@@ -6,6 +6,9 @@ const ProductComplianceDataSchema = z.looseObject({
   weee_symbol: z.boolean().default(false).meta({ description: "Indicates whether the WEEE symbol can be shown on the product" }),
   energy_class: z.string().optional().meta({ description: "The energy class of the product, as required by EU regulations. A,B,C,D,E,F,G, etc" }),
   garan_duration: z.number().optional().meta({ description: "The duration of the guarantee in months as by the EU Garan scheme. Only set if above 24." }),
+  energy_class_range: z.string().optional().meta({ description: 'The scale the energy class belongs to, e.g. "A-G", "A++-G" or "A+++-D". Needed to render the EU class arrow, because the same class letter is drawn differently on different scales.' }),
+  eprel_registration_number: z.string().optional().meta({ description: "The EPREL registration number of the product model (digits only, up to 19). Together with eprel_product_group it identifies the official EU energy label and class arrow." }),
+  eprel_product_group: z.string().optional().meta({ description: 'The EPREL product group URL code the model is registered under, e.g. "spaceheaters" or "localspaceheaters".' }),
   safety_warnings: z.string().optional().meta({ description: "Any safety warnings associated with the product as required by EU regulations." }),
   composition: z.string().optional().meta({ description: "The composition of the product as required by EU regulations." }),
   additional_disclosures: z.string().optional().meta({ description: "Any additional disclosures associated with the product as required by EU regulations." }),

package/schemas/models/shipping-method.model.js

@@ -8,6 +8,13 @@ const ShippingProtocolDataSchema = z.looseObject({
   key: z.string().meta({ description: 'The protocol-specific key, e.g. "timeSlotId".' }),
   value: z.union([z.string(), z.record(z.string(), z.json())]).meta({ description: "The protocol-specific value: either a plain string, or a JSON-serializable object for richer structures." })
 });
+const SHIPPING_PROTOCOL_DATA_KEYS = {
+  /**
+   * The identifier (Store.identifier.key) of the brand's own store an
+   * in-store pickup (BOPIS) shipping method is fulfilled from.
+   */
+  pickupStore: "pickup_store"
+};
 const PickupPointSchema = z.looseObject({
   identifier: z.object({
     key: z.string()
@@ -29,7 +36,7 @@ const ShippingMethodSchema = z.looseObject({
   deliveryTime: z.string(),
   carrier: z.string().optional(),
   fulfillmentType: ShippingFulfillmentTypeSchema.optional().meta({ description: `How this shipping method fulfills the order: "delivery" for shipment to an address (including third-party carrier service points selected via the shipping instruction's pickupPoint), "pickup" for collection at one of the brand's own stores (BOPIS). When absent, "delivery" can be assumed.` }),
-  protocolData: z.array(ShippingProtocolDataSchema).optional().meta({ description: "Additional provider-populated, protocol-specific data for this shipping method, e.g. available pickup time slots." })
+  protocolData: z.array(ShippingProtocolDataSchema).optional().meta({ description: `Additional provider-populated, protocol-specific data for this shipping method, e.g. available pickup time slots. Conventional keys (see SHIPPING_PROTOCOL_DATA_KEYS) include "pickup_store": the identifier of the brand's own store a pickup method is fulfilled from.` })
 });
 const ShippingInstructionSchema = BaseModelSchema.extend({
   shippingMethod: ShippingMethodIdentifierSchema,
@@ -41,6 +48,7 @@ const ShippingInstructionSchema = BaseModelSchema.extend({
 });
 export {
   PickupPointSchema,
+  SHIPPING_PROTOCOL_DATA_KEYS,
   ShippingFulfillmentTypeSchema,
   ShippingInstructionSchema,
   ShippingMethodSchema,

package/src/schemas/models/product-associations.model.d.ts

@@ -30,6 +30,9 @@ export declare const ProductAssociationProductSearchResultItemSchema: z.ZodObjec
             weee_symbol: z.ZodDefault<z.ZodBoolean>;
             energy_class: z.ZodOptional<z.ZodString>;
             garan_duration: z.ZodOptional<z.ZodNumber>;
+            energy_class_range: z.ZodOptional<z.ZodString>;
+            eprel_registration_number: z.ZodOptional<z.ZodString>;
+            eprel_product_group: z.ZodOptional<z.ZodString>;
             is_organic: z.ZodOptional<z.ZodBoolean>;
             organic_certification_type: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;
@@ -85,6 +88,9 @@ export declare const ProductAssociationSchema: z.ZodDiscriminatedUnion<[z.ZodObj
             weee_symbol: z.ZodDefault<z.ZodBoolean>;
             energy_class: z.ZodOptional<z.ZodString>;
             garan_duration: z.ZodOptional<z.ZodNumber>;
+            energy_class_range: z.ZodOptional<z.ZodString>;
+            eprel_registration_number: z.ZodOptional<z.ZodString>;
+            eprel_product_group: z.ZodOptional<z.ZodString>;
             is_organic: z.ZodOptional<z.ZodBoolean>;
             organic_certification_type: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;

package/src/schemas/models/product-recommendations.model.d.ts

@@ -33,6 +33,9 @@ export declare const ProductRecommendationProductSearchResultItemSchema: z.ZodOb
             weee_symbol: z.ZodDefault<z.ZodBoolean>;
             energy_class: z.ZodOptional<z.ZodString>;
             garan_duration: z.ZodOptional<z.ZodNumber>;
+            energy_class_range: z.ZodOptional<z.ZodString>;
+            eprel_registration_number: z.ZodOptional<z.ZodString>;
+            eprel_product_group: z.ZodOptional<z.ZodString>;
             is_organic: z.ZodOptional<z.ZodBoolean>;
             organic_certification_type: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;
@@ -90,6 +93,9 @@ export declare const ProductRecommendationSchema: z.ZodDiscriminatedUnion<[z.Zod
             weee_symbol: z.ZodDefault<z.ZodBoolean>;
             energy_class: z.ZodOptional<z.ZodString>;
             garan_duration: z.ZodOptional<z.ZodNumber>;
+            energy_class_range: z.ZodOptional<z.ZodString>;
+            eprel_registration_number: z.ZodOptional<z.ZodString>;
+            eprel_product_group: z.ZodOptional<z.ZodString>;
             is_organic: z.ZodOptional<z.ZodBoolean>;
             organic_certification_type: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;

package/src/schemas/models/product-search.model.d.ts

@@ -5,6 +5,9 @@ export declare const ProductSearchResultItemComplianceDataSchema: z.ZodObject<{
     weee_symbol: z.ZodDefault<z.ZodBoolean>;
     energy_class: z.ZodOptional<z.ZodString>;
     garan_duration: z.ZodOptional<z.ZodNumber>;
+    energy_class_range: z.ZodOptional<z.ZodString>;
+    eprel_registration_number: z.ZodOptional<z.ZodString>;
+    eprel_product_group: z.ZodOptional<z.ZodString>;
     is_organic: z.ZodOptional<z.ZodBoolean>;
     organic_certification_type: z.ZodOptional<z.ZodString>;
 }, z.core.$loose>;
@@ -45,6 +48,9 @@ export declare const ProductSearchResultItemSchema: z.ZodObject<{
         weee_symbol: z.ZodDefault<z.ZodBoolean>;
         energy_class: z.ZodOptional<z.ZodString>;
         garan_duration: z.ZodOptional<z.ZodNumber>;
+        energy_class_range: z.ZodOptional<z.ZodString>;
+        eprel_registration_number: z.ZodOptional<z.ZodString>;
+        eprel_product_group: z.ZodOptional<z.ZodString>;
         is_organic: z.ZodOptional<z.ZodBoolean>;
         organic_certification_type: z.ZodOptional<z.ZodString>;
     }, z.core.$loose>>;
@@ -119,6 +125,9 @@ export declare const ProductSearchResultSchema: z.ZodObject<{
             weee_symbol: z.ZodDefault<z.ZodBoolean>;
             energy_class: z.ZodOptional<z.ZodString>;
             garan_duration: z.ZodOptional<z.ZodNumber>;
+            energy_class_range: z.ZodOptional<z.ZodString>;
+            eprel_registration_number: z.ZodOptional<z.ZodString>;
+            eprel_product_group: z.ZodOptional<z.ZodString>;
             is_organic: z.ZodOptional<z.ZodBoolean>;
             organic_certification_type: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>>;

package/src/schemas/models/product.model.d.ts

@@ -9,6 +9,9 @@ export declare const ProductComplianceDataSchema: z.ZodObject<{
     weee_symbol: z.ZodDefault<z.ZodBoolean>;
     energy_class: z.ZodOptional<z.ZodString>;
     garan_duration: z.ZodOptional<z.ZodNumber>;
+    energy_class_range: z.ZodOptional<z.ZodString>;
+    eprel_registration_number: z.ZodOptional<z.ZodString>;
+    eprel_product_group: z.ZodOptional<z.ZodString>;
     safety_warnings: z.ZodOptional<z.ZodString>;
     composition: z.ZodOptional<z.ZodString>;
     additional_disclosures: z.ZodOptional<z.ZodString>;
@@ -234,6 +237,9 @@ export declare const ProductSchema: z.ZodObject<{
         weee_symbol: z.ZodDefault<z.ZodBoolean>;
         energy_class: z.ZodOptional<z.ZodString>;
         garan_duration: z.ZodOptional<z.ZodNumber>;
+        energy_class_range: z.ZodOptional<z.ZodString>;
+        eprel_registration_number: z.ZodOptional<z.ZodString>;
+        eprel_product_group: z.ZodOptional<z.ZodString>;
         safety_warnings: z.ZodOptional<z.ZodString>;
         composition: z.ZodOptional<z.ZodString>;
         additional_disclosures: z.ZodOptional<z.ZodString>;

package/src/schemas/models/shipping-method.model.d.ts

@@ -19,6 +19,18 @@ export declare const ShippingProtocolDataSchema: z.ZodObject<{
     key: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
 }, z.core.$loose>;
+/**
+ * Conventional, cross-provider keys for shipping protocol data entries.
+ * Providers emit these keys when the concept applies, so clients can consume
+ * them without provider-specific knowledge.
+ */
+export declare const SHIPPING_PROTOCOL_DATA_KEYS: {
+    /**
+     * The identifier (Store.identifier.key) of the brand's own store an
+     * in-store pickup (BOPIS) shipping method is fulfilled from.
+     */
+    readonly pickupStore: "pickup_store";
+};
 export declare const PickupPointSchema: z.ZodObject<{
     identifier: z.ZodObject<{
         key: z.ZodString;