@appcorp/fusion-storybook 0.2.13 → 0.2.15

package/types/academics.d.ts

@@ -0,0 +1,262 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Academics
+ *
+ * This file contains TypeScript interfaces for class, section, subject, course,
+ * teacher, enrollment, attendance, grade, schedule, student profile, family,
+ * and family member domain models.
+ */
+import { GENDER, FAMILY_MEMBER_ROLE, STUDENT_STATUS, ATTENDANCE_STATUS, GRADE_TYPE, DAY_OF_WEEK } from "./enums";
+import type { SchoolBE, CampusBE, UserBE } from "./user-management";
+import type { FeeStructureBE, StudentFeeBE } from "./finance";
+/**
+ * Family represents a household sharing a single user account
+ * Contains parents and students using the same login credentials
+ */
+export interface FamilyBE {
+    address: string | null;
+    city: string | null;
+    country: string | null;
+    createdAt: string;
+    enabled: boolean;
+    familyCode: string;
+    id: string;
+    postalCode: string | null;
+    schoolId: string;
+    state: string | null;
+    updatedAt: string;
+    members?: FamilyMemberBE[];
+    school?: SchoolBE;
+    studentFees?: StudentFeeBE[];
+}
+/**
+ * FamilyMember represents individuals within a family
+ * Multiple members (parents + students) share the family's user account
+ */
+export interface FamilyMemberBE {
+    avatar: string | null;
+    bloodGroup: string | null;
+    createdAt: string;
+    dateOfBirth: Date | string | null;
+    email: string | null;
+    emergencyPhone: string | null;
+    enabled: boolean;
+    familyId: string;
+    firstName: string;
+    gender: GENDER;
+    id: string;
+    idNumber: string;
+    isPrimary: boolean;
+    lastName: string;
+    occupation: string | null;
+    organization: string | null;
+    phone: string | null;
+    relationship: string;
+    role: FAMILY_MEMBER_ROLE;
+    updatedAt: string;
+    family?: FamilyBE;
+    studentProfile?: StudentProfileBE;
+}
+/**
+ * StudentProfile extends FamilyMember with student-specific data
+ */
+export interface StudentProfileBE {
+    campusId: string | null;
+    computerNumber: number;
+    createdAt: string;
+    discountCode: string | null;
+    enabled: boolean;
+    familyMemberId: string;
+    hafiz: boolean;
+    id: string;
+    notes: string | null;
+    orphan: boolean;
+    previousSchool: string | null;
+    remarks: string | null;
+    status: STUDENT_STATUS;
+    studentCode: string;
+    updatedAt: string;
+    attendances?: AttendanceBE[];
+    campus?: CampusBE;
+    enrollments?: EnrollmentBE[];
+    familyMember?: FamilyMemberBE;
+    grades?: GradeBE[];
+    studentFees?: StudentFeeBE[];
+}
+/**
+ * Class represents grade levels (e.g., Grade 1, Grade 2, Grade 10)
+ */
+export interface ClassBE {
+    campusId: string | null;
+    code: string;
+    createdAt: string;
+    description: string | null;
+    enabled: boolean;
+    id: string;
+    name: string;
+    schoolId: string;
+    updatedAt: string;
+    campus?: CampusBE;
+    feeStructures?: FeeStructureBE[];
+    school?: SchoolBE;
+    sections?: SectionBE[];
+}
+/**
+ * Section represents class divisions (e.g., Grade 1-A, Grade 1-B)
+ */
+export interface SectionBE {
+    capacity: number | null;
+    classId: string;
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    name: string;
+    schoolId: string;
+    updatedAt: string;
+    class?: ClassBE;
+    courses?: CourseBE[];
+    enrollments?: EnrollmentBE[];
+    school?: SchoolBE;
+}
+/**
+ * Subject represents academic subjects (e.g., Mathematics, English, Science)
+ */
+export interface SubjectBE {
+    code: string;
+    createdAt: string;
+    description: string | null;
+    enabled: boolean;
+    id: string;
+    name: string;
+    schoolId: string;
+    updatedAt: string;
+    courses?: CourseBE[];
+    school?: SchoolBE;
+}
+/**
+ * Course represents a subject taught in a specific section by a teacher
+ */
+export interface CourseBE {
+    code: string;
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    schoolId: string;
+    sectionId: string;
+    subjectId: string;
+    teacherId: string;
+    updatedAt: Date;
+    grades?: GradeBE[];
+    schedules?: ScheduleBE[];
+    school?: SchoolBE;
+    section?: SectionBE;
+    subject?: SubjectBE;
+    teacher?: TeacherBE;
+}
+/**
+ * Teacher represents teaching staff
+ */
+export interface TeacherBE {
+    address: string | null;
+    avatar: string | null;
+    bio: string | null;
+    campusId: string | null;
+    city: string | null;
+    country: string | null;
+    createdAt: string;
+    dateOfBirth: Date | string | null;
+    emergencyPhone: string | null;
+    enabled: boolean;
+    experience: number | null;
+    firstName: string;
+    gender: GENDER | null;
+    id: string;
+    joiningDate: Date | string;
+    lastName: string;
+    phone: string | null;
+    postalCode: string | null;
+    qualification: string | null;
+    schoolId: string;
+    specialization: string | null;
+    state: string | null;
+    teacherCode: string;
+    updatedAt: Date;
+    userId: string | null;
+    campus?: CampusBE;
+    courses?: CourseBE[];
+    school?: SchoolBE;
+    user?: UserBE | null;
+}
+/**
+ * Enrollment represents a student enrolled in a section.
+ * All courses taught in that section are implied.
+ */
+export interface EnrollmentBE {
+    createdAt: string;
+    enabled: boolean;
+    enrollmentDate: Date | string;
+    id: string;
+    sectionId: string;
+    studentProfileId: string;
+    updatedAt: string;
+    grades?: GradeBE[];
+    section?: SectionBE;
+    studentProfile?: StudentProfileBE;
+}
+/**
+ * Attendance tracks daily student presence in courses
+ */
+export interface AttendanceBE {
+    createdAt: string;
+    date: Date | string;
+    enabled: boolean;
+    id: string;
+    remarks: string | null;
+    schoolId: string;
+    status: ATTENDANCE_STATUS;
+    studentProfileId: string;
+    updatedAt: string;
+    school?: SchoolBE;
+    studentProfile?: StudentProfileBE;
+}
+/**
+ * Grade represents student assessment results
+ */
+export interface GradeBE {
+    assessmentDate: Date | string;
+    courseId: string;
+    createdAt: Date;
+    enabled: boolean;
+    enrollmentId: string;
+    grade: string | null;
+    gradeType: GRADE_TYPE;
+    id: string;
+    marksObtained: number;
+    maxMarks: number;
+    percentage: number | null;
+    remarks: string | null;
+    schoolId: string;
+    studentProfileId: string;
+    title: string;
+    updatedAt: Date;
+    course?: CourseBE;
+    enrollment?: EnrollmentBE;
+    school?: SchoolBE;
+    studentProfile?: StudentProfileBE;
+}
+/**
+ * Schedule represents class timetable
+ */
+export interface ScheduleBE {
+    courseId: string;
+    createdAt: string;
+    dayOfWeek: DAY_OF_WEEK;
+    enabled: boolean;
+    endTime: string;
+    id: string;
+    room: string | null;
+    schoolId: string;
+    startTime: string;
+    updatedAt: string;
+    course?: CourseBE;
+    school?: SchoolBE;
+}

package/types/academics.js

@@ -0,0 +1,8 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Academics
+ *
+ * This file contains TypeScript interfaces for class, section, subject, course,
+ * teacher, enrollment, attendance, grade, schedule, student profile, family,
+ * and family member domain models.
+ */
+export {};

package/types/admission.d.ts

@@ -0,0 +1,85 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Admission
+ *
+ * This file contains TypeScript interfaces for the admission domain models.
+ */
+import { GENDER, ADMISSION_STATUS } from "./enums";
+import type { SchoolBE } from "./user-management";
+export interface AdmissionDetails {
+    classForAdmission: string;
+    previousSchool: string;
+    siblings: string;
+}
+export interface FatherDetails {
+    fatherIdNumber: string;
+    fatherFirstName: string;
+    fatherLastName: string;
+    fatherMobile: string;
+    fatherOccupation: string;
+    fatherOrganization: string;
+    emergencyContact: boolean;
+}
+export interface MotherDetails {
+    motherIdNumber: string;
+    motherFirstName: string;
+    motherLastName: string;
+    motherMobile: string;
+    emergencyContact: boolean;
+}
+export interface HomeDetails {
+    address: string;
+    city: string;
+    country: string;
+    postalCode: string;
+    state: string;
+}
+export interface StudentDetails {
+    studentIdNumber: string;
+    discountCode: string;
+    dob: string;
+    emergencyContact: string;
+    firstName: string;
+    gender: GENDER;
+    hafiz: boolean;
+    lastName: string;
+    orphan: boolean;
+    registrationCode: string;
+}
+export interface OfficeUse {
+    admissionNotes: string;
+    notes: string;
+}
+/**
+ * StudentAdmission stores raw application payloads as JSON blobs.
+ * This model mirrors the Prisma StudentAdmission model which keeps
+ * structured form data in Json columns so the application layer can
+ * process/transform it into domain entities on approval.
+ */
+export interface AdmissionAIBE {
+    id: string;
+    admissionId: string;
+    schoolId: string;
+    score: number;
+    decision: string;
+    reasons: string[];
+    confidence: number;
+    processedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AdmissionBE {
+    admissionDetails: AdmissionDetails | null;
+    createdAt: string;
+    enabled: boolean;
+    fatherDetails: FatherDetails | null;
+    homeDetails: HomeDetails | null;
+    id: string;
+    motherDetails: MotherDetails | null;
+    officeUse: OfficeUse | null;
+    schoolId: string;
+    status: ADMISSION_STATUS;
+    studentDetails: StudentDetails | null;
+    updatedAt: string;
+    school?: SchoolBE;
+    aiAnalysis?: AdmissionAIBE | null;
+}

package/types/admission.js

@@ -0,0 +1,6 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Admission
+ *
+ * This file contains TypeScript interfaces for the admission domain models.
+ */
+export {};

package/types/communication.d.ts

@@ -0,0 +1,165 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Communication
+ *
+ * This file contains TypeScript interfaces for campaigns, blog posts,
+ * referrals, push tokens, mobile notifications, and notification preferences.
+ */
+import { CAMPAIGN_STATUS, CAMPAIGN_CONTACT_STATUS, DEVICE_PLATFORM, NOTIFICATION_TYPE, REFERRAL_CHANNEL, REFERRAL_STATUS } from "./enums";
+import type { SchoolBE, UserBE } from "./user-management";
+/**
+ * Individual recipient within a broadcast campaign
+ */
+export interface CampaignContactBE {
+    campaignId: string;
+    createdAt: string;
+    errorMessage: string | null;
+    id: string;
+    name: string;
+    phoneNumber: string;
+    sentAt: string | null;
+    status: CAMPAIGN_CONTACT_STATUS;
+    updatedAt: string;
+}
+/**
+ * WhatsApp broadcast campaign
+ */
+export interface CampaignBE {
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    messageTemplate: string;
+    name: string;
+    schoolId: string;
+    status: CAMPAIGN_STATUS;
+    updatedAt: string;
+    workerJobId: string | null;
+    contacts?: CampaignContactBE[];
+    _count?: {
+        contacts: number;
+    };
+    school?: SchoolBE;
+}
+/**
+ * BlogPost metadata and content (MDX/Markdown stored in `content`).
+ */
+export interface BlogPostBE {
+    authorId: string | null;
+    clapCount: number;
+    commentCount: number;
+    content: string;
+    createdAt: string;
+    enabled: boolean;
+    excerpt: string | null;
+    id: string;
+    publishedAt: Date | string | null;
+    schoolId: string | null;
+    slug: string;
+    title: string;
+    updatedAt: string;
+    author?: UserBE;
+    claps?: BlogPostClapBE[];
+    comments?: BlogCommentBE[];
+    school?: SchoolBE | null;
+}
+export interface BlogCommentBE {
+    authorId: string | null;
+    clapCount: number;
+    content: string;
+    createdAt: string;
+    enabled: boolean;
+    id: string;
+    parentId: string | null;
+    postId: string;
+    updatedAt: string;
+    author?: UserBE | null;
+    claps?: BlogCommentClapBE[];
+    parent?: BlogCommentBE | null;
+    post?: BlogPostBE;
+    replies?: BlogCommentBE[];
+}
+export interface BlogPostClapBE {
+    createdAt: string;
+    id: string;
+    postId: string;
+    sessionId: string | null;
+    userId: string | null;
+    post?: BlogPostBE;
+    user?: UserBE | null;
+}
+export interface BlogCommentClapBE {
+    commentId: string;
+    createdAt: string;
+    id: string;
+    sessionId: string | null;
+    userId: string | null;
+    comment?: BlogCommentBE;
+    user?: UserBE | null;
+}
+/**
+ * A referral invite sent by a school user to encourage another school to join the platform
+ */
+export interface ReferralBE {
+    channel: REFERRAL_CHANNEL;
+    createdAt: string;
+    enabled: boolean;
+    errorMessage: string | null;
+    id: string;
+    inviterUserId: string;
+    personalNote: string | null;
+    recipientEmail: string | null;
+    recipientName: string | null;
+    recipientPhone: string | null;
+    schoolId: string;
+    sentAt: string | null;
+    status: REFERRAL_STATUS;
+    updatedAt: string;
+    workerJobId: string | null;
+    school?: SchoolBE;
+}
+/**
+ * Expo push token registered by a mobile device for a specific user
+ */
+export interface UserPushTokenBE {
+    appVersion: string | null;
+    createdAt: string;
+    deviceId: string | null;
+    id: string;
+    platform: DEVICE_PLATFORM;
+    pushToken: string;
+    updatedAt: string;
+    userId: string;
+    user?: UserBE;
+}
+/**
+ * Push notification delivered to a mobile user
+ */
+export interface MobileNotificationBE {
+    archived: boolean;
+    body: string;
+    createdAt: string;
+    data: Record<string, unknown> | null;
+    id: string;
+    read: boolean;
+    title: string;
+    type: NOTIFICATION_TYPE;
+    updatedAt: string;
+    userId: string;
+    user?: UserBE;
+}
+/**
+ * Per-user notification category and channel preferences
+ */
+export interface NotificationPreferenceBE {
+    alertEnabled: boolean;
+    assignmentEnabled: boolean;
+    attendanceEnabled: boolean;
+    createdAt: string;
+    emailEnabled: boolean;
+    generalEnabled: boolean;
+    id: string;
+    paymentEnabled: boolean;
+    pushEnabled: boolean;
+    updatedAt: string;
+    userId: string;
+    user?: UserBE;
+}

package/types/communication.js

@@ -0,0 +1,7 @@
+/**
+ * TypeScript Types Generated from Prisma Schema - Communication
+ *
+ * This file contains TypeScript interfaces for campaigns, blog posts,
+ * referrals, push tokens, mobile notifications, and notification preferences.
+ */
+export {};