ubk.erp.webpack 1.1.0 → 1.1.2

package/README.md

@@ -18,6 +18,20 @@ Install the package:
 npm install ubk.erp.webpack
 ```
 
+## 🔄 Update
+
+Update to the latest published version:
+
+```bash
+npm install ubk.erp.webpack@latest
+```
+
+Or update within your existing dependency range:
+
+```bash
+npm update ubk.erp.webpack
+```
+
 ### Peer Dependencies
 Ensure your project has the following installed:
 - `react` >= 18
@@ -88,6 +102,58 @@ const App = () => {
 export default App;
 ```
 
+### Token
+
+Most components accept a `token` prop and use it for API requests:
+
+```jsx
+import { StaffDirectory } from "ubk.erp.webpack";
+
+export default function Page({ token }) {
+  return <StaffDirectory token={token} />;
+}
+```
+
+### Routing / Navigation
+
+This library exports React components. If you want URL pages like:
+
+`/HumanResourceDashboard/PayrollReceiptDetails?id=1`
+
+```jsx
+export default function Page({ token }) {
+  return  <Payroll
+            token={token}
+            onOpenReceiptDetails={(staffId) => navigate(`/HumanResourceDashboard/PayrollReceiptDetails?id=${staffId}`)}
+           />;
+}
+```
+ 
+
+your app must define a route for that path (React Router example):
+
+```jsx
+import { PayrollReceiptDetails } from "ubk.erp.webpack";
+import { Route, Routes } from "react-router-dom";
+
+export default function AppRoutes({ token }) {
+  return (
+    <Routes>
+      <Route
+        path="/HumanResourceDashboard/PayrollReceiptDetails"
+        element={<PayrollReceiptDetails token={token} />}
+      />
+      <Route
+        path="/AcademicsDashboard/TimeTable"
+        element={<TimeTable token={token} />}
+      />
+    </Routes>
+  );
+}
+```
+
+
+
 ### Using the Transport Module
 
 ```jsx
@@ -100,11 +166,42 @@ const TransportPage = () => {
 
 ## 🧩 Available Components
 
+### Core
+
 | Component | Description |
 | :--- | :--- |
 | `ErpDashboard` | Main dashboard overview. |
 | `MenuSubmenu` | Dynamic menu and navigation component. |
-| `AdmissionEnquiry` | Front office admission enquiry management. |
+
+### Front Office
+
+| Component | Description |
+| :--- | :--- |
+| `AdmissionEnquiry` | Admission enquiry management. |
+
+### Academics
+
+| Component | Description |
+| :--- | :--- |
+| `Class` | Class master. |
+| `Sections` | Section master. |
+| `Subjects` | Subject master. |
+| `Holidays` | Holiday master. |
+| `AssignSubjects` | Assign subjects to class. |
+| `AssignByClass` | Assign class/subjects to teacher. |
+| `CreateTimeGroup` | Create time group. |
+| `AssignTimeGroup` | Assign time group. |
+| `PromoteStudents` | Promote students (selected students, Continue/Leave). |
+| `CoScholasticArea` | Co-scholastic skills + category management. |
+| `Notes` | Notes list + upload. |
+| `Syllabus` | Syllabus list + upload. |
+| `TransferCertificate` | Transfer certificate list + create. |
+| `TimeTable` | Create / Routine / Teacher-wise timetable. |
+
+### Transport
+
+| Component | Description |
+| :--- | :--- |
 | `TransportRoutes` | Manage transport routes and pricing. |
 | `TransportVehicles` | Vehicle fleet management. |
 | `AssignVehicles` | Assign vehicles to specific routes. |
@@ -112,12 +209,49 @@ const TransportPage = () => {
 | `RouteTimeTable` | Schedule management for transport routes. |
 | `AssignStudentToTransport` | Assign students to transport routes. |
 | `Stoppage` | Manage route stops and timings. |
-| `AddBook` | Library: add books. |
-| `BookList` | Library: book list + barcode printing. |
-| `IssueReturn` | Library: issue/return books. |
-| `LibraryAssignStudent` | Library: assign/remove student membership. |
-| `LibraryCategory` | Library: manage book categories. |
-| `LibraryReport` | Library: monthly report. |
+
+### Library
+
+| Component | Description |
+| :--- | :--- |
+| `AddBook` | Add books. |
+| `BookList` | Book list + barcode printing. |
+| `IssueReturn` | Issue/return books. |
+| `LibraryAssignStudent` | Assign/remove student membership. |
+| `LibraryCategory` | Manage book categories. |
+| `LibraryReport` | Monthly report. |
+
+### Store
+
+| Component | Description |
+| :--- | :--- |
+| `Vendor` | Manage vendors. |
+| `Products` | Manage products. |
+| `Category` | Manage categories. |
+| `SubCategory` | Manage sub-categories. |
+| `BuySellProduct` | Buy/sell products workflow. |
+| `Unit` | Manage units. |
+| `SellReports` | Sell reports. |
+| `ManageStock` | Stock management. |
+| `StockReport` | Stock report. |
+
+### Human Resource
+
+| Component | Description |
+| :--- | :--- |
+| `AddStaff` | Add staff wizard. |
+| `StaffDirectory` | Staff list + search. |
+| `StaffAttendance` | Mark staff attendance. |
+| `StaffAttendanceReport` | Monthly attendance report. |
+| `Payroll` | Payroll list by role/month/year. |
+| `AprroveLeaveRequest` | Approve/decline leave requests. |
+| `ApplyLeave` | Apply for leave + requests table. |
+| `LeaveType` | Leave type master. |
+| `Department` | Department master. |
+| `Designation` | Designation master. |
+| `Shift` | Shift master. |
+| `StaffDailyAttendance` | Daily attendance report + print. |
+| `PayrollReceiptDetails` | Payroll receipt details (page/component). |
 
 
 ## 🛠️ Development