@thejob/schema 1.0.106 → 2.0.0

package/dist/esm/job/job.schema.js

@@ -1,408 +0,0 @@
-import { DbDefaultSchema, UserIdAndCreatedAtSchema, } from "../common";
-import { ApplicationReceivePreference, SupportedCompensationTypes, SupportedEducationLevels, SupportedExperienceLevels, SYSTEM_DATE_FORMAT, } from "../constants";
-import { DurationSchema } from "../duration";
-import { LocationSchema } from "../location";
-import { PageSchema } from "../page";
-import { QuestionType, } from "../question";
-import { SkillSchema } from "../skill";
-import { array, boolean, lazy, mixed, number, object, string, } from "../yup-extended";
-import { JobStatus, SupportedJobStatuses } from "./job.constant";
-import { getSchemaByQuestion } from "./utils";
-export const JobSchema = object({
-    /**
-     * Unique ID for the job post, it can be used by external systems to reference the job.
-     */
-    uniqueId: string().optional().label("Unique ID"),
-    /*
-     * Job headline defines the title of the job post.
-     * It is required and should be a string with a minimum length of 10 characters and a maximum length of 100 characters.
-     * This field is used to display the job title in job listings and search results.
-     */
-    headline: string().required().min(5).max(150).label("Headline"),
-    /*
-     * Job slug is a unique identifier for the job post.
-     * It is required and should be a string with a maximum length of 250 characters.
-     * This field is used to create a user-friendly URL for the job post.
-     */
-    slug: string().required().max(250).label("Slug"),
-    /*
-     * Application receive preference defines how the job applications are received.
-     * It is required and should be one of the following values:
-     * - Inbox: Applications are received in the job portal's inbox.
-     * - ExternalWebsite: Applications are received on an external website.
-     * This field is used to determine how the job applications are processed.
-     */
-    applicationReceivePreference: mixed()
-        .oneOf([
-        ApplicationReceivePreference.Inbox,
-        ApplicationReceivePreference.ExternalWebsite,
-    ])
-        .required()
-        .label("Preference"),
-    /*
-     * External apply link is the link to the external website where the job applications are received.
-     * It is required if the application receive preference is set to ExternalWebsite.
-     * It should be a valid URL.
-     * This field is used to redirect users to the external website for job applications.
-     */
-    externalApplyLink: string().when("applicationReceivePreference", {
-        is: (value) => value === ApplicationReceivePreference.ExternalWebsite,
-        then: (schema) => schema.url().required().label("Apply for Job link"),
-        otherwise: (schema) => schema.optional(),
-    }),
-    /*
-     * This property is required and can be used to specify the company associated with the job post.
-     * It can be a predefined company (NameIdLogoSchema) or an other value (OtherValueSchema).
-     * The value should be an object with name, id, and logo properties.
-     */
-    company: PageSchema.pick(["name", "slug", "type", "logo"])
-        .deepPartial()
-        .concat(PageSchema.pick(["name", "type"]))
-        .required()
-        .label("Company"),
-    /*
-     * @deprecated: This field is deprecated and will be removed in future versions.
-     * This property is required and can be used to specify the designation associated with the job post.
-     * It can be a predefined designation (NameIdLogoSchema) or an other value (OtherValueSchema).
-     * The value should be an object with name, id, and logo properties.
-     */
-    designation: string().optional().nullable().label("Designation"),
-    /*
-     * Employment type defines the type of employment for the job post.
-     * It is required and should be a string with a maximum length of 50 characters.
-     * This field is used to categorize the job based on employment type, such as full-time, part-time, contract, etc.
-     */
-    employmentType: string().required().label("Employment type"),
-    /*
-     * Work mode defines the mode of work for the job post.
-     * It is required and should be a string with a maximum length of 50 characters.
-     * This field is used to categorize the job based on work mode, such as remote, on-site, or hybrid.
-     */
-    workMode: string().required().label("Work mode"),
-    /*
-     * This section is optional and can be used to specify the skills required for the job.
-     * It is useful for jobs that require specific skills, such as programming languages, frameworks, etc.
-     * The value should be an array of skills, each skill can be a predefined skill (NameIdLogoSchema) or an other value (OtherValueSchema).
-     *
-     * TODO: Make this field as array of string.
-     * TODO: Add knockout skills that if not present in the application should immediately disqualify the application.
-     */
-    skills: array()
-        .of(SkillSchema.pick(["name", "logo"]).required().label("Skill"))
-        .nullable()
-        .optional()
-        .label("Skills"),
-    /*
-     * This field will store the information about users who have bookmarked the job post.
-     * It is optional and can be used to track the users who are interested in the job
-     */
-    bookmarks: array().of(UserIdAndCreatedAtSchema).optional().label("Bookmarks"),
-    embedding: object({
-        vector: array(number().required()).optional().label("Embedding vector"),
-        model: string().optional().label("Embedding model"),
-    })
-        .nullable()
-        .optional()
-        .label("Embedding"),
-    /*
-     * This field will store the information about users who have applied for the job post using Direct/Quick Apply feature.
-     * It is optional and can be used to track the users who have applied for the job.
-     * It includes the user ID and the date when the application was made.
-     * It is also useful for analytics and reporting purposes.
-     */
-    applicants: array()
-        .of(UserIdAndCreatedAtSchema)
-        .optional()
-        .label("Applicants"),
-    /**
-     * Number of applicants for the job (Direct Apply/Quick Apply).
-     * This is optional and can be used to track the number of applicants.
-     */
-    applicantCount: number().optional().label("Applicant count"),
-    // /*
-    //  * This field is optional and can be used to track the users who have applied for the job through an external website.
-    //  * It includes the user ID and the date when the application was made.
-    //  * It is also useful for analytics and reporting purposes.
-    //  */
-    // externalApplicants: array()
-    //   .of(UserIdAndCreatedAtSchema)
-    //   .optional()
-    //   .label("External Applicants"),
-    // /**
-    //  * Number of external applicants for the job.
-    //  */
-    // externalApplicantCount: number()
-    //   .optional()
-    //   .label("External applicant count"),
-    externalApplicationLinkClickCount: number()
-        .optional()
-        .label("External application link click count"),
-    /*
-     * This field is required and should be used to store the job description.
-     * It is useful for providing detailed information about the job responsibilities, requirements, and other relevant details.
-     * It is recommended to use a Markdown editor to write the job description.
-     */
-    description: string().required().min(100).max(50000).label("Description"),
-    /*
-     * This field is required and can be used to specify the job description.
-     * It is useful for providing detailed information about the job responsibilities, requirements, and other relevant details.
-     */
-    descriptionMarkdown: string().required().label("Description Markdown"),
-    /*
-     * This field is require and should be used to store generated HTML string after parsing Markdown description.
-     * The value should be a string in HTML format.
-     * It is recommended to use a Markdown editor to convert the Markdown description to HTML.
-     *
-     * Note: This field is required to ensure that the job description is always available in HTML format for rendering.
-     *       It is important to keep this field in sync with the Markdown description field.
-     *       If the Markdown description is updated, the HTML description should also be updated accordingly.
-     *       This can be done using a Markdown parser library that converts Markdown to HTML.
-     *       For example, you can use libraries like `marked`, `markdown-it`, or `showdown` to convert Markdown to HTML.
-     *       Ensure that the HTML is sanitized to prevent XSS attacks and other security vulnerabilities.
-     */
-    descriptionHTML: string().optional().label("Description HTML"),
-    /*
-     * Location section
-     * This section is required and can be used to specify the location of the job.
-     * It is useful for jobs that are location-specific, such as on-site jobs.
-     * The value should be an array of locations.
-     * NOTE: Location is also required even if the job is remote, This is to comply with compliance and legal requirements.
-     *
-     * TODO: Make this field optional in the future.
-     */
-    locations: array()
-        .of(LocationSchema)
-        .default([])
-        // .required()
-        // .min(1)
-        .label("Location"),
-    /*
-     * Educational level section
-     * This section is optional and can be used to specify the educational level required for the job.
-     * It is useful for jobs that require specific educational qualifications, such as Bachelor's, Master's, etc.
-     * The value should be an array of supported education levels.
-     */
-    educationLevel: array(string().oneOf(SupportedEducationLevels))
-        .required()
-        .min(1)
-        .label("Educational level"),
-    /*
-     * Validity section
-     * This section is optional and can be used to specify the validity of the job post.
-     * This can be useful for jobs that have a specific duration or deadline.
-     * The value should be an object with start and end dates.
-     */
-    validity: DurationSchema({
-        format: SYSTEM_DATE_FORMAT,
-        startLabel: "Start Date",
-        endLabel: "Expiry Date",
-    }).label("Validity"),
-    /*
-     * Experience level section
-     * This section is optional and can be used to specify the experience level required for the job.
-     * It is useful for jobs that require specific levels of experience, such as entry-level, mid-level, or senior-level positions.
-     * The value should be one of the supported experience levels.
-     */
-    experienceLevel: string()
-        .oneOf(SupportedExperienceLevels)
-        .nullable()
-        .optional()
-        .label("Experience level"),
-    /*
-     * Contact email section
-     * This section is optional and can be used to specify the contact email for the job post.
-     * It is useful for jobs that require direct communication with the employer.
-     */
-    contactEmail: string().email().nullable().optional().label("Contact email"),
-    /*
-     * Working hours per week section
-     * This section is optional and can be used to specify the number of working hours per week for the job.
-     * It is useful for jobs that have a fixed number of hours per week, such as part-time or full-time jobs.
-     * The value should be a number between 1 and 168 (24 hours * 7 days).
-     */
-    workingHoursPerWeek: number()
-        .nullable()
-        .optional()
-        .min(1)
-        .max(24 * 7)
-        .label("Working hours per week"),
-    /*
-     * Tags are used to categorize the job post.
-     * They are optional and can be used to filter job posts.
-     */
-    tags: array().max(50).optional().label("Tags"),
-    /*
-     * Questionnaire section
-     * This section contains a list of questions that the user must answer when applying for the job through Direct/Quick Apply.
-     * It is optional and can be used to gather additional information from the applicants.
-     */
-    questionnaire: array()
-        .of(lazy((question) => {
-        const schema = getSchemaByQuestion(question.type);
-        if (question.type === QuestionType.Input) {
-            return schema.omit([
-                "answers",
-            ]);
-        }
-        else if (question.type === QuestionType.Choice) {
-            return schema.omit([
-                "answers",
-            ]);
-        }
-        else if (question.type === QuestionType.ReadAndAcknowledge) {
-            return schema.omit(["answers"]);
-        }
-        return schema;
-    }))
-        .label("Questionnaire"),
-    /**
-     * Status of the job post.
-     * This is required and can be one of the supported job statuses.
-     * It defaults to 'Draft' if not provided.
-     * This field is used to track the current state of the job post.
-     * Possible values include:
-     * - Draft: The job post is in draft mode and not yet published.
-     * - Published: The job post is live and visible to users.
-     * - Closed: The job post is closed and no longer accepting applications.
-     * - Deleted: The job post has been deleted and is no longer available.
-     */
-    status: string()
-        .oneOf(SupportedJobStatuses)
-        .default(JobStatus.Draft)
-        .required()
-        .label("Status"),
-    /**
-     * SEO tags for the job post.
-     * This is optional and can be used to improve the visibility of the job post in search engines.
-     * It includes meta tags for description and keywords.
-     */
-    seoTags: object({
-        description: string().optional().label("Description"),
-        keywords: array().of(string()).optional().label("Keywords"),
-    })
-        .nullable()
-        .optional()
-        .label("SEO Tags"),
-    /**
-     * Short job summary.
-     * This is optional and can be used to provide a brief overview of the job post.
-     * It is displayed in job listings and search results.
-     */
-    jdSummary: string().optional().label("JD Summary"),
-    /*
-     * Indicates if the job can be bookmarked by the user.
-     * This is optional and can be used to determine if the job supports bookmarking.
-     */
-    canCreateAlert: boolean().optional().label("Can create alert"),
-    /*
-     * Indicates if the job can be directly applied to without going through an external website.
-     * This is optional and can be used to determine if the job supports direct applications.
-     */
-    canDirectApply: boolean().optional().label("Can direct apply"),
-    /*
-     * Indicates if the user has applied for the job.
-     * This is optional and can be used to determine if the user has already applied.
-     */
-    hasApplied: boolean().optional().label("Has applied"),
-    /**
-     * Indicates if the user is the owner of the job.
-     * This is optional and can be used to determine if the user has permissions to edit/delete the job.
-     */
-    isOwner: boolean().optional().label("Is owner"),
-    /**
-     * Has the job been bookmarked by the user.
-     */
-    hasBookmarked: boolean().optional().label("Has bookmarked"),
-    /**
-     *  Indicates if the job has been reported by the user.
-     *  This is optional and can be used to track if the job has been reported for any reason.
-     *  It is useful for moderation and ensuring the quality of job posts.
-     */
-    hasReported: boolean().optional().label("Has reported"),
-    /**
-     * Rate per hour for the job.
-     * This is optional and can be used for freelance or contract jobs.
-     */
-    ratePerHour: number().optional().min(0).label("Rate per hour"),
-    /**
-     * Indicates if the job is promoted.
-     * This is optional and can be used to determine if the job is featured or highlighted.
-     */
-    isPromoted: boolean().optional().label("Is promoted"),
-    /**
-     * Salary range for the job.
-     * This is optional and can be used to specify the salary range for the job.
-     * It includes currency, minimum, and maximum salary.
-     */
-    salaryRange: object({
-        currency: string().required().label("Currency").default("USD"), // Default to USD if not provided
-        min: number().nullable().optional().min(0).label("Minimum Salary"),
-        max: number().nullable().optional().min(0).label("Maximum Salary"),
-        compensationType: string()
-            .oneOf(SupportedCompensationTypes)
-            .nullable()
-            .optional()
-            .label("Compensation Type"),
-        isNegotiable: boolean()
-            .nullable()
-            .optional()
-            .default(true)
-            .label("Is Negotiable"),
-    })
-        .nullable()
-        .optional()
-        .label("Salary Range"),
-    /*
-     * This field will store the information about users who have reported the job post.
-     * It is optional and can be used to track the users who have reported the job for any reason.
-     * It includes the user ID and the date when the report was made.
-     * It is also useful for analytics and reporting purposes.
-     */
-    reports: array().of(UserIdAndCreatedAtSchema).optional().label("Reports"),
-    /**
-     * This field can be used to categorize the job post under a specific category.
-     * It is optional and can help in organizing and filtering job posts based on categories.
-     */
-    category: string().nullable().optional().label("Category"),
-    /**
-     * This field can be used to specify the industry related to the job post.
-     * It is optional and can help in organizing and filtering job posts based on industries.
-     */
-    industry: string().nullable().optional().label("Industry"),
-    /**
-     * This field can be used to specify the sub-categories related to the job post.
-     * It is optional and can help in organizing and filtering job posts based on sub-categories.
-     */
-    subCategories: array()
-        .of(string().trim().required())
-        .nullable()
-        .optional()
-        .label("Sub Categories"),
-    /*
-     * Indicates if the user has accepted the terms and conditions for posting a job.
-     * This is required and should be a boolean value.
-     * It is used to ensure that the user agrees to the terms before proceeding with the job post.
-     */
-    termsAccepted: boolean()
-        .oneOf([true], "Accept terms before proceeding")
-        .required("Accept terms before proceeding")
-        .label("Terms accepted"),
-    /**
-     * Indicates if the job is featured on the home page or other prominent locations.
-     * This is managed by admins. Defaults to false.
-     */
-    isFeatured: boolean().optional().default(false).label("Is featured"),
-    /**
-     * List of market country codes where this job should be featured.
-     * If empty, the job is featured globally across all markets.
-     * Example: ["us", "gb", "se"]
-     */
-    featuredMarkets: array()
-        .of(string().required())
-        .optional()
-        .default([])
-        .label("Featured markets"),
-})
-    .concat(DbDefaultSchema)
-    .noUnknown()
-    .label("Job");

package/dist/esm/job/job.types.d.ts

@@ -1,13 +0,0 @@
-import { TOtherValueSchema } from "../common";
-import { EducationLevel } from "../constants";
-import { TChoiceQuestionSchema, TInputQuestionSchema } from "../question";
-export type JobRoleTemplate = {
-    headline: string;
-    description: string;
-    designation: TOtherValueSchema;
-    skills: TOtherValueSchema[];
-    tags: string[];
-    questionnaire?: Array<TChoiceQuestionSchema | TInputQuestionSchema>;
-    educationLevel?: Array<EducationLevel>;
-};
-//# sourceMappingURL=job.types.d.ts.map

package/dist/esm/job/job.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"job.types.d.ts","sourceRoot":"","sources":["../../../src/job/job.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE1E,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,aAAa,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,oBAAoB,CAAC,CAAC;IACpE,cAAc,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CACxC,CAAC"}

package/dist/esm/job/job.types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/job/utils.d.ts

@@ -1,4 +0,0 @@
-import { ObjectSchema } from "yup";
-import { QuestionType, TQuestionSchema } from "../question";
-export declare const getSchemaByQuestion: (type: QuestionType) => ObjectSchema<TQuestionSchema>;
-//# sourceMappingURL=utils.d.ts.map

package/dist/esm/job/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/job/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,KAAK,CAAC;AACnC,OAAO,EAGL,YAAY,EAEZ,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,eAAO,MAAM,mBAAmB,GAC9B,MAAM,YAAY,KACjB,YAAY,CAAC,eAAe,CAW9B,CAAC"}

package/dist/esm/job/utils.js

@@ -1,13 +0,0 @@
-import { ChoiceQuestionSchema, InputQuestionSchema, QuestionType, ReadAndAcknowledgeQuestionSchema, } from "../question";
-export const getSchemaByQuestion = (type) => {
-    switch (type) {
-        case QuestionType.Input:
-            return InputQuestionSchema;
-        case QuestionType.Choice:
-            return ChoiceQuestionSchema;
-        case QuestionType.ReadAndAcknowledge:
-            return ReadAndAcknowledgeQuestionSchema;
-        default:
-            throw Error("Unsupported schema: " + type);
-    }
-};

package/dist/esm/job-application/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./job-application.schema";
-export * from "./job-application.constant";
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/job-application/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/job-application/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC"}

package/dist/esm/job-application/index.js

@@ -1,2 +0,0 @@
-export * from "./job-application.schema";
-export * from "./job-application.constant";

package/dist/esm/job-application/job-application.constant.d.ts

@@ -1,20 +0,0 @@
-export declare enum JobApplicationStatus {
-    Open = "open",
-    Shortlisted = "shortlisted",
-    Interview = "interview",
-    Offered = "offered",
-    Rejected = "rejected",
-    Hired = "hired",
-    Closed = "closed",
-    Archived = "archived",
-    Expired = "expired"
-}
-export declare const SupportedJobApplicationsStatuses: JobApplicationStatus[];
-export declare enum JobApplicationScore {
-    Exceptional = 10,
-    Qualified = 9,
-    Potential = 8,
-    NotRecommended = 1
-}
-export declare const SupportedJobApplicationScores: JobApplicationScore[];
-//# sourceMappingURL=job-application.constant.d.ts.map

package/dist/esm/job-application/job-application.constant.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"job-application.constant.d.ts","sourceRoot":"","sources":["../../../src/job-application/job-application.constant.ts"],"names":[],"mappings":"AAAA,oBAAY,oBAAoB;IAC9B,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,gCAAgC,wBAS5C,CAAC;AAEF,oBAAY,mBAAmB;IAC7B,WAAW,KAAK;IAChB,SAAS,IAAI;IACb,SAAS,IAAI;IACb,cAAc,IAAI;CACnB;AAED,eAAO,MAAM,6BAA6B,uBAKzC,CAAC"}

package/dist/esm/job-application/job-application.constant.js

@@ -1,35 +0,0 @@
-export var JobApplicationStatus;
-(function (JobApplicationStatus) {
-    JobApplicationStatus["Open"] = "open";
-    JobApplicationStatus["Shortlisted"] = "shortlisted";
-    JobApplicationStatus["Interview"] = "interview";
-    JobApplicationStatus["Offered"] = "offered";
-    JobApplicationStatus["Rejected"] = "rejected";
-    JobApplicationStatus["Hired"] = "hired";
-    JobApplicationStatus["Closed"] = "closed";
-    JobApplicationStatus["Archived"] = "archived";
-    JobApplicationStatus["Expired"] = "expired";
-})(JobApplicationStatus || (JobApplicationStatus = {}));
-export const SupportedJobApplicationsStatuses = [
-    JobApplicationStatus.Open,
-    JobApplicationStatus.Shortlisted,
-    JobApplicationStatus.Interview,
-    JobApplicationStatus.Offered,
-    JobApplicationStatus.Rejected,
-    JobApplicationStatus.Hired,
-    JobApplicationStatus.Closed,
-    JobApplicationStatus.Archived,
-];
-export var JobApplicationScore;
-(function (JobApplicationScore) {
-    JobApplicationScore[JobApplicationScore["Exceptional"] = 10] = "Exceptional";
-    JobApplicationScore[JobApplicationScore["Qualified"] = 9] = "Qualified";
-    JobApplicationScore[JobApplicationScore["Potential"] = 8] = "Potential";
-    JobApplicationScore[JobApplicationScore["NotRecommended"] = 1] = "NotRecommended";
-})(JobApplicationScore || (JobApplicationScore = {}));
-export const SupportedJobApplicationScores = [
-    JobApplicationScore.Exceptional,
-    JobApplicationScore.Qualified,
-    JobApplicationScore.Potential,
-    JobApplicationScore.NotRecommended,
-];