ballerine-io · Feb 17, 2025 · Feb 18, 2025 · Feb 19, 2025 · Feb 20, 2025 · Feb 23, 2025
Showing 663 changed files with 73,726 additions and 5,390 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -3,7 +3,7 @@
   "changelog": "@changesets/changelog-git",
   "commit": false,
   "fixed": [],
-  "linked": [],
+  "linked": [["@ballerine/ui", "@ballerine/backoffice-v2"]],
   "access": "public",
   "baseBranch": "dev",
   "updateInternalDependencies": "patch",

diff --git a/.cursor/rules/comments.mdc b/.cursor/rules/comments.mdc
@@ -0,0 +1,11 @@
+---
+description: How to write comments
+globs: 
+---
+Write comments thoughtfully:
+- Do NOT write comments that explain obvious code or restate WHAT the code does.
+- Comments should primarily explain WHY code exists or WHY a particular approach was chosen.
+- Only add comments for complex, non-intuitive logic where the code itself doesn't clearly communicate intent.
+- Always provide clear documentation for functions (purpose, inputs, outputs).
+- Avoid unnecessary comments that add visual noise without adding value.
+- Write comments only when they provide genuine insight or when explicitly requested.
diff --git a/.github/actions/build-action/action.yml b/.github/actions/build-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/format-action/action.yml b/.github/actions/format-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/integration-test-action/action.yml b/.github/actions/integration-test-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/lint-action/action.yml b/.github/actions/lint-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/spell-check-action/action.yml b/.github/actions/spell-check-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/test-action/action.yml b/.github/actions/test-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/actions/unit-test-action/action.yml b/.github/actions/unit-test-action/action.yml
@@ -22,7 +22,7 @@ runs:
       run: |
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       name: Setup pnpm cache
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/workflows/build-preview-environment.yml b/.github/workflows/build-preview-environment.yml
@@ -6,6 +6,11 @@ concurrency:
 
 on:
   workflow_dispatch:
+    inputs:
+      unified-version:
+        type: string
+        description: 'Provide Unified image tag that you want to use in this preview env'
+        default: 'latest'
   pull_request:
     types: [ labeled, synchronize ]
 
@@ -46,7 +51,7 @@ jobs:
         run: |
           SANITIZED_BRANCH_NAME=$(echo -n "${{ steps.clean-ref.outputs.ref }}" | tr "/" "-")
           echo "Sanitized branch name: $SANITIZED_BRANCH_NAME"
-          TRIMMED_BRANCH_NAME=$(echo -n "$SANITIZED_BRANCH_NAME" | cut -c 1-7 | sed 's/[-/]$//')
+          TRIMMED_BRANCH_NAME=$(echo -n "$SANITIZED_BRANCH_NAME" | cut -c 1-18 | sed 's/[-/]$//')
           echo "sanitized_env_name=$SANITIZED_BRANCH_NAME" >> $GITHUB_OUTPUT;
           echo "trimmed_env_name=$TRIMMED_BRANCH_NAME" >> $GITHUB_OUTPUT;
         
@@ -88,7 +93,7 @@ jobs:
       image_name: backoffice
       ref: ${{ needs.deploy-dev-pr-environment.outputs.ref }}
       tag: ${{ needs.deploy-dev-pr-environment.outputs.env_name }}
-      file: 'apps/backoffice-v2/Dockerfile.preview'
+      file: 'apps/backoffice-v2/Dockerfile'
 
   build-kyb:
     needs: [deploy-dev-pr-environment]
@@ -99,7 +104,7 @@ jobs:
       image_name: kyb-app
       ref: ${{ needs.deploy-dev-pr-environment.outputs.ref }}
       tag: ${{ needs.deploy-dev-pr-environment.outputs.env_name }}
-      file: 'apps/kyb-app/Dockerfile.preview'
+      file: 'apps/kyb-app/Dockerfile'
 
   build-dashboard:
     needs: [deploy-dev-pr-environment]
@@ -110,7 +115,7 @@ jobs:
       image_name: workflows-dashboard
       ref: ${{ needs.deploy-dev-pr-environment.outputs.ref }}
       tag: ${{ needs.deploy-dev-pr-environment.outputs.env_name }}
-      file: 'apps/workflows-dashboard/Dockerfile.preview'
+      file: 'apps/workflows-dashboard/Dockerfile'
 
   build-unified-api:
     runs-on: ubuntu-latest
@@ -146,8 +151,8 @@ jobs:
 
       - name: Checkout repository
         run: |
-          docker pull ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:latest
-          docker tag ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:latest ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:${{ needs.deploy-dev-pr-environment.outputs.env_name }}
+          docker pull ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:${{ github.event_name == 'workflow_dispatch' && inputs.unified-version || 'latest' }}
+          docker tag ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:${{ github.event_name == 'workflow_dispatch' && inputs.unified-version || 'latest' }} ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:${{ needs.deploy-dev-pr-environment.outputs.env_name }}
           docker push ghcr.io/${{ github.repository_owner }}/${{ vars.UNIFIED_IMAGE_NAME }}:${{ needs.deploy-dev-pr-environment.outputs.env_name }} 
 
   deploy-preview:

diff --git a/.github/workflows/build-push-docker-images.yml b/.github/workflows/build-push-docker-images.yml
@@ -119,7 +119,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,10 +6,10 @@ on:
       - main
     paths:
       # Run this pipeline only if there are changes in specified path
-      - "apps/**"
-      - "services/**"
-      - "examples/**"
-      - "experiments/**"
+      - 'apps/**'
+      - 'services/**'
+      - 'examples/**'
+      - 'experiments/**'
   workflow_call:
   workflow_dispatch:
 
@@ -37,7 +37,7 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -66,13 +66,3 @@ jobs:
 
       - name: Test
         uses: ./.github/actions/test-action
-  test_windows:
-    runs-on: windows-latest
-    timeout-minutes: 60
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Test
-        uses: ./.github/actions/unit-test-action
diff --git a/.github/workflows/db-ops.yaml b/.github/workflows/db-ops.yaml
@@ -44,7 +44,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/deploy-wf-service.yml b/.github/workflows/deploy-wf-service.yml
@@ -80,7 +80,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}
@@ -157,7 +157,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/destroy-preview-environment.yml b/.github/workflows/destroy-preview-environment.yml
@@ -36,19 +36,13 @@ jobs:
           CLEAN_BRANCH_NAME=${BRANCH_NAME#refs/heads/}
           echo "ref=$CLEAN_BRANCH_NAME" >> $GITHUB_OUTPUT
 
-      - name: Checkout the Tool and actions
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ steps.clean-ref.outputs.ref }}
-          fetch-depth: 1
-
       - name: "Sanitize ENV name"
         id: sanitize_env
         shell: bash
         run: |
           SANITIZED_BRANCH_NAME=$(echo -n ${{ steps.clean-ref.outputs.ref }} | tr "/" "-")
           echo "Sanitized branch name: $SANITIZED_BRANCH_NAME"
-          TRIMMED_BRANCH_NAME=$(echo -n "$SANITIZED_BRANCH_NAME" | cut -c 1-7)
+          TRIMMED_BRANCH_NAME=$(echo -n "$SANITIZED_BRANCH_NAME" | cut -c 1-18 | sed 's/[-/]$//')
           echo "sanitized_env_name=$SANITIZED_BRANCH_NAME" >> $GITHUB_OUTPUT;
           echo "trimmed_env_name=$TRIMMED_BRANCH_NAME" >> $GITHUB_OUTPUT;
         

diff --git a/.github/workflows/hotfix-wf-service.yml b/.github/workflows/hotfix-wf-service.yml
@@ -77,7 +77,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}
@@ -193,7 +193,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/publish-workflows-service.yml b/.github/workflows/publish-workflows-service.yml
@@ -339,7 +339,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/push-workflows-service-image.yml b/.github/workflows/push-workflows-service-image.yml
@@ -76,7 +76,7 @@ jobs:
 
       - name: Cache Docker layers
         id: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-docker-${{ hashFiles('**/Dockerfile') }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -38,7 +38,7 @@ jobs:
         run: |
           echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         name: Setup pnpm cache
         with:
           path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}

diff --git a/.github/workflows/test-ballerine-deploy.yml b/.github/workflows/test-ballerine-deploy.yml
@@ -0,0 +1,60 @@
+name: Test Ballerine Deploy
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ dev ]
+
+jobs:
+  test-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+      with:
+        platforms: 'arm64,arm'
+
+    - name: Start containers
+      run: |
+        sudo apt-get update
+        sudo apt-get install docker-compose
+        cd deploy
+        docker-compose up -d
+      
+    - name: Wait for containers to be healthy
+      run: |
+        cd deploy
+        timeout=180  # 3 minutes timeout
+        elapsed=0
+        interval=10
+        
+        while [ $elapsed -lt $timeout ]; do
+          if docker-compose ps | grep -q "healthy"; then
+            unhealthy_count=$(docker-compose ps | grep -c "unhealthy" || true)
+            if [ $unhealthy_count -eq 0 ]; then
+              echo "All containers are healthy!"
+              exit 0
+            fi
+          fi
+          
+          echo "Waiting for containers to be healthy... ($elapsed seconds elapsed)"
+          sleep $interval
+          elapsed=$((elapsed + interval))
+        done
+        
+        echo "Timeout reached. Some containers are not healthy."
+        docker-compose ps
+        docker-compose logs
+        exit 1
+    
+    - name: Clean up
+      if: always()
+      run: |
+        cd deploy
+        docker-compose down -v
diff --git a/README.md b/README.md
@@ -74,6 +74,7 @@ We believe in enabling companies to manage user  identity  and risk according to
 **Parts of the system you might look for but are not in THIS demo:**
 - Our Rule Engine is still under construction and will soon be released.
 
+
 **Getting started**
 To set up a local environment, follow these steps:
 1. #### Install prerequisites:
@@ -127,7 +128,7 @@ Once the process is complete,  _2 tabs_   will open in your browser:
    - The Back Office case will update as you progress
 
 3. **Review & Process**
-   - Once complete, the case status changes to "manual review" 
+   - Once complete, the case status changes to "manual review"
    - Assign the case to yourself
    - Choose to: Approve, Reject, or Request Resubmission