@emiran/omu-ubys 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,264 @@
+interface UBYSSessionOptions {
+    baseUrl?: string;
+    timeoutMs?: number;
+    headers?: Record<string, string>;
+}
+
+interface UserProfile {
+    name: string;
+    studentNumber: string;
+    faculty: string;
+    department: string;
+    sapId?: string;
+    studentId?: number;
+    semesterId?: number;
+    academicYear?: number;
+    cumulativeGpa?: number;
+}
+interface Advisor {
+    name: string;
+    email?: string;
+}
+interface Exam {
+    examType: string;
+    name: string;
+    date?: string;
+    score?: number;
+    average?: number;
+    ranking?: string;
+}
+interface Course {
+    code: string;
+    name: string;
+    credit?: number;
+    passingGrade?: number;
+    letterGrade?: string;
+    status?: string;
+    classId?: string;
+    exams?: Exam[];
+}
+interface Semester {
+    name: string;
+    gpa?: number;
+    courses: Course[];
+}
+interface ScheduleItem {
+    day: string;
+    startTime: string;
+    endTime: string;
+    courseName: string;
+    courseCode?: string;
+    classroom?: string;
+    instructor?: string;
+}
+interface MenuItem {
+    name: string;
+    category?: string;
+    calories?: number;
+}
+interface CafeteriaMenu {
+    date: string;
+    items: MenuItem[];
+}
+interface Student {
+    id: string;
+    name: string;
+    surname: string;
+    imageUrl?: string;
+}
+interface Instructor {
+    name: string;
+    imageUrl?: string;
+}
+interface ClassDetailSurvey {
+    required: boolean;
+    message: string;
+    url?: string;
+    expired?: boolean;
+}
+interface ClassDetail {
+    exams: Exam[];
+    students: Student[];
+    instructor?: Instructor;
+    classAverage?: number;
+    status?: string;
+    letterGrade?: string;
+    survey?: ClassDetailSurvey;
+}
+interface ChatSearchOptions {
+    keyword?: string;
+    pageNumber?: number;
+    pageSize?: number;
+}
+interface ChatRecipientSearchOptions {
+    chatIds: string[];
+    pageNumber?: number;
+    pageSize?: number;
+}
+interface ChatMessageSearchOptions {
+    chatRecepientIds: string[];
+    keyword?: string;
+    pageNumber?: number;
+    pageSize?: number;
+}
+interface ChatSearchResult {
+    pageNumber: number;
+    pageSize: number;
+    totalNumberOfPages: number;
+    totalNumberOfRecords: number;
+    nextPageUrl?: string | null;
+    items: Chat[];
+}
+interface ChatRecipientSearchResult {
+    pageNumber: number;
+    pageSize: number;
+    totalNumberOfPages: number;
+    totalNumberOfRecords: number;
+    nextPageUrl?: string | null;
+    items: ChatRecipient[];
+}
+interface ChatMessageSearchResult {
+    pageNumber: number;
+    pageSize: number;
+    totalNumberOfPages: number;
+    totalNumberOfRecords: number;
+    nextPageUrl?: string | null;
+    items: ChatMessageReceipt[];
+}
+interface Chat {
+    id: string;
+    name: string;
+    isGroup: boolean;
+    createdOn: string;
+    createdBy: number;
+    encryptedCreatedBy?: string | null;
+    chatRecepientId?: string;
+    lastMessageSendedOn?: string;
+    lastMessageReadedOn?: string;
+    recipients: ChatRecipient[];
+}
+interface ChatRecipient {
+    id: string;
+    chatId: string;
+    userEncryptId?: string;
+    userId: number;
+    personId: number;
+    personEncryptId?: string;
+    createdOn: string;
+    createdBy: number;
+    encryptedCreatedBy?: string | null;
+    lastMessageId?: string;
+    lastMessageSendedOn?: string;
+    recipientName?: string;
+    recipientSurname?: string;
+    chatMessages: ChatMessageReceipt[];
+}
+interface ChatMessageReceipt {
+    id: string;
+    chatRecepientId: string;
+    messageId: string;
+    readedOn?: string | null;
+    createdOn: string;
+    createdBy: number;
+    encryptedCreatedBy?: string | null;
+    senderName?: string;
+    senderSurname?: string;
+    isEveryBodyReaded: boolean;
+    message: ChatMessage;
+}
+interface ChatMessage {
+    id: string;
+    parentId?: string | null;
+    subject: string;
+    fileArchiveId?: string | null;
+    createdOn: string;
+    createdBy: number;
+    encryptedCreatedBy?: string | null;
+    recipientReadedOnList: Record<string, string | null>;
+}
+interface StudentProgram {
+    StudentId?: number;
+    RecordSemester?: number;
+    RecordYear?: number;
+    AcademicProgramName?: string;
+    UnitName?: string;
+    GANO?: number;
+}
+interface StudentInfoPayload {
+    Programs?: StudentProgram[];
+    Person?: {
+        Person?: {
+            Name?: string;
+            Surname?: string;
+        };
+    };
+}
+
+interface UBYSClientOptions extends UBYSSessionOptions {
+    username?: string;
+    password?: string;
+}
+declare class UBYSClient {
+    private readonly session;
+    private readonly credentials;
+    private closed;
+    private state;
+    constructor(options?: UBYSClientOptions);
+    get isLoggedIn(): boolean;
+    get isClosed(): boolean;
+    login(username?: string | undefined, password?: string | undefined): Promise<void>;
+    getProfile(): Promise<UserProfile>;
+    getAdvisor(): Promise<Advisor | null>;
+    getCafeteriaMenu(): Promise<CafeteriaMenu | null>;
+    getMessages(options?: ChatSearchOptions): Promise<ChatSearchResult>;
+    getChatRecipients(options: ChatRecipientSearchOptions): Promise<ChatRecipientSearchResult>;
+    getChatMessages(options: ChatMessageSearchOptions): Promise<ChatMessageSearchResult>;
+    getGrades(): Promise<Semester[]>;
+    getClassDetails(classId: string): Promise<ClassDetail>;
+    getTranscript(): Promise<Semester[]>;
+    getWeeklySchedule(): Promise<ScheduleItem[]>;
+    clearSession(): void;
+    close(): Promise<void>;
+    private ensureAuthenticated;
+    private ensureOpen;
+    private fetchDashboardHtml;
+    private resolveTranscriptPath;
+}
+
+interface UBYSErrorOptions {
+    cause?: unknown;
+    code?: string;
+    details?: Record<string, unknown>;
+}
+declare class UBYSError extends Error {
+    readonly code: string;
+    readonly details: Record<string, unknown> | undefined;
+    constructor(message: string, options?: UBYSErrorOptions);
+}
+declare class AuthenticationError extends UBYSError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class LoginError extends AuthenticationError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class SessionExpiredError extends AuthenticationError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class NetworkError extends UBYSError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class HttpError extends UBYSError {
+    readonly statusCode: number;
+    constructor(statusCode: number, message?: string, options?: UBYSErrorOptions);
+}
+declare class ParseError extends UBYSError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class NotImplementedUBYSError extends UBYSError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+declare class ClientClosedError extends UBYSError {
+    constructor(message?: string, options?: UBYSErrorOptions);
+}
+
+export { type Advisor, AuthenticationError, type CafeteriaMenu, type Chat, type ChatMessage, type ChatMessageReceipt, type ChatMessageSearchOptions, type ChatMessageSearchResult, type ChatRecipient, type ChatRecipientSearchOptions, type ChatRecipientSearchResult, type ChatSearchOptions, type ChatSearchResult, type ClassDetail, type ClassDetailSurvey, ClientClosedError, type Course, type Exam, HttpError, type Instructor, LoginError, type MenuItem, NetworkError, NotImplementedUBYSError, ParseError, type ScheduleItem, type Semester, SessionExpiredError, type Student, type StudentInfoPayload, type StudentProgram, UBYSClient, type UBYSClientOptions, UBYSError, type UserProfile };