@jobsearch-works/firestore-models 1.0.2 → 1.0.7

package/README.md

@@ -24,22 +24,270 @@ npm install @jsw/firestore-models
 yarn add @jsw/firestore-models
 ```
 
+## Project Structure
+
+```
+firestore-models/
+├── src/
+│   ├── models/           # All Firestore models
+│   │   ├── Application.ts
+│   │   ├── AuthUser.ts
+│   │   ├── Client.ts
+│   │   ├── ClientData.ts
+│   │   ├── ClientLogin.ts
+│   │   ├── Question.ts
+│   │   ├── UserQuestion.ts
+│   │   ├── Vacancy.ts
+│   │   └── VacancySuggestion.ts
+│   ├── BaseModel.ts      # Base interface for all models
+│   └── index.ts          # Main entry point
+├── dist/                 # Compiled output
+└── package.json
+```
+
+## Base Model
+
+All models extend from the BaseModel interface:
+
+```typescript
+interface BaseModel {
+  id?: string; // Optional document ID
+  createdAt?: Date | string; // Optional creation timestamp
+  updatedAt?: Date | string; // Optional update timestamp
+}
+```
+
+## Models and Namespaces
+
+Each model is defined within its own namespace, which includes:
+
+- The model interface
+- Path builders for Firestore collections and documents
+- Utility functions for working with the model
+
+### Client
+
+```typescript
+namespace Client {
+  interface Model extends BaseModel {
+    name: string;
+    email: string;
+    status: "active" | "inactive";
+    resume?: string;
+  }
+
+  // Path builders
+  const collection = () => "clients";
+  const document = (clientId: string) => `clients/${clientId}`;
+
+  // Utility functions
+  const formatClient = (client: Client.Model): string;
+  const createNew = (name: string, email: string): Client.Model;
+}
+```
+
+### Application
+
+```typescript
+namespace Application {
+  interface Model extends BaseModel {
+    vacancyId: string;
+    clientId: string;
+    status:
+      | "new"
+      | "submitted"
+      | "interviewing"
+      | "accepted"
+      | "rejected"
+      | "withdrawn"
+      | "applying"
+      | "suggested"
+      | "approved";
+    coverLetter?: string;
+    resume?: string;
+    // Denormalized fields from Vacancy
+    company?: string;
+    position?: string;
+    location?: string;
+    jobId?: string;
+    advertisingUrl?: string;
+    applicationUrl?: string;
+    applicationDomain?: string;
+    advertisingDomain?: string;
+    description?: string;
+    fullPageText?: string;
+  }
+
+  // Path builders
+  const collection = (clientId: string) => `clients/${clientId}/applications`;
+  const document = (clientId: string, applicationId: string) =>
+    `clients/${clientId}/applications/${applicationId}`;
+
+  // Utility functions
+  const formatSummary = (application: Application.Model): string;
+  const formatDate = (date: Date | string): string;
+  const createNew = (
+    clientId: string,
+    vacancyId: string,
+    vacancyData: Partial<Vacancy.Model>
+  ): Application.Model;
+  const updateStatus = (
+    application: Application.Model,
+    newStatus: Application.Model["status"]
+  ): Application.Model;
+}
+```
+
+### AuthUser
+
+```typescript
+namespace AuthUser {
+  interface Model extends BaseModel {
+    email: string;
+    displayName?: string;
+    photoURL?: string;
+    lastSignIn?: Date | string;
+    emailVerified?: boolean;
+  }
+
+  // Path builders
+  const collection = () => "users";
+  const document = (userId: string) => `users/${userId}`;
+
+  // Utility functions
+  const fromFirebaseUser = (user: any): AuthUser.Model;
+  const formatDates = (user: AuthUser.Model): Record<string, string>;
+  const toFirestore = (user: AuthUser.Model): Record<string, any>;
+  const fromFirestore = (data: Record<string, any>): AuthUser.Model;
+}
+```
+
+### Vacancy
+
+```typescript
+namespace Vacancy {
+  interface Model extends BaseModel {
+    company: string;
+    position: string;
+    location: string;
+    jobId: string;
+    advertisingUrl: string;
+    applicationUrl: string;
+    applicationDomain: string;
+    advertisingDomain: string;
+    description: string;
+    fullPageText: string;
+    status: "active" | "inactive";
+  }
+
+  // Path builders
+  const collection = () => "vacancies";
+  const document = (vacancyId: string) => `vacancies/${vacancyId}`;
+}
+```
+
+### Question
+
+```typescript
+namespace Question {
+  interface Model extends BaseModel {
+    text: string;
+    type: "text" | "multiple_choice" | "single_choice";
+    options?: string[];
+    required: boolean;
+    order: number;
+  }
+
+  // Path builders
+  const collection = () => "questions";
+  const document = (questionId: string) => `questions/${questionId}`;
+}
+```
+
+### UserQuestion
+
+```typescript
+namespace UserQuestion {
+  interface Model extends BaseModel {
+    clientId: string;
+    questionId: string;
+    answer: string;
+  }
+
+  // Path builders
+  const collection = (clientId: string) => `clients/${clientId}/questions`;
+  const document = (clientId: string, questionId: string) =>
+    `clients/${clientId}/questions/${questionId}`;
+}
+```
+
+### ClientData
+
+```typescript
+namespace ClientData {
+  interface Model extends BaseModel {
+    clientId: string;
+    key: string;
+    value: any;
+  }
+
+  // Path builders
+  const collection = (clientId: string) => `clients/${clientId}/data`;
+  const document = (clientId: string, key: string) =>
+    `clients/${clientId}/data/${key}`;
+}
+```
+
+### ClientLogin
+
+```typescript
+namespace ClientLogin {
+  interface Model extends BaseModel {
+    clientId: string;
+    ipAddress: string;
+    userAgent: string;
+  }
+
+  // Path builders
+  const collection = (clientId: string) => `clients/${clientId}/logins`;
+  const document = (clientId: string, loginId: string) =>
+    `clients/${clientId}/logins/${loginId}`;
+}
+```
+
+### VacancySuggestion
+
+```typescript
+namespace VacancySuggestion {
+  interface Model extends BaseModel {
+    clientId: string;
+    vacancyId: string;
+    status: "pending" | "accepted" | "rejected";
+  }
+
+  // Path builders
+  const collection = (clientId: string) => `clients/${clientId}/suggestions`;
+  const document = (clientId: string, suggestionId: string) =>
+    `clients/${clientId}/suggestions/${suggestionId}`;
+}
+```
+
 ## Usage
 
-Import the models and path builders in your application:
+Import the models and their utilities in your application:
 
 ```typescript
-import { User, userPath } from "@jsw/firestore-models";
+import { Client } from "@jsw/firestore-models";
+
+// Create a new client
+const newClient = Client.createNew("John Doe", "john@example.com");
 
-// Use the type-safe model
-const user: User = {
-  id: "123",
-  name: "John Doe",
-  email: "john@example.com",
-};
+// Use the path builders
+const clientDocPath = Client.document("123"); // returns 'clients/123'
+const clientCollectionPath = Client.collection(); // returns 'clients'
 
-// Use the path builder
-const userDocPath = userPath("123"); // returns 'users/123'
+// Use the utility functions
+const formattedClient = Client.formatClient(newClient);
 ```
 
 ## Contributing

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 export * from "./BaseModel";
-export * from "./models/Application";
-export * from "./models/AuthUser";
-export * from "./models/Client";
-export * from "./models/ClientData";
-export * from "./models/ClientLogin";
-export * from "./models/Question";
-export * from "./models/UserQuestion";
-export * from "./models/Vacancy";
-export * from "./models/VacancySuggestion";
+import * as Application from "./models/Application";
+import * as AuthUser from "./models/AuthUser";
+import * as Client from "./models/Client";
+import * as ClientData from "./models/ClientData";
+import * as ClientLogin from "./models/ClientLogin";
+import * as Question from "./models/Question";
+import * as UserQuestion from "./models/UserQuestion";
+import * as Vacancy from "./models/Vacancy";
+import * as VacancySuggestion from "./models/VacancySuggestion";
+export { Application, AuthUser, Client, ClientData, ClientLogin, Question, UserQuestion, Vacancy, VacancySuggestion, };

package/dist/index.js

@@ -1,12 +1,13 @@
 // Re-export base model
 export * from "./BaseModel";
 // Re-export all models
-export * from "./models/Application";
-export * from "./models/AuthUser";
-export * from "./models/Client";
-export * from "./models/ClientData";
-export * from "./models/ClientLogin";
-export * from "./models/Question";
-export * from "./models/UserQuestion";
-export * from "./models/Vacancy";
-export * from "./models/VacancySuggestion";
+import * as Application from "./models/Application";
+import * as AuthUser from "./models/AuthUser";
+import * as Client from "./models/Client";
+import * as ClientData from "./models/ClientData";
+import * as ClientLogin from "./models/ClientLogin";
+import * as Question from "./models/Question";
+import * as UserQuestion from "./models/UserQuestion";
+import * as Vacancy from "./models/Vacancy";
+import * as VacancySuggestion from "./models/VacancySuggestion";
+export { Application, AuthUser, Client, ClientData, ClientLogin, Question, UserQuestion, Vacancy, VacancySuggestion, };

package/dist/models/clientData.d.ts

@@ -12,14 +12,15 @@ export declare namespace ClientData {
         phone: string;
         address: string;
         city: string;
+        suburb: string;
         state: string;
         zip: string;
         country: string;
         linkedIn?: string;
-        countryPhoneCode?: string;
+        countryPhoneCode: string;
     }
     const collection: () => string;
     const document: (clientDataId: string) => string;
     const formatClientData: (clientData: ClientData.Model) => string;
-    const createNew: (firstName: string, lastName: string, email: string, phone: string, address: string, city: string, state: string, zip: string, country: string) => ClientData.Model;
+    const createNew: (firstName: string, lastName: string, email: string, phone: string, address: string, city: string, state: string, zip: string, country: string, countryPhoneCode: string, suburb: string) => ClientData.Model;
 }

package/dist/models/clientData.js

@@ -5,7 +5,7 @@ export var ClientData;
     ClientData.formatClientData = (clientData) => {
         return `${clientData.firstName} ${clientData.lastName} (${clientData.email})`;
     };
-    ClientData.createNew = (firstName, lastName, email, phone, address, city, state, zip, country) => {
+    ClientData.createNew = (firstName, lastName, email, phone, address, city, state, zip, country, countryPhoneCode, suburb) => {
         return {
             firstName,
             lastName,
@@ -15,9 +15,11 @@ export var ClientData;
             phone,
             address,
             city,
+            suburb,
             state,
             zip,
             country,
+            countryPhoneCode,
             createdAt: new Date().toISOString(),
         };
     };

package/package.json

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