@taiger-common/model 1.0.50 → 1.0.52

package/dist/cjs/api/account.js

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

package/dist/cjs/api/applications.js

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

package/dist/cjs/api/audit.js

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

package/dist/cjs/api/auth.js

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

package/dist/cjs/api/common.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Common API response types shared across all domains.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/communications.js

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

package/dist/cjs/api/courses.js

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

package/dist/cjs/api/crm.js

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

package/dist/cjs/api/documentThreads.js

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

package/dist/cjs/api/documentations.js

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

package/dist/cjs/api/events.js

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

package/dist/cjs/api/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./serialized"), exports);
+__exportStar(require("./auth"), exports);
+__exportStar(require("./users"), exports);
+__exportStar(require("./students"), exports);
+__exportStar(require("./programs"), exports);
+__exportStar(require("./applications"), exports);
+__exportStar(require("./communications"), exports);
+__exportStar(require("./documentThreads"), exports);
+__exportStar(require("./interviews"), exports);
+__exportStar(require("./meetings"), exports);
+__exportStar(require("./tickets"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./teams"), exports);
+__exportStar(require("./documentations"), exports);
+__exportStar(require("./programRequirements"), exports);
+__exportStar(require("./courses"), exports);
+__exportStar(require("./crm"), exports);
+__exportStar(require("./account"), exports);
+__exportStar(require("./audit"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./portals"), exports);
+__exportStar(require("./notes"), exports);
+__exportStar(require("./permissions"), exports);
+__exportStar(require("./widgets"), exports);

package/dist/cjs/api/interviews.js

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

package/dist/cjs/api/meetings.js

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

package/dist/cjs/api/notes.js

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

package/dist/cjs/api/permissions.js

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

package/dist/cjs/api/portals.js

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

package/dist/cjs/api/programRequirements.js

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

package/dist/cjs/api/programs.js

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

package/dist/cjs/api/search.js

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

package/dist/cjs/api/serialized.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Serialized "API layer" versions of core model interfaces.
+ * All ObjectId refs become strings to match JSON API serialization.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/students.js

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

package/dist/cjs/api/teams.js

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

package/dist/cjs/api/tickets.js

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

package/dist/cjs/api/users.js

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

package/dist/cjs/api/widgets.js

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

package/dist/cjs/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./model"), exports);
+__exportStar(require("./api"), exports);

package/dist/esm/api/account.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/applications.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/audit.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/auth.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/common.js

@@ -0,0 +1,4 @@
+/**
+ * Common API response types shared across all domains.
+ */
+export {};

package/dist/esm/api/communications.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/courses.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/crm.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/documentThreads.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/documentations.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/events.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/index.js

@@ -0,0 +1,25 @@
+export * from './common';
+export * from './serialized';
+export * from './auth';
+export * from './users';
+export * from './students';
+export * from './programs';
+export * from './applications';
+export * from './communications';
+export * from './documentThreads';
+export * from './interviews';
+export * from './meetings';
+export * from './tickets';
+export * from './events';
+export * from './teams';
+export * from './documentations';
+export * from './programRequirements';
+export * from './courses';
+export * from './crm';
+export * from './account';
+export * from './audit';
+export * from './search';
+export * from './portals';
+export * from './notes';
+export * from './permissions';
+export * from './widgets';

package/dist/esm/api/interviews.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/meetings.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/notes.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/permissions.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/portals.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/programRequirements.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/programs.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/search.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/serialized.js

@@ -0,0 +1,5 @@
+/**
+ * Serialized "API layer" versions of core model interfaces.
+ * All ObjectId refs become strings to match JSON API serialization.
+ */
+export {};

package/dist/esm/api/students.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/teams.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/tickets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/users.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/widgets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -1 +1,2 @@
 export * from './model';
+export * from './api';

package/dist/types/api/account.d.ts

@@ -0,0 +1,48 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IStudentResponse, IUserAcademicBackgroundUniversity, IUserAcademicBackgroundLanguage, IUserApplicationPreference } from './serialized';
+/** POST /api/account/credentials */
+export type UpdateCredentialsResponse = SuccessResponse;
+/** POST /api/account/student/notifications */
+export type UpdateBannerResponse = SuccessResponse;
+/** POST /api/account/agent/notifications */
+export type UpdateAgentBannerResponse = SuccessResponse;
+/** Personal data subset returned after profile update */
+export interface PersonalDataSubset {
+    firstname?: string;
+    firstname_chinese?: string;
+    lastname?: string;
+    lastname_chinese?: string;
+    birthday?: string;
+    linkedIn?: string;
+    lineId?: string;
+}
+/** POST /api/account/profile/:user_id */
+export type UpdatePersonalDataResponse = ApiResponse<PersonalDataSubset>;
+/**
+ * POST /api/account/survey/university/:student_id
+ * Non-standard: returns data (university obj) + profile side-effect
+ */
+export interface UpdateAcademicBackgroundResponse {
+    success: boolean;
+    data?: IUserAcademicBackgroundUniversity;
+    profile?: unknown;
+}
+/**
+ * POST /api/account/survey/language/:student_id
+ * Non-standard: returns data (language obj) + profile side-effect
+ */
+export interface UpdateLanguageSkillResponse {
+    success: boolean;
+    data?: IUserAcademicBackgroundLanguage;
+    profile?: unknown;
+}
+/** POST /api/account/survey/preferences/:student_id */
+export type UpdateApplicationPreferenceResponse = ApiResponse<IUserApplicationPreference>;
+/** GET /api/account/survey */
+export type GetMyAcademicBackgroundResponse = ApiResponse<IStudentResponse>;
+/** GET /api/account/files/template */
+export type GetTemplatesResponse = ApiResponse<unknown[]>;
+/** POST /api/account/files/template/:category */
+export type UploadTemplateResponse = SuccessResponse;
+/** DELETE /api/account/files/template/:category */
+export type DeleteTemplateFileResponse = SuccessResponse;

package/dist/types/api/applications.d.ts

@@ -0,0 +1,64 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IApplicationWithId, IApplicationPopulated, IStudentResponse, IUserWithId, IProgramWithId } from './serialized';
+/** Per-program count used in admissions response */
+export interface ProgramCountItem {
+    program_id?: string;
+    count?: number;
+}
+/** GET /api/applications */
+export type GetApplicationsResponse = ApiResponse<IApplicationPopulated[]>;
+/**
+ * GET /api/applications/taiger-user/:userId
+ * Non-standard: data is an object, not an array
+ */
+export interface GetMyStudentsApplicationsResponse {
+    success: boolean;
+    data?: {
+        applications: IApplicationPopulated[];
+        user: IUserWithId;
+    };
+}
+/** GET /api/applications/all/active/applications */
+export type GetActiveStudentsApplicationsResponse = ApiResponse<IApplicationPopulated[]>;
+/** GET /api/applications/student/:studentId */
+export type GetStudentApplicationsResponse = ApiResponse<IStudentResponse>;
+/** POST /api/applications/student/:studentId */
+export type CreateApplicationResponse = ApiResponse<IApplicationWithId[]>;
+/** PUT /api/applications/student/:studentId */
+export type UpdateStudentApplicationsResponse = ApiResponse<IStudentResponse>;
+/** PUT /api/applications/student/:studentId/:application_id */
+export type UpdateApplicationResponse = ApiResponse<IApplicationWithId>;
+/** DELETE /api/applications/application/:applicationId */
+export type DeleteApplicationResponse = SuccessResponse;
+/** POST /api/applications/:applicationId/refresh */
+export type RefreshApplicationResponse = ApiResponse<IApplicationWithId>;
+/** Admission result summary from GET /api/admissions/overview */
+export interface AdmissionsOverviewData {
+    admission?: number;
+    rejection?: number;
+    pending?: number;
+    notYetSubmitted?: number;
+}
+/**
+ * GET /api/admissions
+ * Non-standard: also returns `result` (per-program counts) alongside `data`
+ */
+export interface GetAdmissionsResponse {
+    success: boolean;
+    data?: IApplicationPopulated[];
+    result?: ProgramCountItem[];
+}
+/** GET /api/admissions/overview */
+export type GetAdmissionsOverviewResponse = ApiResponse<AdmissionsOverviewData>;
+/** GET /api/student-applications/conflicts */
+export type GetApplicationConflictsResponse = ApiResponse<unknown>;
+/**
+ * GET /api/student-applications/deltas
+ * Returns per-program student delta arrays
+ */
+export type GetApplicationTaskDeltasResponse = ApiResponse<Array<{
+    program: IProgramWithId;
+    students: unknown[];
+}>>;
+/** POST /api/account/applications/result/:studentId/:applicationId/:programId/:result */
+export type UpdateStudentApplicationResultResponse = ApiResponse<IApplicationWithId>;

package/dist/types/api/audit.d.ts

@@ -0,0 +1,4 @@
+import type { ApiResponse } from './common';
+import type { IAuditWithId } from './serialized';
+/** GET /api/audit */
+export type GetAuditLogResponse = ApiResponse<IAuditWithId[]>;

package/dist/types/api/auth.d.ts

@@ -0,0 +1,23 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IUserWithId } from './serialized';
+/** GET /auth/verify */
+export interface AuthVerifyResponse {
+    success: boolean;
+    data?: IUserWithId;
+}
+/** POST /auth/login */
+export type AuthLoginResponse = ApiResponse<IUserWithId>;
+/** POST /auth/oauth/google/callback */
+export type AuthOAuthCallbackResponse = ApiResponse<IUserWithId>;
+/** POST /auth/signup */
+export type AuthRegisterResponse = SuccessResponse;
+/** POST /auth/forgot-password */
+export type ForgotPasswordResponse = SuccessResponse;
+/** POST /auth/reset-password */
+export type ResetPasswordResponse = SuccessResponse;
+/** POST /auth/activation */
+export type ActivationResponse = SuccessResponse;
+/** POST /auth/resend-activation */
+export type ResendActivationResponse = SuccessResponse;
+/** GET /auth/logout */
+export type LogoutResponse = SuccessResponse;

package/dist/types/api/common.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Common API response types shared across all domains.
+ */
+/** Base response for mutation endpoints that return no data payload */
+export interface SuccessResponse {
+    success: boolean;
+    message?: string;
+}
+/** Generic API response wrapper used by most backend endpoints */
+export interface ApiResponse<T = unknown> extends SuccessResponse {
+    data?: T;
+}
+/** Paginated list response */
+export interface PaginatedResponse<T> extends ApiResponse<T[]> {
+    total?: number;
+}
+export type StudentId = string;
+export type ApplicationId = string;
+export type UserId = string;
+export type ProgramId = string;
+export type DocumentThreadId = string;
+export type MessageId = string;
+export type SurveyId = string;
+export type EventId = string;
+export type TicketId = string;
+export type MeetingId = string;
+export type InterviewId = string;
+export type LeadId = string;
+export type CourseId = string;
+export type KeywordsSetId = string;

package/dist/types/api/communications.d.ts

@@ -0,0 +1,18 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { ICommunicationWithId } from './serialized';
+/** GET /api/communications/:studentId */
+export type GetCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+/** GET /api/communications/all */
+export type GetMyCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+/** GET /api/communications/ping/all */
+export type GetCommunicationUnreadNumberResponse = ApiResponse<number>;
+/** POST /api/communications/:studentId */
+export type PostCommunicationResponse = ApiResponse<ICommunicationWithId>;
+/** GET /api/communications/:studentId/pages/:pageNumber */
+export type LoadCommunicationThreadResponse = ApiResponse<ICommunicationWithId[]>;
+/** PUT /api/communications/:communication_id/:communication_messageId */
+export type UpdateCommunicationMessageResponse = ApiResponse<ICommunicationWithId>;
+/** DELETE /api/communications/:student_id/:communication_messageId */
+export type DeleteCommunicationMessageResponse = SuccessResponse;
+/** PUT /api/communications/:student_id/:communication_messageId/:ignoreMessageState/ignore */
+export type IgnoreCommunicationMessageResponse = ApiResponse<ICommunicationWithId>;

package/dist/types/api/courses.d.ts

@@ -0,0 +1,27 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IAllCourseWithId, IKeywordsetWithId } from './serialized';
+import type { ICourse } from '../model/Course';
+/** GET /api/all-courses */
+export type GetAllCoursesResponse = ApiResponse<IAllCourseWithId[]>;
+/** GET /api/all-courses/:courseId */
+export type GetAllCourseResponse = ApiResponse<IAllCourseWithId>;
+/** POST /api/all-courses */
+export type CreateAllCourseResponse = ApiResponse<IAllCourseWithId>;
+/** PUT /api/all-courses/:courseId */
+export type UpdateAllCourseResponse = ApiResponse<IAllCourseWithId>;
+/** DELETE /api/all-courses/:courseId */
+export type DeleteAllCourseResponse = SuccessResponse;
+/** GET /api/course-keywords */
+export type GetCourseKeywordsetsResponse = ApiResponse<IKeywordsetWithId[]>;
+/** GET /api/course-keywords/:keywordsSetId */
+export type GetCourseKeywordsetResponse = ApiResponse<IKeywordsetWithId>;
+/** POST /api/course-keywords/new */
+export type CreateKeywordsetResponse = ApiResponse<IKeywordsetWithId>;
+/** PUT /api/course-keywords/:keywordsSetId */
+export type UpdateKeywordsetResponse = ApiResponse<IKeywordsetWithId>;
+/** DELETE /api/course-keywords/:keywordsSetId */
+export type DeleteKeywordsetResponse = SuccessResponse;
+/** GET /api/courses/:student_id */
+export type GetStudentCoursesResponse = ApiResponse<ICourse>;
+/** PUT /api/courses/:student_id */
+export type UpdateStudentCoursesResponse = ApiResponse<ICourse>;

package/dist/types/api/crm.d.ts

@@ -0,0 +1,107 @@
+import type { ApiResponse, SuccessResponse } from './common';
+/**
+ * CRM-specific types.
+ * The CRM module uses a relational database (PostgreSQL), not MongoDB,
+ * so all types are defined purely from the API response shape.
+ */
+/** A CRM lead record */
+export interface CRMLeadItem {
+    id?: string;
+    fullName?: string;
+    source?: string;
+    email?: string;
+    phone?: string;
+    status?: string;
+    closeLikelihood?: string | number;
+    intendedStartTime?: string;
+    intendedProgramLevel?: string;
+    intendedDirection?: string;
+    salesRep?: string;
+    salesNote?: string;
+    meetingCount?: number;
+    createdAt?: string | Date;
+    [key: string]: unknown;
+}
+/** A CRM lead with its associated meetings */
+export interface CRMLeadWithMeetings extends CRMLeadItem {
+    meetings?: CRMMeetingItem[];
+}
+/** A CRM meeting record */
+export interface CRMMeetingItem {
+    id?: string;
+    leadId?: string;
+    leadFullName?: string;
+    dateTime?: string | Date;
+    summary?: string;
+    meetingLink?: string;
+    [key: string]: unknown;
+}
+/** A CRM deal record */
+export interface CRMDealItem {
+    id?: string;
+    dealDataCols?: unknown;
+    leadFullName?: string;
+    salesLabel?: string;
+    [key: string]: unknown;
+}
+/** A CRM sales representative */
+export interface CRMSalesRep {
+    id?: string;
+    name?: string;
+    email?: string;
+    [key: string]: unknown;
+}
+/** CRM statistics summary */
+export interface CRMStatsData {
+    totalLeadCount?: number;
+    recentLeadCount?: number;
+    convertedLeadCount?: number;
+    totalMeetingCount?: number;
+    recentMeetingCount?: number;
+    avgResponseTimeDays?: number;
+    p50ResponseTimeDays?: number;
+    p95ResponseTimeDays?: number;
+    avgSalesCycleDays?: number;
+    p50SalesCycleDays?: number;
+    p95SalesCycleDays?: number;
+    leadsCountByDate?: unknown[];
+    meetingCountByDate?: unknown[];
+    totalLeadsWithMeeting?: number;
+    totalLeadsWithFollowUp?: number;
+}
+/** GET /api/crm/stats */
+export type GetCRMStatsResponse = ApiResponse<CRMStatsData>;
+/** GET /api/crm/leads */
+export type GetCRMLeadsResponse = ApiResponse<CRMLeadItem[]>;
+/** GET /api/crm/leads/:leadId */
+export type GetCRMLeadResponse = ApiResponse<CRMLeadWithMeetings>;
+/** GET /api/crm/students/:userId/lead */
+export type GetLeadIdByUserIdResponse = ApiResponse<{
+    id: string;
+}>;
+/**
+ * POST /api/crm/students/:userId/lead
+ * Non-standard: includes matchingMeetingCounts alongside data
+ */
+export interface CreateLeadFromStudentResponse {
+    success: boolean;
+    message?: string;
+    matchingMeetingCounts?: number;
+    data?: CRMLeadItem;
+}
+/** GET /api/crm/meetings */
+export type GetCRMMeetingsResponse = ApiResponse<CRMMeetingItem[]>;
+/** GET /api/crm/meetings/:meetingId */
+export type GetCRMMeetingResponse = ApiResponse<CRMMeetingItem>;
+/** PUT /api/crm/meetings/:meetingId */
+export type UpdateCRMMeetingResponse = ApiResponse<CRMMeetingItem>;
+/** GET /api/crm/deals */
+export type GetCRMDealsResponse = ApiResponse<CRMDealItem[]>;
+/** POST /api/crm/deals */
+export type CreateCRMDealResponse = ApiResponse<CRMDealItem>;
+/** PUT /api/crm/deals/:dealId */
+export type UpdateCRMDealResponse = ApiResponse<CRMDealItem>;
+/** GET /api/crm/sales-reps */
+export type GetCRMSalesRepsResponse = ApiResponse<CRMSalesRep[]>;
+/** POST /api/crm/instant-invite */
+export type InstantInviteResponse = SuccessResponse;