@jobsearch-works/firestore-models 1.0.7 → 1.0.9

package/dist/index.d.mts

@@ -0,0 +1,308 @@
+/**
+ * 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.d.ts

@@ -1,11 +1,308 @@
-export * from "./BaseModel";
-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, };
+/**
+ * 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 };