cyc-type-def 6.5.0 → 7.1.0

package/dist/index.cjs

@@ -53,6 +53,7 @@ __export(index_exports, {
   cgNum: () => cgNum,
   compareCG: () => compareCG,
   formatDateDDMMYY: () => formatDateDDMMYY,
+  generateId: () => generateId,
   getDayMonthSortKey: () => getDayMonthSortKey,
   isDateInRangeIgnoreYear: () => isDateInRangeIgnoreYear,
   monthStr: () => monthStr,
@@ -257,6 +258,18 @@ var AttSheep = class {
   }
 };
 var DisplayAttendance = class {
+  // Allows dynamic string keys
+  cntOM;
+  cntNB;
+  cntAC;
+  cntNF;
+  cntRNF;
+  desOM;
+  desNB;
+  desAC;
+  desNF;
+  desRNF;
+  total;
   calcTotal() {
     this.total = this.cntOM + this.cntNB + this.cntAC + this.cntNF + this.cntRNF;
   }
@@ -412,13 +425,15 @@ var Session = class {
 
 // src/classes/attendance/Title.ts
 var Title = class {
-  getKey() {
-    return "dddd";
-  }
 };
 
 // src/classes/helper/DateEvent.ts
 var DateEvent = class {
+  datetime;
+  precision;
+  eventName;
+  invitedBy;
+  remark;
   constructor(datetime) {
     if (datetime) this.datetime = datetime;
     this.precision = "DAY" /* DAY */;
@@ -435,6 +450,55 @@ var DatePrecision = /* @__PURE__ */ ((DatePrecision2) => {
 
 // src/classes/pastoral-team/Sheep.ts
 var Sheep = class _Sheep {
+  // pastoral team info
+  st;
+  // small team id
+  cluster;
+  // cluster id
+  cg;
+  // cg id
+  status;
+  discipler;
+  // history record (spiritual journey/milestone)
+  /** first approach/contact (JieChu) */
+  firstApproach;
+  /** first CG/SERVICE */
+  firstAtt;
+  /** accept Christ */
+  acceptChrist;
+  // sheep info
+  name;
+  age;
+  birthday;
+  isBaptised;
+  dtBaptism;
+  contact;
+  gender;
+  nric;
+  address;
+  // in future might break to details like address line 1, state etc.
+  email;
+  // attendance
+  attCnt;
+  /** Attendance count in recent 15 weeks (tentatively) */
+  recentAttCnt;
+  hideAtt;
+  // hide in attendance list
+  // ???
+  show;
+  // show in msj-progress-tracker
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
+  // not submit attributes
+  arrFlwUpCnt;
+  msj;
+  msjRecords;
   constructor(id, name, status, cg, st, cluster, deleted, show, attCnt) {
     this.id = id;
     this.name = name;
@@ -456,6 +520,7 @@ var Sheep = class _Sheep {
 
 // src/classes/attendance-report/ReportSheep.ts
 var ReportSheep = class extends Sheep {
+  attMap;
   constructor(sheep) {
     super(
       sheep.id,
@@ -475,6 +540,9 @@ var ReportSheep = class extends Sheep {
 
 // src/classes/attendance-report/TitleAttendance.ts
 var TitleAttendance = class {
+  cgAtt;
+  serviceAtt;
+  title;
   constructor(cgAtt, serviceAtt, title) {
     this.cgAtt = cgAtt;
     this.serviceAtt = serviceAtt;
@@ -484,6 +552,22 @@ var TitleAttendance = class {
 
 // src/classes/flw-up/FollowUpStatus.ts
 var FollowUpStatus = class {
+  id;
+  method;
+  st;
+  // small team id
+  cluster;
+  // cluster id
+  cg;
+  // cg id
+  sheep;
+  // sheep name
+  in_list;
+  status;
+  timeStamp;
+  date;
+  discipler;
+  user;
   constructor() {
     this.id = "";
     this.method = "";
@@ -501,6 +585,25 @@ var FollowUpStatus = class {
 
 // src/classes/pastoral-team/CG.ts
 var CG = class {
+  name;
+  /** small team id */
+  st;
+  //
+  /** cluster id */
+  cluster;
+  cglCnt;
+  sglCnt;
+  cglName;
+  /** row index in attendance report (1-based) */
+  rptRowIdx;
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, st, cluster, deleted) {
     this.id = id;
     this.name = name;
@@ -512,6 +615,14 @@ var CG = class {
 
 // src/classes/pastoral-team/Cluster.ts
 var Cluster = class {
+  id;
+  deleted;
+  name;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, deleted) {
     this.id = id;
     this.name = name;
@@ -521,6 +632,18 @@ var Cluster = class {
 
 // src/classes/pastoral-team/SmallTeam.ts
 var SmallTeam = class {
+  name;
+  /** cluster id */
+  cluster;
+  // cluster id
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, cluster, deleted) {
     this.id = id;
     this.name = name;
@@ -531,25 +654,46 @@ var SmallTeam = class {
 
 // src/classes/user-management/AssignedCG.ts
 var AssignedCG = class {
+  cg;
   constructor(cg) {
     this.cg = cg;
   }
 };
 
+// src/classes/history/History.ts
+function generateId(history) {
+  history.id = history.idRef + "@" + history.idPeriod;
+}
+
 // src/classes/helper/Click.ts
 var Click = class {
+  action;
+  timeStamp;
+  userId;
+  remark;
 };
 
 // src/classes/helper/Column.ts
 var Column = class {
+  visible = false;
+  name;
   constructor(name) {
-    this.visible = false;
     this.name = name;
   }
 };
 
 // src/classes/AppUser.ts
 var AppUser = class {
+  id;
+  name;
+  /** Login id: phone number/email */
+  phoneNum;
+  permission;
+  pastoral_team;
+  permissions;
+  assigned_cg;
+  idSheep;
+  settings;
   constructor(id, name, phoneNum, permission) {
     this.id = id;
     this.name = name;
@@ -563,6 +707,15 @@ var Period = class {
   constructor(period) {
     Object.assign(this, period);
   }
+  generateId() {
+    if (!this.year) {
+      throw new Error("Cannot generate Period ID: year is required.");
+    }
+    if (!this.month) {
+      throw new Error("Cannot generate Period ID: month is required.");
+    }
+    this.id = this.year.toString() + "-" + this.month.toString().padStart(2, "0");
+  }
   /**
    * Calculates and sets the millisecond timestamps for the start and end of the period.
    * * Uses the instance's `year` and `month` (1-based) to compute:
@@ -577,10 +730,12 @@ var Period = class {
     this.endTimestamp = end.getTime();
   }
   get dtStart() {
-    return new Date(this.startTimestamp);
+    if (this.startTimestamp) return new Date(this.startTimestamp);
+    else return void 0;
   }
   get dtEnd() {
-    return new Date(this.endTimestamp);
+    if (this.endTimestamp) return new Date(this.endTimestamp);
+    else return void 0;
   }
 };
 
@@ -763,6 +918,7 @@ function compareCG(a, b) {
   cgNum,
   compareCG,
   formatDateDDMMYY,
+  generateId,
   getDayMonthSortKey,
   isDateInRangeIgnoreYear,
   monthStr,

package/dist/index.d.cts

@@ -88,6 +88,7 @@ declare class Sheep implements Base {
     gender?: string;
     nric?: string;
     address?: string;
+    email?: string;
     attCnt: number;
     /** Attendance count in recent 15 weeks (tentatively) */
     recentAttCnt?: number;
@@ -197,6 +198,7 @@ declare class DisplayAttendance {
 }
 
 interface Title extends Base {
+    idPeriod: string;
     startDt: number;
     endDt: number;
     code: string;
@@ -204,7 +206,6 @@ interface Title extends Base {
 }
 /** represents a week */
 declare class Title implements Title {
-    getKey(): string;
 }
 
 interface Attendance extends Title {
@@ -446,6 +447,14 @@ interface Claim extends Base {
     status: string;
 }
 
+type History<T extends Base> = T & {
+    /** id of the current period */
+    idPeriod: string;
+    /** original id of the object */
+    idRef: string;
+};
+declare function generateId(history: History<Base>): void;
+
 declare enum ClickAction {
     P_WeeklyAttendance = 0,
     P_AttendanceReport = 1,
@@ -540,19 +549,15 @@ interface BaseDialogInput {
     action: DialogAction;
 }
 
-declare class Period implements Base {
-    id: string;
-    deleted: boolean;
-    createdAt?: number | undefined;
-    createdBy?: string | undefined;
-    updatedAt?: number | undefined;
-    updatedBy?: string | undefined;
-    remark?: string | undefined;
+interface Period extends Base {
     year: number;
     month: number;
     startTimestamp: number;
     endTimestamp: number;
+}
+declare class Period implements Period {
     constructor(period: Partial<Period>);
+    generateId(): void;
     /**
      * Calculates and sets the millisecond timestamps for the start and end of the period.
      * * Uses the instance's `year` and `month` (1-based) to compute:
@@ -561,8 +566,8 @@ declare class Period implements Base {
      * * @throws This method will produce invalid timestamps (`NaN`) if `year` or `month` are undefined.
      */
     setBounds(): void;
-    get dtStart(): Date;
-    get dtEnd(): Date;
+    get dtStart(): Date | undefined;
+    get dtEnd(): Date | undefined;
 }
 
 declare const METHOD: {
@@ -614,4 +619,4 @@ declare function getDayMonthSortKey(timestamp: number): number;
 
 declare function compareCG(a: CG, b: CG): number;
 
-export { type AppPage, AppUser, AssignedCG, AttSheep, Attendance, BackupAttendance, type Base, type BaseDialog, type BaseDialogInput, CG, type Claim, ClaimStatus, ClaimType, Click, ClickAction, Cluster, Column, DateEvent, DatePrecision, type Device, DialogAction, DisplayAttendance, FollowUpStatus, LIST_STATUS, METHOD, type MsjClassBatch, type MsjClassTime, type MsjClassType, MsjJoinStatus, MsjJoinStatusInfo, type MsjStudBatch, type MsjStudClass, PERMISSION, type PastoralTeam, Period, ReportSheep, Session, SessionAttendance, Sheep, SmallTeam, Title, TitleAttendance, cgNum, compareCG, formatDateDDMMYY, getDayMonthSortKey, isDateInRangeIgnoreYear, monthStr, parseYYMMDD, yearStr };
+export { type AppPage, AppUser, AssignedCG, AttSheep, Attendance, BackupAttendance, type Base, type BaseDialog, type BaseDialogInput, CG, type Claim, ClaimStatus, ClaimType, Click, ClickAction, Cluster, Column, DateEvent, DatePrecision, type Device, DialogAction, DisplayAttendance, FollowUpStatus, type History, LIST_STATUS, METHOD, type MsjClassBatch, type MsjClassTime, type MsjClassType, MsjJoinStatus, MsjJoinStatusInfo, type MsjStudBatch, type MsjStudClass, PERMISSION, type PastoralTeam, Period, ReportSheep, Session, SessionAttendance, Sheep, SmallTeam, Title, TitleAttendance, cgNum, compareCG, formatDateDDMMYY, generateId, getDayMonthSortKey, isDateInRangeIgnoreYear, monthStr, parseYYMMDD, yearStr };

package/dist/index.d.ts

@@ -88,6 +88,7 @@ declare class Sheep implements Base {
     gender?: string;
     nric?: string;
     address?: string;
+    email?: string;
     attCnt: number;
     /** Attendance count in recent 15 weeks (tentatively) */
     recentAttCnt?: number;
@@ -197,6 +198,7 @@ declare class DisplayAttendance {
 }
 
 interface Title extends Base {
+    idPeriod: string;
     startDt: number;
     endDt: number;
     code: string;
@@ -204,7 +206,6 @@ interface Title extends Base {
 }
 /** represents a week */
 declare class Title implements Title {
-    getKey(): string;
 }
 
 interface Attendance extends Title {
@@ -446,6 +447,14 @@ interface Claim extends Base {
     status: string;
 }
 
+type History<T extends Base> = T & {
+    /** id of the current period */
+    idPeriod: string;
+    /** original id of the object */
+    idRef: string;
+};
+declare function generateId(history: History<Base>): void;
+
 declare enum ClickAction {
     P_WeeklyAttendance = 0,
     P_AttendanceReport = 1,
@@ -540,19 +549,15 @@ interface BaseDialogInput {
     action: DialogAction;
 }
 
-declare class Period implements Base {
-    id: string;
-    deleted: boolean;
-    createdAt?: number | undefined;
-    createdBy?: string | undefined;
-    updatedAt?: number | undefined;
-    updatedBy?: string | undefined;
-    remark?: string | undefined;
+interface Period extends Base {
     year: number;
     month: number;
     startTimestamp: number;
     endTimestamp: number;
+}
+declare class Period implements Period {
     constructor(period: Partial<Period>);
+    generateId(): void;
     /**
      * Calculates and sets the millisecond timestamps for the start and end of the period.
      * * Uses the instance's `year` and `month` (1-based) to compute:
@@ -561,8 +566,8 @@ declare class Period implements Base {
      * * @throws This method will produce invalid timestamps (`NaN`) if `year` or `month` are undefined.
      */
     setBounds(): void;
-    get dtStart(): Date;
-    get dtEnd(): Date;
+    get dtStart(): Date | undefined;
+    get dtEnd(): Date | undefined;
 }
 
 declare const METHOD: {
@@ -614,4 +619,4 @@ declare function getDayMonthSortKey(timestamp: number): number;
 
 declare function compareCG(a: CG, b: CG): number;
 
-export { type AppPage, AppUser, AssignedCG, AttSheep, Attendance, BackupAttendance, type Base, type BaseDialog, type BaseDialogInput, CG, type Claim, ClaimStatus, ClaimType, Click, ClickAction, Cluster, Column, DateEvent, DatePrecision, type Device, DialogAction, DisplayAttendance, FollowUpStatus, LIST_STATUS, METHOD, type MsjClassBatch, type MsjClassTime, type MsjClassType, MsjJoinStatus, MsjJoinStatusInfo, type MsjStudBatch, type MsjStudClass, PERMISSION, type PastoralTeam, Period, ReportSheep, Session, SessionAttendance, Sheep, SmallTeam, Title, TitleAttendance, cgNum, compareCG, formatDateDDMMYY, getDayMonthSortKey, isDateInRangeIgnoreYear, monthStr, parseYYMMDD, yearStr };
+export { type AppPage, AppUser, AssignedCG, AttSheep, Attendance, BackupAttendance, type Base, type BaseDialog, type BaseDialogInput, CG, type Claim, ClaimStatus, ClaimType, Click, ClickAction, Cluster, Column, DateEvent, DatePrecision, type Device, DialogAction, DisplayAttendance, FollowUpStatus, type History, LIST_STATUS, METHOD, type MsjClassBatch, type MsjClassTime, type MsjClassType, MsjJoinStatus, MsjJoinStatusInfo, type MsjStudBatch, type MsjStudClass, PERMISSION, type PastoralTeam, Period, ReportSheep, Session, SessionAttendance, Sheep, SmallTeam, Title, TitleAttendance, cgNum, compareCG, formatDateDDMMYY, generateId, getDayMonthSortKey, isDateInRangeIgnoreYear, monthStr, parseYYMMDD, yearStr };

package/dist/index.js

@@ -194,6 +194,18 @@ var AttSheep = class {
   }
 };
 var DisplayAttendance = class {
+  // Allows dynamic string keys
+  cntOM;
+  cntNB;
+  cntAC;
+  cntNF;
+  cntRNF;
+  desOM;
+  desNB;
+  desAC;
+  desNF;
+  desRNF;
+  total;
   calcTotal() {
     this.total = this.cntOM + this.cntNB + this.cntAC + this.cntNF + this.cntRNF;
   }
@@ -349,13 +361,15 @@ var Session = class {
 
 // src/classes/attendance/Title.ts
 var Title = class {
-  getKey() {
-    return "dddd";
-  }
 };
 
 // src/classes/helper/DateEvent.ts
 var DateEvent = class {
+  datetime;
+  precision;
+  eventName;
+  invitedBy;
+  remark;
   constructor(datetime) {
     if (datetime) this.datetime = datetime;
     this.precision = "DAY" /* DAY */;
@@ -372,6 +386,55 @@ var DatePrecision = /* @__PURE__ */ ((DatePrecision2) => {
 
 // src/classes/pastoral-team/Sheep.ts
 var Sheep = class _Sheep {
+  // pastoral team info
+  st;
+  // small team id
+  cluster;
+  // cluster id
+  cg;
+  // cg id
+  status;
+  discipler;
+  // history record (spiritual journey/milestone)
+  /** first approach/contact (JieChu) */
+  firstApproach;
+  /** first CG/SERVICE */
+  firstAtt;
+  /** accept Christ */
+  acceptChrist;
+  // sheep info
+  name;
+  age;
+  birthday;
+  isBaptised;
+  dtBaptism;
+  contact;
+  gender;
+  nric;
+  address;
+  // in future might break to details like address line 1, state etc.
+  email;
+  // attendance
+  attCnt;
+  /** Attendance count in recent 15 weeks (tentatively) */
+  recentAttCnt;
+  hideAtt;
+  // hide in attendance list
+  // ???
+  show;
+  // show in msj-progress-tracker
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
+  // not submit attributes
+  arrFlwUpCnt;
+  msj;
+  msjRecords;
   constructor(id, name, status, cg, st, cluster, deleted, show, attCnt) {
     this.id = id;
     this.name = name;
@@ -393,6 +456,7 @@ var Sheep = class _Sheep {
 
 // src/classes/attendance-report/ReportSheep.ts
 var ReportSheep = class extends Sheep {
+  attMap;
   constructor(sheep) {
     super(
       sheep.id,
@@ -412,6 +476,9 @@ var ReportSheep = class extends Sheep {
 
 // src/classes/attendance-report/TitleAttendance.ts
 var TitleAttendance = class {
+  cgAtt;
+  serviceAtt;
+  title;
   constructor(cgAtt, serviceAtt, title) {
     this.cgAtt = cgAtt;
     this.serviceAtt = serviceAtt;
@@ -421,6 +488,22 @@ var TitleAttendance = class {
 
 // src/classes/flw-up/FollowUpStatus.ts
 var FollowUpStatus = class {
+  id;
+  method;
+  st;
+  // small team id
+  cluster;
+  // cluster id
+  cg;
+  // cg id
+  sheep;
+  // sheep name
+  in_list;
+  status;
+  timeStamp;
+  date;
+  discipler;
+  user;
   constructor() {
     this.id = "";
     this.method = "";
@@ -438,6 +521,25 @@ var FollowUpStatus = class {
 
 // src/classes/pastoral-team/CG.ts
 var CG = class {
+  name;
+  /** small team id */
+  st;
+  //
+  /** cluster id */
+  cluster;
+  cglCnt;
+  sglCnt;
+  cglName;
+  /** row index in attendance report (1-based) */
+  rptRowIdx;
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, st, cluster, deleted) {
     this.id = id;
     this.name = name;
@@ -449,6 +551,14 @@ var CG = class {
 
 // src/classes/pastoral-team/Cluster.ts
 var Cluster = class {
+  id;
+  deleted;
+  name;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, deleted) {
     this.id = id;
     this.name = name;
@@ -458,6 +568,18 @@ var Cluster = class {
 
 // src/classes/pastoral-team/SmallTeam.ts
 var SmallTeam = class {
+  name;
+  /** cluster id */
+  cluster;
+  // cluster id
+  // base attributes
+  id;
+  deleted;
+  createdAt;
+  createdBy;
+  updatedAt;
+  updatedBy;
+  remark;
   constructor(id, name, cluster, deleted) {
     this.id = id;
     this.name = name;
@@ -468,25 +590,46 @@ var SmallTeam = class {
 
 // src/classes/user-management/AssignedCG.ts
 var AssignedCG = class {
+  cg;
   constructor(cg) {
     this.cg = cg;
   }
 };
 
+// src/classes/history/History.ts
+function generateId(history) {
+  history.id = history.idRef + "@" + history.idPeriod;
+}
+
 // src/classes/helper/Click.ts
 var Click = class {
+  action;
+  timeStamp;
+  userId;
+  remark;
 };
 
 // src/classes/helper/Column.ts
 var Column = class {
+  visible = false;
+  name;
   constructor(name) {
-    this.visible = false;
     this.name = name;
   }
 };
 
 // src/classes/AppUser.ts
 var AppUser = class {
+  id;
+  name;
+  /** Login id: phone number/email */
+  phoneNum;
+  permission;
+  pastoral_team;
+  permissions;
+  assigned_cg;
+  idSheep;
+  settings;
   constructor(id, name, phoneNum, permission) {
     this.id = id;
     this.name = name;
@@ -500,6 +643,15 @@ var Period = class {
   constructor(period) {
     Object.assign(this, period);
   }
+  generateId() {
+    if (!this.year) {
+      throw new Error("Cannot generate Period ID: year is required.");
+    }
+    if (!this.month) {
+      throw new Error("Cannot generate Period ID: month is required.");
+    }
+    this.id = this.year.toString() + "-" + this.month.toString().padStart(2, "0");
+  }
   /**
    * Calculates and sets the millisecond timestamps for the start and end of the period.
    * * Uses the instance's `year` and `month` (1-based) to compute:
@@ -514,10 +666,12 @@ var Period = class {
     this.endTimestamp = end.getTime();
   }
   get dtStart() {
-    return new Date(this.startTimestamp);
+    if (this.startTimestamp) return new Date(this.startTimestamp);
+    else return void 0;
   }
   get dtEnd() {
-    return new Date(this.endTimestamp);
+    if (this.endTimestamp) return new Date(this.endTimestamp);
+    else return void 0;
   }
 };
 
@@ -699,6 +853,7 @@ export {
   cgNum,
   compareCG,
   formatDateDDMMYY,
+  generateId,
   getDayMonthSortKey,
   isDateInRangeIgnoreYear,
   monthStr,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyc-type-def",
-  "version": "6.5.0",
+  "version": "7.1.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",