@jobsearch-works/firestore-models 4.1.0 → 4.2.1

package/dist/index.d.mts

@@ -767,6 +767,16 @@ interface Application {
     coverLetter?: string;
     resume?: ClientResume;
     questions?: ApplicationQuestion[];
+    automationSummary?: string;
+    automationTokensUsed?: number;
+    automationLog?: string;
+    automationFailedAt?: Date | string;
+    automationFailureReason?: string;
+    latestRunId?: string;
+    totalAutomationRuns?: number;
+    totalTokensUsed?: number;
+    lastRunAt?: Date | string;
+    lastRunStatus?: string;
     submittedAt?: Date | string;
     interviewingAt?: Date | string;
     acceptedAt?: Date | string;
@@ -789,6 +799,65 @@ interface Application {
     updatedAt?: Date | string;
 }
 
+/**
+ * Represents a single automation run attempt for an application
+ * Each application can have multiple runs (retries, manual interventions, etc.)
+ */
+declare const ApplicationRunStatus: {
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly ManualTakeover: "manual_takeover";
+};
+type ApplicationRunStatus = (typeof ApplicationRunStatus)[keyof typeof ApplicationRunStatus];
+declare const ApplicationRunOutcome: {
+    readonly Submitted: "submitted";
+    readonly Failed: "failed";
+    readonly CaptchaBlocked: "captcha_blocked";
+    readonly FormNotFound: "form_not_found";
+    readonly AuthenticationFailed: "authentication_failed";
+    readonly ManualInterventionRequired: "manual_intervention_required";
+    readonly Timeout: "timeout";
+    readonly NetworkError: "network_error";
+};
+type ApplicationRunOutcome = (typeof ApplicationRunOutcome)[keyof typeof ApplicationRunOutcome];
+declare const ApplicationRunTrigger: {
+    readonly Automation: "automation";
+    readonly Manual: "manual";
+    readonly RetryScheduled: "retry_scheduled";
+    readonly AdminIntervention: "admin_intervention";
+};
+type ApplicationRunTrigger = (typeof ApplicationRunTrigger)[keyof typeof ApplicationRunTrigger];
+interface ApplicationRunMetadata {
+    formVersion?: string;
+    browserAgent?: string;
+    interventionNotes?: string;
+    captchaSolved?: boolean;
+    emailVerificationRequired?: boolean;
+    documentsUploaded?: string[];
+    questionsAnswered?: number;
+    fieldsCompleted?: number;
+    durationSeconds?: number;
+}
+interface ApplicationRun {
+    id?: string;
+    applicationId: string;
+    clientId: string;
+    runNumber: number;
+    status: ApplicationRunStatus;
+    outcome?: ApplicationRunOutcome;
+    startedAt: Date | string;
+    completedAt?: Date | string;
+    tokensUsed?: number;
+    summary?: string;
+    log?: string;
+    failureReason?: string;
+    triggeredBy: ApplicationRunTrigger;
+    metadata?: ApplicationRunMetadata;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+}
+
 /**
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
@@ -811,15 +880,13 @@ interface ClientPersonalData {
     countryPhoneCode: string;
     nationality: string;
     dateOfBirth?: Date | string;
+    gender?: 'Male' | 'Female' | 'Non-binary' | 'Prefer not to say' | 'Other';
     ethnicity?: string;
     disabilityStatus?: string;
     securityClearance?: string;
     workEligibility?: 'Australian Citizen' | 'Permanent Resident' | 'Temporary Visa' | 'Student Visa' | 'Working Holiday Visa' | 'Other';
     visaType?: string;
     workRestrictions?: string;
-    emergencyContactName?: string;
-    emergencyContactPhone?: string;
-    emergencyContactRelationship?: string;
     backgroundCheckConsent?: 'Yes' | 'No';
     drugTestConsent?: 'Yes' | 'No';
     travelWillingness?: 'Yes' | 'No' | 'Sometimes';
@@ -850,7 +917,7 @@ interface ClientJobPreferences {
     maxSalary?: number;
     employmentTypes: string[];
     remotePreference: 'remote' | 'hybrid' | 'office';
-    earliestStartDate?: string;
+    noticePeriod?: 'immediate' | '1_week' | '2_weeks' | '1_month' | '2_months' | '3_months' | '6_months' | 'negotiable';
     workAvailability?: 'full-time' | 'part-time' | 'casual' | 'contract' | 'flexible';
     weekendWork?: 'yes' | 'no' | 'sometimes';
     shiftWork?: 'yes' | 'no' | 'sometimes';
@@ -870,6 +937,19 @@ interface ClientWebsitePreferences {
     notifications: string;
 }
 
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/gmailTokens/{docId}
+ * @see Client - Parent document
+ */
+interface ClientGmailToken {
+    readonly id?: string;
+    accessToken: string;
+    refreshToken: string;
+    email: string;
+    useThisEmail: boolean;
+}
+
 type ClientStatus = (typeof ClientStatusEnum)[keyof typeof ClientStatusEnum];
 /**
  * Root Client document
@@ -884,23 +964,11 @@ interface Client {
     readonly personalData?: ClientPersonalData;
     readonly jobPreferences?: ClientJobPreferences;
     readonly websitePreferences?: ClientWebsitePreferences;
+    readonly gmailToken?: ClientGmailToken;
     resume: ClientResume;
     readonly createdAt?: Date | string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/gmailTokens/{docId}
- * @see Client - Parent document
- */
-interface ClientGmailToken {
-    readonly id?: string;
-    accessToken: string;
-    refreshToken: string;
-    email: string;
-    useThisEmail: boolean;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/initialQuestions/{docId}
@@ -1030,10 +1098,6 @@ declare const firestorePaths: {
     readonly clients: {
         readonly collection: () => string;
         readonly doc: (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;
@@ -1053,6 +1117,10 @@ declare const firestorePaths: {
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
+            readonly runs: {
+                readonly collection: (clientId: string, applicationId: string) => string;
+                readonly doc: (clientId: string, applicationId: string, runId: string) => string;
+            };
             readonly notes: {
                 readonly collection: (clientId: string, applicationId: string) => string;
                 readonly doc: (clientId: string, applicationId: string, noteId: string) => string;
@@ -1101,4 +1169,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };
+export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };

package/dist/index.d.ts

@@ -767,6 +767,16 @@ interface Application {
     coverLetter?: string;
     resume?: ClientResume;
     questions?: ApplicationQuestion[];
+    automationSummary?: string;
+    automationTokensUsed?: number;
+    automationLog?: string;
+    automationFailedAt?: Date | string;
+    automationFailureReason?: string;
+    latestRunId?: string;
+    totalAutomationRuns?: number;
+    totalTokensUsed?: number;
+    lastRunAt?: Date | string;
+    lastRunStatus?: string;
     submittedAt?: Date | string;
     interviewingAt?: Date | string;
     acceptedAt?: Date | string;
@@ -789,6 +799,65 @@ interface Application {
     updatedAt?: Date | string;
 }
 
+/**
+ * Represents a single automation run attempt for an application
+ * Each application can have multiple runs (retries, manual interventions, etc.)
+ */
+declare const ApplicationRunStatus: {
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly ManualTakeover: "manual_takeover";
+};
+type ApplicationRunStatus = (typeof ApplicationRunStatus)[keyof typeof ApplicationRunStatus];
+declare const ApplicationRunOutcome: {
+    readonly Submitted: "submitted";
+    readonly Failed: "failed";
+    readonly CaptchaBlocked: "captcha_blocked";
+    readonly FormNotFound: "form_not_found";
+    readonly AuthenticationFailed: "authentication_failed";
+    readonly ManualInterventionRequired: "manual_intervention_required";
+    readonly Timeout: "timeout";
+    readonly NetworkError: "network_error";
+};
+type ApplicationRunOutcome = (typeof ApplicationRunOutcome)[keyof typeof ApplicationRunOutcome];
+declare const ApplicationRunTrigger: {
+    readonly Automation: "automation";
+    readonly Manual: "manual";
+    readonly RetryScheduled: "retry_scheduled";
+    readonly AdminIntervention: "admin_intervention";
+};
+type ApplicationRunTrigger = (typeof ApplicationRunTrigger)[keyof typeof ApplicationRunTrigger];
+interface ApplicationRunMetadata {
+    formVersion?: string;
+    browserAgent?: string;
+    interventionNotes?: string;
+    captchaSolved?: boolean;
+    emailVerificationRequired?: boolean;
+    documentsUploaded?: string[];
+    questionsAnswered?: number;
+    fieldsCompleted?: number;
+    durationSeconds?: number;
+}
+interface ApplicationRun {
+    id?: string;
+    applicationId: string;
+    clientId: string;
+    runNumber: number;
+    status: ApplicationRunStatus;
+    outcome?: ApplicationRunOutcome;
+    startedAt: Date | string;
+    completedAt?: Date | string;
+    tokensUsed?: number;
+    summary?: string;
+    log?: string;
+    failureReason?: string;
+    triggeredBy: ApplicationRunTrigger;
+    metadata?: ApplicationRunMetadata;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+}
+
 /**
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
@@ -811,15 +880,13 @@ interface ClientPersonalData {
     countryPhoneCode: string;
     nationality: string;
     dateOfBirth?: Date | string;
+    gender?: 'Male' | 'Female' | 'Non-binary' | 'Prefer not to say' | 'Other';
     ethnicity?: string;
     disabilityStatus?: string;
     securityClearance?: string;
     workEligibility?: 'Australian Citizen' | 'Permanent Resident' | 'Temporary Visa' | 'Student Visa' | 'Working Holiday Visa' | 'Other';
     visaType?: string;
     workRestrictions?: string;
-    emergencyContactName?: string;
-    emergencyContactPhone?: string;
-    emergencyContactRelationship?: string;
     backgroundCheckConsent?: 'Yes' | 'No';
     drugTestConsent?: 'Yes' | 'No';
     travelWillingness?: 'Yes' | 'No' | 'Sometimes';
@@ -850,7 +917,7 @@ interface ClientJobPreferences {
     maxSalary?: number;
     employmentTypes: string[];
     remotePreference: 'remote' | 'hybrid' | 'office';
-    earliestStartDate?: string;
+    noticePeriod?: 'immediate' | '1_week' | '2_weeks' | '1_month' | '2_months' | '3_months' | '6_months' | 'negotiable';
     workAvailability?: 'full-time' | 'part-time' | 'casual' | 'contract' | 'flexible';
     weekendWork?: 'yes' | 'no' | 'sometimes';
     shiftWork?: 'yes' | 'no' | 'sometimes';
@@ -870,6 +937,19 @@ interface ClientWebsitePreferences {
     notifications: string;
 }
 
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/gmailTokens/{docId}
+ * @see Client - Parent document
+ */
+interface ClientGmailToken {
+    readonly id?: string;
+    accessToken: string;
+    refreshToken: string;
+    email: string;
+    useThisEmail: boolean;
+}
+
 type ClientStatus = (typeof ClientStatusEnum)[keyof typeof ClientStatusEnum];
 /**
  * Root Client document
@@ -884,23 +964,11 @@ interface Client {
     readonly personalData?: ClientPersonalData;
     readonly jobPreferences?: ClientJobPreferences;
     readonly websitePreferences?: ClientWebsitePreferences;
+    readonly gmailToken?: ClientGmailToken;
     resume: ClientResume;
     readonly createdAt?: Date | string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/gmailTokens/{docId}
- * @see Client - Parent document
- */
-interface ClientGmailToken {
-    readonly id?: string;
-    accessToken: string;
-    refreshToken: string;
-    email: string;
-    useThisEmail: boolean;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/initialQuestions/{docId}
@@ -1030,10 +1098,6 @@ declare const firestorePaths: {
     readonly clients: {
         readonly collection: () => string;
         readonly doc: (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;
@@ -1053,6 +1117,10 @@ declare const firestorePaths: {
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
+            readonly runs: {
+                readonly collection: (clientId: string, applicationId: string) => string;
+                readonly doc: (clientId: string, applicationId: string, runId: string) => string;
+            };
             readonly notes: {
                 readonly collection: (clientId: string, applicationId: string) => string;
                 readonly doc: (clientId: string, applicationId: string, noteId: string) => string;
@@ -1101,4 +1169,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };
+export { Address, AdminReport, Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationRun, ApplicationRunMetadata, ApplicationRunOutcome, ApplicationRunStatus, ApplicationRunTrigger, ApplicationStatus, AuthEmail, AuthUser, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };

package/dist/index.js

@@ -21,6 +21,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   ApplicationQuestionTypeOptions: () => ApplicationQuestionTypeOptions,
+  ApplicationRunOutcome: () => ApplicationRunOutcome,
+  ApplicationRunStatus: () => ApplicationRunStatus,
+  ApplicationRunTrigger: () => ApplicationRunTrigger,
   ApplicationStatus: () => ApplicationStatus,
   ClientStatusEnum: () => ClientStatusEnum,
   VacancyCategory: () => VacancyCategory,
@@ -1284,15 +1287,35 @@ var ApplicationStatus = {
 // src/types/clients/ApplicationQuestion.ts
 var ApplicationQuestionTypeOptions = ["text", "select", "radio", "checkbox", "textarea", "file"];
 
+// src/types/clients/ApplicationRun.ts
+var ApplicationRunStatus = {
+  InProgress: "in_progress",
+  Completed: "completed",
+  Failed: "failed",
+  ManualTakeover: "manual_takeover"
+};
+var ApplicationRunOutcome = {
+  Submitted: "submitted",
+  Failed: "failed",
+  CaptchaBlocked: "captcha_blocked",
+  FormNotFound: "form_not_found",
+  AuthenticationFailed: "authentication_failed",
+  ManualInterventionRequired: "manual_intervention_required",
+  Timeout: "timeout",
+  NetworkError: "network_error"
+};
+var ApplicationRunTrigger = {
+  Automation: "automation",
+  Manual: "manual",
+  RetryScheduled: "retry_scheduled",
+  AdminIntervention: "admin_intervention"
+};
+
 // src/paths/firestorePaths.ts
 var firestorePaths = {
   clients: {
     collection: () => "clients",
     doc: (id) => `clients/${id}`,
-    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}`
@@ -1312,6 +1335,10 @@ var firestorePaths = {
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
+      runs: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/runs`,
+        doc: (clientId, applicationId, runId) => `clients/${clientId}/applications/${applicationId}/runs/${runId}`
+      },
       notes: {
         collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/notes`,
         doc: (clientId, applicationId, noteId) => `clients/${clientId}/applications/${applicationId}/notes/${noteId}`
@@ -1362,6 +1389,9 @@ var firestorePaths = {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApplicationQuestionTypeOptions,
+  ApplicationRunOutcome,
+  ApplicationRunStatus,
+  ApplicationRunTrigger,
   ApplicationStatus,
   ClientStatusEnum,
   VacancyCategory,

package/dist/index.mjs

@@ -1250,15 +1250,35 @@ var ApplicationStatus = {
 // src/types/clients/ApplicationQuestion.ts
 var ApplicationQuestionTypeOptions = ["text", "select", "radio", "checkbox", "textarea", "file"];
 
+// src/types/clients/ApplicationRun.ts
+var ApplicationRunStatus = {
+  InProgress: "in_progress",
+  Completed: "completed",
+  Failed: "failed",
+  ManualTakeover: "manual_takeover"
+};
+var ApplicationRunOutcome = {
+  Submitted: "submitted",
+  Failed: "failed",
+  CaptchaBlocked: "captcha_blocked",
+  FormNotFound: "form_not_found",
+  AuthenticationFailed: "authentication_failed",
+  ManualInterventionRequired: "manual_intervention_required",
+  Timeout: "timeout",
+  NetworkError: "network_error"
+};
+var ApplicationRunTrigger = {
+  Automation: "automation",
+  Manual: "manual",
+  RetryScheduled: "retry_scheduled",
+  AdminIntervention: "admin_intervention"
+};
+
 // src/paths/firestorePaths.ts
 var firestorePaths = {
   clients: {
     collection: () => "clients",
     doc: (id) => `clients/${id}`,
-    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}`
@@ -1278,6 +1298,10 @@ var firestorePaths = {
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
+      runs: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/runs`,
+        doc: (clientId, applicationId, runId) => `clients/${clientId}/applications/${applicationId}/runs/${runId}`
+      },
       notes: {
         collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/notes`,
         doc: (clientId, applicationId, noteId) => `clients/${clientId}/applications/${applicationId}/notes/${noteId}`
@@ -1327,6 +1351,9 @@ var firestorePaths = {
 };
 export {
   ApplicationQuestionTypeOptions,
+  ApplicationRunOutcome,
+  ApplicationRunStatus,
+  ApplicationRunTrigger,
   ApplicationStatus,
   ClientStatusEnum,
   VacancyCategory,

package/package.json

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