ubk.erp.webpack 1.1.7 → 1.1.8

package/README.md

@@ -258,6 +258,106 @@ const GeneralSettingPage = ({ token }) => {
 | `LibraryCategory` | Manage book categories. |
 | `LibraryReport` | Monthly report. |
 
+# 📚 Library `IssueReturn` — Return Callback
+
+`IssueReturn` accepts an optional `onReturn` callback that is invoked after a successful book return.
+
+## Props
+
+| Prop | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| `token` | `string` | Yes | Authentication token for API requests. |
+| `onReturn` | `(returnArray: ReturnItem[]) => void` | No | Callback fired after a successful return. |
+
+## Return Item Shape
+
+Each object in the returned array represents one returned book:
+
+```ts
+{
+  studentId: number;
+  branchId: number;
+  academicYearId: number;
+  fromDate: string;      // "YYYY-MM-DD"
+  toDate: string;        // "YYYY-MM-DD"
+  customField1: number;  // book_issues_id
+  description: string;   // "book_title-author"
+  amount: number;        // individual book totalfine
+}
+```
+
+## Usage
+
+```jsx
+import { IssueReturn } from "ubk.erp.webpack";
+
+const LibraryPage = ({ token }) => {
+  const handleIssueReturn = (returnArray) => {
+    // Example returnArray:
+ const example = [
+    {
+      studentId: 8,
+      fromDate: "2026-09-13",
+      toDate: "2026-08-13",
+      customField1: 21,
+      description: "Mathematics-John Smith",
+      amount: 100,
+    },
+    {
+      studentId: 8,
+      fromDate: "2026-09-13",
+      toDate: "2026-08-13",
+      customField1: 22,
+      description: "Science-Jane Doe",
+      amount: 50,
+    },
+  ];
+  };
+
+  return (
+    <IssueReturn
+      token={token}
+      onReturn={handleIssueReturn}
+    />
+  );
+};
+```
+
+## Behavior
+
+- `onReturn` is only called when the return API responds with `Status: "Success"`.
+- It is **not** called if the API returns `Failed`.
+- The callback receives **one object per returned book**, mapped from the current return selection.
+- `amount` always reflects the individual book’s `totalfine`, regardless of the collection type (`NO_FINE`, `FINE_PAID`, or `FINE_PAY_LATER`).
+- Existing return, fine, and payment workflows remain unchanged.
+
+## Example Output
+
+```js
+[
+  {
+    studentId: 8,
+    branchId: 2,
+    academicYearId: 2026,
+    fromDate: "2026-09-13",
+    toDate: "2026-08-13",
+    customField1: 21,
+    description: "Mathematics-John Smith",
+    amount: 100
+  },
+  {
+    studentId: 8,
+    branchId: 2,
+    academicYearId: 2026,
+    fromDate: "2026-09-13",
+    toDate: "2026-08-13",
+    customField1: 22,
+    description: "Science-Jane Doe",
+    amount: 50
+  }
+]
+```
+
 ### Store
 
 | Component | Description |

package/dist/Layout/Library/IssueReturn copy.d.ts

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+export default IssueReturn;
+declare function IssueReturn({ token: tokenProp }: {
+    token: any;
+}): React.JSX.Element;

package/dist/Layout/Library/IssueReturn.d.ts

@@ -1,5 +1,6 @@
 import { default as React } from 'react';
 export default IssueReturn;
-declare function IssueReturn({ token: tokenProp }: {
+declare function IssueReturn({ token: tokenProp, onReturn }: {
     token: any;
+    onReturn: any;
 }): React.JSX.Element;