@asaleh37/ui-base 25.6.19-6 → 25.6.21

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

@@ -0,0 +1,49 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - prod
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install dependencies
+        run: npm install --force
+
+      - name: Run build (optional)
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  notify:
+    needs: publish
+    runs-on: ubuntu-latest
+    if: always() # ensures this step runs regardless of success or failure
+    steps:
+      - name: Send email notification
+        uses: dawidd6/action-send-mail@v3
+        with:
+          server_address: smtp.gmail.com
+          server_port: 587
+          username: ${{ secrets.SMTP_USERNAME }}
+          password: ${{ secrets.SMTP_PASSWORD }}
+          subject: ui-base package publish  job is finished
+          to: ahmed.saleh.mohamed.92@gmail.com
+          from: ${{ secrets.SMTP_USERNAME }}
+          body: |
+            The GitHub Actions workflow has finished.
+            Status: ${{ needs.publish.result }}

package/README.md

@@ -1,52 +1,52 @@
-**UI Base** is a React JS template designed for quickly scaffolding robust, production-ready Enterprise Applications Interface. It incorporates enterprise-grade architectural patterns and integrates a suite of essential features to accelerate development, including:
-
-- A modular, layered architecture with a clean separation of concerns and industry-standard project structure.
-
-- [ ] Create new react project using vite.
-
-```javascript
-npm create vite@latest YOUR_APP_NAME    //choose typescript as template
-cd YOUR_APP_NAME
-npm install
-```
-
-- [ ] Install the UI Base Dependency.
-
-```javascript
-npm install @asaleh37/ui-base --force
-```
-
-- [ ] replace the content of the file src/main.tsx
-
-```javascript
-import { BaseApp } from "@asaleh37/ui-base";
-import { createRoot } from "react-dom/client";
-
-createRoot(document.getElementById("root")!).render(
-  <BaseApp
-    apiBaseUrl="YOUR_API_URL"
-    appLogo={"YOUR_APP_LOGO_PATH"}
-    appName="YOUR_APP_NAME"
-    appVersion="YOUR_APP_VERSION"
-    businessCommonStoresMetaData={{}}
-    businessNavigationItems={[]}
-    businessReduxReducers={{}}
-    businessRoutes={[]}
-    documentTitle="YOUR_HTML_DOCUMENT_TITLE"
-    enableAdministrationModule={true}  // to enable administration module or not
-		/* // To Change APP Coloring Theme modify the following colors
-    appTheme={{
-      dark: { primaryColor: "#b3a10c", secondaryColor: "#2b3c46" },
-      light: { primaryColor: "#2b3c46", secondaryColor: "#b3a10c" },
-    }}
-		*/
-   muiPremiumKey="YOUR_MUI_PREMIUM_KEY"
-  />
-);
-```
-
-- [ ] then go to the root of your project and then run the following command	
-
-```javascript
-npm run dev
+**UI Base** is a React JS template designed for quickly scaffolding robust, production-ready Enterprise Applications Interface. It incorporates enterprise-grade architectural patterns and integrates a suite of essential features to accelerate development, including:
+
+- A modular, layered architecture with a clean separation of concerns and industry-standard project structure.
+
+- [ ] Create new react project using vite.
+
+```javascript
+npm create vite@latest YOUR_APP_NAME    //choose typescript as template
+cd YOUR_APP_NAME
+npm install
+```
+
+- [ ] Install the UI Base Dependency.
+
+```javascript
+npm install @asaleh37/ui-base --force
+```
+
+- [ ] replace the content of the file src/main.tsx
+
+```javascript
+import { BaseApp } from "@asaleh37/ui-base";
+import { createRoot } from "react-dom/client";
+
+createRoot(document.getElementById("root")!).render(
+  <BaseApp
+    apiBaseUrl="YOUR_API_URL"
+    appLogo={"YOUR_APP_LOGO_PATH"}
+    appName="YOUR_APP_NAME"
+    appVersion="YOUR_APP_VERSION"
+    businessCommonStoresMetaData={{}}
+    businessNavigationItems={[]}
+    businessReduxReducers={{}}
+    businessRoutes={[]}
+    documentTitle="YOUR_HTML_DOCUMENT_TITLE"
+    enableAdministrationModule={true}  // to enable administration module or not
+		/* // To Change APP Coloring Theme modify the following colors
+    appTheme={{
+      dark: { primaryColor: "#b3a10c", secondaryColor: "#2b3c46" },
+      light: { primaryColor: "#2b3c46", secondaryColor: "#b3a10c" },
+    }}
+		*/
+   muiPremiumKey="YOUR_MUI_PREMIUM_KEY"
+  />
+);
+```
+
+- [ ] then go to the root of your project and then run the following command	
+
+```javascript
+npm run dev
 ```

package/dist/index.d.ts

@@ -17,6 +17,7 @@ import { ResponseType } from 'axios';
 interface SystemRoute {
     path: string;
     component: React.FC;
+    applicationModule?: string;
     authority?: string;
 }
 
@@ -26,6 +27,7 @@ type ExtendedTreeItemProps = {
     label: string;
     action?: "NAVIGATION";
     authority?: string;
+    applicationModule?: string;
     actionPayload?: {
         path?: string;
         parameters?: object;
@@ -73,6 +75,7 @@ type AppInfo = {
     };
     muiPremiumKey: string;
     enableAdministrationModule: boolean;
+    enableUINotifications: Boolean;
     appTheme?: {
         light: {
             primaryColor: string;
@@ -451,6 +454,7 @@ type AttachmentImageViewerProps = {
     refKey?: string;
     category?: string;
     showAsAvatar?: boolean;
+    onErrorImage?: string;
     style?: SxProps;
 };
 declare const AttachmentImageViewer: React.FC<AttachmentImageViewerProps>;
@@ -597,6 +601,7 @@ declare const useIsMobile: (breakpoint?: number) => boolean;
 declare const useSession: () => {
     UserSession: any;
     isUserAuthorized: (authorityCode: string) => boolean;
+    isCurrentOrganizationAuthorizedToModule: (moduleCode: string) => Boolean;
     UserInfo: any;
 };