@jobsearch-works/firestore-models 2.3.0 → 2.4.0

package/dist/index.d.mts

@@ -529,6 +529,13 @@ interface Agent {
     readonly updatedAt?: Date | string;
 }
 
+/**
+ * Document under authEmails/{authEmail}
+ */
+interface AuthEmail {
+    UID: string;
+}
+
 interface AuthUser {
     id?: string;
     email: string;
@@ -556,24 +563,6 @@ interface UserPublic {
     updatedAt?: Date | string;
 }
 
-interface VacancyExtractedForm {
-    fields: VacancyExtractedField[];
-    formSelector: string;
-    submitButtonSelector: string;
-    url: string;
-    extractedAt: Date | string;
-}
-interface VacancyExtractedField {
-    id?: string;
-    type: string;
-    name: string;
-    label: string;
-    selector: string;
-    options: string[] | null;
-    required: boolean;
-    value?: string;
-}
-
 declare const VacancyCategory: {
     readonly Accounting: "Accounting";
     readonly AdministrationAndOfficeSupport: "Administration & Office Support";
@@ -621,7 +610,6 @@ interface Vacancy {
     jobId: string;
     category: VacancyCategory;
     suggestedTo?: string[];
-    extractedForm?: VacancyExtractedForm;
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -634,34 +622,6 @@ interface VacancySuggestion {
     createdAt?: Date | string;
 }
 
-/**
- * Document under authEmails/{authEmail}
- */
-interface AuthEmail {
-    UID: string;
-}
-
-interface ApplicationEnrichedForm {
-    fields: ApplicationEnrichedField[];
-    formSelector: string;
-    submitButtonSelector: string;
-    url: string;
-    enrichedAt: Date | string;
-}
-interface ApplicationEnrichedField {
-    id: string;
-    name: string;
-    label: string;
-    type: string;
-    value: string;
-    confidence: number;
-    response?: string;
-    selector?: string;
-    required?: boolean;
-    options?: string[] | null;
-    needsClientReview?: boolean;
-}
-
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -690,7 +650,6 @@ interface Application {
     applyingAt?: Date | string;
     suggestedAt?: Date | string;
     approvedAt?: Date | string;
-    enrichedForm?: ApplicationEnrichedForm;
     company?: string;
     position?: string;
     location?: string;
@@ -714,6 +673,8 @@ interface ApplicationQuestion {
     type: ApplicationQuestionType;
     createdAt?: Date | string;
     updatedAt?: Date | string;
+    selector?: string;
+    action?: string;
 }
 
 interface ClientLanguage {
@@ -801,6 +762,9 @@ interface ClientPersonalData {
     countryPhoneCode: string;
     nationality: string;
     dateOfBirth?: Date | string;
+    ethnicity?: string;
+    disabilityStatus?: string;
+    securityClearance?: string;
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -851,28 +815,6 @@ interface ClientInitialQuestion {
     answerText: string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
- * @see Client - Parent document
- * @see Application - Related application
- */
-interface ClientVirtualInterview {
-    readonly id?: string;
-    jobTitle: string;
-    company: string;
-    role: string;
-    date: string;
-    clientId: string;
-    messages: Array<{
-        sender: 'user' | 'interviewer' | 'feedback';
-        text: string;
-        timestamp: string;
-        duration?: number;
-        audioUrl?: string;
-    }>;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/logins/{docId}
@@ -949,6 +891,28 @@ interface ClientResume {
     }>;
 }
 
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
+ * @see Client - Parent document
+ * @see Application - Related application
+ */
+interface ClientVirtualInterview {
+    readonly id?: string;
+    jobTitle: string;
+    company: string;
+    role: string;
+    date: string;
+    clientId: string;
+    messages: Array<{
+        sender: 'user' | 'interviewer' | 'feedback';
+        text: string;
+        timestamp: string;
+        duration?: number;
+        audioUrl?: string;
+    }>;
+}
+
 /**
  * Subcollection document under clients/{userId}/access_tokens/{provider}
  */
@@ -966,7 +930,8 @@ interface ClientAccessToken {
  * Subcollection document under clients/{userId}/emails/{emailId}
  * For new email structure
  */
-interface ClientEmailV2 {
+type EmailCategory = "One Time Pin" | "Spam" | "Job Interview" | "Job Rejection" | "Require More Info" | "Job Suggestions" | "Uncategorised";
+interface ClientEmail {
     bcc: string[];
     cc: string[];
     to: string[];
@@ -980,24 +945,7 @@ interface ClientEmailV2 {
     thread_id: string;
     timestamp: number;
     labels: string[];
-}
-
-/**
- * Subcollection document under clients/{userId}/emails/{emailId}/analysed/general
- */
-interface EmailAnalysedGeneral {
-    category: string;
-    date: string;
-    job_response: boolean;
-    suggested_action: string;
-}
-
-/**
- * Subcollection document under clients/{userId}/emails/{emailId}/analysed/classified
- * All fields are dynamic.
- */
-interface EmailAnalysedClassified {
-    [key: string]: any;
+    categories: EmailCategory[];
 }
 
 type FirestoreTimestamp = {
@@ -1016,10 +964,6 @@ declare const firestorePaths: {
         readonly emails: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, emailId: string) => string;
-            readonly analysed: {
-                readonly collection: (clientId: string, emailId: string) => string;
-                readonly doc: (clientId: string, emailId: string, analysedType: "general" | "classified") => string;
-            };
         };
         readonly questions: {
             readonly collection: (clientId: string) => string;
@@ -1078,10 +1022,14 @@ declare const firestorePaths: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
     };
+    readonly companies: {
+        readonly collection: () => string;
+        readonly doc: (companyId: string) => string;
+    };
     readonly authEmails: {
         readonly collection: () => string;
         readonly doc: (authEmail: string) => string;
     };
 };
 
-export { Agent, AgentStatus, Application, ApplicationEnrichedField, ApplicationEnrichedForm, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientEducation, ClientEmailV2, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, EmailAnalysedClassified, EmailAnalysedGeneral, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancyExtractedField, VacancyExtractedForm, VacancySuggestion, firestorePaths, jobClassifications, locations };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths, jobClassifications, locations };

package/dist/index.d.ts

@@ -529,6 +529,13 @@ interface Agent {
     readonly updatedAt?: Date | string;
 }
 
+/**
+ * Document under authEmails/{authEmail}
+ */
+interface AuthEmail {
+    UID: string;
+}
+
 interface AuthUser {
     id?: string;
     email: string;
@@ -556,24 +563,6 @@ interface UserPublic {
     updatedAt?: Date | string;
 }
 
-interface VacancyExtractedForm {
-    fields: VacancyExtractedField[];
-    formSelector: string;
-    submitButtonSelector: string;
-    url: string;
-    extractedAt: Date | string;
-}
-interface VacancyExtractedField {
-    id?: string;
-    type: string;
-    name: string;
-    label: string;
-    selector: string;
-    options: string[] | null;
-    required: boolean;
-    value?: string;
-}
-
 declare const VacancyCategory: {
     readonly Accounting: "Accounting";
     readonly AdministrationAndOfficeSupport: "Administration & Office Support";
@@ -621,7 +610,6 @@ interface Vacancy {
     jobId: string;
     category: VacancyCategory;
     suggestedTo?: string[];
-    extractedForm?: VacancyExtractedForm;
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -634,34 +622,6 @@ interface VacancySuggestion {
     createdAt?: Date | string;
 }
 
-/**
- * Document under authEmails/{authEmail}
- */
-interface AuthEmail {
-    UID: string;
-}
-
-interface ApplicationEnrichedForm {
-    fields: ApplicationEnrichedField[];
-    formSelector: string;
-    submitButtonSelector: string;
-    url: string;
-    enrichedAt: Date | string;
-}
-interface ApplicationEnrichedField {
-    id: string;
-    name: string;
-    label: string;
-    type: string;
-    value: string;
-    confidence: number;
-    response?: string;
-    selector?: string;
-    required?: boolean;
-    options?: string[] | null;
-    needsClientReview?: boolean;
-}
-
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -690,7 +650,6 @@ interface Application {
     applyingAt?: Date | string;
     suggestedAt?: Date | string;
     approvedAt?: Date | string;
-    enrichedForm?: ApplicationEnrichedForm;
     company?: string;
     position?: string;
     location?: string;
@@ -714,6 +673,8 @@ interface ApplicationQuestion {
     type: ApplicationQuestionType;
     createdAt?: Date | string;
     updatedAt?: Date | string;
+    selector?: string;
+    action?: string;
 }
 
 interface ClientLanguage {
@@ -801,6 +762,9 @@ interface ClientPersonalData {
     countryPhoneCode: string;
     nationality: string;
     dateOfBirth?: Date | string;
+    ethnicity?: string;
+    disabilityStatus?: string;
+    securityClearance?: string;
     createdAt?: Date | string;
     updatedAt?: Date | string;
 }
@@ -851,28 +815,6 @@ interface ClientInitialQuestion {
     answerText: string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
- * @see Client - Parent document
- * @see Application - Related application
- */
-interface ClientVirtualInterview {
-    readonly id?: string;
-    jobTitle: string;
-    company: string;
-    role: string;
-    date: string;
-    clientId: string;
-    messages: Array<{
-        sender: 'user' | 'interviewer' | 'feedback';
-        text: string;
-        timestamp: string;
-        duration?: number;
-        audioUrl?: string;
-    }>;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/logins/{docId}
@@ -949,6 +891,28 @@ interface ClientResume {
     }>;
 }
 
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
+ * @see Client - Parent document
+ * @see Application - Related application
+ */
+interface ClientVirtualInterview {
+    readonly id?: string;
+    jobTitle: string;
+    company: string;
+    role: string;
+    date: string;
+    clientId: string;
+    messages: Array<{
+        sender: 'user' | 'interviewer' | 'feedback';
+        text: string;
+        timestamp: string;
+        duration?: number;
+        audioUrl?: string;
+    }>;
+}
+
 /**
  * Subcollection document under clients/{userId}/access_tokens/{provider}
  */
@@ -966,7 +930,8 @@ interface ClientAccessToken {
  * Subcollection document under clients/{userId}/emails/{emailId}
  * For new email structure
  */
-interface ClientEmailV2 {
+type EmailCategory = "One Time Pin" | "Spam" | "Job Interview" | "Job Rejection" | "Require More Info" | "Job Suggestions" | "Uncategorised";
+interface ClientEmail {
     bcc: string[];
     cc: string[];
     to: string[];
@@ -980,24 +945,7 @@ interface ClientEmailV2 {
     thread_id: string;
     timestamp: number;
     labels: string[];
-}
-
-/**
- * Subcollection document under clients/{userId}/emails/{emailId}/analysed/general
- */
-interface EmailAnalysedGeneral {
-    category: string;
-    date: string;
-    job_response: boolean;
-    suggested_action: string;
-}
-
-/**
- * Subcollection document under clients/{userId}/emails/{emailId}/analysed/classified
- * All fields are dynamic.
- */
-interface EmailAnalysedClassified {
-    [key: string]: any;
+    categories: EmailCategory[];
 }
 
 type FirestoreTimestamp = {
@@ -1016,10 +964,6 @@ declare const firestorePaths: {
         readonly emails: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, emailId: string) => string;
-            readonly analysed: {
-                readonly collection: (clientId: string, emailId: string) => string;
-                readonly doc: (clientId: string, emailId: string, analysedType: "general" | "classified") => string;
-            };
         };
         readonly questions: {
             readonly collection: (clientId: string) => string;
@@ -1078,10 +1022,14 @@ declare const firestorePaths: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
     };
+    readonly companies: {
+        readonly collection: () => string;
+        readonly doc: (companyId: string) => string;
+    };
     readonly authEmails: {
         readonly collection: () => string;
         readonly doc: (authEmail: string) => string;
     };
 };
 
-export { Agent, AgentStatus, Application, ApplicationEnrichedField, ApplicationEnrichedForm, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientEducation, ClientEmailV2, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, EmailAnalysedClassified, EmailAnalysedGeneral, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancyExtractedField, VacancyExtractedForm, VacancySuggestion, firestorePaths, jobClassifications, locations };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths, jobClassifications, locations };

package/dist/index.js

@@ -1071,11 +1071,7 @@ var firestorePaths = {
     },
     emails: {
       collection: (clientId) => `clients/${clientId}/emails`,
-      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`,
-      analysed: {
-        collection: (clientId, emailId) => `clients/${clientId}/emails/${emailId}/analysed`,
-        doc: (clientId, emailId, analysedType) => `clients/${clientId}/emails/${emailId}/analysed/${analysedType}`
-      }
+      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`
     },
     questions: {
       collection: (clientId) => `clients/${clientId}/questions`,
@@ -1134,6 +1130,10 @@ var firestorePaths = {
     collection: () => "agents",
     doc: (id) => `agents/${id}`
   },
+  companies: {
+    collection: () => "companies",
+    doc: (companyId) => `companies/${companyId}`
+  },
   authEmails: {
     collection: () => "authEmails",
     doc: (authEmail) => `authEmails/${authEmail}`

package/dist/index.mjs

@@ -1040,11 +1040,7 @@ var firestorePaths = {
     },
     emails: {
       collection: (clientId) => `clients/${clientId}/emails`,
-      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`,
-      analysed: {
-        collection: (clientId, emailId) => `clients/${clientId}/emails/${emailId}/analysed`,
-        doc: (clientId, emailId, analysedType) => `clients/${clientId}/emails/${emailId}/analysed/${analysedType}`
-      }
+      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`
     },
     questions: {
       collection: (clientId) => `clients/${clientId}/questions`,
@@ -1103,6 +1099,10 @@ var firestorePaths = {
     collection: () => "agents",
     doc: (id) => `agents/${id}`
   },
+  companies: {
+    collection: () => "companies",
+    doc: (companyId) => `companies/${companyId}`
+  },
   authEmails: {
     collection: () => "authEmails",
     doc: (authEmail) => `authEmails/${authEmail}`

package/package.json

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