@jobsearch-works/firestore-models 4.3.3 → 4.3.5

package/dist/index.d.mts

@@ -560,11 +560,22 @@ interface AuthUser {
     deletedAt?: Date;
 }
 
-interface Companies {
+/**
+ * Company - Represents a company being monitored for job vacancies
+ * Path: companies/{companyId}
+ */
+interface Company {
     companyId?: string;
     name: string;
     careersUrl: string;
-    location: string;
+    checkCount?: number;
+    industry?: string;
+    lastChecked?: Date | string;
+    lastFoundJobs?: number;
+    platform?: string;
+    status?: "active" | "inactive" | "paused";
+    totalJobsFound?: number;
+    createdAt?: Date | string;
 }
 
 interface UserPublic {
@@ -766,6 +777,30 @@ interface ClientResume {
     additional_info: string;
 }
 
+/**
+ * Application Note - Activity log entry stored as array item in Application document
+ * Stored in: Application.notes[]
+ *
+ * Tracks all actions and changes made to an application with timestamps.
+ * Examples: status changes, withdrawals, manual interventions, etc.
+ */
+interface ApplicationNote {
+    /** Type of action/note */
+    type: "status_change" | "withdrawal" | "manual_intervention" | "note" | "other";
+    /** Human-readable message describing the action */
+    message: string;
+    /** Previous status (if status change) */
+    previousStatus?: string;
+    /** New status (if status change) */
+    newStatus?: string;
+    /** User who performed the action (clientId or admin userId) */
+    performedBy?: string;
+    /** Additional metadata */
+    metadata?: Record<string, any>;
+    /** Timestamp when the note was created */
+    createdAt: Date | string;
+}
+
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -820,6 +855,7 @@ interface Application {
     fullPageText?: string;
     requiresHumanVerification?: boolean;
     verificationType?: string;
+    notes?: ApplicationNote[];
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -1276,4 +1312,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationPeriodStats, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunLogEntry, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStats, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, EMAIL_CATEGORIES, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, GmailOAuthSession, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };
+export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationNote, ApplicationPeriodStats, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunLogEntry, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStats, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Company, EMAIL_CATEGORIES, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, GmailOAuthSession, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };

package/dist/index.d.ts

@@ -560,11 +560,22 @@ interface AuthUser {
     deletedAt?: Date;
 }
 
-interface Companies {
+/**
+ * Company - Represents a company being monitored for job vacancies
+ * Path: companies/{companyId}
+ */
+interface Company {
     companyId?: string;
     name: string;
     careersUrl: string;
-    location: string;
+    checkCount?: number;
+    industry?: string;
+    lastChecked?: Date | string;
+    lastFoundJobs?: number;
+    platform?: string;
+    status?: "active" | "inactive" | "paused";
+    totalJobsFound?: number;
+    createdAt?: Date | string;
 }
 
 interface UserPublic {
@@ -766,6 +777,30 @@ interface ClientResume {
     additional_info: string;
 }
 
+/**
+ * Application Note - Activity log entry stored as array item in Application document
+ * Stored in: Application.notes[]
+ *
+ * Tracks all actions and changes made to an application with timestamps.
+ * Examples: status changes, withdrawals, manual interventions, etc.
+ */
+interface ApplicationNote {
+    /** Type of action/note */
+    type: "status_change" | "withdrawal" | "manual_intervention" | "note" | "other";
+    /** Human-readable message describing the action */
+    message: string;
+    /** Previous status (if status change) */
+    previousStatus?: string;
+    /** New status (if status change) */
+    newStatus?: string;
+    /** User who performed the action (clientId or admin userId) */
+    performedBy?: string;
+    /** Additional metadata */
+    metadata?: Record<string, any>;
+    /** Timestamp when the note was created */
+    createdAt: Date | string;
+}
+
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -820,6 +855,7 @@ interface Application {
     fullPageText?: string;
     requiresHumanVerification?: boolean;
     verificationType?: string;
+    notes?: ApplicationNote[];
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -1276,4 +1312,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationPeriodStats, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunLogEntry, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStats, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, EMAIL_CATEGORIES, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, GmailOAuthSession, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };
+export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationNote, ApplicationPeriodStats, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunLogEntry, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStats, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Company, EMAIL_CATEGORIES, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, GmailOAuthSession, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobsearch-works/firestore-models",
-  "version": "4.3.3",
+  "version": "4.3.5",
   "description": "A shared library for standardizing Firestore document schemas and paths across multiple projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",