@jobsearch-works/firestore-models 2.4.10 → 3.0.0

package/dist/index.d.mts

@@ -640,6 +640,74 @@ interface VacancySuggestion {
     createdAt?: Date | string;
 }
 
+interface Education {
+    degree: string;
+    fieldOfStudy: string;
+    institution: string;
+    startDate: string | null;
+    endDate: string | null;
+}
+
+interface WorkExperience {
+    jobTitle: string;
+    company: string;
+    startDate: string;
+    endDate: string;
+    description: string;
+}
+
+interface Certification {
+    name: string;
+    organization: string;
+    issueDate: string;
+    expirationDate?: string;
+    credentialId?: string;
+    verificationUrl?: string;
+}
+
+interface Language {
+    language: string;
+}
+
+interface Project {
+    projectName: string;
+    description: string;
+    technologies: string[];
+    startDate: string;
+    endDate: string;
+    url: string | null;
+}
+
+type Skill = string;
+
+type Summary = string | null;
+
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/resumes/{docId}
+ * @see Client - Parent document
+ *
+ * @description Represents a client's resume document.
+ */
+interface ClientResume {
+    readonly id?: string;
+    jobTitle?: string;
+    skills?: Skill[];
+    education?: Education[];
+    experience?: WorkExperience[];
+    certifications?: Certification[];
+    languages?: Language[];
+    projects?: Project[];
+    summary?: Summary;
+    github?: string;
+    linkedin?: string;
+    website?: string;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    storagePath?: string;
+    additionalInfo?: string;
+}
+
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -659,7 +727,7 @@ interface Application {
     status: ApplicationStatus;
     assignedTo?: string;
     coverLetter?: string;
-    resume?: string;
+    resume?: ClientResume;
     submittedAt?: Date | string;
     interviewingAt?: Date | string;
     acceptedAt?: Date | string;
@@ -696,52 +764,37 @@ interface ApplicationQuestion {
     action?: string;
 }
 
-interface ClientCompanyPreferences {
-    companyId?: string;
-    name: string;
-    careersUrl: string;
-    location: string;
-}
-
-interface ClientLanguage {
-    readonly language: string;
-    readonly level: string;
-}
-
-interface ClientCertifications {
-    readonly name: string;
-    readonly date: Date;
-}
-
-interface ClientSkill {
-    readonly name: string;
-    readonly level: string;
-}
-
-interface ClientEducation {
-    readonly schoolName: string;
-    readonly degree: string;
-    readonly fieldOfStudy: string;
-    readonly startDate: Date;
-    readonly endDate: Date;
-}
-
-interface ClientWorkExperience {
-    readonly companyName: string;
-    readonly position: string;
-    readonly startDate: Date;
-    readonly endDate: Date;
-    readonly description: string;
-}
-
 /**
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
  */
-interface ClientWebsitePreferences {
-    readonly id?: string;
-    theme: string;
-    notifications: string;
+interface ClientPersonalData {
+    id?: string;
+    firstName: string;
+    lastName: string;
+    middleName?: string;
+    preferredName?: string;
+    email: string;
+    phone: string;
+    address: string;
+    city: string;
+    suburb: string;
+    state: string;
+    postcode: string;
+    country: string;
+    linkedIn?: string;
+    countryPhoneCode: string;
+    nationality: string;
+    dateOfBirth?: Date | string;
+    ethnicity?: string;
+    disabilityStatus?: string;
+    securityClearance?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    photoUrl?: string;
+    personalWebsite?: string;
+    portfolioUrl?: string;
+    professionalTitle?: string;
 }
 
 /**
@@ -770,32 +823,13 @@ interface ClientJobPreferences {
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
  */
-interface ClientPersonalData {
-    id?: string;
-    firstName: string;
-    lastName: string;
-    middleName?: string;
-    preferredName?: string;
-    email: string;
-    phone: string;
-    address: string;
-    city: string;
-    suburb: string;
-    state: string;
-    postcode: string;
-    country: string;
-    linkedIn?: string;
-    countryPhoneCode: string;
-    nationality: string;
-    dateOfBirth?: Date | string;
-    ethnicity?: string;
-    disabilityStatus?: string;
-    securityClearance?: string;
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
+interface ClientWebsitePreferences {
+    readonly id?: string;
+    theme: string;
+    notifications: string;
 }
 
-type ClientStatus = typeof ClientStatusEnum[keyof typeof ClientStatusEnum];
+type ClientStatus = (typeof ClientStatusEnum)[keyof typeof ClientStatusEnum];
 /**
  * Root Client document
  * Path: clients/{clientId}
@@ -809,12 +843,7 @@ interface Client {
     readonly personalData?: ClientPersonalData;
     readonly jobPreferences?: ClientJobPreferences;
     readonly websitePreferences?: ClientWebsitePreferences;
-    readonly workExperience?: ClientWorkExperience[];
-    readonly education?: ClientEducation[];
-    readonly skills?: ClientSkill[];
-    readonly certifications?: ClientCertifications;
-    readonly languages?: ClientLanguage[];
-    readonly clientCompanyPreferences?: ClientCompanyPreferences[];
+    resume: ClientResume;
     readonly createdAt?: Date | string;
 }
 
@@ -879,45 +908,6 @@ interface ClientQuestion {
     vacancyId?: string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/resumes/{docId}
- * @see Client - Parent document
- *
- * @description Represents a client's resume document.
- * @author [Your Name]
- * @version 1.0.0
- * @since [Date]
- */
-interface ClientResume {
-    readonly id?: string;
-    title: string;
-    createdAt: Date | string;
-    updatedAt: Date | string;
-    format: string;
-    storagePath: string;
-    notes: string;
-    isActive: boolean;
-    clientId: string;
-    about: {
-        summary: string;
-    };
-    education: Array<{
-        school: string;
-        degree: string;
-        field: string;
-        startDate: Date | string;
-        endDate?: Date | string;
-    }>;
-    workExperience: Array<{
-        company: string;
-        role: string;
-        startDate: Date | string;
-        endDate?: Date | string;
-        description: string;
-    }>;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
@@ -940,6 +930,49 @@ interface ClientVirtualInterview {
     }>;
 }
 
+interface Award {
+    readonly name: string;
+    readonly organization: string;
+    readonly date: Date | string;
+    readonly description?: string;
+}
+
+interface Publication {
+    readonly title: string;
+    readonly venue: string;
+    readonly date: Date | string;
+    readonly coAuthors?: string[];
+    readonly url?: string;
+}
+
+interface Reference {
+    readonly name: string;
+    readonly title: string;
+    readonly company: string;
+    readonly relationship: string;
+    readonly contactInfo: {
+        email?: string;
+        phone?: string;
+    };
+    readonly highlights?: string;
+}
+
+interface VolunteerEntry {
+    readonly organization: string;
+    readonly role: string;
+    readonly startDate: Date | string;
+    readonly endDate?: Date | string;
+    readonly responsibilities?: string;
+    readonly achievements?: string;
+}
+
+interface ClientCompanyPreferences {
+    companyId?: string;
+    name: string;
+    careersUrl: string;
+    location: string;
+}
+
 /**
  * Subcollection document under clients/{userId}/access_tokens/{provider}
  */
@@ -1005,10 +1038,6 @@ declare const firestorePaths: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, loginId: string) => string;
         };
-        readonly resumes: {
-            readonly collection: (clientId: string) => string;
-            readonly doc: (clientId: string, resumeId: string) => string;
-        };
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
@@ -1060,4 +1089,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientCompanyPreferences, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientStatusEnum, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, Companies, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, jobClassifications, locations };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Award, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, Language, LocationId, Project, Publication, Reference, Skill, Summary, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, VolunteerEntry, WorkExperience, countries, firestorePaths, jobClassifications, locations };

package/dist/index.d.ts

@@ -640,6 +640,74 @@ interface VacancySuggestion {
     createdAt?: Date | string;
 }
 
+interface Education {
+    degree: string;
+    fieldOfStudy: string;
+    institution: string;
+    startDate: string | null;
+    endDate: string | null;
+}
+
+interface WorkExperience {
+    jobTitle: string;
+    company: string;
+    startDate: string;
+    endDate: string;
+    description: string;
+}
+
+interface Certification {
+    name: string;
+    organization: string;
+    issueDate: string;
+    expirationDate?: string;
+    credentialId?: string;
+    verificationUrl?: string;
+}
+
+interface Language {
+    language: string;
+}
+
+interface Project {
+    projectName: string;
+    description: string;
+    technologies: string[];
+    startDate: string;
+    endDate: string;
+    url: string | null;
+}
+
+type Skill = string;
+
+type Summary = string | null;
+
+/**
+ * Subcollection document under Client
+ * Path: clients/{clientId}/resumes/{docId}
+ * @see Client - Parent document
+ *
+ * @description Represents a client's resume document.
+ */
+interface ClientResume {
+    readonly id?: string;
+    jobTitle?: string;
+    skills?: Skill[];
+    education?: Education[];
+    experience?: WorkExperience[];
+    certifications?: Certification[];
+    languages?: Language[];
+    projects?: Project[];
+    summary?: Summary;
+    github?: string;
+    linkedin?: string;
+    website?: string;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    storagePath?: string;
+    additionalInfo?: string;
+}
+
 declare const ApplicationStatus: {
     readonly New: "new";
     readonly Submitted: "submitted";
@@ -659,7 +727,7 @@ interface Application {
     status: ApplicationStatus;
     assignedTo?: string;
     coverLetter?: string;
-    resume?: string;
+    resume?: ClientResume;
     submittedAt?: Date | string;
     interviewingAt?: Date | string;
     acceptedAt?: Date | string;
@@ -696,52 +764,37 @@ interface ApplicationQuestion {
     action?: string;
 }
 
-interface ClientCompanyPreferences {
-    companyId?: string;
-    name: string;
-    careersUrl: string;
-    location: string;
-}
-
-interface ClientLanguage {
-    readonly language: string;
-    readonly level: string;
-}
-
-interface ClientCertifications {
-    readonly name: string;
-    readonly date: Date;
-}
-
-interface ClientSkill {
-    readonly name: string;
-    readonly level: string;
-}
-
-interface ClientEducation {
-    readonly schoolName: string;
-    readonly degree: string;
-    readonly fieldOfStudy: string;
-    readonly startDate: Date;
-    readonly endDate: Date;
-}
-
-interface ClientWorkExperience {
-    readonly companyName: string;
-    readonly position: string;
-    readonly startDate: Date;
-    readonly endDate: Date;
-    readonly description: string;
-}
-
 /**
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
  */
-interface ClientWebsitePreferences {
-    readonly id?: string;
-    theme: string;
-    notifications: string;
+interface ClientPersonalData {
+    id?: string;
+    firstName: string;
+    lastName: string;
+    middleName?: string;
+    preferredName?: string;
+    email: string;
+    phone: string;
+    address: string;
+    city: string;
+    suburb: string;
+    state: string;
+    postcode: string;
+    country: string;
+    linkedIn?: string;
+    countryPhoneCode: string;
+    nationality: string;
+    dateOfBirth?: Date | string;
+    ethnicity?: string;
+    disabilityStatus?: string;
+    securityClearance?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    photoUrl?: string;
+    personalWebsite?: string;
+    portfolioUrl?: string;
+    professionalTitle?: string;
 }
 
 /**
@@ -770,32 +823,13 @@ interface ClientJobPreferences {
  * Embedded sub-object within Client document
  * @see Client - Parent document interface
  */
-interface ClientPersonalData {
-    id?: string;
-    firstName: string;
-    lastName: string;
-    middleName?: string;
-    preferredName?: string;
-    email: string;
-    phone: string;
-    address: string;
-    city: string;
-    suburb: string;
-    state: string;
-    postcode: string;
-    country: string;
-    linkedIn?: string;
-    countryPhoneCode: string;
-    nationality: string;
-    dateOfBirth?: Date | string;
-    ethnicity?: string;
-    disabilityStatus?: string;
-    securityClearance?: string;
-    createdAt?: Date | string;
-    updatedAt?: Date | string;
+interface ClientWebsitePreferences {
+    readonly id?: string;
+    theme: string;
+    notifications: string;
 }
 
-type ClientStatus = typeof ClientStatusEnum[keyof typeof ClientStatusEnum];
+type ClientStatus = (typeof ClientStatusEnum)[keyof typeof ClientStatusEnum];
 /**
  * Root Client document
  * Path: clients/{clientId}
@@ -809,12 +843,7 @@ interface Client {
     readonly personalData?: ClientPersonalData;
     readonly jobPreferences?: ClientJobPreferences;
     readonly websitePreferences?: ClientWebsitePreferences;
-    readonly workExperience?: ClientWorkExperience[];
-    readonly education?: ClientEducation[];
-    readonly skills?: ClientSkill[];
-    readonly certifications?: ClientCertifications;
-    readonly languages?: ClientLanguage[];
-    readonly clientCompanyPreferences?: ClientCompanyPreferences[];
+    resume: ClientResume;
     readonly createdAt?: Date | string;
 }
 
@@ -879,45 +908,6 @@ interface ClientQuestion {
     vacancyId?: string;
 }
 
-/**
- * Subcollection document under Client
- * Path: clients/{clientId}/resumes/{docId}
- * @see Client - Parent document
- *
- * @description Represents a client's resume document.
- * @author [Your Name]
- * @version 1.0.0
- * @since [Date]
- */
-interface ClientResume {
-    readonly id?: string;
-    title: string;
-    createdAt: Date | string;
-    updatedAt: Date | string;
-    format: string;
-    storagePath: string;
-    notes: string;
-    isActive: boolean;
-    clientId: string;
-    about: {
-        summary: string;
-    };
-    education: Array<{
-        school: string;
-        degree: string;
-        field: string;
-        startDate: Date | string;
-        endDate?: Date | string;
-    }>;
-    workExperience: Array<{
-        company: string;
-        role: string;
-        startDate: Date | string;
-        endDate?: Date | string;
-        description: string;
-    }>;
-}
-
 /**
  * Subcollection document under Client
  * Path: clients/{clientId}/applications/{applicationId}/virtualInterview/{interviewId}
@@ -940,6 +930,49 @@ interface ClientVirtualInterview {
     }>;
 }
 
+interface Award {
+    readonly name: string;
+    readonly organization: string;
+    readonly date: Date | string;
+    readonly description?: string;
+}
+
+interface Publication {
+    readonly title: string;
+    readonly venue: string;
+    readonly date: Date | string;
+    readonly coAuthors?: string[];
+    readonly url?: string;
+}
+
+interface Reference {
+    readonly name: string;
+    readonly title: string;
+    readonly company: string;
+    readonly relationship: string;
+    readonly contactInfo: {
+        email?: string;
+        phone?: string;
+    };
+    readonly highlights?: string;
+}
+
+interface VolunteerEntry {
+    readonly organization: string;
+    readonly role: string;
+    readonly startDate: Date | string;
+    readonly endDate?: Date | string;
+    readonly responsibilities?: string;
+    readonly achievements?: string;
+}
+
+interface ClientCompanyPreferences {
+    companyId?: string;
+    name: string;
+    careersUrl: string;
+    location: string;
+}
+
 /**
  * Subcollection document under clients/{userId}/access_tokens/{provider}
  */
@@ -1005,10 +1038,6 @@ declare const firestorePaths: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, loginId: string) => string;
         };
-        readonly resumes: {
-            readonly collection: (clientId: string) => string;
-            readonly doc: (clientId: string, resumeId: string) => string;
-        };
         readonly applications: {
             readonly collection: (clientId: string) => string;
             readonly doc: (clientId: string, applicationId: string) => string;
@@ -1060,4 +1089,4 @@ declare const firestorePaths: {
     };
 };
 
-export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Client, ClientAccessToken, ClientCertifications, ClientCompanyPreferences, ClientEducation, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLanguage, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientSkill, ClientStatus, ClientStatusEnum, ClientVirtualInterview, ClientWebsitePreferences, ClientWorkExperience, Companies, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, LocationId, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, countries, firestorePaths, jobClassifications, locations };
+export { Agent, AgentStatus, Application, ApplicationQuestion, ApplicationQuestionType, ApplicationQuestionTypeOptions, ApplicationStatus, AuthEmail, AuthUser, Award, Certification, Client, ClientAccessToken, ClientCompanyPreferences, ClientEmail, ClientGmailToken, ClientInitialQuestion, ClientJobPreferences, ClientLogin, ClientPersonalData, ClientQuestion, ClientResume, ClientStatus, ClientStatusEnum, ClientVirtualInterview, Companies, Education, EmailCategory, FirestoreTimestamp, JobCategory, JobTitle, Language, LocationId, Project, Publication, Reference, Skill, Summary, UserPublic, Vacancy, VacancyCategory, VacancySuggestion, VolunteerEntry, WorkExperience, countries, firestorePaths, jobClassifications, locations };

package/dist/index.js

@@ -1296,10 +1296,6 @@ var firestorePaths = {
       collection: (clientId) => `clients/${clientId}/logins`,
       doc: (clientId, loginId) => `clients/${clientId}/logins/${loginId}`
     },
-    resumes: {
-      collection: (clientId) => `clients/${clientId}/resumes`,
-      doc: (clientId, resumeId) => `clients/${clientId}/resumes/${resumeId}`
-    },
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,

package/dist/index.mjs

@@ -1263,10 +1263,6 @@ var firestorePaths = {
       collection: (clientId) => `clients/${clientId}/logins`,
       doc: (clientId, loginId) => `clients/${clientId}/logins/${loginId}`
     },
-    resumes: {
-      collection: (clientId) => `clients/${clientId}/resumes`,
-      doc: (clientId, resumeId) => `clients/${clientId}/resumes/${resumeId}`
-    },
     applications: {
       collection: (clientId) => `clients/${clientId}/applications`,
       doc: (clientId, applicationId) => `clients/${clientId}/applications/${applicationId}`,

package/package.json

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