feat!: Add exception to onVerificationFailed callback, improve error handling, add API Guard to CI

.github/workflows/build_dev.yaml

@@ -6,62 +6,13 @@ on:
       - dev
 
 jobs:
-  version:
-    name: Version & Build
+  validate:
+    name: Validate Package
     runs-on: macos-latest
-    environment: release
-    permissions:
-      contents: write
-
-    outputs:
-      version: ${{ steps.get_new_version.outputs.result}}
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-        with:
-          token: ${{secrets.ELEVATED_TOKEN}}
-
-      - name: 📇 Configure git
-        run: |
-          git fetch --prune --unshallow
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "gh-actions@merckgroup.com"
-        shell: bash
-
-      # Retrieve the new version
-      - name: 🔂 Run standard-version
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const {execSync} = require('child_process');
-            execSync('npx standard-version --skip.tag --prerelease', {stdio: 'inherit'});
-
-      # Retrieve the new version
-      - name: ⏎ Get new version
-        uses: actions/github-script@v7
-        id: get_new_version
-        with:
-          result-encoding: string
-          script: |
-            const fs = require('fs');
-            const package = JSON.parse(fs.readFileSync('package.json', 'utf8'));
-            return package.version;
-
-      - name: Print new version
-        run: echo ${{ steps.get_new_version.outputs.result}}
-
-      # Bump the pubspec.yaml file
-      - name: ⬆️ Bump pubspec.yaml
-        uses: emdgroup/mtrust-urp/.github/shared_actions/update-pubspec@dev
-        with:
-          version: ${{ steps.get_new_version.outputs.result }}
-          directory: .
-
-      - name: 📝 Update version in readme
-        uses: emdgroup/mtrust-urp/.github/shared_actions/update-pubspec-readme-version@dev
-        with:
-          directory: .
 
       - name: Setup Dart
         uses: dart-lang/setup-dart@v1
@@ -82,17 +33,11 @@ jobs:
         with:
           directory: "."
 
-      #  We first commit with proper message and add an empty commit to keep the files history clean
-      - name: Update repo versions
-        run: |
-          git add . 
-          git commit -m "chore(release): ${{ steps.get_new_version.outputs.result }}"
-          git commit --allow-empty -m "chore(release): ${{ steps.get_new_version.outputs.result }} [skip ci]"
-          git push origin dev
-
-      #  For this part it is important to not push a commit with [skip ci] before the tag release
-      - name: Push tag for pub.dev
-        run: |
-          git commit --allow-empty -m "chore(release): ${{ steps.get_new_version.outputs.result }}"
-          git tag -a v${{ steps.get_new_version.outputs.result }} -m "Pub.dev version ${{ steps.get_new_version.outputs.result }}"
-          git push origin v${{ steps.get_new_version.outputs.result }}
+  api-guard:
+    needs: validate
+    uses: emdgroup/mtrust-api-guard/.github/workflows/publish_workflow.yaml@main
+    with:
+      git_push_branch: dev
+      git_push: true
+      pre_release: true
+    secrets: inherit

.github/workflows/build_main.yaml

@@ -6,62 +6,13 @@ on:
       - main
 
 jobs:
-  version:
-    name: Version & Build
+  validate:
+    name: Validate Package
     runs-on: macos-latest
-    environment: release
-    permissions:
-      contents: write
-
-    outputs:
-      version: ${{ steps.get_new_version.outputs.result}}
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-        with:
-          token: ${{secrets.ELEVATED_TOKEN}}
-
-      - name: 📇 Configure git
-        run: |
-          git fetch --prune --unshallow
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "gh-actions@merckgroup.com"
-        shell: bash
-
-      # Retrieve the new version
-      - name: 🔂 Run standard-version
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const {execSync} = require('child_process');
-            execSync('npx standard-version --skip.tag', {stdio: 'inherit'});
-
-      # Retrieve the new version
-      - name: ⏎ Get new version
-        uses: actions/github-script@v7
-        id: get_new_version
-        with:
-          result-encoding: string
-          script: |
-            const fs = require('fs');
-            const package = JSON.parse(fs.readFileSync('package.json', 'utf8'));
-            return package.version;
-
-      - name: Print new version
-        run: echo ${{ steps.get_new_version.outputs.result}}
-
-      # Bump the pubspec.yaml file
-      - name: ⬆️ Bump pubspec.yaml
-        uses: emdgroup/mtrust-urp/.github/shared_actions/update-pubspec@main
-        with:
-          version: ${{ steps.get_new_version.outputs.result }}
-          directory: .
-
-      - name: 📝 Update version in readme
-        uses: emdgroup/mtrust-urp/.github/shared_actions/update-pubspec-readme-version@main
-        with:
-          directory: .
 
       - name: Setup Dart
         uses: dart-lang/setup-dart@v1
@@ -82,24 +33,17 @@ jobs:
         with:
           directory: "."
 
-      #  We first commit with proper message and add an empty commit to keep the files history clean
-      - name: Update repo versions
-        run: |
-          git add . 
-          git commit -m "chore(release): ${{ steps.get_new_version.outputs.result }}"
-          git commit --allow-empty -m "chore(release): ${{ steps.get_new_version.outputs.result }} [skip ci]"
-          git push origin main
-
-      #  For this part it is important to not push a commit with [skip ci] before the tag release
-      - name: Push tag for pub.dev
-        run: |
-          git commit --allow-empty -m "chore(release): ${{ steps.get_new_version.outputs.result }}"
-          git tag -a v${{ steps.get_new_version.outputs.result }} -m "Pub.dev version ${{ steps.get_new_version.outputs.result }}"
-          git push origin v${{ steps.get_new_version.outputs.result }}
+  api-guard:
+    needs: validate
+    uses: emdgroup/mtrust-api-guard/.github/workflows/publish_workflow.yaml@main
+    with:
+      git_push_branch: main
+      git_push: true
+    secrets: inherit
 
   rebase_dev:
     name: Write changes to dev branch
-    needs: [version]
+    needs: [api-guard]
     runs-on: ubuntu-latest
     permissions:
       contents: write

.github/workflows/pr_dev.yaml

@@ -66,3 +66,8 @@ jobs:
         uses: emdgroup/mtrust-urp/.github/shared_actions/check-dart-licenses@dev
         with:
           directory: .
+
+  api-guard:
+    uses: emdgroup/mtrust-api-guard/.github/workflows/pr_workflow.yaml@main
+    with:
+      pre_release: true

.github/workflows/pr_main.yaml

@@ -66,3 +66,6 @@ jobs:
         uses: emdgroup/mtrust-urp/.github/shared_actions/check-dart-licenses@main
         with:
           directory: .
+
+  api-guard:
+    uses: emdgroup/mtrust-api-guard/.github/workflows/pr_workflow.yaml@main

.gitignore

@@ -35,4 +35,4 @@ test/failures
 **/GeneratedPluginRegistrant.swift
 **/generated_plugin_registrant.cc
 **/generated_plugin_registrant.h
-**/generated_plugins.cmake
+**/generated_plugins.cmake

README.md

@@ -95,7 +95,9 @@ To display the SEC Modal, utilize the `SecModalBuilder` widget. It requires a co
     strategy: _connectionStrategy,
     payload: // Payload,
     onVerificationDone: (mesurement) {},
-    onVerificationFailed: () {},
+    onVerificationFailed: (exception) {
+      // Handle verification failure. The exception provides details about the cause.
+    },
     onDismiss: (){ } // Optionally 
     canDismiss: true, // Define whether the user can dismiss the modal
     builder: (context, openModal) {

analysis_options.yaml

@@ -6,4 +6,8 @@ analyzer:
   exclude:
     - "lib/src/**/*.g.dart"
     - "lib/src/**/*.freezed.dart"
-    - "lib/src/ui/l10n/*.dart"
+    - "lib/src/ui/l10n/*.dart"
+
+api_guard:
+  exclude:
+    - "example/**"

example/lib/main.dart

@@ -1,9 +1,8 @@
 import 'package:example/virtual_strategy.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
-import 'package:mtrust_sec_kit/mtrust_sec_kit.dart';
-
 import 'package:liquid_flutter/liquid_flutter.dart';
+import 'package:mtrust_sec_kit/mtrust_sec_kit.dart';
 import 'package:mtrust_urp_ble_strategy/mtrust_urp_ble_strategy.dart';
 
 void main() {
@@ -102,8 +101,8 @@ class _MainAppState extends State<MainApp> {
               onVerificationDone: (measurement) {
                 debugPrint("Verification done ${measurement.measurement}");
               },
-              onVerificationFailed: () {
-                debugPrint("Verification failed");
+              onVerificationFailed: (exception) {
+                debugPrint("Verification failed: $exception");
               },
               builder: (context, openModal) {
                 return LdButton(