cyc-type-def 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,10 +1,399 @@
-declare function greet(name: string): string;
-declare function sum(a: number, b: number): number;
+interface Base {
+    id: string;
+    deleted: boolean;
+    createdAt?: number;
+    createdBy?: string;
+    updatedAt?: number;
+    updatedBy?: string;
+    remark?: string;
+}
 
-interface User {
+declare class CG implements Base {
     id: string;
+    deleted: boolean;
+    name: string;
+    /** small team id */
+    st: string;
+    /** cluster id */
+    cluster: string;
+    cglCnt?: number;
+    sglCnt?: number;
+    cglName?: string;
+    constructor(id: string, name: string, st: string, cluster: string, deleted: boolean);
+}
+
+declare class Sheep implements Base {
+    name: string;
+    st: string;
+    cluster: string;
+    cg: string;
+    status: string;
+    discipler?: string;
+    age?: number;
+    show: boolean;
+    birthday?: number;
+    isBaptised?: boolean;
+    dtBaptism?: number;
+    attCnt: number;
+    hideAtt?: boolean;
+    id: string;
+    deleted: boolean;
+    createdAt?: number;
+    createdBy?: string;
+    updatedAt?: number;
+    updatedBy?: string;
+    remark?: string;
+    arrFlwUpCnt?: number[];
+    constructor(id: string, name: string, status: string, cg: string, st: string, cluster: string, deleted: boolean, show: boolean, attCnt: number);
+}
+
+interface Session extends Base {
+    code: string;
+    desc: string;
+    seq: number;
+    type: string;
+    needAbsReason: boolean;
+}
+/** Session object indicating session of title */
+declare class Session implements Session {
+    constructor();
+}
+
+interface SessionAttendance extends Session {
+    /** array of attendance sheep (AttSheep) */
+    arrSheep: AttSheep[];
+    input: string;
+    sky: DisplayAttendance;
+    ground: DisplayAttendance;
+    total: DisplayAttendance;
+    cntAbs: number;
+    desAbs: string;
+}
+/**
+ * attendance of a session
+ *
+ * @extends
+ * Session
+ */
+declare class SessionAttendance implements SessionAttendance {
+    constructor();
+    constructor(session: Session);
+    sortedArrAttSheep(): AttSheep[];
+    get arrFilteredSheep(): AttSheep[];
+    getCnt(status: string, attType: string): number;
+    getAbsCnt(): number;
+    getDesc(status: string, attType: string): string;
+    getAbsDesc(): string;
+    calc(): void;
+    /** generate count of OM, NB, AC, NF, RNF */
+    calcFigure(): void;
+    /** generate description of OM, NB, AC, NF, RNF */
+    calcDesc(): void;
+    /**
+     * reset all display attendance figure to zero
+     */
+    resetDisplayAttendance(): void;
+    /**
+     * Sums CG's sessionAttendance into total sessionAttendance.
+     * @param sessionAttendance
+     */
+    sum(sessionAttendance: SessionAttendance): void;
+}
+interface AttSheep {
+    idSheep: string;
     name: string;
-    email: string;
+    status: string;
+    attended: boolean;
+    absReason: string;
+    method: string;
+}
+/** represents a single member in a SessionAttendance. */
+declare class AttSheep implements AttSheep {
+    /**
+     * initialize AttSheep object from Sheep object
+     * @param sheep
+     */
+    constructor(sheep: Sheep);
+    copyAtt(attSheep: AttSheep): void;
+}
+/**
+ * Contains a SessionAttendance data, to display.
+ * Ground/Sky/Total
+ */
+declare class DisplayAttendance {
+    [key: string]: any;
+    cntOM: number;
+    cntNB: number;
+    cntAC: number;
+    cntNF: number;
+    cntRNF: number;
+    desOM: string;
+    desNB: string;
+    desAC: string;
+    desNF: string;
+    desRNF: string;
+    total: number;
+    calcTotal(): void;
+}
+
+interface Title extends Base {
+    startDt: number;
+    endDt: number;
+    code: string;
+    arrSession: Session[];
 }
+/** represents a week */
+declare class Title implements Title {
+    getKey(): string;
+}
+
+interface Attendance extends Title {
+    idTitle: string;
+    idCg: string;
+    idSt: string;
+    idCluster: string;
+    timestamp: number;
+    arrSessionAttendance: SessionAttendance[];
+}
+/**
+ * attendance of week
+ *
+ * @extends Title
+ */
+declare class Attendance implements Attendance {
+    constructor();
+    constructor(attendance: Attendance);
+    getSessionAttendance(session: Session): void;
+    setSessionAttendance(arrSession: Session[]): void;
+    deepCopySessionAttendance(arrSessionAttendance: SessionAttendance[]): SessionAttendance[];
+    clearArrAttSheep(idCG: string, arrSheepForRef: {
+        [key: string]: Sheep;
+    }): void;
+    setArrAttSheep(arrSheep: Sheep[]): void;
+    addSheep(sheep: Sheep): void;
+    setCG(cg: CG): void;
+    /**
+     * remove sheep where attended=false from arrSheep to submit attendance,
+     * won't remove OM
+     */
+    removeNotAttendForSubmission(): void;
+    /** calculate session attendance's figure & description  */
+    calc(): void;
+    /** Reset all display attendance figure to zero. */
+    resetDisplayAttendance(): void;
+    getSessionAttendanceByCode(code: string): SessionAttendance;
+    /**
+     * copy attendance to the writing panel
+     * @param attendance
+     */
+    copy(attendance: Attendance): void;
+}
+
+interface BackupAttendance {
+    attendance: Attendance;
+    timestamp: number;
+}
+declare class BackupAttendance implements BackupAttendance {
+}
+
+declare class TitleAttendance {
+    cgAtt: AttSheep;
+    serviceAtt: AttSheep;
+    title: Title;
+    constructor(cgAtt: AttSheep, serviceAtt: AttSheep, title: Title);
+}
+
+declare class ReportSheep extends Sheep {
+    attMap: {
+        [key: string]: TitleAttendance;
+    };
+    constructor(sheep: Sheep);
+}
+
+interface MsjClassType extends Base {
+    title: string;
+    seq?: number;
+    defaultMinAtt?: number;
+}
+
+interface MsjClassBatch extends Base {
+    idMsjClassType: string;
+    yearTimestamp: number;
+    monthTimestamp: number;
+    msjClassType?: MsjClassType;
+    numOfClass: number;
+    dt?: Date;
+    minAtt?: number;
+}
+
+interface MsjClassTime extends Base {
+    idMsjClassBatch: string;
+    time: number;
+    msjClassBatch?: MsjClassBatch;
+    classNo: number;
+    backtracked?: boolean;
+}
+
+interface MsjStudClass {
+    idClass?: string;
+    attended: boolean;
+    classNo: number;
+    replaced?: boolean;
+    absReason?: string;
+    markBy?: string;
+    markAt?: number;
+    provedAbsent?: boolean;
+    isWatchedRecording?: boolean;
+    markByName?: string;
+}
+
+interface MsjStudBatch extends Base {
+    idSheep: string;
+    idBatch: string;
+    completed?: boolean;
+    proceed?: boolean;
+    attendance?: MsjStudClass[];
+    status?: string;
+}
+
+declare class FollowUpStatus {
+    id: string;
+    method: string;
+    st: string;
+    cluster: string;
+    cg: string;
+    sheep: string;
+    in_list: boolean;
+    status: string;
+    timeStamp: string;
+    date: string;
+    discipler: string;
+    user?: string;
+    constructor();
+}
+
+declare class Cluster implements Base {
+    id: string;
+    deleted: boolean;
+    name: string;
+    createdAt?: number;
+    createdBy: string | undefined;
+    updatedAt?: number;
+    updatedBy: string | undefined;
+    remark?: string;
+    constructor(id: string, name: string, deleted: boolean);
+}
+
+declare class SmallTeam implements Base {
+    id: string;
+    name: string;
+    /** cluster id */
+    cluster: string;
+    deleted: boolean;
+    constructor(id: string, name: string, cluster: string, deleted: boolean);
+}
+
+/** Navigation List Item */
+interface AppPage {
+    /** Title shown in navigation list */
+    title: string;
+    /** redirect target */
+    url: string;
+    /** Ionic icon name */
+    icon: string;
+    /** control whether show in navigation list or not */
+    canAccess: boolean;
+    category: string;
+    /** Angular Material icon name */
+    matIcon: string;
+    /** user need sign in to view */
+    isSecure: boolean;
+    /** Permissions need to view. Blank indicates everyone can view. */
+    permissions: string[];
+}
+
+interface PastoralTeam {
+    cg?: string;
+    cluster?: string;
+    st?: string;
+}
+declare class AppUser {
+    id: string;
+    name: string;
+    /** Login id: phone number/email */
+    phoneNum: string;
+    permission: string;
+    pastoral_team?: PastoralTeam;
+    permissions?: string[];
+    constructor(id: string, name: string, phoneNum: string, permission: string);
+}
+
+interface BaseDialog {
+    close(): void;
+}
+
+declare enum ClickAction {
+    P_WeeklyAttendance = 0,
+    P_AttendanceReport = 1,
+    P_CGNameList = 2,
+    F_CopyAttendance = 3,
+    F_CheckAttendanceHistory = 4,
+    F_AttendanceReminder = 5,
+    F_ExportWeekAttendance = 6,
+    F_ClickEditSheep = 7,
+    F_EditSheep = 8,
+    F_VerticalViewAttendance = 9
+}
+
+declare class Click {
+    action: ClickAction;
+    timeStamp: number;
+    userId?: string;
+}
+
+declare class Column {
+    visible: boolean;
+    name: string;
+    constructor(name: string);
+}
+
+interface Device extends Base {
+    version?: number;
+}
+
+declare const METHOD: {
+    SKY: string;
+    GROUND: string;
+    TOTAL: string;
+};
+
+declare const PERMISSION: {
+    SUPER_USER: string;
+    TL: string;
+    SCGL: string;
+    CGL: string;
+    FL: string;
+    WM: string;
+    NOT_VERIFIED: string;
+    PASTORAL_ADMIN: string;
+    ST_ADMIN: string;
+};
+declare const PERMISSION_TYPE: {
+    USER_MANAGEMENT: string[];
+    WEEKLY_ATT: string[];
+    ATT_RPT: string[];
+    TITLE: string[];
+    CLICKS: string[];
+    monthlyReport: string[];
+    read: string[];
+    msjStudentRecord: string[];
+    msjProgress: string[];
+    msjToAttend: string[];
+    addSheep: string[];
+    addCG: string[];
+    oprAddSheep: string[];
+};
+
+declare const LIST_STATUS: string[];
 
-export { type User, greet, sum };
+export { type AppPage, AppUser, AttSheep, Attendance, BackupAttendance, type Base, type BaseDialog, CG, Click, ClickAction, Cluster, Column, type Device, DisplayAttendance, FollowUpStatus, LIST_STATUS, METHOD, type MsjClassBatch, type MsjClassTime, type MsjClassType, type MsjStudBatch, type MsjStudClass, PERMISSION, PERMISSION_TYPE, type PastoralTeam, ReportSheep, Session, SessionAttendance, Sheep, SmallTeam, Title, TitleAttendance };