@jobsearch-works/firestore-models 2.2.4 → 2.3.0

package/dist/index.d.mts

@@ -556,6 +556,24 @@ 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";
@@ -603,29 +621,11 @@ interface Vacancy {
     jobId: string;
     category: VacancyCategory;
     suggestedTo?: string[];
-    extractedAt: number;
+    extractedForm?: VacancyExtractedForm;
     createdAt?: Date | string;
     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;
-}
-
 interface VacancySuggestion {
     readonly id?: string;
     clientId: string;
@@ -634,6 +634,34 @@ 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";
@@ -662,6 +690,7 @@ interface Application {
     applyingAt?: Date | string;
     suggestedAt?: Date | string;
     approvedAt?: Date | string;
+    enrichedForm?: ApplicationEnrichedForm;
     company?: string;
     position?: string;
     location?: string;
@@ -676,27 +705,6 @@ interface Application {
     updatedAt?: Date | 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;
-}
-
 type ApplicationQuestionType = "text" | "select";
 declare const ApplicationQuestionTypeOptions: readonly ApplicationQuestionType[];
 interface ApplicationQuestion {
@@ -819,37 +827,6 @@ interface Client {
     readonly createdAt?: Date | string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/emails/{docId}
- * @see Client - Parent document
- */
-interface ClientEmail {
-    id?: string;
-    messageId: string;
-    threadId?: string;
-    labelIds?: string[];
-    snippet?: string;
-    internalDate?: string;
-    payload?: {
-        headers?: Array<{
-            name: string;
-            value: string;
-        }>;
-        body?: {
-            data?: string;
-        };
-        parts?: Array<{
-            mimeType?: string;
-            body?: {
-                data?: string;
-            };
-        }>;
-    };
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/gmailTokens/{docId}
@@ -876,7 +853,7 @@ interface ClientInitialQuestion {
 
 /**
  * Subcollection document under Client
- * Path: clients/{clientId}/applications/{applicationId}/virtualinterview/{interviewId}
+ * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
  * @see Client - Parent document
  * @see Application - Related application
  */
@@ -972,6 +949,57 @@ interface ClientResume {
     }>;
 }
 
+/**
+ * Subcollection document under clients/{userId}/access_tokens/{provider}
+ */
+interface ClientAccessToken {
+    access_token: string;
+    auth_email: string;
+    created_at: Date | string;
+    gmail_watch_history_id: number;
+    refresh_token: string;
+    scope: string[];
+    token_type: string;
+}
+
+/**
+ * Subcollection document under clients/{userId}/emails/{emailId}
+ * For new email structure
+ */
+interface ClientEmailV2 {
+    bcc: string[];
+    cc: string[];
+    to: string[];
+    from: string[];
+    date: string;
+    "html-content": string;
+    "text-content": string;
+    message_id: string;
+    snippet: string;
+    subject: string;
+    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;
+}
+
 type FirestoreTimestamp = {
     seconds: number;
     nanoseconds: number;
@@ -981,10 +1009,17 @@ declare const firestorePaths: {
     readonly clients: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
-        readonly gmailTokens: (id: string) => string;
+        readonly accessTokens: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, providerName: string) => string;
+        };
         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;
@@ -1005,7 +1040,7 @@ declare const firestorePaths: {
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
-            readonly virtualinterview: {
+            readonly virtualInterview: {
                 readonly collection: (clientId: string, applicationId: string) => string;
                 readonly doc: (clientId: string, applicationId: string, interviewId: string) => string;
             };
@@ -1043,6 +1078,10 @@ declare const firestorePaths: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
     };
+    readonly authEmails: {
+        readonly collection: () => string;
+        readonly doc: (authEmail: string) => string;
+    };
 };
 
-export { Agent, AgentStatus, Application, ApplicationEnrichedField, ApplicationEnrichedForm, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientCertifications, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancyExtractedField, VacancyExtractedForm, VacancySuggestion, firestorePaths, jobClassifications, locations };
+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 };

package/dist/index.d.ts

@@ -556,6 +556,24 @@ 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";
@@ -603,29 +621,11 @@ interface Vacancy {
     jobId: string;
     category: VacancyCategory;
     suggestedTo?: string[];
-    extractedAt: number;
+    extractedForm?: VacancyExtractedForm;
     createdAt?: Date | string;
     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;
-}
-
 interface VacancySuggestion {
     readonly id?: string;
     clientId: string;
@@ -634,6 +634,34 @@ 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";
@@ -662,6 +690,7 @@ interface Application {
     applyingAt?: Date | string;
     suggestedAt?: Date | string;
     approvedAt?: Date | string;
+    enrichedForm?: ApplicationEnrichedForm;
     company?: string;
     position?: string;
     location?: string;
@@ -676,27 +705,6 @@ interface Application {
     updatedAt?: Date | 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;
-}
-
 type ApplicationQuestionType = "text" | "select";
 declare const ApplicationQuestionTypeOptions: readonly ApplicationQuestionType[];
 interface ApplicationQuestion {
@@ -819,37 +827,6 @@ interface Client {
     readonly createdAt?: Date | string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/emails/{docId}
- * @see Client - Parent document
- */
-interface ClientEmail {
-    id?: string;
-    messageId: string;
-    threadId?: string;
-    labelIds?: string[];
-    snippet?: string;
-    internalDate?: string;
-    payload?: {
-        headers?: Array<{
-            name: string;
-            value: string;
-        }>;
-        body?: {
-            data?: string;
-        };
-        parts?: Array<{
-            mimeType?: string;
-            body?: {
-                data?: string;
-            };
-        }>;
-    };
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/gmailTokens/{docId}
@@ -876,7 +853,7 @@ interface ClientInitialQuestion {
 
 /**
  * Subcollection document under Client
- * Path: clients/{clientId}/applications/{applicationId}/virtualinterview/{interviewId}
+ * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
  * @see Client - Parent document
  * @see Application - Related application
  */
@@ -972,6 +949,57 @@ interface ClientResume {
     }>;
 }
 
+/**
+ * Subcollection document under clients/{userId}/access_tokens/{provider}
+ */
+interface ClientAccessToken {
+    access_token: string;
+    auth_email: string;
+    created_at: Date | string;
+    gmail_watch_history_id: number;
+    refresh_token: string;
+    scope: string[];
+    token_type: string;
+}
+
+/**
+ * Subcollection document under clients/{userId}/emails/{emailId}
+ * For new email structure
+ */
+interface ClientEmailV2 {
+    bcc: string[];
+    cc: string[];
+    to: string[];
+    from: string[];
+    date: string;
+    "html-content": string;
+    "text-content": string;
+    message_id: string;
+    snippet: string;
+    subject: string;
+    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;
+}
+
 type FirestoreTimestamp = {
     seconds: number;
     nanoseconds: number;
@@ -981,10 +1009,17 @@ declare const firestorePaths: {
     readonly clients: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
-        readonly gmailTokens: (id: string) => string;
+        readonly accessTokens: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, providerName: string) => string;
+        };
         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;
@@ -1005,7 +1040,7 @@ declare const firestorePaths: {
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
-            readonly virtualinterview: {
+            readonly virtualInterview: {
                 readonly collection: (clientId: string, applicationId: string) => string;
                 readonly doc: (clientId: string, applicationId: string, interviewId: string) => string;
             };
@@ -1043,6 +1078,10 @@ declare const firestorePaths: {
         readonly collection: () => string;
         readonly doc: (id: string) => string;
     };
+    readonly authEmails: {
+        readonly collection: () => string;
+        readonly doc: (authEmail: string) => string;
+    };
 };
 
-export { Agent, AgentStatus, Application, ApplicationEnrichedField, ApplicationEnrichedForm, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientCertifications, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancyExtractedField, VacancyExtractedForm, VacancySuggestion, firestorePaths, jobClassifications, locations };
+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 };

package/dist/index.js

@@ -1065,10 +1065,17 @@ var firestorePaths = {
   clients: {
     collection: () => "clients",
     doc: (id) => `clients/${id}`,
-    gmailTokens: (id) => `clients/${id}/gmailTokens`,
+    accessTokens: {
+      collection: (clientId) => `clients/${clientId}/access_tokens`,
+      doc: (clientId, providerName) => `clients/${clientId}/access_tokens/${providerName}`
+    },
     emails: {
       collection: (clientId) => `clients/${clientId}/emails`,
-      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`
+      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}`
+      }
     },
     questions: {
       collection: (clientId) => `clients/${clientId}/questions`,
@@ -1089,9 +1096,9 @@ var firestorePaths = {
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
-      virtualinterview: {
-        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/virtualinterview`,
-        doc: (clientId, applicationId, interviewId) => `clients/${clientId}/applications/${applicationId}/virtualinterview/${interviewId}`
+      virtualInterview: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/virtualInterview`,
+        doc: (clientId, applicationId, interviewId) => `clients/${clientId}/applications/${applicationId}/virtualInterview/${interviewId}`
       },
       questions: {
         collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
@@ -1126,6 +1133,10 @@ var firestorePaths = {
   agents: {
     collection: () => "agents",
     doc: (id) => `agents/${id}`
+  },
+  authEmails: {
+    collection: () => "authEmails",
+    doc: (authEmail) => `authEmails/${authEmail}`
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -1034,10 +1034,17 @@ var firestorePaths = {
   clients: {
     collection: () => "clients",
     doc: (id) => `clients/${id}`,
-    gmailTokens: (id) => `clients/${id}/gmailTokens`,
+    accessTokens: {
+      collection: (clientId) => `clients/${clientId}/access_tokens`,
+      doc: (clientId, providerName) => `clients/${clientId}/access_tokens/${providerName}`
+    },
     emails: {
       collection: (clientId) => `clients/${clientId}/emails`,
-      doc: (clientId, emailId) => `clients/${clientId}/emails/${emailId}`
+      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}`
+      }
     },
     questions: {
       collection: (clientId) => `clients/${clientId}/questions`,
@@ -1058,9 +1065,9 @@ var firestorePaths = {
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
-      virtualinterview: {
-        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/virtualinterview`,
-        doc: (clientId, applicationId, interviewId) => `clients/${clientId}/applications/${applicationId}/virtualinterview/${interviewId}`
+      virtualInterview: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/virtualInterview`,
+        doc: (clientId, applicationId, interviewId) => `clients/${clientId}/applications/${applicationId}/virtualInterview/${interviewId}`
       },
       questions: {
         collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
@@ -1095,6 +1102,10 @@ var firestorePaths = {
   agents: {
     collection: () => "agents",
     doc: (id) => `agents/${id}`
+  },
+  authEmails: {
+    collection: () => "authEmails",
+    doc: (authEmail) => `authEmails/${authEmail}`
   }
 };
 export {

package/package.json

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