juno-erp-client 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,463 @@
+/**
+ * Configuration options for the Juno API client.
+ */
+export interface JunoConfig {
+    /** The base URL of the Juno ERP system. Defaults to 'https://erp.mgmu.ac.in' */
+    baseUrl?: string;
+    /** Enable detailed debug logging to the console. */
+    debug?: boolean;
+    /** Optional path to a JSON file for persisting session cookies across executions. */
+    sessionPath?: string;
+    /** Whether to automatically save the session to the sessionPath after login. Defaults to true if sessionPath is provided. */
+    autoSave?: boolean;
+}
+/**
+ * Detailed student profile information.
+ */
+export interface StudentProfile {
+    studentId: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    /** Primary mobile number */
+    mobileNo: string;
+    /** Primary email address */
+    personalEmailId: string;
+    /** Alternative email address */
+    alternetEmailID: string;
+    /** Date of birth (format typically Mar 25, 2025) */
+    dob: string;
+    gender: string;
+    categoryId: string;
+    categoryName: string;
+    /** Date of admission */
+    admissionDate: string;
+    bloodGroup: string;
+    motherName: string;
+    fatherName: string;
+    /** University Permanent Registration Number */
+    uniPRNNo: string;
+    /** Institute roll number */
+    rollNo: string;
+    programType: string;
+    degreeType: string;
+    religionId: string;
+    nationalityId: string;
+    nation: string;
+    stateId: string;
+    state: string;
+    hostelite: string;
+    studMaritalStatus: string;
+    motherTongue: string;
+    otherKnownLanguages: string;
+    Gender: string;
+    Caste: string;
+    adharcardNo: string;
+    admissionTypeName: string;
+    /** Whether the profile is currently active */
+    profileStatus: boolean;
+    /** Whether the profile is locked for editing */
+    isProfileFreezed: string;
+    /** Whether a profile image exists */
+    studentProfileImage: boolean;
+    /** Whether a profile signature exists */
+    studentProfileSignature: boolean;
+}
+/**
+ * Basic personal contact and address information.
+ */
+export interface PersonalInfo {
+    uniqueNumber: string;
+    personalMailId: string;
+    alternateContactNo: string;
+    fullName: string;
+    studentId: number;
+    fatherName: string;
+    motherName: string;
+    /** Current residential address line 1 */
+    currAddressLine1: string;
+    currAddressLine2: string;
+    currCity: string;
+    currDistrict: string;
+    currState: string;
+    currCountry: string;
+    currPin: string;
+    /** Permanent address line 1 */
+    permAddressLine1: string;
+    permAddressLine2: string;
+    permCity: string;
+    permState: string;
+    permCountry: string;
+    permPin: string;
+    /** Current academic status (e.g., PURSUING) */
+    currStatus: string;
+    mobile: string;
+    dob: string;
+    userName: string;
+    emailId: string;
+    bloodGroup: string;
+    pcNumber: string;
+    prnNumber: string;
+    fatherMobNo: string;
+    motherMobNo: string;
+    caste: string;
+    category: string;
+    gender: string;
+    joiningDate: string;
+    admissionDate: string;
+    NADId: string;
+    abcAccountId: string;
+    aadharNo: string;
+    antiRaggingNo: string;
+}
+/**
+ * Academic enrollment information including course and semester details.
+ */
+export interface AcademicInfo {
+    studentId: number;
+    /** Detailed name of the enrolled course */
+    courseName: string;
+    /** Type of course (e.g., COURSE_TYPE_UG) */
+    courseType: string;
+    /** Course name including the department */
+    courseWithDepartmentName: string;
+    rollNo: string;
+    /** Academic year level (e.g., Second Year) */
+    divisionName: string;
+    /** The batch range (e.g., 2024 - 2028) */
+    academicBatch: string;
+    /** Standard name of the current semester (e.g., SEM IV) */
+    semesterName: string;
+    PRNnumber: string;
+    instituteCourseId: number;
+    /** Internal identifier for the semester context */
+    semester_ICS: string;
+    isEngineeringStream: boolean;
+    isMentorAllocated: boolean;
+    classCordinators: any[];
+}
+/**
+ * Information regarding the student's admission status and documentation.
+ */
+export interface AdmissionDetail {
+    entranceExamName: string;
+    admissionType: string;
+    admissionCategoryName: string;
+    courseType: string;
+    documentSubmissionDate: string;
+    applicationNo: string;
+    antiRaggingNo: string;
+    studentUniqueNumber: string;
+    hasDocumentSubmitted: boolean;
+    totalDocumentToBeSubmitted: number;
+    totalDocumentSubmitted: number;
+    remainingDocumentSubmitted: number;
+}
+/**
+ * Details of a specific course/subject and the student's attendance in it.
+ */
+export interface Course {
+    /** Subject name (e.g., Operating System) */
+    subject: string;
+    subjectId: number;
+    subjectCode: string;
+    termName: string;
+    termId: number;
+    facultName: string;
+    /** String representation of present lectures */
+    presentCount: string;
+    /** String representation of absent lectures */
+    absentCount: string;
+    credits: string;
+    session: string;
+    academicBatch: string;
+    /** Numeric count of present lectures */
+    stdAttPresentCount: number;
+    /** Numeric count of absent lectures */
+    stdAttAbsentCount: number;
+    /** Numeric count of leave sessions */
+    stdAttLeaveCount: number;
+    /** Raw delimited string of attendance history */
+    studentAttendanceData: string;
+    SubjectwiseStudentId: number;
+    subBatchId: number;
+    subjectCategory: string;
+    courseType: string;
+    medicalLeave: string;
+    specialLeave: string;
+    instituteLevelLeave: string;
+    totalLeave: string;
+    nextLectDate: string;
+    nextLectTime: string;
+}
+/**
+ * Wrapper for overall attendance statistics.
+ */
+export interface AttendanceDetails {
+    hasAttendanceDetails: boolean;
+    isSchool: boolean;
+    AttendaceDetailsJObject: {
+        /** Cumulative lectures in the current semester */
+        totalLectures: string;
+        /** Cumulative attended lectures */
+        totalAttendedLectures: string;
+        /** Attendance percentage as a string */
+        percent: string;
+    };
+}
+/**
+ * Data point for attendance graphing.
+ */
+export interface AttendanceGraph {
+    name: string;
+    drilldown: string;
+    color: string;
+    y: number;
+}
+/**
+ * Detailed examination result for a specific subject.
+ */
+export interface ResultDetail {
+    studentName: string;
+    seatNo: string;
+    motherName: string;
+    FatherName: string;
+    subjectCode: string;
+    subjectName: string;
+    InternalMarks: string;
+    ExternalMarks: string;
+    internalExternalTotal: string;
+    Grade: string;
+    Pointer: string;
+    creditPoint: string;
+    earnedCredit: string;
+    int: string;
+    ext: string;
+    sgpaCreditPointTotal: string;
+    sgpaEarnedPointsTotal: string;
+    sgpaObtainedMarks: string;
+    cgTotal: string;
+    sgpa: string;
+    percentage: string;
+    status: string;
+    outOff: string;
+    cgpaCGTotal: string;
+    cgpaCreditPointTotal: string;
+    cgpaEarnPointTotal: string;
+    cgpa: string;
+    cg: string;
+    programName: string;
+    resultBlockStatus: string;
+    resultBlockReason: string;
+    ordinance: string;
+    intPassing: string;
+    extPassing: string;
+    resultStatus: string;
+    UniversityId: number;
+    FailStatus: string;
+}
+/**
+ * Summary of exam performance and academic marks.
+ */
+export interface ExamDetails {
+    hasExamMarksDetails: boolean;
+    hasExamApprovalDetails: boolean;
+    ExamDetailsJObject: {
+        lastAttemptedSemester: string;
+        totalInternalMarks: number;
+        totalExternalMarks: number;
+        subjectTotalMarks: number;
+        totalMarksObtained: number;
+        totalAttemptedSubject: number;
+        percent: number;
+    };
+    /** Student contextual information for the exam scope */
+    type: {
+        type: string;
+        instCourseStrngthId: number;
+        instCourseId: number;
+        name: string;
+        studentId: number;
+    };
+}
+/**
+ * Current fee structure and invoicing status.
+ */
+export interface FeesDetails {
+    currentFeeStructureExist: boolean;
+    ApplicableFeeStructureAndInvoice: {
+        feeStructureId: number;
+        feeStructureName: string;
+        /** Total fees formatted as string with currency */
+        totalFees: string;
+        studentFeeInvoiceId: number;
+        /** Total amount payable by the student */
+        totalPayableAmount: string;
+        invoiceNo: string;
+        /** Total amount paid to date */
+        totalPaidAmount: string;
+        /** Remaining balance outstanding */
+        remainingPayableAmount: number;
+        remainingPayableToStudentAmount: string;
+        isSponsored: boolean;
+        currentInvoiceGenerated: boolean;
+    };
+}
+/**
+ * Breakdown of a specific fee structure.
+ */
+export interface FeeStructure {
+    feeItemId: number;
+    instituteCourseStrengthId: number;
+    freezeStatus: boolean;
+    concessionAmount: number;
+    concessionAmt: number;
+    govermentLablity: number;
+    revisionNo: number;
+    instituteCourseId: number;
+    StudentPayable: number;
+    StudentPaid: number;
+    sponsorshiprecevable: number;
+    sponsorshipreceived: number;
+    year: string;
+    Admissiontype: string;
+    category: string;
+    feestructurename: string;
+    studentFeeInvoiceId: string | number;
+    rollNo: string;
+    currencyCode?: string;
+    currencyId?: number;
+    currentFeeStructre?: boolean;
+}
+/**
+ * Summary of total financial receivables from a student.
+ */
+export interface StudentReceivable {
+    academicFees: number;
+    hostelFees: number;
+    miscFee: number;
+    studentPayable: string;
+    studentPaidTill: number;
+    totalAmount: number;
+    sponsorshingRecev: number;
+    offlinePayment: string;
+}
+/**
+ * A single entry in the student's timetable.
+ */
+export interface TimetableEntry {
+    instituteCourseBatchSemesterConductedTimeTableId?: string;
+    subjectWisebatchId?: string;
+    subjectId?: string;
+    /** Short abbreviated subject name */
+    subShortName?: string;
+    /** Subject name */
+    sub?: string;
+    /** Start time in HH:mm:ss */
+    startTimeHM: string;
+    /** End time in HH:mm:ss */
+    endTimeHM: string;
+    recess?: string;
+    infraType?: string;
+    /** Faculty description or initials */
+    lecDesc?: string;
+    infraName?: string;
+    /** Start time in 12-hour format (e.g., 10:00 AM) */
+    startTimeHHMMA: string;
+    /** End time in 12-hour format (e.g., 11:00 AM) */
+    endTimeHHMMA: string;
+    documents?: any[];
+    documentUpl?: any[];
+}
+/**
+ * Represents the schedule for a specific day.
+ */
+export interface TodaySchedule {
+    timetable: TimetableEntry[];
+}
+/**
+ * More detailed timetable information when searching between specific dates.
+ */
+export interface DetailedTimetableEntry {
+    lectureDate: string;
+    lectureDay: string;
+    lectureStartTime: string;
+    lectureEndTime: string;
+    sessoionNo: string;
+    subjectName: string;
+    chapterName: string;
+    /** Classroom name or number */
+    classRoom: string;
+    facultyName: string;
+    lectureDateWithoutFormat: string;
+    guestLecDescription: string;
+    teachingAids: string;
+    documents: any[];
+    documentUpl: any[];
+    employeeSubjectAllocationId: string;
+    subjectWisebatchId: string;
+    isGooleMeet: boolean;
+    isMicrosoftTeams: boolean;
+    isZoomMeet: boolean;
+    isWebConferenceAvailable: boolean;
+    eventWebId: string;
+    link: string;
+    sharedLink: string;
+}
+/**
+ * A single result from a global platform search.
+ */
+export interface SearchResult {
+    /** Unique ID prefixed with result type (e.g., Individual-12345) */
+    id: string;
+    /** Full name and batch info */
+    name: string;
+    /** Detailed description containing course, semester, and roll number */
+    Desc: string;
+    /** Relative URL to the profile image */
+    imageUrl: string;
+    /** Primary contact number if available */
+    contactNo: string;
+    GroupName: string;
+    employeeId?: string;
+    /** Type of result (e.g., Student, Faculty) */
+    resultType?: string;
+}
+/**
+ * Caste information for student categorization.
+ */
+export interface Caste {
+    casteId: string;
+    casteName: string;
+}
+/**
+ * Country information for nationality selection.
+ */
+export interface Country {
+    countryId: number;
+    country: string;
+}
+/**
+ * Individual entry for a student's division or course transfer request.
+ */
+export interface TransferDetail {
+    transferType: string;
+    fromDivision: string;
+    toDivision: string;
+    semester: string;
+    division: string;
+    studentTransferDetailId: number;
+    approved1: boolean;
+    requestedDate: string;
+}
+/**
+ * Historical record of a student's transfer.
+ */
+export interface TransferDetailsOfStudent {
+    approvedDate: string;
+    approvedBy: string;
+    from: string;
+    to: string;
+    transferType: string;
+    transferDate: string;
+}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "juno-erp-client",
+  "version": "1.0.0",
+  "description": "A high-level TypeScript API wrapper for the JUNO Campus ERP platform, supporting automated login and session persistence.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "dev": "ts-node src/index.ts",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "juno",
+    "juno-campus",
+    "erp",
+    "mgm",
+    "api-wrapper",
+    "student-portal",
+    "automation"
+  ],
+  "author": "Denizuh <danishs2007@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/danish-mar/juno.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/danish-mar/juno.js/issues"
+  },
+  "homepage": "https://github.com/danish-mar/juno.js#readme",
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "@types/tough-cookie": "^4.0.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "axios": "^1.13.2",
+    "axios-cookiejar-support": "^6.0.5",
+    "tough-cookie": "^6.0.0"
+  }
+}