@jobsearch-works/firestore-models 4.2.2 → 4.2.4

package/README.md

@@ -212,3 +212,20 @@ type LocationId = (typeof locations)[number]["id"];
 ```bash
 npm install @jobsearch-works/firestore-models
 ```
+
+## Consumption Policy (Important)
+
+- Always consume this library via the published npm package (semver), e.g. `^4.x`.
+- Do not link it via local file paths (e.g. `"file:../firestore-models"`) in downstream projects.
+- Reason: CI/CD and remote environments cannot resolve local file links; using the registry guarantees consistent, reproducible builds.
+- If you need changes, bump the version here and update dependents to that version.
+
+Example in a consumer project's `package.json`:
+
+```json
+{
+  "dependencies": {
+    "@jobsearch-works/firestore-models": "^4.2.3"
+  }
+}
+```

package/dist/index.d.mts

@@ -669,6 +669,23 @@ interface AdminReport {
     readonly applications: WeeklyApplication;
 }
 
+/**
+ * Gmail OAuth session document for PKCE flow
+ * Path: gmailOAuthSessions/{sessionId}
+ * Used for secure OAuth state management with PKCE support
+ */
+interface GmailOAuthSession {
+    readonly id?: string;
+    userId: string;
+    state: string;
+    codeVerifier: string;
+    redirectUri: string;
+    createdAt: Date | string;
+    expiresAt: Date | string;
+    status: "pending" | "completed" | "expired";
+    completedAt?: Date | string;
+}
+
 /**
  * Address interface for client resume
  */
@@ -767,6 +784,7 @@ interface Application {
     coverLetter?: string;
     resume?: ClientResume;
     questions?: ApplicationQuestion[];
+    relatedEmailIds?: string[];
     automationSummary?: string;
     automationTokensUsed?: number;
     automationLog?: string;
@@ -1064,6 +1082,11 @@ interface ClientAccessToken {
  * For new email structure
  */
 type EmailCategory = "One Time Pin" | "Spam" | "Job Submitted" | "Job Interview" | "Job Accepted" | "Job Rejection" | "Require More Info" | "Job Suggestions" | "Uncategorised";
+/**
+ * Array of all valid EmailCategory values for validation and iteration
+ * This ensures consistency across the system
+ */
+declare const EMAIL_CATEGORIES: EmailCategory[];
 interface EmailLog {
     outcome: string;
     status: string;
@@ -1169,4 +1192,4 @@ declare const firestorePaths: {
     };
 };
 
-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 };
+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, 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

@@ -669,6 +669,23 @@ interface AdminReport {
     readonly applications: WeeklyApplication;
 }
 
+/**
+ * Gmail OAuth session document for PKCE flow
+ * Path: gmailOAuthSessions/{sessionId}
+ * Used for secure OAuth state management with PKCE support
+ */
+interface GmailOAuthSession {
+    readonly id?: string;
+    userId: string;
+    state: string;
+    codeVerifier: string;
+    redirectUri: string;
+    createdAt: Date | string;
+    expiresAt: Date | string;
+    status: "pending" | "completed" | "expired";
+    completedAt?: Date | string;
+}
+
 /**
  * Address interface for client resume
  */
@@ -767,6 +784,7 @@ interface Application {
     coverLetter?: string;
     resume?: ClientResume;
     questions?: ApplicationQuestion[];
+    relatedEmailIds?: string[];
     automationSummary?: string;
     automationTokensUsed?: number;
     automationLog?: string;
@@ -1064,6 +1082,11 @@ interface ClientAccessToken {
  * For new email structure
  */
 type EmailCategory = "One Time Pin" | "Spam" | "Job Submitted" | "Job Interview" | "Job Accepted" | "Job Rejection" | "Require More Info" | "Job Suggestions" | "Uncategorised";
+/**
+ * Array of all valid EmailCategory values for validation and iteration
+ * This ensures consistency across the system
+ */
+declare const EMAIL_CATEGORIES: EmailCategory[];
 interface EmailLog {
     outcome: string;
     status: string;
@@ -1169,4 +1192,4 @@ declare const firestorePaths: {
     };
 };
 
-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 };
+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, EMAIL_CATEGORIES, Education, EmailCategory, EmailLog, Experience, FirestoreTimestamp, GmailOAuthSession, JobCategory, JobTitle, LocationId, Project, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, initialQuestions, jobClassifications, locations };

package/dist/index.js

@@ -26,6 +26,7 @@ __export(src_exports, {
   ApplicationRunTrigger: () => ApplicationRunTrigger,
   ApplicationStatus: () => ApplicationStatus,
   ClientStatusEnum: () => ClientStatusEnum,
+  EMAIL_CATEGORIES: () => EMAIL_CATEGORIES,
   VacancyCategory: () => VacancyCategory,
   countries: () => countries,
   firestorePaths: () => firestorePaths,
@@ -1311,6 +1312,19 @@ var ApplicationRunTrigger = {
   AdminIntervention: "admin_intervention"
 };
 
+// src/types/clients/ClientEmail.ts
+var EMAIL_CATEGORIES = [
+  "One Time Pin",
+  "Spam",
+  "Job Submitted",
+  "Job Interview",
+  "Job Accepted",
+  "Job Rejection",
+  "Require More Info",
+  "Job Suggestions",
+  "Uncategorised"
+];
+
 // src/paths/firestorePaths.ts
 var firestorePaths = {
   clients: {
@@ -1394,6 +1408,7 @@ var firestorePaths = {
   ApplicationRunTrigger,
   ApplicationStatus,
   ClientStatusEnum,
+  EMAIL_CATEGORIES,
   VacancyCategory,
   countries,
   firestorePaths,

package/dist/index.mjs

@@ -1274,6 +1274,19 @@ var ApplicationRunTrigger = {
   AdminIntervention: "admin_intervention"
 };
 
+// src/types/clients/ClientEmail.ts
+var EMAIL_CATEGORIES = [
+  "One Time Pin",
+  "Spam",
+  "Job Submitted",
+  "Job Interview",
+  "Job Accepted",
+  "Job Rejection",
+  "Require More Info",
+  "Job Suggestions",
+  "Uncategorised"
+];
+
 // src/paths/firestorePaths.ts
 var firestorePaths = {
   clients: {
@@ -1356,6 +1369,7 @@ export {
   ApplicationRunTrigger,
   ApplicationStatus,
   ClientStatusEnum,
+  EMAIL_CATEGORIES,
   VacancyCategory,
   countries,
   firestorePaths,

package/package.json

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