@taiger-common/model 1.0.49 → 1.0.51

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

@@ -0,0 +1,66 @@
+import type { ApiResponse } from './common';
+import type { IUserWithId, IStudentResponse } from './serialized';
+/** Agent–student distribution item used in statistics */
+export interface AgentStudentDistributionItem {
+    agent_id?: string;
+    firstname?: string;
+    lastname?: string;
+    studentCount?: number;
+}
+/** Statistics overview payload */
+export interface StatisticsOverviewData {
+    documents?: unknown;
+    agents_data?: unknown[];
+    editors_data?: unknown[];
+    students_years_pair?: unknown[];
+    students_creation_dates?: unknown;
+}
+/** Statistics KPI payload */
+export interface StatisticsKPIData {
+    finished_docs?: unknown[];
+}
+/** Statistics response-time payload */
+export interface StatisticsResponseTimeData {
+    agents_data?: unknown[];
+    editors_data?: unknown[];
+    studentAvgResponseTime?: unknown[];
+}
+/** Tasks overview payload */
+export interface TasksOverviewData {
+    noAgentsStudents?: number;
+    noEditorsStudents?: number;
+    noTrainerInInterviewsStudents?: number;
+    noEssayWritersEssays?: number;
+}
+/** GET /api/teams */
+export type GetTeamMembersResponse = ApiResponse<IUserWithId[]>;
+/** GET /api/teams/archiv/:TaiGerStaffId */
+export type GetArchivStudentsResponse = ApiResponse<IStudentResponse[]>;
+/** GET /api/teams/statistics/overview */
+export type GetStatisticsOverviewResponse = ApiResponse<StatisticsOverviewData>;
+/**
+ * GET /api/teams/statistics/agents
+ * Non-standard: returns agentStudentDistribution at top level
+ */
+export interface GetStatisticsAgentsResponse {
+    success: boolean;
+    agentStudentDistribution?: AgentStudentDistributionItem[];
+}
+/** GET /api/teams/statistics */
+export type GetStatisticsV2Response = ApiResponse<unknown>;
+/** GET /api/teams/statistics/kpi */
+export type GetStatisticsKPIResponse = ApiResponse<StatisticsKPIData>;
+/** GET /api/teams/statistics/response-time */
+export type GetStatisticsResponseTimeResponse = ApiResponse<StatisticsResponseTimeData>;
+/** GET /api/teams/tasks-overview */
+export type GetTasksOverviewResponse = ApiResponse<TasksOverviewData>;
+/** GET /api/teams/is-manager */
+export type GetIsManagerResponse = ApiResponse<{
+    isManager: boolean;
+}>;
+/** GET /api/agents/profile/:agent_id */
+export type GetAgentProfileResponse = ApiResponse<IUserWithId>;
+/** GET /api/teams/response-interval/:studentId */
+export type GetResponseIntervalByStudentResponse = ApiResponse<IStudentResponse>;
+/** GET /api/essay-writers */
+export type GetEssayWritersTeamsResponse = ApiResponse<IUserWithId[]>;

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

@@ -0,0 +1,26 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { ITicketWithId, IComplaintWithId } from './serialized';
+/** GET /api/tickets */
+export type GetProgramTicketsResponse = ApiResponse<ITicketWithId[]>;
+/** GET /api/tickets?type=&program_id= (single ticket) */
+export type GetProgramTicketResponse = ApiResponse<ITicketWithId[]>;
+/** POST /api/tickets/ */
+export type CreateTicketResponse = ApiResponse<ITicketWithId>;
+/** PUT /api/tickets/:ticket_id */
+export type UpdateTicketResponse = ApiResponse<ITicketWithId>;
+/** DELETE /api/tickets/:ticket_id */
+export type DeleteTicketResponse = SuccessResponse;
+/** GET /api/complaints */
+export type GetComplaintsResponse = ApiResponse<IComplaintWithId[]>;
+/** GET /api/complaints/:ticketId */
+export type GetComplaintResponse = ApiResponse<IComplaintWithId>;
+/** POST /api/complaints/ */
+export type CreateComplaintResponse = ApiResponse<IComplaintWithId>;
+/** PUT /api/complaints/:ticketId */
+export type UpdateComplaintResponse = ApiResponse<IComplaintWithId>;
+/** POST /api/complaints/new-message/:ticketId/:studentId */
+export type PostMessageInComplaintResponse = ApiResponse<IComplaintWithId>;
+/** DELETE /api/complaints/:ticketId/:message_id */
+export type DeleteMessageInComplaintResponse = SuccessResponse;
+/** DELETE /api/complaints/:ticketId */
+export type DeleteComplaintResponse = SuccessResponse;

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

@@ -0,0 +1,51 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { IUserWithId } from './serialized';
+/** Shape of the users count summary returned by GET /api/users/count */
+export interface UsersCountData {
+    totalUsers?: number;
+    studentCount?: number;
+    agentCount?: number;
+    editorCount?: number;
+    externalCount?: number;
+    adminCount?: number;
+    guestCount?: number;
+}
+/** GET /api/users/count */
+export interface GetUsersCountResponse extends UsersCountData {
+    success?: boolean;
+    [key: string]: unknown;
+}
+/** A single metric breakdown item (e.g. by degree, by language) */
+export interface UsersOverviewMetricItem {
+    count: number;
+    [key: string]: unknown;
+}
+/** Shape of data returned by GET /api/users/overview */
+export interface UsersOverviewData {
+    byTargetDegree?: UsersOverviewMetricItem[];
+    byApplicationSemester?: UsersOverviewMetricItem[];
+    byTargetField?: UsersOverviewMetricItem[];
+    byProgramLanguage?: UsersOverviewMetricItem[];
+    byUniversity?: UsersOverviewMetricItem[];
+    generatedAt?: Date;
+}
+/** GET /api/users/overview */
+export type GetUsersOverviewResponse = ApiResponse<UsersOverviewData>;
+/** GET /api/users */
+export type GetUsersResponse = ApiResponse<IUserWithId[]>;
+/** GET /api/users/:user_id */
+export type GetUserResponse = ApiResponse<IUserWithId>;
+/** POST /api/users (add user) — returns full user list + new user id */
+export interface AddUserResponse {
+    success: boolean;
+    data: IUserWithId[];
+    newUser: string;
+}
+/** POST /api/users/:id (update user) */
+export type UpdateUserResponse = ApiResponse<IUserWithId>;
+/** DELETE /api/users/:id */
+export type DeleteUserResponse = SuccessResponse;
+/** POST /api/users/archiv/:user_id */
+export type UpdateArchivUserResponse = ApiResponse<IUserWithId[]>;
+/** GET /api/essay-writers */
+export type GetEssayWritersResponse = ApiResponse<IUserWithId[]>;

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

@@ -0,0 +1,29 @@
+import type { ApiResponse, SuccessResponse } from './common';
+import type { ICourseAnalysis } from '../model/Course';
+/** POST /api/widgets/transcript/engine/v2/:language — returns analysis metadata */
+export type WidgetTranscriptResponse = ApiResponse<ICourseAnalysis>;
+/**
+ * GET /api/widgets/transcript/v2/:adminId
+ * Non-standard: returns json payload + fileKey alongside success
+ */
+export interface WidgetDownloadJsonResponse {
+    success: boolean;
+    json?: unknown;
+    fileKey?: string;
+}
+/** GET /api/widgets/messages/export/:student_id — returns PDF blob (non-JSON) */
+export type WidgetExportPDFResponse = SuccessResponse;
+/** POST /api/taigerai/general — streaming or standard AI response */
+export type TaigerAiResponse = ApiResponse<string>;
+/** GET /api/taigerai/program/:programId */
+export type ProcessProgramListResponse = SuccessResponse;
+/** POST /api/taigerai/cvmlrl */
+export type CvmlrlAiResponse = ApiResponse<string>;
+/** POST /api/taigerai/chat/:studentId */
+export type TaigerChatAssistantResponse = ApiResponse<string>;
+/** POST /api/courses/transcript/v2/:studentId/:language */
+export type TranscriptAnalyserResponse = ApiResponse<ICourseAnalysis>;
+/** GET /api/courses/transcript/v2/:user_id */
+export type AnalyzedFileDownloadResponse = WidgetDownloadJsonResponse;
+/** GET /api/expenses/users/:taiger_user_id */
+export type GetExpenseResponse = ApiResponse<unknown>;

package/dist/types/index.d.ts

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

package/dist/types/model/Allcourse.d.ts

@@ -24,8 +24,9 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
 export interface IAllCourse {
-    updatedBy: Schema.Types.ObjectId;
+    updatedBy: IUser | Schema.Types.ObjectId | string;
     all_course_chinese: string;
     all_course_english: string;
     description: string;

package/dist/types/model/Application.d.ts

@@ -24,6 +24,8 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IProgram } from './Program';
+import { IStudent } from './User';
 export interface IApplicationUniAssist {
     status?: string;
     vpd_file_path?: string;
@@ -56,8 +58,8 @@ export interface IApplicationAdmissionLetter {
     updatedAt?: Date;
 }
 export interface IApplication {
-    programId?: Schema.Types.ObjectId;
-    studentId?: Schema.Types.ObjectId;
+    programId?: IProgram | Schema.Types.ObjectId | string;
+    studentId?: IStudent | Schema.Types.ObjectId | string;
     uni_assist?: IApplicationUniAssist;
     portal_credentials?: IApplicationPortalCredentials;
     doc_modification_thread?: IApplicationDocModificationThreadItem[];

package/dist/types/model/Audit.d.ts

@@ -24,11 +24,14 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
+import { IDocumentthread } from './Documentthread';
+import { IInterview } from './Interview';
 export interface IAudit {
-    performedBy?: Schema.Types.ObjectId;
-    targetUserId?: Schema.Types.ObjectId;
-    targetDocumentThreadId?: Schema.Types.ObjectId;
-    interviewThreadId?: Schema.Types.ObjectId;
+    performedBy?: IUser | Schema.Types.ObjectId | string;
+    targetUserId?: IUser | Schema.Types.ObjectId | string;
+    targetDocumentThreadId?: IDocumentthread | Schema.Types.ObjectId | string;
+    interviewThreadId?: IInterview | Schema.Types.ObjectId | string;
     action?: string;
     field?: string;
     changes?: {

package/dist/types/model/Communication.d.ts

@@ -24,21 +24,23 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
+import { IStudent } from './User';
 export interface ICommunicationFile {
     name: string;
     path: string;
 }
 export interface ICommunication {
-    student_id?: Schema.Types.ObjectId;
-    user_id?: Schema.Types.ObjectId;
+    student_id?: IStudent | Schema.Types.ObjectId | string;
+    user_id?: IUser | Schema.Types.ObjectId | string;
     message?: string;
-    readBy?: Schema.Types.ObjectId[];
+    readBy?: IUser[] | Schema.Types.ObjectId[] | string[];
     timeStampReadBy?: Schema.Types.Mixed;
     files?: ICommunicationFile[];
     createdAt?: Date;
     ignore_message?: boolean;
     ignoredMessageUpdatedAt?: Date;
-    ignoredMessageBy?: Schema.Types.ObjectId;
+    ignoredMessageBy?: IUser | Schema.Types.ObjectId | string;
 }
 export declare const communicationsSchema: Schema<ICommunication, import("mongoose").Model<ICommunication, any, any, any, import("mongoose").Document<unknown, any, ICommunication> & ICommunication & {
     _id: import("mongoose").Types.ObjectId;

package/dist/types/model/Complaint.d.ts

@@ -24,19 +24,20 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
 export interface IComplaintMessageFile {
     name: string;
     path: string;
 }
 export interface IComplaintMessage {
-    user_id?: Schema.Types.ObjectId;
+    user_id?: IUser | Schema.Types.ObjectId | string;
     message?: string;
     createdAt?: Date;
     file?: IComplaintMessageFile[];
     ignore_message?: boolean;
 }
 export interface IComplaint {
-    requester_id: Schema.Types.ObjectId;
+    requester_id: IUser | Schema.Types.ObjectId | string;
     status?: string;
     title?: string;
     category?: string;

package/dist/types/model/Documentthread.d.ts

@@ -24,31 +24,35 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
+import { IStudent } from './User';
+import { IProgram } from './Program';
+import { IApplication } from './Application';
 export interface IDocumentthreadMessageFile {
     name: string;
     path: string;
 }
 export interface IDocumentthreadMessage {
-    user_id?: Schema.Types.ObjectId;
+    user_id?: IUser | Schema.Types.ObjectId | string;
     message?: string;
     createdAt?: Date;
     file?: IDocumentthreadMessageFile[];
     ignore_message?: boolean;
 }
 export interface IDocumentthread {
-    student_id: Schema.Types.ObjectId;
-    program_id?: Schema.Types.ObjectId;
-    application_id?: Schema.Types.ObjectId;
-    outsourced_user_id?: Schema.Types.ObjectId[];
-    pin_by_user_id?: Schema.Types.ObjectId[];
-    flag_by_user_id?: Schema.Types.ObjectId[];
+    student_id: IStudent | Schema.Types.ObjectId | string;
+    program_id?: IProgram | Schema.Types.ObjectId | string;
+    application_id?: IApplication | Schema.Types.ObjectId | string;
+    outsourced_user_id?: IUser[] | Schema.Types.ObjectId[] | string[];
+    pin_by_user_id?: IUser[] | Schema.Types.ObjectId[] | string[];
+    flag_by_user_id?: IUser[] | Schema.Types.ObjectId[] | string[];
     file_type: string;
     isFinalVersion?: boolean;
     isOriginAuthorDeclarationConfirmedByStudent?: boolean;
     isOriginAuthorDeclarationConfirmedByStudentTimestamp?: Date;
     messages?: IDocumentthreadMessage[];
     isEssayConsultantNeeded?: boolean;
-    essayConsultantIds?: Schema.Types.ObjectId[];
+    essayConsultantIds?: IUser[] | Schema.Types.ObjectId[] | string[];
     updatedAt?: Date;
 }
 export declare const documentThreadsSchema: Schema<IDocumentthread, import("mongoose").Model<IDocumentthread, any, any, any, import("mongoose").Document<unknown, any, IDocumentthread> & IDocumentthread & {

package/dist/types/model/Event.d.ts

@@ -24,9 +24,10 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
 export interface IEvent {
-    requester_id?: Schema.Types.ObjectId[];
-    receiver_id?: Schema.Types.ObjectId[];
+    requester_id?: IUser[] | Schema.Types.ObjectId[] | string[];
+    receiver_id?: IUser[] | Schema.Types.ObjectId[] | string[];
     isConfirmedRequester?: boolean;
     isConfirmedReceiver?: boolean;
     meetingLink?: string;

package/dist/types/model/Interview.d.ts

@@ -24,12 +24,17 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
+import { IStudent } from './User';
+import { IProgram } from './Program';
+import { IDocumentthread } from './Documentthread';
+import { IEvent } from './Event';
 export interface IInterview {
-    student_id?: Schema.Types.ObjectId;
-    trainer_id?: Schema.Types.ObjectId[];
-    thread_id?: Schema.Types.ObjectId;
-    program_id?: Schema.Types.ObjectId;
-    event_id?: Schema.Types.ObjectId;
+    student_id?: IStudent | Schema.Types.ObjectId | string;
+    trainer_id?: IUser[] | Schema.Types.ObjectId[] | string[];
+    thread_id?: IDocumentthread | Schema.Types.ObjectId | string;
+    program_id?: IProgram | Schema.Types.ObjectId | string;
+    event_id?: IEvent | Schema.Types.ObjectId | string;
     interview_description?: string;
     interviewer?: string;
     interview_duration?: string;

package/dist/types/model/InterviewSurveyResponse.d.ts

@@ -24,14 +24,17 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IStudent } from './User';
+import { IProgram } from './Program';
+import { IInterview } from './Interview';
 export interface IInterviewSurveyResponseResponse {
     questionId?: string;
     answer?: number;
 }
 export interface IInterviewSurveyResponse {
-    student_id?: Schema.Types.ObjectId;
-    interview_id?: Schema.Types.ObjectId;
-    program_id?: Schema.Types.ObjectId;
+    student_id?: IStudent | Schema.Types.ObjectId | string;
+    interview_id?: IInterview | Schema.Types.ObjectId | string;
+    program_id?: IProgram | Schema.Types.ObjectId | string;
     responses?: IInterviewSurveyResponseResponse[];
     isFinal?: boolean;
     interviewQuestions?: string;

package/dist/types/model/Note.d.ts

@@ -24,8 +24,9 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IStudent } from './User';
 export interface INote {
-    student_id?: Schema.Types.ObjectId;
+    student_id?: IStudent | Schema.Types.ObjectId | string;
     notes?: string;
     updatedAt?: Date;
 }

package/dist/types/model/Permission.d.ts

@@ -24,8 +24,9 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
 export interface IPermission {
-    user_id?: Schema.Types.ObjectId;
+    user_id?: IUser | Schema.Types.ObjectId | string;
     taigerAiQuota?: number;
     canAssignEditors?: boolean;
     canUseTaiGerAI?: boolean;

package/dist/types/model/ResponseTime.d.ts

@@ -24,9 +24,11 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IDocumentthread } from './Documentthread';
+import { IStudent } from './User';
 export interface IResponseTime {
-    thread_id?: Schema.Types.ObjectId;
-    student_id?: Schema.Types.ObjectId;
+    thread_id?: IDocumentthread | Schema.Types.ObjectId | string;
+    student_id?: IStudent | Schema.Types.ObjectId | string;
     interval_type: string;
     intervalAvg: number;
     updatedAt?: Date;

package/dist/types/model/SurveyInput.d.ts

@@ -24,6 +24,8 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IStudent } from './User';
+import { IProgram } from './Program';
 export interface ISurveyInputSurveyContent {
     questionId?: string;
     question?: string;
@@ -32,8 +34,8 @@ export interface ISurveyInputSurveyContent {
     contentType?: string;
 }
 export interface ISurveyInput {
-    studentId: Schema.Types.ObjectId;
-    programId?: Schema.Types.ObjectId;
+    studentId: IStudent | Schema.Types.ObjectId | string;
+    programId?: IProgram | Schema.Types.ObjectId | string;
     fileType: string;
     isFinalVersion?: boolean;
     surveyContent?: ISurveyInputSurveyContent[];

package/dist/types/model/Ticket.d.ts

@@ -24,10 +24,12 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
+import { IProgram } from './Program';
 export interface ITicket {
-    requester_id: Schema.Types.ObjectId;
-    resolver_id?: Schema.Types.ObjectId;
-    program_id?: Schema.Types.ObjectId;
+    requester_id: IUser | Schema.Types.ObjectId | string;
+    resolver_id?: IUser | Schema.Types.ObjectId | string;
+    program_id?: IProgram | Schema.Types.ObjectId | string;
     status?: string;
     type?: string;
     description?: string;

package/dist/types/model/Token.d.ts

@@ -24,8 +24,9 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Schema } from 'mongoose';
+import { IUser } from './User';
 export interface IToken {
-    userId: Schema.Types.ObjectId;
+    userId: IUser | Schema.Types.ObjectId | string;
     value: string;
     createdAt?: Date;
 }