@jobsearch-works/firestore-models 1.0.3 → 1.0.8

package/dist/index.d.ts

@@ -1,10 +1,308 @@
-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";
+/**
+ * Generic type for all model interfaces
+ */
+interface BaseModel {
+    id?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+}
+
+declare namespace Application {
+    /**
+     * Represents a job application
+     */
+    interface Model extends BaseModel {
+        vacancyId: string;
+        clientId: string;
+        status: "new" | "submitted" | "interviewing" | "accepted" | "rejected" | "withdrawn" | "applying" | "suggested" | "approved";
+        coverLetter?: string;
+        resume?: string;
+        company?: string;
+        position?: string;
+        location?: string;
+        jobId?: string;
+        advertisingUrl?: string;
+        applicationUrl?: string;
+        applicationDomain?: string;
+        advertisingDomain?: string;
+        description?: string;
+        fullPageText?: string;
+    }
+    const collection: (clientId: string) => string;
+    const document: (clientId: string, applicationId: string) => string;
+    const formatSummary: (application: Application.Model) => string;
+    const formatDate: (date: Date | string) => string;
+    const createNew: (clientId: string, vacancyId: string, vacancyData?: {
+        company?: string;
+        position?: string;
+        location?: string;
+        jobId?: string;
+        advertisingUrl?: string;
+        applicationUrl?: string;
+        applicationDomain?: string;
+        advertisingDomain?: string;
+        description?: string;
+        fullPageText?: string;
+    }) => Application.Model;
+    const updateStatus: (application: Application.Model, newStatus: Application.Model["status"]) => Application.Model;
+}
+
+declare const Application$1_Application: typeof Application;
+declare namespace Application$1 {
+  export {
+    Application$1_Application as Application,
+  };
+}
+
+interface FirestoreTimestamp {
+    seconds: number;
+    nanoseconds: number;
+    _firestore_timestamp?: boolean;
+}
+/**
+ * AuthUser interface - replaces the old class-based model
+ */
+interface AuthUser extends BaseModel {
+    email: string;
+    displayName?: string;
+    photoURL?: string;
+    lastSignIn?: Date | string;
+    emailVerified?: boolean;
+}
+declare const AuthUserCollectionPath = "users";
+declare const getAuthUserDocumentPath: (userId: string) => string;
+declare const AuthUserUtils: {
+    getTimestampFields: () => string[];
+    isFirestoreTimestamp: (value: any) => value is FirestoreTimestamp;
+    fromFirebaseUser: (user: any) => AuthUser;
+    formatDates: (user: AuthUser) => {
+        lastSignIn: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+    toFirestore: (user: AuthUser) => Record<string, any>;
+    fromFirestore: (data: Record<string, any>) => AuthUser;
+};
+
+type AuthUser$1_AuthUser = AuthUser;
+declare const AuthUser$1_AuthUserCollectionPath: typeof AuthUserCollectionPath;
+declare const AuthUser$1_AuthUserUtils: typeof AuthUserUtils;
+declare const AuthUser$1_getAuthUserDocumentPath: typeof getAuthUserDocumentPath;
+declare namespace AuthUser$1 {
+  export {
+    AuthUser$1_AuthUser as AuthUser,
+    AuthUser$1_AuthUserCollectionPath as AuthUserCollectionPath,
+    AuthUser$1_AuthUserUtils as AuthUserUtils,
+    AuthUser$1_getAuthUserDocumentPath as getAuthUserDocumentPath,
+  };
+}
+
+declare namespace Client {
+    interface Model extends BaseModel {
+        name: string;
+        email: string;
+        status: "active" | "inactive";
+        resume?: string;
+    }
+    const collection: () => string;
+    const document: (clientId: string) => string;
+    const formatClient: (client: Client.Model) => string;
+    const createNew: (name: string, email: string) => Client.Model;
+}
+
+declare const Client$1_Client: typeof Client;
+declare namespace Client$1 {
+  export {
+    Client$1_Client as Client,
+  };
+}
+
+declare namespace ClientData {
+    /**
+     * Represents a user's personal data.
+     */
+    interface Model extends BaseModel {
+        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;
+    }
+    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, countryPhoneCode: string, suburb: string) => ClientData.Model;
+}
+
+declare const ClientData$1_ClientData: typeof ClientData;
+declare namespace ClientData$1 {
+  export {
+    ClientData$1_ClientData as ClientData,
+  };
+}
+
+declare namespace ClientLogin {
+    /**
+     * Represents login credentials for a client website
+     */
+    interface Model extends BaseModel {
+        userId: string;
+        url: string;
+        domain: string;
+        username?: string;
+        password: string;
+        email?: string;
+    }
+    const collection: (userId: string) => string;
+    const document: (userId: string, domain: string) => string;
+    const formatClientLogin: (clientLogin: ClientLogin.Model) => string;
+    const createNew: (userId: string, url: string, domain: string, password: string, username?: string, email?: string) => ClientLogin.Model;
+}
+
+declare const ClientLogin$1_ClientLogin: typeof ClientLogin;
+declare namespace ClientLogin$1 {
+  export {
+    ClientLogin$1_ClientLogin as ClientLogin,
+  };
+}
+
+/**
+ * QuestionData interface defines the core data fields for a generic question.
+ */
+interface QuestionData {
+    question: string;
+    options: string[];
+}
+/**
+ * Question interface - extends BaseModelInterface and includes QuestionData
+ */
+interface Question extends BaseModel, QuestionData {
+}
+interface ApplicationQuestion {
+    questionText: string;
+    type: "text";
+    answer?: string;
+}
+/**
+ * Represents ApplicationQuestion data including its Firestore document ID.
+ */
+type ApplicationQuestionDocument = ApplicationQuestion & {
+    id: string;
+};
+/**
+ * Represents a question-answer pair stored centrally for a client.
+ * Assumes structure in clients/{clientId}/questions collection.
+ */
+interface ClientQuestionAnswerPair {
+    id?: string;
+    questionText: string;
+    answer: string;
+    createdAt?: Date;
+}
+
+type Question$1_ApplicationQuestion = ApplicationQuestion;
+type Question$1_ApplicationQuestionDocument = ApplicationQuestionDocument;
+type Question$1_ClientQuestionAnswerPair = ClientQuestionAnswerPair;
+type Question$1_Question = Question;
+type Question$1_QuestionData = QuestionData;
+declare namespace Question$1 {
+  export {
+    Question$1_ApplicationQuestion as ApplicationQuestion,
+    Question$1_ApplicationQuestionDocument as ApplicationQuestionDocument,
+    Question$1_ClientQuestionAnswerPair as ClientQuestionAnswerPair,
+    Question$1_Question as Question,
+    Question$1_QuestionData as QuestionData,
+  };
+}
+
+/**
+ * UserQuestionData interface defines the core data fields for a user question.
+ */
+interface UserQuestionData {
+    userId: string;
+    question: string;
+    answer: string;
+    options: string[];
+}
+/**
+ * UserQuestion interface - extends BaseModel and includes UserQuestionData
+ */
+interface UserQuestion extends BaseModel, UserQuestionData {
+}
+
+type UserQuestion$1_UserQuestion = UserQuestion;
+type UserQuestion$1_UserQuestionData = UserQuestionData;
+declare namespace UserQuestion$1 {
+  export {
+    UserQuestion$1_UserQuestion as UserQuestion,
+    UserQuestion$1_UserQuestionData as UserQuestionData,
+  };
+}
+
+declare namespace Vacancy {
+    /**
+     * Represents a job vacancy
+     */
+    interface Model extends BaseModel {
+        company: string;
+        position: string;
+        location: string;
+        description: string;
+        advertisingUrl: string;
+        applicationUrl: string;
+        applicationDomain: string;
+        advertisingDomain: string;
+        fullPageText: string;
+        jobId: string;
+        suggestedTo?: string[];
+    }
+    const collection: () => string;
+    const document: (vacancyId: string) => string;
+    const formatSummary: (vacancy: Vacancy.Model) => string;
+    const formatDate: (date: Date | string) => string;
+    const createNew: (company: string, position: string, location: string, description: string, advertisingUrl: string, applicationUrl: string, applicationDomain: string, advertisingDomain: string, fullPageText: string, jobId: string) => Vacancy.Model;
+}
+
+declare const Vacancy$1_Vacancy: typeof Vacancy;
+declare namespace Vacancy$1 {
+  export {
+    Vacancy$1_Vacancy as Vacancy,
+  };
+}
+
+declare namespace VacancySuggestion {
+    /**
+     * Represents a job vacancy suggestion for a client
+     */
+    interface Model extends BaseModel {
+        clientId: string;
+        vacancyId: string;
+        vacancyCompany: string;
+        vacancyPosition: string;
+        status: string;
+        createdAt: Date | string;
+        updatedAt?: Date | string;
+    }
+    const collection: (clientId: string) => string;
+    const document: (clientId: string, suggestionId: string) => string;
+    const formatSummary: (suggestion: VacancySuggestion.Model) => string;
+    const createNew: (clientId: string, vacancyId: string, vacancyCompany: string, vacancyPosition: string, status?: string) => VacancySuggestion.Model;
+}
+
+declare const VacancySuggestion$1_VacancySuggestion: typeof VacancySuggestion;
+declare namespace VacancySuggestion$1 {
+  export {
+    VacancySuggestion$1_VacancySuggestion as VacancySuggestion,
+  };
+}
+
+export { Application$1 as Application, AuthUser$1 as AuthUser, BaseModel, Client$1 as Client, ClientData$1 as ClientData, ClientLogin$1 as ClientLogin, Question$1 as Question, UserQuestion$1 as UserQuestion, Vacancy$1 as Vacancy, VacancySuggestion$1 as VacancySuggestion };

package/dist/index.js

@@ -1,12 +1,308 @@
-// 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";
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Application: () => Application_exports,
+  AuthUser: () => AuthUser_exports,
+  Client: () => Client_exports,
+  ClientData: () => ClientData_exports,
+  ClientLogin: () => ClientLogin_exports,
+  Question: () => Question_exports,
+  UserQuestion: () => UserQuestion_exports,
+  Vacancy: () => Vacancy_exports,
+  VacancySuggestion: () => VacancySuggestion_exports
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/models2/Application.ts
+var Application_exports = {};
+__export(Application_exports, {
+  Application: () => Application
+});
+var Application;
+((Application2) => {
+  Application2.collection = (clientId) => `clients/${clientId}/applications`;
+  Application2.document = (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`;
+  Application2.formatSummary = (application) => {
+    return `${application.position} at ${application.company} (${application.status})`;
+  };
+  Application2.formatDate = (date) => {
+    const dateObj = date instanceof Date ? date : new Date(date);
+    return dateObj.toLocaleDateString();
+  };
+  Application2.createNew = (clientId, vacancyId, vacancyData = {}) => {
+    return {
+      clientId,
+      vacancyId,
+      status: "new",
+      company: vacancyData.company,
+      position: vacancyData.position,
+      location: vacancyData.location,
+      jobId: vacancyData.jobId,
+      advertisingUrl: vacancyData.advertisingUrl,
+      applicationUrl: vacancyData.applicationUrl,
+      applicationDomain: vacancyData.applicationDomain,
+      advertisingDomain: vacancyData.advertisingDomain,
+      description: vacancyData.description,
+      fullPageText: vacancyData.fullPageText,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+  Application2.updateStatus = (application, newStatus) => {
+    return {
+      ...application,
+      status: newStatus,
+      updatedAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(Application || (Application = {}));
+
+// src/models2/AuthUser.ts
+var AuthUser_exports = {};
+__export(AuthUser_exports, {
+  AuthUserCollectionPath: () => AuthUserCollectionPath,
+  AuthUserUtils: () => AuthUserUtils,
+  getAuthUserDocumentPath: () => getAuthUserDocumentPath
+});
+var AuthUserCollectionPath = "users";
+var getAuthUserDocumentPath = (userId) => `users/${userId}`;
+var AuthUserUtils = {
+  // Get timestamp fields for AuthUser
+  getTimestampFields: () => [],
+  // Check if value is a Firestore timestamp
+  isFirestoreTimestamp: (value) => {
+    return typeof value === "object" && value !== null && ("seconds" in value || "_firestore_timestamp" in value);
+  },
+  // Create from Firebase user object
+  fromFirebaseUser: (user) => {
+    return {
+      id: user.uid,
+      email: user.email,
+      displayName: user.displayName,
+      photoURL: user.photoURL,
+      emailVerified: user.emailVerified,
+      lastSignIn: (/* @__PURE__ */ new Date()).toISOString(),
+      // Current timestamp for new logins
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  },
+  // Convert dates to display format
+  formatDates: (user) => {
+    const formatDate = (dateValue) => {
+      if (!dateValue)
+        return "N/A";
+      const date = typeof dateValue === "string" ? new Date(dateValue) : dateValue;
+      return date.toLocaleString();
+    };
+    return {
+      lastSignIn: formatDate(user.lastSignIn),
+      createdAt: formatDate(user.createdAt),
+      updatedAt: user.updatedAt ? formatDate(user.updatedAt) : void 0
+    };
+  },
+  // Convert AuthUser to format for storage
+  toFirestore: (user) => {
+    const { id, ...data } = user;
+    if (data.lastSignIn && data.lastSignIn instanceof Date) {
+      data.lastSignIn = data.lastSignIn.toISOString();
+    }
+    if (data.createdAt && data.createdAt instanceof Date) {
+      data.createdAt = data.createdAt.toISOString();
+    }
+    if (data.updatedAt && data.updatedAt instanceof Date) {
+      data.updatedAt = data.updatedAt.toISOString();
+    } else {
+      data.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
+    }
+    return data;
+  },
+  // Convert from Firestore data to AuthUser
+  fromFirestore: (data) => {
+    const processedData = { ...data };
+    const timestampFields = [];
+    timestampFields.forEach((field) => {
+      if (data[field]) {
+        if (AuthUserUtils.isFirestoreTimestamp(data[field])) {
+          processedData[field] = new Date(
+            data[field].seconds * 1e3
+          ).toISOString();
+        } else if (typeof data[field] === "string") {
+          processedData[field] = data[field];
+        }
+      }
+    });
+    return processedData;
+  }
+};
+
+// src/models2/Client.ts
+var Client_exports = {};
+__export(Client_exports, {
+  Client: () => Client
+});
+var Client;
+((Client2) => {
+  Client2.collection = () => "clients";
+  Client2.document = (clientId) => `clients/${clientId}`;
+  Client2.formatClient = (client) => {
+    return `${client.name} (${client.email}) - ${client.status}`;
+  };
+  Client2.createNew = (name, email) => {
+    return {
+      name,
+      email,
+      status: "active",
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(Client || (Client = {}));
+
+// src/models2/ClientData.ts
+var ClientData_exports = {};
+__export(ClientData_exports, {
+  ClientData: () => ClientData
+});
+var ClientData;
+((ClientData2) => {
+  ClientData2.collection = () => "clientData";
+  ClientData2.document = (clientDataId) => `clientData/${clientDataId}`;
+  ClientData2.formatClientData = (clientData) => {
+    return `${clientData.firstName} ${clientData.lastName} (${clientData.email})`;
+  };
+  ClientData2.createNew = (firstName, lastName, email, phone, address, city, state, zip, country, countryPhoneCode, suburb) => {
+    return {
+      firstName,
+      lastName,
+      middleName: "",
+      preferredName: "",
+      email,
+      phone,
+      address,
+      city,
+      suburb,
+      state,
+      zip,
+      country,
+      countryPhoneCode,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(ClientData || (ClientData = {}));
+
+// src/models2/ClientLogin.ts
+var ClientLogin_exports = {};
+__export(ClientLogin_exports, {
+  ClientLogin: () => ClientLogin
+});
+var ClientLogin;
+((ClientLogin2) => {
+  ClientLogin2.collection = (userId) => `clientLogins/${userId}`;
+  ClientLogin2.document = (userId, domain) => `clientLogins/${userId}/logins/${domain}`;
+  ClientLogin2.formatClientLogin = (clientLogin) => {
+    return `${clientLogin.domain} (${clientLogin.username || clientLogin.email || "no username"})`;
+  };
+  ClientLogin2.createNew = (userId, url, domain, password, username, email) => {
+    return {
+      userId,
+      url,
+      domain,
+      password,
+      username,
+      email,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(ClientLogin || (ClientLogin = {}));
+
+// src/models2/Question.ts
+var Question_exports = {};
+
+// src/models2/UserQuestion.ts
+var UserQuestion_exports = {};
+
+// src/models2/Vacancy.ts
+var Vacancy_exports = {};
+__export(Vacancy_exports, {
+  Vacancy: () => Vacancy
+});
+var Vacancy;
+((Vacancy2) => {
+  Vacancy2.collection = () => "vacancies";
+  Vacancy2.document = (vacancyId) => `vacancies/${vacancyId}`;
+  Vacancy2.formatSummary = (vacancy) => {
+    return `${vacancy.position} at ${vacancy.company} (${vacancy.location})`;
+  };
+  Vacancy2.formatDate = (date) => {
+    const dateObj = date instanceof Date ? date : new Date(date);
+    return dateObj.toLocaleDateString();
+  };
+  Vacancy2.createNew = (company, position, location, description, advertisingUrl, applicationUrl, applicationDomain, advertisingDomain, fullPageText, jobId) => {
+    return {
+      company,
+      position,
+      location,
+      description,
+      advertisingUrl,
+      applicationUrl,
+      applicationDomain,
+      advertisingDomain,
+      fullPageText,
+      jobId,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(Vacancy || (Vacancy = {}));
+
+// src/models2/VacancySuggestion.ts
+var VacancySuggestion_exports = {};
+__export(VacancySuggestion_exports, {
+  VacancySuggestion: () => VacancySuggestion
+});
+var VacancySuggestion;
+((VacancySuggestion2) => {
+  VacancySuggestion2.collection = (clientId) => `clients/${clientId}/vacancySuggestions`;
+  VacancySuggestion2.document = (clientId, suggestionId) => `clients/${clientId}/vacancySuggestions/${suggestionId}`;
+  VacancySuggestion2.formatSummary = (suggestion) => {
+    return `${suggestion.vacancyPosition} at ${suggestion.vacancyCompany} (${suggestion.status})`;
+  };
+  VacancySuggestion2.createNew = (clientId, vacancyId, vacancyCompany, vacancyPosition, status = "new") => {
+    return {
+      clientId,
+      vacancyId,
+      vacancyCompany,
+      vacancyPosition,
+      status,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString()
+    };
+  };
+})(VacancySuggestion || (VacancySuggestion = {}));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Application,
+  AuthUser,
+  Client,
+  ClientData,
+  ClientLogin,
+  Question,
+  UserQuestion,
+  Vacancy,
+  VacancySuggestion
+});