@jobsearch-works/firestore-models 1.0.33 → 1.1.0

package/dist/index.d.ts

@@ -1,340 +1,252 @@
-/**
- * Generic type for all model interfaces
- */
-interface BaseModel {
+interface Client {
     id?: string;
+    name: string;
+    email: string;
+    status: "active" | "inactive";
+    resume?: string;
     createdAt?: Date | string;
-    updatedAt?: Date | string;
 }
 
-declare namespace Application {
-    /**
-     * Represents a job application
-     */
-    interface Model extends BaseModel {
-        vacancyId: string;
-        clientId: string;
-        status: Status;
-        assignedTo?: string;
-        coverLetter?: string;
-        resume?: string;
-        submittedAt?: Date | string;
-        interviewingAt?: Date | string;
-        acceptedAt?: Date | string;
-        rejectedAt?: Date | string;
-        withdrawnAt?: Date | string;
-        applyingAt?: Date | string;
-        suggestedAt?: Date | string;
-        approvedAt?: Date | string;
-        company?: string;
-        position?: string;
-        location?: string;
-        jobId?: string;
-        advertisingUrl?: string;
-        applicationUrl?: string;
-        applicationDomain?: string;
-        advertisingDomain?: string;
-        description?: string;
-        fullPageText?: string;
-    }
-    const Status: {
-        readonly New: "new";
-        readonly Submitted: "submitted";
-        readonly Interviewing: "interviewing";
-        readonly Accepted: "accepted";
-        readonly Rejected: "rejected";
-        readonly Withdrawn: "withdrawn";
-        readonly Applying: "applying";
-        readonly Suggested: "suggested";
-        readonly Approved: "approved";
-    };
-    type Status = (typeof Status)[keyof typeof Status];
-    const StatusOptions: readonly Status[];
-    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 namespace AuthUser {
-    export interface Model extends BaseModel {
-        email: string;
-        displayName?: string;
-        photoURL?: string;
-        lastSignIn?: string;
-        emailVerified?: boolean;
-    }
-    interface FirestoreTimestamp {
-        seconds: number;
-        nanoseconds: number;
-        _firestore_timestamp?: boolean;
-    }
-    export const collection: () => string;
-    export const document: (userId: string) => string;
-    export const getTimestampFields: () => (keyof Model)[];
-    export const isFirestoreTimestamp: (value: any) => value is FirestoreTimestamp;
-    export const fromFirebaseUser: (user: any) => Model;
-    export const format: (user: Model) => string;
-    export const formatDates: (user: Model) => {
-        lastSignIn: string;
-        createdAt: string;
-        updatedAt?: string;
-    };
-    export const toFirestore: (user: Model) => Record<string, any>;
-    export const fromFirestore: (data: Record<string, any>) => Model;
-    export const createNew: (email: string, displayName?: string, photoURL?: string) => Model;
-    export {};
+declare const ApplicationStatus: {
+    readonly New: "new";
+    readonly Submitted: "submitted";
+    readonly Interviewing: "interviewing";
+    readonly Accepted: "accepted";
+    readonly Rejected: "rejected";
+    readonly Withdrawn: "withdrawn";
+    readonly Applying: "applying";
+    readonly Suggested: "suggested";
+    readonly Approved: "approved";
+};
+type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
+interface Application {
+    id?: string;
+    vacancyId: string;
+    clientId: string;
+    status: ApplicationStatus;
+    assignedTo?: string;
+    coverLetter?: string;
+    resume?: string;
+    submittedAt?: Date | string;
+    interviewingAt?: Date | string;
+    acceptedAt?: Date | string;
+    rejectedAt?: Date | string;
+    withdrawnAt?: Date | string;
+    applyingAt?: Date | string;
+    suggestedAt?: Date | string;
+    approvedAt?: Date | string;
+    company?: string;
+    position?: string;
+    location?: string;
+    jobId?: string;
+    advertisingUrl?: string;
+    applicationUrl?: string;
+    applicationDomain?: string;
+    advertisingDomain?: string;
+    description?: string;
+    fullPageText?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-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;
+interface AuthUser {
+    id?: string;
+    email: string;
+    displayName?: string;
+    photoURL?: string;
+    lastSignIn?: string;
+    emailVerified?: boolean;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-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;
-        nationality: string;
-        dateOfBirth?: Date | 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, nationality: string, dateOfBirth?: Date | string, middleName?: string, preferredName?: string) => ClientData.Model;
+declare const VacancyCategory: {
+    readonly Accounting: "Accounting";
+    readonly AdministrationAndOfficeSupport: "Administration & Office Support";
+    readonly AdvertisingArtsAndMedia: "Advertising, Arts & Media";
+    readonly BankingAndFinancialServices: "Banking & Financial Services";
+    readonly CallCentreAndCustomerService: "Call Centre & Customer Service";
+    readonly CEOAndGeneralManagement: "CEO & General Management";
+    readonly CommunityServicesAndDevelopment: "Community Services & Development";
+    readonly Construction: "Construction";
+    readonly ConsultingAndStrategy: "Consulting & Strategy";
+    readonly DesignAndArchitecture: "Design & Architecture";
+    readonly EducationAndTraining: "Education & Training";
+    readonly Engineering: "Engineering";
+    readonly FarmingAnimalsAndConservation: "Farming, Animals & Conservation";
+    readonly GovernmentAndDefence: "Government & Defence";
+    readonly HealthcareAndMedical: "Healthcare & Medical";
+    readonly HospitalityAndTourism: "Hospitality & Tourism";
+    readonly HumanResourcesAndRecruitment: "Human Resources & Recruitment";
+    readonly InformationAndCommunicationTechnology: "Information & Communication Technology";
+    readonly InsuranceAndSuperannuation: "Insurance & Superannuation";
+    readonly Legal: "Legal";
+    readonly ManufacturingTransportAndLogistics: "Manufacturing, Transport & Logistics";
+    readonly MarketingAndCommunications: "Marketing & Communications";
+    readonly MiningResourcesAndEnergy: "Mining, Resources & Energy";
+    readonly RealEstateAndProperty: "Real Estate & Property";
+    readonly RetailAndConsumerProducts: "Retail & Consumer Products";
+    readonly Sales: "Sales";
+    readonly ScienceAndTechnology: "Science & Technology";
+    readonly SelfEmployment: "Self Employment";
+    readonly SportAndRecreation: "Sport & Recreation";
+    readonly TradesAndServices: "Trades & Services";
+};
+type VacancyCategory = (typeof VacancyCategory)[keyof typeof VacancyCategory];
+interface Vacancy {
+    id?: string;
+    company: string;
+    position: string;
+    location: string;
+    description: string;
+    advertisingUrl: string;
+    applicationUrl: string;
+    applicationDomain: string;
+    advertisingDomain: string;
+    fullPageText: string;
+    jobId: string;
+    category: VacancyCategory;
+    suggestedTo?: string[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-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;
+interface Agent {
+    id?: string;
+    name: string;
+    email: string;
+    status: "active" | "inactive";
+    profilePicture?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace ClientQuestion {
-    /**
-     * Represents a Q&A pair in the user's knowledge base
-     */
-    interface Model extends BaseModel {
-        questionText: string;
-        answerText?: string;
-        type: Type;
-        options?: string[];
-    }
-    type Type = "text" | "select";
-    const TypeOptions: readonly Type[];
-    const collection: (clientId: string) => string;
-    const document: (clientId: string, questionId: string) => string;
-    const createNew: (questionText: string, type: Type, answerText?: string, options?: string[]) => ClientQuestion.Model;
+type ClientQuestionType = "text" | "select";
+declare const ClientQuestionTypeOptions: readonly ClientQuestionType[];
+interface ClientQuestion {
+    id?: string;
+    questionText: string;
+    answerText?: string;
+    type: ClientQuestionType;
+    options?: string[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace Vacancy {
-    /**
-     * Runtime constant object representing all categories.
-     */
-    const Category: {
-        readonly Accounting: "Accounting";
-        readonly AdministrationAndOfficeSupport: "Administration & Office Support";
-        readonly AdvertisingArtsAndMedia: "Advertising, Arts & Media";
-        readonly BankingAndFinancialServices: "Banking & Financial Services";
-        readonly CallCentreAndCustomerService: "Call Centre & Customer Service";
-        readonly CEOAndGeneralManagement: "CEO & General Management";
-        readonly CommunityServicesAndDevelopment: "Community Services & Development";
-        readonly Construction: "Construction";
-        readonly ConsultingAndStrategy: "Consulting & Strategy";
-        readonly DesignAndArchitecture: "Design & Architecture";
-        readonly EducationAndTraining: "Education & Training";
-        readonly Engineering: "Engineering";
-        readonly FarmingAnimalsAndConservation: "Farming, Animals & Conservation";
-        readonly GovernmentAndDefence: "Government & Defence";
-        readonly HealthcareAndMedical: "Healthcare & Medical";
-        readonly HospitalityAndTourism: "Hospitality & Tourism";
-        readonly HumanResourcesAndRecruitment: "Human Resources & Recruitment";
-        readonly InformationAndCommunicationTechnology: "Information & Communication Technology";
-        readonly InsuranceAndSuperannuation: "Insurance & Superannuation";
-        readonly Legal: "Legal";
-        readonly ManufacturingTransportAndLogistics: "Manufacturing, Transport & Logistics";
-        readonly MarketingAndCommunications: "Marketing & Communications";
-        readonly MiningResourcesAndEnergy: "Mining, Resources & Energy";
-        readonly RealEstateAndProperty: "Real Estate & Property";
-        readonly RetailAndConsumerProducts: "Retail & Consumer Products";
-        readonly Sales: "Sales";
-        readonly ScienceAndTechnology: "Science & Technology";
-        readonly SelfEmployment: "Self Employment";
-        readonly SportAndRecreation: "Sport & Recreation";
-        readonly TradesAndServices: "Trades & Services";
-    };
-    /**
-     * Type representing a valid category value.
-     */
-    type Category = (typeof Category)[keyof typeof Category];
-    /**
-     * Vacancy model definition.
-     */
-    interface Model extends BaseModel {
-        company: string;
-        position: string;
-        location: string;
-        description: string;
-        advertisingUrl: string;
-        applicationUrl: string;
-        applicationDomain: string;
-        advertisingDomain: string;
-        fullPageText: string;
-        jobId: string;
-        category: Category;
-        suggestedTo?: string[];
-    }
-    /**
-     * Returns the Firestore collection path for vacancies.
-     */
-    const collection: () => string;
-    /**
-     * Returns the Firestore document path for a specific vacancy.
-     */
-    const document: (vacancyId: string) => string;
-    /**
-     * Formats a short summary of a vacancy.
-     */
-    const formatSummary: (vacancy: Vacancy.Model) => string;
-    /**
-     * Formats a date into a localized string.
-     */
-    const formatDate: (date: Date | string) => string;
-    /**
-     * Creates a new Vacancy.Model with the given data.
-     */
-    const createNew: (company: string, position: string, location: string, description: string, advertisingUrl: string, applicationUrl: string, applicationDomain: string, advertisingDomain: string, fullPageText: string, jobId: string, category: Category) => Vacancy.Model;
+interface ClientData {
+    id?: string;
+    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;
+    nationality: string;
+    dateOfBirth?: Date | string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace VacancySuggestion {
-    /**
-     * Represents a job vacancy suggestion for a client
-     */
-    interface Model extends BaseModel {
-        clientId: string;
-        vacancyId: string;
-        status: string;
-        company: string;
-        position: string;
-        location: string;
-        description: string;
-        advertisingUrl: string;
-        applicationUrl: string;
-        applicationDomain: string;
-        advertisingDomain: string;
-        fullPageText: string;
-        jobId: string;
-        category: Vacancy.Category;
-    }
-    const collection: (clientId: string) => string;
-    const document: (clientId: string, suggestionId: string) => string;
-    const formatSummary: (suggestion: VacancySuggestion.Model) => string;
-    const createNew: (clientId: string, vacancyId: string, status: string, company: string, position: string, location: string, description: string, advertisingUrl: string, applicationUrl: string, applicationDomain: string, advertisingDomain: string, fullPageText: string, jobId: string, category: Vacancy.Category) => VacancySuggestion.Model;
+interface ClientLogin {
+    id?: string;
+    userId: string;
+    url: string;
+    domain: string;
+    username?: string;
+    password: string;
+    email?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace ApplicationQuestion {
-    /**
-     * Represents a question and answer for a job application
-     */
-    interface Model extends BaseModel {
-        questionText: string;
-        answerText?: string;
-        type: Type;
-    }
-    type Type = "text" | "select";
-    const TypeOptions: readonly Type[];
-    const collection: (clientId: string, applicationId: string) => string;
-    const document: (clientId: string, applicationId: string, questionId: string) => string;
-    const createNew: (questionText: string, type: Type, answerText?: string) => ApplicationQuestion.Model;
+type ApplicationQuestionType = "text" | "select";
+declare const ApplicationQuestionTypeOptions: readonly ApplicationQuestionType[];
+interface ApplicationQuestion {
+    id?: string;
+    questionText: string;
+    answerText?: string;
+    type: ApplicationQuestionType;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace Agent {
-    interface Model extends BaseModel {
-        name: string;
-        email: string;
-        status: "active" | "inactive";
-        profilePicture?: string;
-    }
-    const collection: () => string;
-    const document: (agentId: string) => string;
-    const formatAgent: (agent: Agent.Model) => string;
-    const createNew: (name: string, email: string) => Agent.Model;
+interface VacancySuggestion {
+    id?: string;
+    clientId: string;
+    vacancyId: string;
+    status: string;
+    company: string;
+    position: string;
+    location: string;
+    description: string;
+    advertisingUrl: string;
+    applicationUrl: string;
+    applicationDomain: string;
+    advertisingDomain: string;
+    fullPageText: string;
+    jobId: string;
+    category: VacancyCategory;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-declare namespace GmailMessage {
-    interface Model extends BaseModel {
-        messageId: string;
-        threadId?: string;
-        labelIds?: string[];
-        snippet?: string;
-        internalDate?: string;
-        payload?: {
-            headers?: Array<{
-                name: string;
-                value: string;
-            }>;
+interface GmailMessage {
+    id?: string;
+    messageId: string;
+    threadId?: string;
+    labelIds?: string[];
+    snippet?: string;
+    internalDate?: string;
+    payload?: {
+        headers?: Array<{
+            name: string;
+            value: string;
+        }>;
+        body?: {
+            data?: string;
+        };
+        parts?: Array<{
+            mimeType?: string;
             body?: {
                 data?: string;
             };
-            parts?: Array<{
-                mimeType?: string;
-                body?: {
-                    data?: string;
-                };
-            }>;
-        };
-    }
-    const collection: (clientId: string) => string;
-    const document: (clientId: string, messageId: string) => string;
-    const createNew: (messageId: string, threadId?: string, payload?: Model["payload"], labelIds?: string[], snippet?: string, internalDate?: string) => Model;
+        }>;
+    };
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
 }
 
-export { Agent, Application, ApplicationQuestion, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, GmailMessage, Vacancy, VacancySuggestion };
+declare const pathStrings: {
+    readonly clients: () => string;
+    readonly client: (clientId: string) => string;
+    readonly applications: (clientId: string) => string;
+    readonly application: (clientId: string, applicationId: string) => string;
+    readonly users: () => string;
+    readonly user: (userId: string) => string;
+    readonly vacancies: () => string;
+    readonly vacancy: (vacancyId: string) => string;
+    readonly agents: () => string;
+    readonly agent: (agentId: string) => string;
+    readonly clientQuestions: (clientId: string) => string;
+    readonly clientQuestion: (clientId: string, questionId: string) => string;
+    readonly clientData: () => string;
+    readonly clientDataItem: (clientDataId: string) => string;
+    readonly clientLogins: (userId: string) => string;
+    readonly clientLogin: (userId: string, domain: string) => string;
+    readonly applicationQuestions: (clientId: string, applicationId: string) => string;
+    readonly applicationQuestion: (clientId: string, applicationId: string, questionId: string) => string;
+    readonly vacancySuggestions: (clientId: string) => string;
+    readonly vacancySuggestion: (clientId: string, suggestionId: string) => string;
+    readonly gmailMessages: (clientId: string) => string;
+    readonly gmailMessage: (clientId: string, messageId: string) => string;
+};
+
+export { Agent, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthUser, Client, ClientData, ClientLogin, ClientQuestion, ClientQuestionType, ClientQuestionTypeOptions, GmailMessage, Vacancy, VacancyCategory, VacancySuggestion, pathStrings };