@reactionary/core 0.10.25 → 0.10.26

package/capabilities/product.capability.js

@@ -27,7 +27,11 @@ class ProductCapability extends BaseCapability {
       published: false,
       sharedAttributes: [],
       slug: "",
-      variants: []
+      variants: [],
+      complianceData: {
+        ce_marking: false,
+        weee_symbol: false
+      }
     };
     return product;
   }

package/package.json

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

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

@@ -2,6 +2,14 @@ import * as z from "zod";
 import { ProductIdentifierSchema, FacetValueIdentifierSchema, FacetIdentifierSchema, ProductSearchIdentifierSchema, ProductVariantIdentifierSchema } from "./identifiers.model.js";
 import { BaseModelSchema, createPaginatedResponseSchema, ImageSchema } from "./base.model.js";
 import { ProductVariantOptionSchema } from "./product.model.js";
+const ProductSearchResultItemComplianceDataSchema = z.looseObject({
+  ce_marking: z.boolean().default(false).meta({ description: "Indicates whether CE marking can be shown on the product" }),
+  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." }),
+  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." })
+});
 const ProductSearchResultItemVariantSchema = z.looseObject({
   variant: ProductVariantIdentifierSchema.describe("The specific variant of the product"),
   image: ImageSchema.describe("The image representing this variant in the search results"),
@@ -11,6 +19,7 @@ const ProductSearchResultItemSchema = BaseModelSchema.extend({
   identifier: ProductIdentifierSchema,
   name: z.string(),
   slug: z.string(),
+  complianceData: ProductSearchResultItemComplianceDataSchema.optional().meta({ description: "Compliance data for the product as required by EU regulations." }),
   variants: z.array(ProductSearchResultItemVariantSchema).meta({ description: "A list of variants associated with the product in the search results. If exactly one is present, you can use add-to-cart directly from PLP. If none are present, you must direct to PDP. If mulitple are present, and no options are set, you must direct to PDP. If multiple are present, and they have options, you can render swatches on PLP and allow customer to flip between variants." })
 });
 const ProductSearchResultFacetValueSchema = z.looseObject({
@@ -31,6 +40,7 @@ const ProductSearchResultSchema = createPaginatedResponseSchema(ProductSearchRes
 export {
   ProductSearchResultFacetSchema,
   ProductSearchResultFacetValueSchema,
+  ProductSearchResultItemComplianceDataSchema,
   ProductSearchResultItemSchema,
   ProductSearchResultItemVariantSchema,
   ProductSearchResultSchema

package/schemas/models/product.model.js

@@ -1,6 +1,35 @@
 import * as z from "zod";
 import { CategoryIdentifierSchema, ProductAttributeIdentifierSchema, ProductAttributeValueIdentifierSchema, ProductIdentifierSchema, ProductOptionIdentifierSchema, ProductOptionValueIdentifierSchema, ProductVariantIdentifierSchema } from "./identifiers.model.js";
 import { BaseModelSchema, ImageSchema } from "./base.model.js";
+const ProductComplianceDataSchema = z.looseObject({
+  ce_marking: z.boolean().default(false).meta({ description: "Indicates whether CE marking can be shown on the product" }),
+  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." }),
+  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." }),
+  traceability: z.object({
+    product_identifier: z.string().optional().meta({ description: 'The unique identifier for the product batch, e.g., "BATCH-2026-X9".' }),
+    manufacturer: z.object({
+      name: z.string().optional().meta({ description: "The name of the manufacturer." }),
+      postal_address: z.string().optional().meta({ description: "The postal address of the manufacturer." }),
+      electronic_address: z.string().optional().meta({ description: "The electronic address of the manufacturer." })
+    }).meta({ description: "Information about the manufacturer of the product." }),
+    eu_responsible_person: z.object({
+      name: z.string().optional().meta({ description: "The name of the EU responsible person." }),
+      postal_address: z.string().optional().meta({ description: "The postal address of the EU responsible person." }),
+      electronic_address: z.string().optional().meta({ description: "The electronic address of the EU responsible person." })
+    }).meta({ description: "Information about the EU responsible person for the product." })
+  }).optional().meta({ description: "Traceability information for the product as required by EU regulations." }),
+  organic: z.object({
+    is_organic: z.boolean().meta({ description: "true, if the product is organic according to EU regulations." }),
+    certification_type: z.string().optional().meta({ description: "The type of organic certification, e.g., EU_ORGANIC_LEAF, GOTS, ECOCERT." }),
+    control_body_code: z.string().optional().meta({ description: "The code of the control body responsible for the certification." }),
+    agriculture_origin: z.string().optional().meta({ description: "The origin of the agriculture, e.g., EU or non-EU." }),
+    certificate_url: z.url().optional().meta({ description: "The URL to the organic certification document." })
+  }).optional().meta({ description: "Information about the organic certification of the product as required by EU regulations." })
+});
 const ProductOptionValueSchema = z.looseObject({
   identifier: ProductOptionValueIdentifierSchema.describe("The unique identifier for the product option value."),
   label: z.string().meta({ description: "The human-friendly label for the product option value." })
@@ -49,11 +78,13 @@ const ProductSchema = BaseModelSchema.extend({
   sharedAttributes: z.array(ProductAttributeSchema).meta({ description: "A list of technical attributes associated with the product" }),
   options: z.array(ProductOptionSchema).meta({ description: "A list of options available for the product, such as size or color. Can be empty if product is single-sku" }),
   mainVariant: ProductVariantSchema.describe("The primary SKU for the product"),
-  variants: z.array(ProductVariantSchema).default([]).meta({ description: "A list of all SKUs for the product. Can be empty or omitted if product is single-sku" })
+  variants: z.array(ProductVariantSchema).default([]).meta({ description: "A list of all SKUs for the product. Can be empty or omitted if product is single-sku" }),
+  complianceData: ProductComplianceDataSchema.optional().describe("Compliance information for the product, including certifications and regulatory markings.")
 }).describe("A product is a wrapper around sellable items. It contains all the shared information for a set of SKUs. All products have at least one SKU, but can potentially have hundreds.");
 export {
   ProductAttributeSchema,
   ProductAttributeValueSchema,
+  ProductComplianceDataSchema,
   ProductOptionSchema,
   ProductOptionValueSchema,
   ProductSchema,

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

@@ -25,6 +25,14 @@ export declare const ProductAssociationProductSearchResultItemSchema: z.ZodObjec
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;
@@ -72,6 +80,14 @@ export declare const ProductAssociationSchema: z.ZodDiscriminatedUnion<[z.ZodObj
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;

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

@@ -28,6 +28,14 @@ export declare const ProductRecommendationProductSearchResultItemSchema: z.ZodOb
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;
@@ -77,6 +85,14 @@ export declare const ProductRecommendationSchema: z.ZodDiscriminatedUnion<[z.Zod
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;

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

@@ -1,5 +1,13 @@
 import * as z from 'zod';
 import type { InferType } from '../../zod-utils.js';
+export declare const ProductSearchResultItemComplianceDataSchema: z.ZodObject<{
+    ce_marking: z.ZodDefault<z.ZodBoolean>;
+    weee_symbol: z.ZodDefault<z.ZodBoolean>;
+    energy_class: z.ZodOptional<z.ZodString>;
+    garan_duration: z.ZodOptional<z.ZodNumber>;
+    is_organic: z.ZodOptional<z.ZodBoolean>;
+    organic_certification_type: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
 export declare const ProductSearchResultItemVariantSchema: z.ZodObject<{
     variant: z.ZodObject<{
         sku: z.ZodString;
@@ -32,6 +40,14 @@ export declare const ProductSearchResultItemSchema: z.ZodObject<{
     }, z.core.$loose>;
     name: z.ZodString;
     slug: z.ZodString;
+    complianceData: z.ZodOptional<z.ZodObject<{
+        ce_marking: z.ZodDefault<z.ZodBoolean>;
+        weee_symbol: z.ZodDefault<z.ZodBoolean>;
+        energy_class: z.ZodOptional<z.ZodString>;
+        garan_duration: z.ZodOptional<z.ZodNumber>;
+        is_organic: z.ZodOptional<z.ZodBoolean>;
+        organic_certification_type: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
     variants: z.ZodArray<z.ZodObject<{
         variant: z.ZodObject<{
             sku: z.ZodString;
@@ -98,6 +114,14 @@ export declare const ProductSearchResultSchema: z.ZodObject<{
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;
@@ -168,6 +192,7 @@ export declare const ProductSearchResultSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type ProductSearchResultItemVariant = InferType<typeof ProductSearchResultItemVariantSchema>;
 export type ProductSearchResultItem = InferType<typeof ProductSearchResultItemSchema>;
+export type ProductSearchResultItemComplianceData = InferType<typeof ProductSearchResultItemComplianceDataSchema>;
 export type ProductSearchResult = InferType<typeof ProductSearchResultSchema>;
 export type ProductSearchResultFacet = InferType<typeof ProductSearchResultFacetSchema>;
 export type ProductSearchResultFacetValue = InferType<typeof ProductSearchResultFacetValueSchema>;

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

@@ -1,5 +1,38 @@
 import * as z from 'zod';
 import type { InferType } from '../../zod-utils.js';
+/**
+ * This type represents all the various compliance fields that EU law mandates for products sold within the European Union.
+ * It includes information such as the unique identifier for the compliance information.
+ */
+export declare const ProductComplianceDataSchema: z.ZodObject<{
+    ce_marking: z.ZodDefault<z.ZodBoolean>;
+    weee_symbol: z.ZodDefault<z.ZodBoolean>;
+    energy_class: z.ZodOptional<z.ZodString>;
+    garan_duration: z.ZodOptional<z.ZodNumber>;
+    safety_warnings: z.ZodOptional<z.ZodString>;
+    composition: z.ZodOptional<z.ZodString>;
+    additional_disclosures: z.ZodOptional<z.ZodString>;
+    traceability: z.ZodOptional<z.ZodObject<{
+        product_identifier: z.ZodOptional<z.ZodString>;
+        manufacturer: z.ZodObject<{
+            name: z.ZodOptional<z.ZodString>;
+            postal_address: z.ZodOptional<z.ZodString>;
+            electronic_address: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        eu_responsible_person: z.ZodObject<{
+            name: z.ZodOptional<z.ZodString>;
+            postal_address: z.ZodOptional<z.ZodString>;
+            electronic_address: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    organic: z.ZodOptional<z.ZodObject<{
+        is_organic: z.ZodBoolean;
+        certification_type: z.ZodOptional<z.ZodString>;
+        control_body_code: z.ZodOptional<z.ZodString>;
+        agriculture_origin: z.ZodOptional<z.ZodString>;
+        certificate_url: z.ZodOptional<z.ZodURL>;
+    }, z.core.$strip>>;
+}, z.core.$loose>;
 export declare const ProductOptionValueSchema: z.ZodObject<{
     identifier: z.ZodObject<{
         option: z.ZodObject<{
@@ -196,9 +229,39 @@ export declare const ProductSchema: z.ZodObject<{
             }, z.core.$loose>;
         }, z.core.$loose>>;
     }, z.core.$loose>>>;
+    complianceData: z.ZodOptional<z.ZodObject<{
+        ce_marking: z.ZodDefault<z.ZodBoolean>;
+        weee_symbol: z.ZodDefault<z.ZodBoolean>;
+        energy_class: z.ZodOptional<z.ZodString>;
+        garan_duration: z.ZodOptional<z.ZodNumber>;
+        safety_warnings: z.ZodOptional<z.ZodString>;
+        composition: z.ZodOptional<z.ZodString>;
+        additional_disclosures: z.ZodOptional<z.ZodString>;
+        traceability: z.ZodOptional<z.ZodObject<{
+            product_identifier: z.ZodOptional<z.ZodString>;
+            manufacturer: z.ZodObject<{
+                name: z.ZodOptional<z.ZodString>;
+                postal_address: z.ZodOptional<z.ZodString>;
+                electronic_address: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            eu_responsible_person: z.ZodObject<{
+                name: z.ZodOptional<z.ZodString>;
+                postal_address: z.ZodOptional<z.ZodString>;
+                electronic_address: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        organic: z.ZodOptional<z.ZodObject<{
+            is_organic: z.ZodBoolean;
+            certification_type: z.ZodOptional<z.ZodString>;
+            control_body_code: z.ZodOptional<z.ZodString>;
+            agriculture_origin: z.ZodOptional<z.ZodString>;
+            certificate_url: z.ZodOptional<z.ZodURL>;
+        }, z.core.$strip>>;
+    }, z.core.$loose>>;
 }, z.core.$loose>;
 export type ProductVariant = InferType<typeof ProductVariantSchema>;
 export type Product = InferType<typeof ProductSchema>;
+export type ProductComplianceData = InferType<typeof ProductComplianceDataSchema>;
 export type ProductAttribute = InferType<typeof ProductAttributeSchema>;
 export type ProductAttributeValue = InferType<typeof ProductAttributeValueSchema>;
 export type ProductOption = InferType<typeof ProductOptionSchema>;