ui-soxo-bootstrap-core 2.6.40-dev.0 → 2.6.40-dev.1

package/.github/workflows/npm-publish.yml

@@ -1,33 +1,40 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm i
-#       - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm i
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+
+      - name: Determine npm dist-tag
+        id: dist_tag
+        shell: bash
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "package.json version: $VERSION"
+          echo "release tag:          ${GITHUB_REF_NAME}"
+          if [[ "v${VERSION}" != "${GITHUB_REF_NAME}" ]]; then
+            echo "::error::Release tag '${GITHUB_REF_NAME}' does not match package.json version 'v${VERSION}'."
+            echo "::error::Bump the version with 'npm version' and re-create the release."
+            exit 1
+          fi
+          if [[ "$VERSION" == *-dev* ]]; then
+            echo "tag=dev" >> "$GITHUB_OUTPUT"
+            echo "Will publish with dist-tag: dev"
+          else
+            echo "tag=latest" >> "$GITHUB_OUTPUT"
+            echo "Will publish with dist-tag: latest"
+          fi
+
+      - run: npm publish --access public --tag ${{ steps.dist_tag.outputs.tag }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/DEVELOPER_GUIDE.md

@@ -17,6 +17,7 @@ Incorrect versioning or incorrect tags will break the publish pipeline — follo
 - Publishing via GitHub Release UI
 - How GitHub Action Detects Release Type
 - Summary Table
+- CI/CD Authentication (Trusted Publishing)
 - Common Mistakes & Fixes
 
 ---
@@ -255,17 +256,14 @@ npm publish --tag dev
 
 # ⚙️ How GitHub Action Detects Release Type
 
-If version contains `dev`:
+The workflow reads the `version` field from `package.json` at publish time:
 
-```
-npm publish --tag dev
-```
+| Condition                    | Command                                                 | Result                             |
+| ---------------------------- | ------------------------------------------------------- | ---------------------------------- |
+| Version contains `-dev`      | `npm publish --provenance --access public --tag dev`    | Publishes to the `dev` dist-tag    |
+| Version has no `-dev` suffix | `npm publish --provenance --access public --tag latest` | Publishes to the `latest` dist-tag |
 
-Otherwise:
-
-```
-npm publish
-```
+The workflow also enforces that the GitHub release tag matches `v<version>` from `package.json` and fails the run immediately if they diverge — this prevents the most common publish failure described below.
 
 ---
 
@@ -283,6 +281,37 @@ npm publish
 
 ---
 
+# 🔐 CI/CD Authentication (Trusted Publishing)
+
+As of npm's 2025 policy changes, classic automation tokens (`NPM_TOKEN`) are deprecated. This repo now authenticates to npm via **OIDC Trusted Publishing** — GitHub Actions exchanges a short-lived OIDC token for a publish token at run time, so **no secret is stored in the repository**.
+
+## What this means for developers
+
+Nothing. You still follow the same flow: `npm version` → push tag → create GitHub Release. The auth happens transparently in CI.
+
+## What this means for maintainers
+
+The first-time setup on npmjs.com must be done once per package:
+
+1. Log in to [npmjs.com](https://www.npmjs.com) → open the package (`ui-soxo-bootstrap-core`) → **Settings**.
+2. Under **Trusted Publisher**, click **Add trusted publisher** and fill in:
+   - Publisher: **GitHub Actions**
+   - Organization or user: `soxo-tech`
+   - Repository: `bootstrap-core`
+   - Workflow filename: `npm-publish.yml`
+   - Environment name: *(leave blank)*
+3. Save. Any old `NPM_TOKEN` repository secret can be removed.
+
+## Runtime requirements
+
+The workflow runs on Node 20 and upgrades npm to the latest CLI (`npm install -g npm@latest`) because OIDC trusted publishing requires **npm ≥ 11.5.1**. The `--provenance` flag attaches a verifiable build attestation to every published version, visible on the npmjs.com package page.
+
+## If publish fails with `403 Forbidden` or `ENEEDAUTH`
+
+The trusted publisher config on npmjs.com no longer matches the workflow. Check that org, repo, and workflow filename match exactly — including case.
+
+---
+
 # ⚠️ Common Mistakes & Fixes
 
 | Mistake                   | Issue              | Fix                          |

package/core/components/index.js

@@ -1,7 +1,3 @@
-
-
-
-
 import LandingAPI from './landing-api/landing-api';
 
 import ExtraInfoDetail from './extra-info/extra-info-details';
@@ -11,11 +7,6 @@ import RootApplicationAPI from './root-application-api/root-application-api';
 import { HomePageAPI } from '../modules';
 
 import { ExternalWindow } from './external-window/external-window';
+import LicenseAlert from './license-management/license-alert';
 
-export {
-    LandingAPI,
-    RootApplicationAPI,
-    ExtraInfoDetail,
-    HomePageAPI,
-    ExternalWindow
-}
+export { LandingAPI, RootApplicationAPI, ExtraInfoDetail, HomePageAPI, ExternalWindow, LicenseAlert };

package/core/components/landing-api/landing-api.js

@@ -2,9 +2,20 @@ import { useContext, useEffect, useRef, useState } from 'react';
 
 import { Route, Switch } from 'react-router-dom';
 
-import { Skeleton } from 'antd';
-
-import { Card, ChangePassword, GlobalContext, GlobalHeader, ModuleRoutes, Profile, SettingsUtil, SpotlightSearch, useTranslation } from '../../lib';
+import { Skeleton, message, Modal } from 'antd';
+
+import {
+  GlobalHeader,
+  ChangePassword,
+  useTranslation,
+  GlobalContext,
+  ModuleRoutes,
+  SpotlightSearch,
+  SettingsUtil,
+  Profile,
+  Card,
+  safeJSON,
+} from '../../lib';
 
 import './landing-api.scss';
 
@@ -46,7 +57,6 @@ function getRandomMessage(previousMessage = '') {
  */
 export default function LandingApi({ history, CustomComponents, CustomModels, appSettings, transitionPending = false, onHomeReady, ...props }) {
   const [loader, setLoader] = useState(false);
-
   // const [modules, setModules] = useState([]);
 
   const [connected] = useState();
@@ -59,11 +69,31 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
 
   const [meta, setMeta] = useState({});
   const [loadingMessage, setLoadingMessage] = useState('');
+  const [licenseData, setLicenseData] = useState(null);
+
+  const [licAlert, setLicAlert] = useState(false);
+  // License data state
 
   // const [reports, setReports] = useState([]);
 
   var config = {};
 
+  //fetch license summary
+  // const fetchSummary = async () => {
+  //   try {
+  //     const res = await MenusAPI.getSummary();
+  //     if (res?.data) {
+  //       setLicenseData(res?.data);
+  //       setLicAlert(true);
+  //     } else {
+  //       setLicenseData(null);
+  //       setLicAlert(false);
+  //     }
+  //   } catch (err) {
+  //     console.error(err);
+  //   }
+  // };
+
   // Variable decides the control of homepage
   // #TODO This is a temporary fix - Homemage
 
@@ -73,6 +103,70 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
     disableHomepage = JSON.parse(process.env.REACT_APP_DISABLEHOMEPAGE);
   }
 
+  /**
+   * Normalizes the user's branch access list from `organization_details`.
+   *
+   * The API can return `organization_details` as a JSON string, so we always
+   * parse it through `safeJSON` before reading the branch collection.
+   *
+   * @returns {Array} List of branches the current user can access.
+   */
+  const getAccessibleBranches = () => {
+    const orgDetails = safeJSON(user?.organization_details);
+    return Array.isArray(orgDetails?.branch) ? orgDetails.branch : [];
+  };
+
+  /**
+   * Resolves the currently selected branch record using the persisted db pointer.
+   *
+   * @param {Array} branches
+   * @returns {Object|null}
+   */
+  const getCurrentBranchRecord = (branches) => {
+    const currentDbPtr = localStorage.getItem('db_ptr');
+    return branches.find((branch) => String(branch.dbPtr) === String(currentDbPtr)) || null;
+  };
+
+  /**
+   * Resolves the target branch from the URL `index` query parameter.
+   *
+   * @param {Array} branches
+   * @param {string|null} branchId
+   * @returns {Object|null}
+   */
+  const getBranchRecordById = (branches, branchId) => {
+    return branches.find((branch) => String(branch.branch_id) === String(branchId)) || null;
+  };
+
+  /**
+   * Persists branch-specific auth data after a successful switch.
+   *
+   * @param {Object} tokenBundle
+   * @param {string} dbPtr
+   */
+  const persistBranchSession = (tokenBundle, dbPtr) => {
+    const accessToken = tokenBundle?.access_token;
+    const refreshToken = tokenBundle?.refresh_token;
+
+    if (accessToken) localStorage.setItem('access_token', accessToken);
+    if (refreshToken) localStorage.setItem('refresh_token', refreshToken);
+    if (dbPtr) localStorage.setItem('db_ptr', dbPtr);
+  };
+
+  const fetchSummary = async () => {
+    try {
+      const res = await MenusAPI.getSummary();
+      if (res?.data) {
+        setLicenseData(res?.data);
+        setLicAlert(true);
+      } else {
+        setLicenseData(null);
+        setLicAlert(false);
+      }
+    } catch (err) {
+      console.error(err);
+    }
+  };
   // useEffect(() => {
 
   //     // Initialize the menus for the logged in user
@@ -88,6 +182,67 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
   //     }
   // }, [loader]);
 
+  /**
+   * Synchronizes the active branch with the `index` query parameter.
+   *
+   * Flow:
+   * 1. Read the target branch id from the URL.
+   * 2. Compare it against the branch represented by the current `db_ptr`.
+   * 3. Switch branch only when the user has access and the branch actually differs.
+   * 4. Refresh auth/profile state and reload menus for the new branch context.
+   */
+  useEffect(() => {
+    const handleUrlBranchSwitch = async () => {
+      const searchParams = new URLSearchParams(history.location.search);
+      const urlDbPtr = searchParams.get('index');
+      if (!urlDbPtr) return;
+
+      const accessibleBranches = getAccessibleBranches();
+      const currentBranch = getCurrentBranchRecord(accessibleBranches);
+      const targetBranch = getBranchRecordById(accessibleBranches, urlDbPtr);
+
+      if (!targetBranch || String(currentBranch?.branch_id) === String(urlDbPtr)) return;
+
+      setLoader(true);
+
+      try {
+        const switchResult = await MenusAPI.switchBranch(
+          {
+            firm_id: targetBranch.firm_ptr,
+            branch_id: targetBranch.branch_id,
+          },
+          targetBranch.dbPtr
+        );
+
+        if (!switchResult?.success) {
+          Modal.error({
+            title: 'Branch Switch Failed',
+            content: switchResult?.message || 'An error occurred while attempting to switch branches.',
+          });
+          return;
+        }
+
+        persistBranchSession(switchResult?.token, targetBranch.dbPtr);
+        window.dispatchEvent(new CustomEvent('branchChanged', { detail: targetBranch.dbPtr }));
+
+        const accessToken = switchResult?.token?.access_token;
+        const profileResult = await MenusAPI.getProfile(accessToken);
+        const updatedUser = { ...profileResult, loggedCheckDone: true };
+
+        dispatch({ type: 'user', payload: updatedUser });
+        localStorage.setItem('userInfo', JSON.stringify(updatedUser));
+
+        await initializeUserMenus();
+      } catch (error) {
+        console.error('Auto branch switch failed:', error);
+      } finally {
+        setLoader(false);
+      }
+    };
+
+    if (user?.id && history?.location) handleUrlBranchSwitch();
+  }, [history?.location?.search, user?.id]);
+
   useEffect(() => {
     // Initialize the menus for the logged in user
     initializeUserMenus();
@@ -138,9 +293,12 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
    */
   async function initializeUserMenus() {
     // need to find what implement, with a login who has the respective value ("wug_custreportids")
+
     const report = await loadScripts(user);
 
     await loadMenus(report);
+    // fetch license summary
+    fetchSummary();
   }
 
   // const keyMap = {
@@ -162,7 +320,7 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
     setLoader(true);
 
     // setReports(report)
-
+    fetchSummary();
     const result = await MenusAPI.getMenus(user);
 
     // console.log(result);
@@ -292,6 +450,8 @@ export default function LandingApi({ history, CustomComponents, CustomModels, ap
         modules={allModules}
         user={user}
         history={history}
+        licenseData={licenseData}
+        licAlert={licAlert}
       >
         {loader ? (
           <Card className="skeleton-card">

package/core/components/license-management/license-alert.js

@@ -0,0 +1,97 @@
+import { Alert } from 'antd';
+import React, { useState, useEffect } from 'react';
+
+export default function LicenseAlert({ data }) {
+  // setting visibility of alert based on license status
+  const [visible, setVisible] = useState(true);
+  // resolve alert configuration based on license data
+  const alertConfig = resolveLicenseAlert(data);
+  // auto-hide alert after 10 seconds or when data changes
+  useEffect(() => {
+    if (alertConfig) {
+      setVisible(true);
+
+      const timer = setTimeout(() => {
+        setVisible(false);
+      }, 10000); // 10 seconds
+
+      return () => {
+        clearTimeout(timer);
+      };
+    }
+  }, [data]);
+  // if no alert configuration or not visible, render nothing
+  if (!alertConfig || !visible) return null;
+
+  return (
+    // render the alert with appropriate type, message, and description
+    <Alert
+      type={alertConfig.type}
+      message={alertConfig.message}
+      description={alertConfig.description}
+      showIcon
+      closable
+      onClose={() => setVisible(false)}
+    />
+  );
+}
+// function to determine alert configuration based on license data
+function resolveLicenseAlert(data) {
+  if (!data) return null;
+  // destructure relevant fields from license data
+  const { status, expiresInDays, isExpiringSoon, gracePeriod } = data;
+
+  // ===== NOT INSTALLED =====
+  if (status === 'NOT_INSTALLED') {
+    return {
+      type: 'error',
+      message: 'License not found',
+      description: 'Please install a valid license to continue.',
+    };
+  }
+
+  // ===== GRACE PERIOD =====
+  if (gracePeriod) {
+    return {
+      type: 'warning',
+      message: 'Grace period mode',
+      description: 'License expired. Running in read-only mode.',
+    };
+  }
+
+  // ===== EXPIRING SOON =====
+  if (status === 'ACTIVE' && isExpiringSoon) {
+    let descriptionText = '';
+    // customize message based on how soon the license is expiring
+    if (expiresInDays === 0) {
+      descriptionText = 'Your license will expire today. Please renew immediately.';
+    } else {
+      descriptionText = `Your license will expire in ${expiresInDays} days. Please plan for renewal.`;
+    }
+
+    return {
+      type: 'warning',
+      message: 'License expiring soon',
+      description: descriptionText,
+    };
+  }
+
+  // ===== NOT INSTALLED =====
+  if (status === 'NOT_INSTALLED') {
+    return {
+      type: 'error',
+      message: 'License not found',
+      description: 'Please install a valid license to continue.',
+    };
+  }
+  // =====EXPIRED=====
+  if (status === 'EXPIRED') {
+    return {
+      type: 'error',
+      message: 'License expired',
+      description: 'Your license has expired. Please renew or install a new license.',
+    };
+  }
+
+  return null;
+}