@jobsearch-works/firestore-models 1.1.9 → 1.1.11

package/README.md

@@ -37,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
@@ -98,6 +109,7 @@ ClientLogin
 | 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:**
 
@@ -110,6 +122,8 @@ ClientLogin
 
 ## ✅ 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
@@ -279,6 +293,27 @@ All Firestore document schemas are defined as TypeScript interfaces in `src/type
   }
   ```
 
+- **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

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";
@@ -237,6 +239,16 @@ interface TargetPreferences {
     updatedAt: Date;
 }
 
+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;
@@ -260,6 +272,10 @@ declare const firestorePaths: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, suggestionId: string) => string;
         };
+        readonly resumeLinks: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, resumeLinkId: string) => string;
+        };
     };
     readonly users: {
         readonly collection: () => string;
@@ -287,4 +303,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Agent, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, GmailMessage, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths };
+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";
@@ -237,6 +239,16 @@ interface TargetPreferences {
     updatedAt: Date;
 }
 
+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;
@@ -260,6 +272,10 @@ declare const firestorePaths: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, suggestionId: string) => string;
         };
+        readonly resumeLinks: {
+            readonly collection: (clientId: string) => string;
+            readonly doc: (clientId: string, resumeLinkId: string) => string;
+        };
     };
     readonly users: {
         readonly collection: () => string;
@@ -287,4 +303,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Agent, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, GmailMessage, TargetJob, TargetLocation, TargetPreferences, Vacancy, VacancyCategory, VacancySuggestion, firestorePaths };
+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

@@ -107,6 +107,10 @@ var firestorePaths = {
     vacancySuggestions: {
       collection: (clientId) => `clients/${clientId}/vacancySuggestions`,
       doc: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`
+    },
+    resumeLinks: {
+      collection: (clientId) => `clients/${clientId}/resumeLinks`,
+      doc: (clientId, resumeLinkId) => `clients/${clientId}/resumeLinks/${resumeLinkId}`
     }
   },
   users: {
@@ -126,7 +130,7 @@ var firestorePaths = {
     doc: (clientDataId) => `clientData/${clientDataId}`
   },
   clientLogins: {
-    collection: (userId) => `clientLogins/${userId}`,
+    collection: (userId) => `clientLogins/${userId}/logins`,
     doc: (userId, domain) => `clientLogins/${userId}/logins/${domain}`
   },
   gmailMessages: {

package/dist/index.mjs

@@ -77,6 +77,10 @@ var firestorePaths = {
     vacancySuggestions: {
       collection: (clientId) => `clients/${clientId}/vacancySuggestions`,
       doc: (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`
+    },
+    resumeLinks: {
+      collection: (clientId) => `clients/${clientId}/resumeLinks`,
+      doc: (clientId, resumeLinkId) => `clients/${clientId}/resumeLinks/${resumeLinkId}`
     }
   },
   users: {
@@ -96,7 +100,7 @@ var firestorePaths = {
     doc: (clientDataId) => `clientData/${clientDataId}`
   },
   clientLogins: {
-    collection: (userId) => `clientLogins/${userId}`,
+    collection: (userId) => `clientLogins/${userId}/logins`,
     doc: (userId, domain) => `clientLogins/${userId}/logins/${domain}`
   },
   gmailMessages: {

package/package.json

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