@jobsearch-works/firestore-models 1.1.8 → 1.1.10

package/README.md

@@ -1,5 +1,8 @@
 # firestore-models
 
+[![npm version](https://img.shields.io/npm/v/@jobsearch-works/firestore-models.svg?style=flat-square)](https://www.npmjs.com/package/@jobsearch-works/firestore-models)
+[![license](https://img.shields.io/npm/l/@jobsearch-works/firestore-models.svg?style=flat-square)](./LICENSE)
+
 A shared library for standardizing Firestore document schemas and paths across multiple projects.
 
 This library provides:
@@ -34,6 +37,17 @@ This package acts as a single source of truth for Firestore schema and paths, en
 - Consistent Firestore path generation (no hardcoded strings)
 - Cross-environment compatibility (e.g., CLI, testing, rules)
 
+This package provides no Firestore SDK bindings. Firestore `DocumentReference`s and `CollectionReference`s are constructed in your application using these path strings, typically in a `firestoreRefs.ts` file like:
+
+```ts
+import { doc, collection } from "firebase/firestore";
+import { firestore } from "./firebaseConfig";
+import { firestorePaths } from "@jobsearch-works/firestore-models";
+
+export const userRef = (userId: string) =>
+  doc(firestore, firestorePaths.users.doc(userId));
+```
+
 ---
 
 ## 🧱 Project Structure
@@ -50,32 +64,416 @@ firestore-models/
 
 ---
 
+## 🔗 Entity Relationships
+
+The following diagram and table illustrate how the main Firestore models relate to each other, both by reference (IDs) and by Firestore subcollections/paths:
+
+```
+Client
+  ├── applications (Application)
+  │     └── questions (ApplicationQuestion)
+  ├── questions (ClientQuestion)
+  ├── preferences/targetPreferences (TargetPreferences)
+  ├── vacancySuggestions (VacancySuggestion)
+  └── clientEmails/{clientId}/messages (GmailMessage)
+
+Vacancy
+  └── Referenced by Application and VacancySuggestion
+
+Agent
+  └── Root collection
+
+User
+  └── Root collection
+
+ClientData
+  └── Root collection
+
+ClientLogin
+  └── clientLogins/{userId}/logins/{domain}
+```
+
+| Entity              | References / Path                                    | Description                                                          |
+| ------------------- | ---------------------------------------------------- | -------------------------------------------------------------------- |
+| Client              | Root collection                                      | Main user entity                                                     |
+| Application         | clients/{clientId}/applications/{applicationId}      | References `clientId`, `vacancyId`                                   |
+| ApplicationQuestion | .../applications/{applicationId}/questions/{qId}     | Subcollection of Application                                         |
+| ClientQuestion      | clients/{clientId}/questions/{questionId}            | Subcollection of Client                                              |
+| Vacancy             | Root collection                                      | Referenced by Application, VacancySuggestion                         |
+| VacancySuggestion   | clients/{clientId}/vacancySuggestions/{suggestionId} | References `clientId`, `vacancyId`                                   |
+| TargetPreferences   | clients/{clientId}/preferences/targetPreferences     | References `clientId`, contains `TargetJob[]` and `TargetLocation[]` |
+| TargetJob           | Embedded in TargetPreferences                        | Contains `category` (VacancyCategory)                                |
+| TargetLocation      | Embedded in TargetPreferences                        | List of preferred locations                                          |
+| Agent               | Root collection                                      | Standalone entity                                                    |
+| AuthUser            | Root collection                                      | Standalone entity                                                    |
+| ClientData          | Root collection                                      | Standalone entity                                                    |
+| ClientLogin         | clientLogins/{userId}/logins/{domain}                | References `userId`                                                  |
+| GmailMessage        | clientEmails/{clientId}/messages/{messageId}         | References `clientId`                                                |
+| ResumeLink          | clients/{clientId}/resumeLinks/{linkId}              | References `clientId`, stores PDF resume URLs                        |
+
+**Notes:**
+
+- Most subcollections are nested under `Client` (e.g., applications, questions, vacancySuggestions).
+- `Application` and `VacancySuggestion` reference both `clientId` (parent) and `vacancyId` (target job).
+- `TargetPreferences` embeds arrays of `TargetJob` and `TargetLocation`.
+- All relationships are enforced by Firestore path structure and cross-referenced IDs.
+
+---
+
 ## ✅ Usage
 
+This library is intentionally SDK-free. All Firebase logic — including `Timestamp`, `doc()`, and `onSnapshot()` — is handled in your app’s service layer. This ensures portability across React apps, Firebase functions, and testing environments.
+
 ### Importing Models and Paths
 
 ```ts
 import { Client } from "@jobsearch-works/firestore-models/types/Client";
-import { pathStrings } from "@jobsearch-works/firestore-models/paths/pathStrings";
+import { firestorePaths } from "@jobsearch-works/firestore-models/paths/firestorePaths";
 
-const clientPath = pathStrings.client("abc123"); // → "clients/abc123"
+const clientDocPath = firestorePaths.clients.doc("abc123"); // → "clients/abc123"
 ```
 
 ---
 
-## 🔒 Type Definition Example
+## 📄 Firestore Models (Types)
+
+All Firestore document schemas are defined as TypeScript interfaces in `src/types`. These are pure data types (SDK-free) and can be reused across apps, functions, and tests.
+
+> **Why does every model include `id?: string`?**
+> Firestore's `.data()` does **not** include the document ID. This library's types include `id` as an optional property, which is added manually when fetching data. This makes it easier to use models in UI, caching, and linking between entities.
+
+### Main Types (alphabetical)
+
+- **Agent**
+
+  ```ts
+  export interface Agent {
+    id?: string;
+    name: string;
+    email: string;
+    status: "active" | "inactive";
+    profilePicture?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **Application**
+
+  ```ts
+  export interface Application {
+    id?: string;
+    vacancyId: string;
+    clientId: string;
+    status: ApplicationStatus;
+    assignedTo?: string;
+    coverLetter?: string;
+    resume?: string;
+    // Status timestamps
+    submittedAt?: Date | string;
+    interviewingAt?: Date | string;
+    acceptedAt?: Date | string;
+    rejectedAt?: Date | string;
+    withdrawnAt?: Date | string;
+    applyingAt?: Date | string;
+    suggestedAt?: Date | string;
+    approvedAt?: Date | string;
+    // Denormalized/snapshot fields from Vacancy
+    company?: string;
+    position?: string;
+    location?: string;
+    jobId?: string;
+    advertisingUrl?: string;
+    applicationUrl?: string;
+    applicationDomain?: string;
+    advertisingDomain?: string;
+    description?: string;
+    fullPageText?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+  - `ApplicationStatus` values: new, submitted, interviewing, accepted, rejected, withdrawn, applying, suggested, approved
+
+- **ApplicationQuestion**
+
+  ```ts
+  export interface ApplicationQuestion {
+    id?: string;
+    questionText: string;
+    answerText?: string;
+    type: "text" | "select";
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **AuthUser**
+
+  ```ts
+  export interface AuthUser {
+    id?: string;
+    email: string;
+    displayName?: string;
+    photoURL?: string;
+    lastSignIn?: string; // ISO string
+    emailVerified?: boolean;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **Client**
+
+  ```ts
+  export interface Client {
+    id?: string;
+    name: string;
+    email: string;
+    status: "active" | "inactive";
+    resume?: string;
+    createdAt?: Date | string;
+  }
+  ```
+
+- **ClientData**
+
+  ```ts
+  export interface ClientData {
+    id?: string;
+    firstName: string;
+    lastName: string;
+    middleName?: string;
+    preferredName?: string;
+    email: string;
+    phone: string;
+    address: string;
+    city: string;
+    suburb: string;
+    state: string;
+    zip: string;
+    country: string;
+    linkedIn?: string;
+    countryPhoneCode: string;
+    nationality: string;
+    dateOfBirth?: Date | string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **ClientLogin**
+
+  ```ts
+  export interface ClientLogin {
+    id?: string;
+    userId: string;
+    url: string;
+    domain: string;
+    username?: string;
+    password: string;
+    email?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **ClientQuestion**
+
+  ```ts
+  export interface ClientQuestion {
+    id?: string;
+    questionText: string;
+    answerText?: string;
+    type: "text" | "select";
+    options?: string[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **GmailMessage**
+
+  ```ts
+  export interface GmailMessage {
+    id?: string;
+  ```
+
+- **ResumeLink**
+
+  ```ts
+  export interface ResumeLink {
+    id: string;
+    title: string;
+    url: string;
+    description: string;
+    createdAt: any; // Timestamp from firebase/firestore
+    createdBy: string;
+    clientId: string;
+  }
+  ```
+
+- **GmailMessage**
+
+  ```ts
+  export interface GmailMessage {
+    id?: string;
+    messageId: string;
+    threadId?: string;
+    labelIds?: string[];
+    snippet?: string;
+    internalDate?: string;
+    payload?: object;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **TargetJob**
+
+  ```ts
+  export interface TargetJob {
+    id?: string;
+    category: VacancyCategory;
+    position: string;
+    notes?: string;
+  }
+  ```
+
+- **TargetLocation**
+
+  ```ts
+  export interface TargetLocation {
+    id?: string;
+    country: string;
+    cities: {
+      name: string;
+      areas: string[];
+    }[];
+  }
+  ```
+
+- **TargetPreferences**
+
+  ```ts
+  export interface TargetPreferences {
+    id?: string;
+    clientId: string;
+    locations: TargetLocation[];
+    jobs: TargetJob[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+- **Vacancy**
+
+  ```ts
+  export interface Vacancy {
+    id?: string;
+    company: string;
+    position: string;
+    location: string;
+    description: string;
+    advertisingUrl: string;
+    applicationUrl: string;
+    applicationDomain: string;
+    advertisingDomain: string;
+    fullPageText: string;
+    jobId: string;
+    category: VacancyCategory;
+    suggestedTo?: string[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+  }
+  ```
+
+  - `VacancyCategory` includes: Accounting, IT, Healthcare, Sales, etc.
+
+- **VacancySuggestion**
+  ```ts
+  export interface VacancySuggestion {
+    id?: string;
+    clientId: string;
+    vacancyId: string;
+    status: string;
+    createdAt?: Date | string;
+  }
+  ```
+
+---
+
+## 🗂️ Firestore Path Utilities
+
+All Firestore collection/document path builders are centralized in `src/paths/firestorePaths.ts` as pure string helpers. **Every helper returns a Firestore path string, not a Firestore SDK reference.** This keeps the library SDK-free and fully portable for use in any environment (Node.js, browser, SSR, CLI, etc). No Firestore SDK is required or included.
+
+### Example Usage
 
 ```ts
-// types/Client.ts
-export interface Client {
-  id?: string;
-  name: string;
-  email: string;
-  status: "active" | "inactive";
-  createdAt?: Date | string;
+import { firestorePaths } from "@jobsearch-works/firestore-models/paths/firestorePaths";
+
+const clientDoc = firestorePaths.clients.doc("clientId"); // "clients/clientId"
+const appDoc = firestorePaths.clients.applications.doc(
+  "clientId",
+  "applicationId"
+); // "clients/clientId/applications/applicationId"
+const vacancyDoc = firestorePaths.vacancies.doc("vacancyId"); // "vacancies/vacancyId"
+```
+
+#### Fetching a Firestore Document and Including Its ID
+
+```ts
+import { doc, getDoc } from "firebase/firestore";
+import { firestore } from "../firebaseConfig";
+import { firestorePaths } from "@jobsearch-works/firestore-models";
+
+const ref = doc(firestore, firestorePaths.vacancies.doc("vac123"));
+const snap = await getDoc(ref);
+const vacancy = { id: snap.id, ...snap.data() };
+```
+
+**Reusable withId Utility:**
+
+```ts
+export function withId<T>(snap: DocumentSnapshot): T & { id: string } {
+  return { id: snap.id, ...snap.data() } as T & { id: string };
 }
 ```
 
+#### Main Path Helpers
+
+- `firestorePaths.clients.collection()` → "clients"
+- `firestorePaths.clients.doc(clientId)` → "clients/{clientId}"
+- `firestorePaths.clients.applications.collection(clientId)` → "clients/{clientId}/applications"
+- `firestorePaths.clients.applications.doc(clientId, applicationId)` → "clients/{clientId}/applications/{applicationId}"
+- `firestorePaths.clients.questions.collection(clientId)` → "clients/{clientId}/questions"
+- `firestorePaths.clients.questions.doc(clientId, questionId)` → "clients/{clientId}/questions/{questionId}"
+- `firestorePaths.clients.preferences.target(clientId)` → "clients/{clientId}/preferences/targetPreferences"
+- `firestorePaths.clients.vacancySuggestions.collection(clientId)` → "clients/{clientId}/vacancySuggestions"
+- `firestorePaths.clients.vacancySuggestions.doc(clientId, suggestionId)` → "clients/{clientId}/vacancySuggestions/{suggestionId}"
+- `firestorePaths.users.collection()` → "users"
+- `firestorePaths.users.doc(userId)` → "users/{userId}"
+- `firestorePaths.vacancies.collection()` → "vacancies"
+- `firestorePaths.vacancies.doc(vacancyId)` → "vacancies/{vacancyId}"
+- `firestorePaths.agents.collection()` → "agents"
+- `firestorePaths.agents.doc(agentId)` → "agents/{agentId}"
+- `firestorePaths.clientData.collection()` → "clientData"
+- `firestorePaths.clientData.doc(clientDataId)` → "clientData/{clientDataId}"
+- `firestorePaths.clientLogins.collection(userId)` → "clientLogins/{userId}"
+- `firestorePaths.clientLogins.doc(userId, domain)` → "clientLogins/{userId}/logins/{domain}"
+- `firestorePaths.gmailMessages.collection(clientId)` → "clientEmails/{clientId}/messages"
+- `firestorePaths.gmailMessages.doc(clientId, messageId)` → "clientEmails/{clientId}/messages/{messageId}"
+
+---
+
+## 🛡️ Notes
+
+- All types and paths are SDK-independent and safe to use in any TypeScript/Node/React project.
+- This package does not include any Firestore SDK or database logic—just models and helpers.
+- For Firestore access, use your own service layer or SDK wrapper.
+- This library follows semantic versioning and is safe for production use.
+
 ---
 
 ## 🔗 Path Builder Example
@@ -98,9 +496,3 @@ When adding a new model:
 2. Add its path builder in `src/paths/pathStrings.ts`
 3. Update the documentation if needed
 4. Maintain backward compatibility
-
----
-
-## 📄 License
-
-MIT

package/dist/index.d.mts

@@ -1,10 +1,11 @@
+type ClientStatus = "active" | "inactive";
 interface Client {
-    id?: string;
-    name: string;
-    email: string;
-    status: "active" | "inactive";
-    resume?: string;
-    createdAt?: Date | string;
+    readonly id?: string;
+    readonly name: string;
+    readonly email: string;
+    readonly status: ClientStatus;
+    readonly resume?: string;
+    readonly createdAt?: Date | string;
 }
 
 declare const ApplicationStatus: {
@@ -111,14 +112,15 @@ interface Vacancy {
     updatedAt?: Date | string;
 }
 
+type AgentStatus = "active" | "inactive";
 interface Agent {
-    id?: string;
-    name: string;
-    email: string;
-    status: "active" | "inactive";
-    profilePicture?: string;
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
+    readonly id?: string;
+    readonly name: string;
+    readonly email: string;
+    readonly status: AgentStatus;
+    readonly profilePicture?: string;
+    readonly createdAt?: Date | string;
+    readonly updatedAt?: Date | string;
 }
 
 type ClientQuestionType = "text" | "select";
@@ -179,6 +181,7 @@ interface ApplicationQuestion {
 }
 
 interface VacancySuggestion {
+    id?: string;
     clientId: string;
     vacancyId: string;
     status: string;
@@ -212,6 +215,7 @@ interface GmailMessage {
 }
 
 interface TargetLocation {
+    id?: string;
     country: string;
     cities: {
         name: string;
@@ -220,13 +224,14 @@ interface TargetLocation {
 }
 
 interface TargetJob {
+    id?: string;
     category: VacancyCategory;
     position: string;
     notes?: string;
 }
 
 interface TargetPreferences {
-    id: string;
+    id?: string;
     clientId: string;
     locations: TargetLocation[];
     jobs: TargetJob[];
@@ -234,30 +239,68 @@ interface TargetPreferences {
     updatedAt: Date;
 }
 
-declare const pathStrings: {
-    readonly clients: () => string;
-    readonly client: (clientId: string) => string;
-    readonly applications: (clientId: string) => string;
-    readonly application: (clientId: string, applicationId: string) => string;
-    readonly users: () => string;
-    readonly user: (userId: string) => string;
-    readonly vacancies: () => string;
-    readonly vacancy: (vacancyId: string) => string;
-    readonly agents: () => string;
-    readonly agent: (agentId: string) => string;
-    readonly clientQuestions: (clientId: string) => string;
-    readonly clientQuestion: (clientId: string, questionId: string) => string;
-    readonly clientData: () => string;
-    readonly clientDataItem: (clientDataId: string) => string;
-    readonly clientLogins: (userId: string) => string;
-    readonly clientLogin: (userId: string, domain: string) => string;
-    readonly applicationQuestions: (clientId: string, applicationId: string) => string;
-    readonly applicationQuestion: (clientId: string, applicationId: string, questionId: string) => string;
-    readonly vacancySuggestions: (clientId: string) => string;
-    readonly vacancySuggestion: (clientId: string, suggestionId: string) => string;
-    readonly gmailMessages: (clientId: string) => string;
-    readonly gmailMessage: (clientId: string, messageId: string) => string;
-    readonly targetPreferences: (clientId: string) => string;
+interface ResumeLink {
+    id?: string;
+    title: string;
+    url: string;
+    description: string;
+    createdAt?: Date | string;
+    createdBy: string;
+    clientId: string;
+}
+
+declare const firestorePaths: {
+    readonly clients: {
+        readonly collection: () => string;
+        readonly doc: (clientId: string) => string;
+        readonly applications: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, applicationId: string) => string;
+            readonly questions: {
+                readonly collection: (clientId: string, applicationId: string) => string;
+                readonly doc: (clientId: string, applicationId: string, questionId: string) => string;
+            };
+        };
+        readonly questions: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, questionId: string) => string;
+        };
+        readonly preferences: {
+            readonly target: (clientId: string) => string;
+        };
+        readonly vacancySuggestions: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, suggestionId: string) => string;
+        };
+    };
+    readonly users: {
+        readonly collection: () => string;
+        readonly doc: (userId: string) => string;
+    };
+    readonly vacancies: {
+        readonly collection: () => string;
+        readonly doc: (vacancyId: string) => string;
+    };
+    readonly agents: {
+        readonly collection: () => string;
+        readonly doc: (agentId: string) => string;
+    };
+    readonly clientData: {
+        readonly collection: () => string;
+        readonly doc: (clientDataId: string) => string;
+    };
+    readonly clientLogins: {
+        readonly collection: (userId: string) => string;
+        readonly doc: (userId: string, domain: string) => string;
+    };
+    readonly gmailMessages: {
+        readonly collection: (clientId: string) => string;
+        readonly doc: (clientId: string, messageId: string) => string;
+    };
+    readonly resumeLinks: {
+        readonly collection: (clientId: string) => string;
+        readonly doc: (clientId: string, resumeLinkId: string) => string;
+    };
 };
 
-export { Agent, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, GmailMessage, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, pathStrings };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, ClientStatus, GmailMessage, ResumeLink, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
+type ClientStatus = "active" | "inactive";
 interface Client {
-    id?: string;
-    name: string;
-    email: string;
-    status: "active" | "inactive";
-    resume?: string;
-    createdAt?: Date | string;
+    readonly id?: string;
+    readonly name: string;
+    readonly email: string;
+    readonly status: ClientStatus;
+    readonly resume?: string;
+    readonly createdAt?: Date | string;
 }
 
 declare const ApplicationStatus: {
@@ -111,14 +112,15 @@ interface Vacancy {
     updatedAt?: Date | string;
 }
 
+type AgentStatus = "active" | "inactive";
 interface Agent {
-    id?: string;
-    name: string;
-    email: string;
-    status: "active" | "inactive";
-    profilePicture?: string;
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
+    readonly id?: string;
+    readonly name: string;
+    readonly email: string;
+    readonly status: AgentStatus;
+    readonly profilePicture?: string;
+    readonly createdAt?: Date | string;
+    readonly updatedAt?: Date | string;
 }
 
 type ClientQuestionType = "text" | "select";
@@ -179,6 +181,7 @@ interface ApplicationQuestion {
 }
 
 interface VacancySuggestion {
+    id?: string;
     clientId: string;
     vacancyId: string;
     status: string;
@@ -212,6 +215,7 @@ interface GmailMessage {
 }
 
 interface TargetLocation {
+    id?: string;
     country: string;
     cities: {
         name: string;
@@ -220,13 +224,14 @@ interface TargetLocation {
 }
 
 interface TargetJob {
+    id?: string;
     category: VacancyCategory;
     position: string;
     notes?: string;
 }
 
 interface TargetPreferences {
-    id: string;
+    id?: string;
     clientId: string;
     locations: TargetLocation[];
     jobs: TargetJob[];
@@ -234,30 +239,68 @@ interface TargetPreferences {
     updatedAt: Date;
 }
 
-declare const pathStrings: {
-    readonly clients: () => string;
-    readonly client: (clientId: string) => string;
-    readonly applications: (clientId: string) => string;
-    readonly application: (clientId: string, applicationId: string) => string;
-    readonly users: () => string;
-    readonly user: (userId: string) => string;
-    readonly vacancies: () => string;
-    readonly vacancy: (vacancyId: string) => string;
-    readonly agents: () => string;
-    readonly agent: (agentId: string) => string;
-    readonly clientQuestions: (clientId: string) => string;
-    readonly clientQuestion: (clientId: string, questionId: string) => string;
-    readonly clientData: () => string;
-    readonly clientDataItem: (clientDataId: string) => string;
-    readonly clientLogins: (userId: string) => string;
-    readonly clientLogin: (userId: string, domain: string) => string;
-    readonly applicationQuestions: (clientId: string, applicationId: string) => string;
-    readonly applicationQuestion: (clientId: string, applicationId: string, questionId: string) => string;
-    readonly vacancySuggestions: (clientId: string) => string;
-    readonly vacancySuggestion: (clientId: string, suggestionId: string) => string;
-    readonly gmailMessages: (clientId: string) => string;
-    readonly gmailMessage: (clientId: string, messageId: string) => string;
-    readonly targetPreferences: (clientId: string) => string;
+interface ResumeLink {
+    id?: string;
+    title: string;
+    url: string;
+    description: string;
+    createdAt?: Date | string;
+    createdBy: string;
+    clientId: string;
+}
+
+declare const firestorePaths: {
+    readonly clients: {
+        readonly collection: () => string;
+        readonly doc: (clientId: string) => string;
+        readonly applications: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, applicationId: string) => string;
+            readonly questions: {
+                readonly collection: (clientId: string, applicationId: string) => string;
+                readonly doc: (clientId: string, applicationId: string, questionId: string) => string;
+            };
+        };
+        readonly questions: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, questionId: string) => string;
+        };
+        readonly preferences: {
+            readonly target: (clientId: string) => string;
+        };
+        readonly vacancySuggestions: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, suggestionId: string) => string;
+        };
+    };
+    readonly users: {
+        readonly collection: () => string;
+        readonly doc: (userId: string) => string;
+    };
+    readonly vacancies: {
+        readonly collection: () => string;
+        readonly doc: (vacancyId: string) => string;
+    };
+    readonly agents: {
+        readonly collection: () => string;
+        readonly doc: (agentId: string) => string;
+    };
+    readonly clientData: {
+        readonly collection: () => string;
+        readonly doc: (clientDataId: string) => string;
+    };
+    readonly clientLogins: {
+        readonly collection: (userId: string) => string;
+        readonly doc: (userId: string, domain: string) => string;
+    };
+    readonly gmailMessages: {
+        readonly collection: (clientId: string) => string;
+        readonly doc: (clientId: string, messageId: string) => string;
+    };
+    readonly resumeLinks: {
+        readonly collection: (clientId: string) => string;
+        readonly doc: (clientId: string, resumeLinkId: string) => string;
+    };
 };
 
-export { Agent, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, GmailMessage, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, pathStrings };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, ClientStatus, GmailMessage, ResumeLink, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths };

package/dist/index.js

@@ -24,7 +24,7 @@ __export(src_exports, {
   ApplicationStatus: () => ApplicationStatus,
   ClientQuestionTypeOptions: () => ClientQuestionTypeOptions,
   VacancyCategory: () => VacancyCategory,
-  pathStrings: () => pathStrings
+  firestorePaths: () => firestorePaths
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -84,42 +84,59 @@ var ClientQuestionTypeOptions = [
 // src/types/ApplicationQuestion.ts
 var ApplicationQuestionTypeOptions = ["text", "select"];
 
-// src/paths/pathStrings.ts
-var pathStrings = {
-  clients: () => "clients",
-  client: (clientId) => `clients/${clientId}`,
-  // Application paths
-  applications: (clientId) => `clients/${clientId}/applications`,
-  application: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
-  // AuthUser paths
-  users: () => "users",
-  user: (userId) => `users/${userId}`,
-  // Vacancy paths
-  vacancies: () => "vacancies",
-  vacancy: (vacancyId) => `vacancies/${vacancyId}`,
-  // Agent paths
-  agents: () => "agents",
-  agent: (agentId) => `agents/${agentId}`,
-  // ClientQuestion paths
-  clientQuestions: (clientId) => `clients/${clientId}/questions`,
-  clientQuestion: (clientId, questionId) => `clients/${clientId}/questions/${questionId}`,
-  // ClientData paths
-  clientData: () => "clientData",
-  clientDataItem: (clientDataId) => `clientData/${clientDataId}`,
-  // ClientLogin paths
-  clientLogins: (userId) => `clientLogins/${userId}`,
-  clientLogin: (userId, domain) => `clientLogins/${userId}/logins/${domain}`,
-  // ApplicationQuestion paths
-  applicationQuestions: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
-  applicationQuestion: (clientId, applicationId, questionId) => `clients/${clientId}/applications/${applicationId}/questions/${questionId}`,
-  // VacancySuggestion paths
-  vacancySuggestions: (clientId) => `clients/${clientId}/vacancySuggestions`,
-  vacancySuggestion: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`,
-  // GmailMessage paths
-  gmailMessages: (clientId) => `clientEmails/${clientId}/messages`,
-  gmailMessage: (clientId, messageId) => `clientEmails/${clientId}/messages/${messageId}`,
-  // TargetPreferences paths
-  targetPreferences: (clientId) => `clients/${clientId}/preferences/targetPreferences`
+// src/paths/firestorePaths.ts
+var firestorePaths = {
+  clients: {
+    collection: () => "clients",
+    doc: (clientId) => `clients/${clientId}`,
+    applications: {
+      collection: (clientId) => `clients/${clientId}/applications`,
+      doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
+      questions: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
+        doc: (clientId, applicationId, questionId) => `clients/${clientId}/applications/${applicationId}/questions/${questionId}`
+      }
+    },
+    questions: {
+      collection: (clientId) => `clients/${clientId}/questions`,
+      doc: (clientId, questionId) => `clients/${clientId}/questions/${questionId}`
+    },
+    preferences: {
+      target: (clientId) => `clients/${clientId}/preferences/targetPreferences`
+    },
+    vacancySuggestions: {
+      collection: (clientId) => `clients/${clientId}/vacancySuggestions`,
+      doc: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`
+    }
+  },
+  users: {
+    collection: () => "users",
+    doc: (userId) => `users/${userId}`
+  },
+  vacancies: {
+    collection: () => "vacancies",
+    doc: (vacancyId) => `vacancies/${vacancyId}`
+  },
+  agents: {
+    collection: () => "agents",
+    doc: (agentId) => `agents/${agentId}`
+  },
+  clientData: {
+    collection: () => "clientData",
+    doc: (clientDataId) => `clientData/${clientDataId}`
+  },
+  clientLogins: {
+    collection: (userId) => `clientLogins/${userId}/logins`,
+    doc: (userId, domain) => `clientLogins/${userId}/logins/${domain}`
+  },
+  gmailMessages: {
+    collection: (clientId) => `clientEmails/${clientId}/messages`,
+    doc: (clientId, messageId) => `clientEmails/${clientId}/messages/${messageId}`
+  },
+  resumeLinks: {
+    collection: (clientId) => `clients/${clientId}/resumeLinks`,
+    doc: (clientId, resumeLinkId) => `clients/${clientId}/resumeLinks/${resumeLinkId}`
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -127,5 +144,5 @@ var pathStrings = {
   ApplicationStatus,
   ClientQuestionTypeOptions,
   VacancyCategory,
-  pathStrings
+  firestorePaths
 });

package/dist/index.mjs

@@ -54,47 +54,64 @@ var ClientQuestionTypeOptions = [
 // src/types/ApplicationQuestion.ts
 var ApplicationQuestionTypeOptions = ["text", "select"];
 
-// src/paths/pathStrings.ts
-var pathStrings = {
-  clients: () => "clients",
-  client: (clientId) => `clients/${clientId}`,
-  // Application paths
-  applications: (clientId) => `clients/${clientId}/applications`,
-  application: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
-  // AuthUser paths
-  users: () => "users",
-  user: (userId) => `users/${userId}`,
-  // Vacancy paths
-  vacancies: () => "vacancies",
-  vacancy: (vacancyId) => `vacancies/${vacancyId}`,
-  // Agent paths
-  agents: () => "agents",
-  agent: (agentId) => `agents/${agentId}`,
-  // ClientQuestion paths
-  clientQuestions: (clientId) => `clients/${clientId}/questions`,
-  clientQuestion: (clientId, questionId) => `clients/${clientId}/questions/${questionId}`,
-  // ClientData paths
-  clientData: () => "clientData",
-  clientDataItem: (clientDataId) => `clientData/${clientDataId}`,
-  // ClientLogin paths
-  clientLogins: (userId) => `clientLogins/${userId}`,
-  clientLogin: (userId, domain) => `clientLogins/${userId}/logins/${domain}`,
-  // ApplicationQuestion paths
-  applicationQuestions: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
-  applicationQuestion: (clientId, applicationId, questionId) => `clients/${clientId}/applications/${applicationId}/questions/${questionId}`,
-  // VacancySuggestion paths
-  vacancySuggestions: (clientId) => `clients/${clientId}/vacancySuggestions`,
-  vacancySuggestion: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`,
-  // GmailMessage paths
-  gmailMessages: (clientId) => `clientEmails/${clientId}/messages`,
-  gmailMessage: (clientId, messageId) => `clientEmails/${clientId}/messages/${messageId}`,
-  // TargetPreferences paths
-  targetPreferences: (clientId) => `clients/${clientId}/preferences/targetPreferences`
+// src/paths/firestorePaths.ts
+var firestorePaths = {
+  clients: {
+    collection: () => "clients",
+    doc: (clientId) => `clients/${clientId}`,
+    applications: {
+      collection: (clientId) => `clients/${clientId}/applications`,
+      doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,
+      questions: {
+        collection: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}/questions`,
+        doc: (clientId, applicationId, questionId) => `clients/${clientId}/applications/${applicationId}/questions/${questionId}`
+      }
+    },
+    questions: {
+      collection: (clientId) => `clients/${clientId}/questions`,
+      doc: (clientId, questionId) => `clients/${clientId}/questions/${questionId}`
+    },
+    preferences: {
+      target: (clientId) => `clients/${clientId}/preferences/targetPreferences`
+    },
+    vacancySuggestions: {
+      collection: (clientId) => `clients/${clientId}/vacancySuggestions`,
+      doc: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`
+    }
+  },
+  users: {
+    collection: () => "users",
+    doc: (userId) => `users/${userId}`
+  },
+  vacancies: {
+    collection: () => "vacancies",
+    doc: (vacancyId) => `vacancies/${vacancyId}`
+  },
+  agents: {
+    collection: () => "agents",
+    doc: (agentId) => `agents/${agentId}`
+  },
+  clientData: {
+    collection: () => "clientData",
+    doc: (clientDataId) => `clientData/${clientDataId}`
+  },
+  clientLogins: {
+    collection: (userId) => `clientLogins/${userId}/logins`,
+    doc: (userId, domain) => `clientLogins/${userId}/logins/${domain}`
+  },
+  gmailMessages: {
+    collection: (clientId) => `clientEmails/${clientId}/messages`,
+    doc: (clientId, messageId) => `clientEmails/${clientId}/messages/${messageId}`
+  },
+  resumeLinks: {
+    collection: (clientId) => `clients/${clientId}/resumeLinks`,
+    doc: (clientId, resumeLinkId) => `clients/${clientId}/resumeLinks/${resumeLinkId}`
+  }
 };
 export {
   ApplicationQuestionTypeOptions,
   ApplicationStatus,
   ClientQuestionTypeOptions,
   VacancyCategory,
-  pathStrings
+  firestorePaths
 };

package/package.json

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