From 392fc5f91ba53f42fc6b6b8d5b6cfd7203619d90 Mon Sep 17 00:00:00 2001
From: Miguel Torres Valls <miguel.torres@invopop.com>
Date: Fri, 24 Apr 2026 16:37:47 +0000
Subject: [PATCH 1/3] added support for zatca

---
 pom.xml                                         | 7 +++++++
 src/main/java/config/PhiveRulesInitializer.java | 3 +++
 2 files changed, 10 insertions(+)

diff --git a/pom.xml b/pom.xml
index 6587878..38e5ddb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -158,6 +158,13 @@
       <version>${phive-rules.version}</version>
     </dependency>
 
+    <!-- ZATCA (Saudi Arabia e-invoice) -->
+    <dependency>
+      <groupId>com.helger.phive.rules</groupId>
+      <artifactId>phive-rules-zatca</artifactId>
+      <version>${phive-rules.version}</version>
+    </dependency>
+
     <!-- Add more phive-rules dependencies as needed -->
     <!-- Uncomment the ones you need:
     <dependency>
diff --git a/src/main/java/config/PhiveRulesInitializer.java b/src/main/java/config/PhiveRulesInitializer.java
index c9ba2bd..ba8a157 100644
--- a/src/main/java/config/PhiveRulesInitializer.java
+++ b/src/main/java/config/PhiveRulesInitializer.java
@@ -70,6 +70,9 @@ public void initialize() {
             // France CTC (Chorus Pro - French e-invoicing)
             registerRules("com.helger.phive.france.FranceCTCValidation", "initFranceCTC");
 
+            // ZATCA (Saudi Arabia e-invoicing)
+            registerRules("com.helger.phive.zatca.ZATCAValidation", "initZATCA");
+
             // Log the number of registered validation executor sets
             final int count = registry.getAll().size();
 

From 64a09269db023656216544dd319f7674a2af4523 Mon Sep 17 00:00:00 2001
From: Miguel Torres Valls <miguel.torres@invopop.com>
Date: Fri, 24 Apr 2026 16:58:14 +0000
Subject: [PATCH 2/3] zatca fix

---
 src/main/java/rpc/ValidationServiceImpl.java | 141 ++++++++++++++++++-
 1 file changed, 134 insertions(+), 7 deletions(-)

diff --git a/src/main/java/rpc/ValidationServiceImpl.java b/src/main/java/rpc/ValidationServiceImpl.java
index 0f476c4..59584e0 100644
--- a/src/main/java/rpc/ValidationServiceImpl.java
+++ b/src/main/java/rpc/ValidationServiceImpl.java
@@ -21,20 +21,31 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
 import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 import com.helger.collection.commons.ICommonsList;
 import com.helger.diagnostics.error.level.IErrorLevel;
 import com.helger.diagnostics.error.list.ErrorList;
 import com.helger.diver.api.coord.DVRCoordinate;
+import com.helger.phive.api.artefact.IValidationArtefact;
 import com.helger.phive.api.execute.ValidationExecutionManager;
+import com.helger.phive.api.result.ValidationResult;
+import com.helger.phive.api.result.ValidationResultList;
+import com.helger.phive.api.validity.EExtendedValidity;
 import com.helger.phive.api.validity.IValidityDeterminator;
 import com.helger.phive.api.executorset.IValidationExecutorSet;
 import com.helger.phive.api.executorset.ValidationExecutorSetRegistry;
-import com.helger.phive.api.result.ValidationResult;
-import com.helger.phive.api.result.ValidationResultList;
 import com.helger.phive.api.source.IValidationSource;
 import com.helger.phive.xml.source.ValidationSourceXML;
+import com.helger.schematron.svrl.SVRLFailedAssert;
+import com.helger.schematron.svrl.SVRLHelper;
+import com.helger.schematron.svrl.SVRLMarshaller;
+import com.helger.schematron.svrl.SVRLSuccessfulReport;
+import com.helger.schematron.svrl.jaxb.SchematronOutputType;
+import com.helger.schematron.xslt.SchematronResourceXSLT;
 import com.helger.xml.serialize.read.DOMReader;
 import config.PhiveRulesInitializer;
 
@@ -183,12 +194,19 @@ public void validateXml(
             boolean overallSuccess = true;
             if (resultList != null) {
                 for (final ValidationResult result : resultList) {
+                    // Fix ZATCA Schematron SVRL parsing issue: the ZATCA XSLT
+                    // produces whitespace text nodes in <svrl:schematron-output>
+                    // which causes JAXB to fail. Re-run and parse without XSD
+                    // validation when the internal error is detected.
+                    final ValidationResult effectiveResult =
+                            fixZATCASchematronResult(result, xmlNode);
+
                     final ValidationProto.ValidationLayerResult.Builder layerBuilder =
                             ValidationProto.ValidationLayerResult.newBuilder();
 
                     // Set validation type and artifact
-                    if (result.getValidationArtefact() != null) {
-                        final var artefact = result.getValidationArtefact();
+                    if (effectiveResult.getValidationArtefact() != null) {
+                        final var artefact = effectiveResult.getValidationArtefact();
                         layerBuilder.setValidationType(artefact.getValidationType().getID());
 
                         if (artefact.getRuleResource() != null) {
@@ -197,15 +215,15 @@ public void validateXml(
                     }
 
                     // Check success - result is valid if it has no errors
-                    final boolean layerSuccess = !result.getErrorList().containsAtLeastOneError();
+                    final boolean layerSuccess = !effectiveResult.getErrorList().containsAtLeastOneError();
                     layerBuilder.setSuccess(layerSuccess);
                     if (!layerSuccess) {
                         overallSuccess = false;
                     }
 
                     // Process errors and warnings
-                    if (result.getErrorList() != null && result.getErrorList().isNotEmpty()) {
-                        result.getErrorList().forEach(error -> {
+                    if (effectiveResult.getErrorList() != null && effectiveResult.getErrorList().isNotEmpty()) {
+                        effectiveResult.getErrorList().forEach(error -> {
                             final ValidationProto.ValidationError.Builder errorBuilder =
                                     ValidationProto.ValidationError.newBuilder()
                                     .setLevel(error.getErrorLevel().getID())
@@ -255,4 +273,113 @@ public void validateXml(
             responseObserver.onCompleted();
         }
     }
+
+    /**
+     * Fixes a ZATCA Schematron validation result that failed due to SVRL whitespace
+     * parsing issues. The ZATCA XSLT uses {@code <xsl:output indent="yes"/>} which
+     * produces whitespace text nodes inside {@code <svrl:schematron-output>}. Phive's
+     * JAXB unmarshaller rejects these with strict XSD validation.
+     *
+     * <p>When the ZATCA Schematron layer reports "Internal error interpreting Schematron
+     * result", this method re-runs the XSLT, strips whitespace from the SVRL DOM,
+     * and re-parses with schema validation disabled.</p>
+     *
+     * @return the fixed result, or the original if no fix was needed
+     */
+    @Nonnull
+    private ValidationResult fixZATCASchematronResult(
+            @Nonnull final ValidationResult result,
+            @Nonnull final Node xmlNode) {
+
+        final IValidationArtefact artefact = result.getValidationArtefact();
+        if (artefact == null || artefact.getRuleResource() == null) {
+            return result;
+        }
+        final String path = artefact.getRuleResource().getPath();
+
+        // Only target ZATCA Schematron results that failed with internal error
+        if (!path.contains("ZATCA_E-invoice_Validation_Rules")) {
+            return result;
+        }
+        if (!result.getErrorList().containsAtLeastOneError()) {
+            return result;
+        }
+
+        boolean isInternalError = false;
+        for (final var error : result.getErrorList()) {
+            if (error.getErrorText(Locale.US).contains("Internal error interpreting Schematron result")) {
+                isInternalError = true;
+                break;
+            }
+        }
+        if (!isInternalError) {
+            return result;
+        }
+
+        LOGGER.info("Attempting ZATCA Schematron SVRL fallback re-parse for: {}", path);
+
+        try {
+            // Re-run the XSLT with the same resource
+            final SchematronResourceXSLT schematron = new SchematronResourceXSLT(
+                    artefact.getRuleResource());
+            final Document svrlDoc = schematron.applySchematronValidation(
+                    new javax.xml.transform.dom.DOMSource(xmlNode));
+            if (svrlDoc == null) {
+                LOGGER.warn("ZATCA Schematron XSLT re-run returned null SVRL");
+                return result;
+            }
+
+            // Strip whitespace text nodes that cause JAXB to fail
+            stripWhitespaceTextNodes(svrlDoc.getDocumentElement());
+
+            // Parse SVRL without XSD validation
+            final SVRLMarshaller marshaller = new SVRLMarshaller();
+            marshaller.setUseSchema(false);
+            final SchematronOutputType svrl = marshaller.read(svrlDoc);
+            if (svrl == null) {
+                LOGGER.warn("ZATCA SVRL fallback: SVRLMarshaller.read() returned null");
+                return result;
+            }
+
+            // Build error list from parsed SVRL
+            final ErrorList errorList = new ErrorList();
+            for (final SVRLFailedAssert fa : SVRLHelper.getAllFailedAssertions(svrl)) {
+                errorList.add(fa.getAsResourceError(path));
+            }
+            for (final SVRLSuccessfulReport sr : SVRLHelper.getAllSuccessfulReports(svrl)) {
+                errorList.add(sr.getAsResourceError(path));
+            }
+
+            // Determine validity based on errors
+            final EExtendedValidity validity = errorList.containsAtLeastOneError()
+                    ? EExtendedValidity.INVALID
+                    : EExtendedValidity.VALID;
+
+            LOGGER.info("ZATCA Schematron SVRL fallback succeeded: {} errors, {} total items",
+                    errorList.getErrorCount(),
+                    errorList.size());
+
+            return new ValidationResult(artefact, errorList, validity, 0);
+
+        } catch (final Exception ex) {
+            LOGGER.error("ZATCA Schematron SVRL fallback failed", ex);
+            return result;
+        }
+    }
+
+    /**
+     * Recursively removes whitespace-only text nodes from a DOM element.
+     */
+    private void stripWhitespaceTextNodes(@Nonnull final Element element) {
+        final NodeList children = element.getChildNodes();
+        for (int i = children.getLength() - 1; i >= 0; i--) {
+            final Node child = children.item(i);
+            if (child.getNodeType() == Node.TEXT_NODE
+                    && child.getTextContent().trim().isEmpty()) {
+                element.removeChild(child);
+            } else if (child.getNodeType() == Node.ELEMENT_NODE) {
+                stripWhitespaceTextNodes((Element) child);
+            }
+        }
+    }
 }

From 7f7025ca63a15579e0662d8db507012d5d268d20 Mon Sep 17 00:00:00 2001
From: Miguel Torres <miguel.torres@invopop.com>
Date: Mon, 8 Jun 2026 08:16:40 +0000
Subject: [PATCH 3/3] unncessary code fixed with phive bump

---
 src/main/java/rpc/ValidationServiceImpl.java | 140 +------------------
 1 file changed, 5 insertions(+), 135 deletions(-)

diff --git a/src/main/java/rpc/ValidationServiceImpl.java b/src/main/java/rpc/ValidationServiceImpl.java
index 59584e0..402b3e5 100644
--- a/src/main/java/rpc/ValidationServiceImpl.java
+++ b/src/main/java/rpc/ValidationServiceImpl.java
@@ -15,37 +15,23 @@
  */
 package rpc;
 
-import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.Locale;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
 import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
 
 import com.helger.collection.commons.ICommonsList;
-import com.helger.diagnostics.error.level.IErrorLevel;
-import com.helger.diagnostics.error.list.ErrorList;
 import com.helger.diver.api.coord.DVRCoordinate;
-import com.helger.phive.api.artefact.IValidationArtefact;
 import com.helger.phive.api.execute.ValidationExecutionManager;
 import com.helger.phive.api.result.ValidationResult;
 import com.helger.phive.api.result.ValidationResultList;
-import com.helger.phive.api.validity.EExtendedValidity;
 import com.helger.phive.api.validity.IValidityDeterminator;
 import com.helger.phive.api.executorset.IValidationExecutorSet;
 import com.helger.phive.api.executorset.ValidationExecutorSetRegistry;
 import com.helger.phive.api.source.IValidationSource;
 import com.helger.phive.xml.source.ValidationSourceXML;
-import com.helger.schematron.svrl.SVRLFailedAssert;
-import com.helger.schematron.svrl.SVRLHelper;
-import com.helger.schematron.svrl.SVRLMarshaller;
-import com.helger.schematron.svrl.SVRLSuccessfulReport;
-import com.helger.schematron.svrl.jaxb.SchematronOutputType;
-import com.helger.schematron.xslt.SchematronResourceXSLT;
 import com.helger.xml.serialize.read.DOMReader;
 import config.PhiveRulesInitializer;
 
@@ -194,19 +180,12 @@ public void validateXml(
             boolean overallSuccess = true;
             if (resultList != null) {
                 for (final ValidationResult result : resultList) {
-                    // Fix ZATCA Schematron SVRL parsing issue: the ZATCA XSLT
-                    // produces whitespace text nodes in <svrl:schematron-output>
-                    // which causes JAXB to fail. Re-run and parse without XSD
-                    // validation when the internal error is detected.
-                    final ValidationResult effectiveResult =
-                            fixZATCASchematronResult(result, xmlNode);
-
                     final ValidationProto.ValidationLayerResult.Builder layerBuilder =
                             ValidationProto.ValidationLayerResult.newBuilder();
 
                     // Set validation type and artifact
-                    if (effectiveResult.getValidationArtefact() != null) {
-                        final var artefact = effectiveResult.getValidationArtefact();
+                    if (result.getValidationArtefact() != null) {
+                        final var artefact = result.getValidationArtefact();
                         layerBuilder.setValidationType(artefact.getValidationType().getID());
 
                         if (artefact.getRuleResource() != null) {
@@ -215,15 +194,15 @@ public void validateXml(
                     }
 
                     // Check success - result is valid if it has no errors
-                    final boolean layerSuccess = !effectiveResult.getErrorList().containsAtLeastOneError();
+                    final boolean layerSuccess = !result.getErrorList().containsAtLeastOneError();
                     layerBuilder.setSuccess(layerSuccess);
                     if (!layerSuccess) {
                         overallSuccess = false;
                     }
 
                     // Process errors and warnings
-                    if (effectiveResult.getErrorList() != null && effectiveResult.getErrorList().isNotEmpty()) {
-                        effectiveResult.getErrorList().forEach(error -> {
+                    if (result.getErrorList() != null && result.getErrorList().isNotEmpty()) {
+                        result.getErrorList().forEach(error -> {
                             final ValidationProto.ValidationError.Builder errorBuilder =
                                     ValidationProto.ValidationError.newBuilder()
                                     .setLevel(error.getErrorLevel().getID())
@@ -273,113 +252,4 @@ public void validateXml(
             responseObserver.onCompleted();
         }
     }
-
-    /**
-     * Fixes a ZATCA Schematron validation result that failed due to SVRL whitespace
-     * parsing issues. The ZATCA XSLT uses {@code <xsl:output indent="yes"/>} which
-     * produces whitespace text nodes inside {@code <svrl:schematron-output>}. Phive's
-     * JAXB unmarshaller rejects these with strict XSD validation.
-     *
-     * <p>When the ZATCA Schematron layer reports "Internal error interpreting Schematron
-     * result", this method re-runs the XSLT, strips whitespace from the SVRL DOM,
-     * and re-parses with schema validation disabled.</p>
-     *
-     * @return the fixed result, or the original if no fix was needed
-     */
-    @Nonnull
-    private ValidationResult fixZATCASchematronResult(
-            @Nonnull final ValidationResult result,
-            @Nonnull final Node xmlNode) {
-
-        final IValidationArtefact artefact = result.getValidationArtefact();
-        if (artefact == null || artefact.getRuleResource() == null) {
-            return result;
-        }
-        final String path = artefact.getRuleResource().getPath();
-
-        // Only target ZATCA Schematron results that failed with internal error
-        if (!path.contains("ZATCA_E-invoice_Validation_Rules")) {
-            return result;
-        }
-        if (!result.getErrorList().containsAtLeastOneError()) {
-            return result;
-        }
-
-        boolean isInternalError = false;
-        for (final var error : result.getErrorList()) {
-            if (error.getErrorText(Locale.US).contains("Internal error interpreting Schematron result")) {
-                isInternalError = true;
-                break;
-            }
-        }
-        if (!isInternalError) {
-            return result;
-        }
-
-        LOGGER.info("Attempting ZATCA Schematron SVRL fallback re-parse for: {}", path);
-
-        try {
-            // Re-run the XSLT with the same resource
-            final SchematronResourceXSLT schematron = new SchematronResourceXSLT(
-                    artefact.getRuleResource());
-            final Document svrlDoc = schematron.applySchematronValidation(
-                    new javax.xml.transform.dom.DOMSource(xmlNode));
-            if (svrlDoc == null) {
-                LOGGER.warn("ZATCA Schematron XSLT re-run returned null SVRL");
-                return result;
-            }
-
-            // Strip whitespace text nodes that cause JAXB to fail
-            stripWhitespaceTextNodes(svrlDoc.getDocumentElement());
-
-            // Parse SVRL without XSD validation
-            final SVRLMarshaller marshaller = new SVRLMarshaller();
-            marshaller.setUseSchema(false);
-            final SchematronOutputType svrl = marshaller.read(svrlDoc);
-            if (svrl == null) {
-                LOGGER.warn("ZATCA SVRL fallback: SVRLMarshaller.read() returned null");
-                return result;
-            }
-
-            // Build error list from parsed SVRL
-            final ErrorList errorList = new ErrorList();
-            for (final SVRLFailedAssert fa : SVRLHelper.getAllFailedAssertions(svrl)) {
-                errorList.add(fa.getAsResourceError(path));
-            }
-            for (final SVRLSuccessfulReport sr : SVRLHelper.getAllSuccessfulReports(svrl)) {
-                errorList.add(sr.getAsResourceError(path));
-            }
-
-            // Determine validity based on errors
-            final EExtendedValidity validity = errorList.containsAtLeastOneError()
-                    ? EExtendedValidity.INVALID
-                    : EExtendedValidity.VALID;
-
-            LOGGER.info("ZATCA Schematron SVRL fallback succeeded: {} errors, {} total items",
-                    errorList.getErrorCount(),
-                    errorList.size());
-
-            return new ValidationResult(artefact, errorList, validity, 0);
-
-        } catch (final Exception ex) {
-            LOGGER.error("ZATCA Schematron SVRL fallback failed", ex);
-            return result;
-        }
-    }
-
-    /**
-     * Recursively removes whitespace-only text nodes from a DOM element.
-     */
-    private void stripWhitespaceTextNodes(@Nonnull final Element element) {
-        final NodeList children = element.getChildNodes();
-        for (int i = children.getLength() - 1; i >= 0; i--) {
-            final Node child = children.item(i);
-            if (child.getNodeType() == Node.TEXT_NODE
-                    && child.getTextContent().trim().isEmpty()) {
-                element.removeChild(child);
-            } else if (child.getNodeType() == Node.ELEMENT_NODE) {
-                stripWhitespaceTextNodes((Element) child);
-            }
-        }
-    }
 }