@jobsearch-works/firestore-models 1.0.2 → 1.0.3

package/README.md

@@ -24,22 +24,186 @@ 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
+```
+
+## Models
+
+### Client
+
+```typescript
+interface Client {
+  name: string;
+  email: string;
+  status: "active" | "inactive";
+  resume?: string;
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### Application
+
+```typescript
+interface Application {
+  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;
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### AuthUser
+
+```typescript
+interface AuthUser {
+  email: string;
+  role: "admin" | "client";
+  clientId?: string; // Required if role is "client"
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### Vacancy
+
+```typescript
+interface Vacancy {
+  company: string;
+  position: string;
+  location: string;
+  jobId: string;
+  advertisingUrl: string;
+  applicationUrl: string;
+  applicationDomain: string;
+  advertisingDomain: string;
+  description: string;
+  fullPageText: string;
+  status: "active" | "inactive";
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### Question
+
+```typescript
+interface Question {
+  text: string;
+  type: "text" | "multiple_choice" | "single_choice";
+  options?: string[];
+  required: boolean;
+  order: number;
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### UserQuestion
+
+```typescript
+interface UserQuestion {
+  clientId: string;
+  questionId: string;
+  answer: string;
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### ClientData
+
+```typescript
+interface ClientData {
+  clientId: string;
+  key: string;
+  value: any;
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
+### ClientLogin
+
+```typescript
+interface ClientLogin {
+  clientId: string;
+  ipAddress: string;
+  userAgent: string;
+  createdAt: string;
+}
+```
+
+### VacancySuggestion
+
+```typescript
+interface VacancySuggestion {
+  clientId: string;
+  vacancyId: string;
+  status: "pending" | "accepted" | "rejected";
+  createdAt: string;
+  updatedAt?: string;
+}
+```
+
 ## Usage
 
 Import the models and path builders in your application:
 
 ```typescript
-import { User, userPath } from "@jsw/firestore-models";
+import { Client, clientPath } from "@jsw/firestore-models";
 
 // Use the type-safe model
-const user: User = {
+const client: Client.Model = {
   id: "123",
   name: "John Doe",
   email: "john@example.com",
+  status: "active",
 };
 
 // Use the path builder
-const userDocPath = userPath("123"); // returns 'users/123'
+const clientDocPath = clientPath("123"); // returns 'clients/123'
 ```
 
 ## Contributing

package/package.json

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