@jobsearch-works/firestore-models 1.0.21 → 1.0.23

package/dist/index.d.mts

@@ -157,9 +157,47 @@ declare namespace ClientQuestion {
 
 declare namespace Vacancy {
     /**
-     * Represents a job 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.
      */
-    type Category = "Accounting" | "Administration & Office Support" | "Advertising, Arts & Media" | "Banking & Financial Services" | "Call Centre & Customer Service" | "CEO & General Management" | "Community Services & Development" | "Construction" | "Consulting & Strategy" | "Design & Architecture" | "Education & Training" | "Engineering" | "Farming, Animals & Conservation" | "Government & Defence" | "Healthcare & Medical" | "Hospitality & Tourism" | "Human Resources & Recruitment" | "Information & Communication Technology" | "Insurance & Superannuation" | "Legal" | "Manufacturing, Transport & Logistics" | "Marketing & Communications" | "Mining, Resources & Energy" | "Real Estate & Property" | "Retail & Consumer Products" | "Sales" | "Science & Technology" | "Self Employment" | "Sport & Recreation" | "Trades & Services";
     interface Model extends BaseModel {
         company: string;
         position: string;
@@ -174,10 +212,25 @@ declare namespace Vacancy {
         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;
 }
 

package/dist/index.d.ts

@@ -157,9 +157,47 @@ declare namespace ClientQuestion {
 
 declare namespace Vacancy {
     /**
-     * Represents a job 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.
      */
-    type Category = "Accounting" | "Administration & Office Support" | "Advertising, Arts & Media" | "Banking & Financial Services" | "Call Centre & Customer Service" | "CEO & General Management" | "Community Services & Development" | "Construction" | "Consulting & Strategy" | "Design & Architecture" | "Education & Training" | "Engineering" | "Farming, Animals & Conservation" | "Government & Defence" | "Healthcare & Medical" | "Hospitality & Tourism" | "Human Resources & Recruitment" | "Information & Communication Technology" | "Insurance & Superannuation" | "Legal" | "Manufacturing, Transport & Logistics" | "Marketing & Communications" | "Mining, Resources & Energy" | "Real Estate & Property" | "Retail & Consumer Products" | "Sales" | "Science & Technology" | "Self Employment" | "Sport & Recreation" | "Trades & Services";
     interface Model extends BaseModel {
         company: string;
         position: string;
@@ -174,10 +212,25 @@ declare namespace Vacancy {
         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;
 }
 

package/dist/index.js

@@ -243,11 +243,41 @@ var ClientQuestion;
 // src/models/Vacancy.ts
 var Vacancy;
 ((Vacancy2) => {
+  Vacancy2.Category = {
+    Accounting: "Accounting",
+    AdministrationAndOfficeSupport: "Administration & Office Support",
+    AdvertisingArtsAndMedia: "Advertising, Arts & Media",
+    BankingAndFinancialServices: "Banking & Financial Services",
+    CallCentreAndCustomerService: "Call Centre & Customer Service",
+    CEOAndGeneralManagement: "CEO & General Management",
+    CommunityServicesAndDevelopment: "Community Services & Development",
+    Construction: "Construction",
+    ConsultingAndStrategy: "Consulting & Strategy",
+    DesignAndArchitecture: "Design & Architecture",
+    EducationAndTraining: "Education & Training",
+    Engineering: "Engineering",
+    FarmingAnimalsAndConservation: "Farming, Animals & Conservation",
+    GovernmentAndDefence: "Government & Defence",
+    HealthcareAndMedical: "Healthcare & Medical",
+    HospitalityAndTourism: "Hospitality & Tourism",
+    HumanResourcesAndRecruitment: "Human Resources & Recruitment",
+    InformationAndCommunicationTechnology: "Information & Communication Technology",
+    InsuranceAndSuperannuation: "Insurance & Superannuation",
+    Legal: "Legal",
+    ManufacturingTransportAndLogistics: "Manufacturing, Transport & Logistics",
+    MarketingAndCommunications: "Marketing & Communications",
+    MiningResourcesAndEnergy: "Mining, Resources & Energy",
+    RealEstateAndProperty: "Real Estate & Property",
+    RetailAndConsumerProducts: "Retail & Consumer Products",
+    Sales: "Sales",
+    ScienceAndTechnology: "Science & Technology",
+    SelfEmployment: "Self Employment",
+    SportAndRecreation: "Sport & Recreation",
+    TradesAndServices: "Trades & Services"
+  };
   Vacancy2.collection = () => "vacancies";
   Vacancy2.document = (vacancyId) => `vacancies/${vacancyId}`;
-  Vacancy2.formatSummary = (vacancy) => {
-    return `${vacancy.position} at ${vacancy.company} (${vacancy.location})`;
-  };
+  Vacancy2.formatSummary = (vacancy) => `${vacancy.position} at ${vacancy.company} (${vacancy.location})`;
   Vacancy2.formatDate = (date) => {
     const dateObj = date instanceof Date ? date : new Date(date);
     return dateObj.toLocaleDateString();

package/dist/index.mjs

@@ -208,11 +208,41 @@ var ClientQuestion;
 // src/models/Vacancy.ts
 var Vacancy;
 ((Vacancy2) => {
+  Vacancy2.Category = {
+    Accounting: "Accounting",
+    AdministrationAndOfficeSupport: "Administration & Office Support",
+    AdvertisingArtsAndMedia: "Advertising, Arts & Media",
+    BankingAndFinancialServices: "Banking & Financial Services",
+    CallCentreAndCustomerService: "Call Centre & Customer Service",
+    CEOAndGeneralManagement: "CEO & General Management",
+    CommunityServicesAndDevelopment: "Community Services & Development",
+    Construction: "Construction",
+    ConsultingAndStrategy: "Consulting & Strategy",
+    DesignAndArchitecture: "Design & Architecture",
+    EducationAndTraining: "Education & Training",
+    Engineering: "Engineering",
+    FarmingAnimalsAndConservation: "Farming, Animals & Conservation",
+    GovernmentAndDefence: "Government & Defence",
+    HealthcareAndMedical: "Healthcare & Medical",
+    HospitalityAndTourism: "Hospitality & Tourism",
+    HumanResourcesAndRecruitment: "Human Resources & Recruitment",
+    InformationAndCommunicationTechnology: "Information & Communication Technology",
+    InsuranceAndSuperannuation: "Insurance & Superannuation",
+    Legal: "Legal",
+    ManufacturingTransportAndLogistics: "Manufacturing, Transport & Logistics",
+    MarketingAndCommunications: "Marketing & Communications",
+    MiningResourcesAndEnergy: "Mining, Resources & Energy",
+    RealEstateAndProperty: "Real Estate & Property",
+    RetailAndConsumerProducts: "Retail & Consumer Products",
+    Sales: "Sales",
+    ScienceAndTechnology: "Science & Technology",
+    SelfEmployment: "Self Employment",
+    SportAndRecreation: "Sport & Recreation",
+    TradesAndServices: "Trades & Services"
+  };
   Vacancy2.collection = () => "vacancies";
   Vacancy2.document = (vacancyId) => `vacancies/${vacancyId}`;
-  Vacancy2.formatSummary = (vacancy) => {
-    return `${vacancy.position} at ${vacancy.company} (${vacancy.location})`;
-  };
+  Vacancy2.formatSummary = (vacancy) => `${vacancy.position} at ${vacancy.company} (${vacancy.location})`;
   Vacancy2.formatDate = (date) => {
     const dateObj = date instanceof Date ? date : new Date(date);
     return dateObj.toLocaleDateString();

package/package.json

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