@thejob/schema 1.0.6 → 1.0.8

package/dist/cjs/job/job.schema.js

@@ -9,11 +9,25 @@ const job_constant_1 = require("./job.constant");
 const utils_1 = require("./utils");
 exports.JobSchema = (0, yup_extended_1.object)()
     .shape({
-    // Headline section
+    /*
+     * 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: (0, yup_extended_1.string)().required().min(10).max(150).label("Headline"),
-    slug: (0, yup_extended_1.string)().optional().max(250).label("Slug"),
-    // TODO: Make shortId required
-    // Application receive preference section
+    /*
+     * 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: (0, yup_extended_1.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: (0, yup_extended_1.mixed)()
         .oneOf([
         common_1.ApplicationReceivePreference.Inbox,
@@ -21,27 +35,54 @@ exports.JobSchema = (0, yup_extended_1.object)()
     ])
         .required()
         .label("Preference"),
-    // External apply link section
+    /*
+     * 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: (0, yup_extended_1.string)().when("applicationReceivePreference", {
         is: (value) => value === common_1.ApplicationReceivePreference.ExternalWebsite,
         then: (schema) => schema.url().required().label("Apply for Job link"),
         otherwise: (schema) => schema.optional(),
     }),
-    // Company section
+    /*
+     * 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: (0, yup_extended_1.mixed)()
         .oneOfSchema([common_1.NameIdLogoSchema, common_1.OtherValueSchema])
         .required()
         .label("Company"),
-    // Designation section
+    /*
+     * 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: (0, yup_extended_1.mixed)()
         .oneOfSchema([common_1.NameIdLogoSchema, common_1.OtherValueSchema])
         .required()
         .label("Designation"),
-    // Employment type section
+    /*
+     * 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: (0, yup_extended_1.string)().required().label("Employment type"),
-    // Work mode section
+    /*
+     * 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: (0, yup_extended_1.string)().required().label("Work mode"),
-    // Skill section
+    /*
+     * 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: Add knockout skills that if not present in the application should immediately disqualify the application.
+     */
     skills: (0, yup_extended_1.array)()
         .of((0, yup_extended_1.mixed)().oneOfSchema([
         common_1.NameIdLogoSchema,
@@ -50,79 +91,150 @@ exports.JobSchema = (0, yup_extended_1.object)()
         .optional()
         .max(20)
         .label("Skills"),
-    // TODO: Add knockout skills that if not present in the application should immediately disqualify the application.
+    /*
+     * 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: (0, yup_extended_1.array)()
-        .of((0, yup_extended_1.object)().shape({
-        userId: (0, yup_extended_1.string)().required().label("Use Id"),
-        createdAt: (0, yup_extended_1.string)().optional().label("Created At"),
-    }))
+        .of(common_1.UserIdAndCreatedAtSchema)
         .optional()
         .label("Bookmarks"),
+    /*
+     * 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: (0, yup_extended_1.array)()
-        .of((0, yup_extended_1.object)({
-        userId: (0, yup_extended_1.string)().required().label("User Id"),
-        appliedOn: (0, yup_extended_1.date)().required().label("Applied On"),
-    }))
+        .of(common_1.UserIdAndCreatedAtSchema)
         .optional()
         .label("Applicants"),
+    /*
+     * 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: (0, yup_extended_1.array)()
-        .of((0, yup_extended_1.object)({
-        userId: (0, yup_extended_1.string)().required().label("User Id"),
-        appliedOn: (0, yup_extended_1.date)().required().label("Applied On"),
-    }))
+        .of(common_1.UserIdAndCreatedAtSchema)
         .optional()
         .label("External Applicants"),
-    // Description section
+    /*
+     * 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: (0, yup_extended_1.string)().required().min(250).max(10000).label("Description"),
-    descriptionHTML: (0, yup_extended_1.string)().optional().label("Description Markup"),
+    /*
+     * 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: (0, yup_extended_1.string)().optional().label("Description Markdown"),
-    promoted: (0, yup_extended_1.boolean)().optional().label("Promoted"),
-    // Location section
+    /*
+     * 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: (0, yup_extended_1.string)().required().label("Description Markup"),
+    /*
+     * 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.
+     */
     locations: (0, yup_extended_1.array)()
         .of(location_1.LocationSchema)
         .required()
         .min(1)
         .label("Location"),
-    // // Category section TODO: Remove this section
-    // category: array().optional().default([]).max(3).label("Category"),
-    // Education level section
+    /*
+     * 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: (0, yup_extended_1.array)((0, yup_extended_1.string)().oneOf(common_1.SupportedEducationLevels))
         .required()
         .min(1)
         .label("Educational level"),
-    // Job post validity section
+    /*
+     * 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: (0, duration_1.DurationSchema)({
         format: common_1.SystemDateFormat,
         startLabel: "Start Date",
         endLabel: "Expiry Date",
     }).label("Validity"),
-    // // Experience level section
+    /*
+     * 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: (0, yup_extended_1.string)()
         .oneOf(common_1.SupportedExperienceLevels)
         .optional()
         .label("Experience level"),
-    // Contact section
+    /*
+     * 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: (0, yup_extended_1.string)().email().optional().label("Contact email"),
-    // Career level section
-    // careerLevel: string()
-    //   .oneOf(SupportedCareerLevels)
-    //   .optional()
-    //   .label("Career level"),
-    // Working hours per week section
+    /*
+     * 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: (0, yup_extended_1.number)()
         .optional()
         .min(1)
         .max(24 * 7)
         .label("Working hours per week"),
-    // Tags section
+    /*
+     * Tags are used to categorize the job post.
+     * They are optional and can be used to filter job posts.
+     */
     tags: (0, yup_extended_1.array)().max(50).optional().label("Tags"),
-    //TODO: Add questionnaire section
+    /*
+     * 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: (0, yup_extended_1.array)().of((0, yup_extended_1.lazy)((question) => (0, utils_1.getSchemaByQuestion)(question.type))),
+    /**
+     * 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: (0, yup_extended_1.string)()
         .oneOf(job_constant_1.SupportedJobStatuses)
         .default(job_constant_1.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: (0, yup_extended_1.object)()
         .shape({
         meta: (0, yup_extended_1.object)().shape({
@@ -132,21 +244,95 @@ exports.JobSchema = (0, yup_extended_1.object)()
     })
         .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: (0, yup_extended_1.string)().optional().label("JD Summary"),
-    // Addidional properties
+    /*
+     * 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: (0, yup_extended_1.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: (0, yup_extended_1.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: (0, yup_extended_1.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: (0, yup_extended_1.boolean)().optional().label("Is owner"),
+    /**
+     * Has the job been bookmarked by the user.
+     */
     hasBookmarked: (0, yup_extended_1.boolean)().optional().label("Has bookmarked"),
+    /**
+     * Number of applicants for the job (Direct Apply/Quick Apply).
+     * This is optional and can be used to track the number of applicants.
+     */
     applicantCount: (0, yup_extended_1.number)().optional().label("Applicant count"),
+    /**
+     * Rate per hour for the job.
+     * This is optional and can be used for freelance or contract jobs.
+     */
+    ratePerHour: (0, yup_extended_1.number)().optional().min(0).label("Rate per hour"),
+    /**
+     * Number of external applicants for the job.
+     */
     externalApplicantCount: (0, yup_extended_1.number)()
         .optional()
         .label("External applicant count"),
-    // TODO: Add termsAccepted section to the schema
-    //   termsAccepted: boolean()
-    //     .oneOf([true], "Accept terms before proceeding")
-    //     .required("Accept terms before proceeding"),
+    /**
+     * Indicates if the job is promoted.
+     * This is optional and can be used to determine if the job is featured or highlighted.
+     */
+    isPromoted: (0, yup_extended_1.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: (0, yup_extended_1.object)()
+        .shape({
+        currency: (0, yup_extended_1.string)().required().label("Currency").default("USD"), // Default to USD if not provided
+        min: (0, yup_extended_1.number)().optional().min(0).label("Minimum Salary"),
+        max: (0, yup_extended_1.number)().optional().min(0).label("Maximum Salary"),
+        compensationType: (0, yup_extended_1.string)()
+            .oneOf(common_1.SupportedCompensationTypes)
+            .required()
+            .label("Compensation Type"),
+        isNegotiable: (0, yup_extended_1.boolean)()
+            .optional()
+            .default(false)
+            .label("Is Negotiable"),
+    })
+        .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: (0, yup_extended_1.array)().of(common_1.UserIdAndCreatedAtSchema).optional().label("Reports"),
+    /*
+     * 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: (0, yup_extended_1.boolean)()
+        .oneOf([true], "Accept terms before proceeding")
+        .required("Accept terms before proceeding")
+        .required()
+        .label("Terms accepted"),
 })
     .concat(common_1.DbDefaultSchema)
     .noUnknown()

package/dist/cjs/job-application/job-application.schema.d.ts

@@ -161,7 +161,7 @@ export declare const JobApplicationSchema: ObjectSchema<{
         status: NonNullable<JobApplicationStatus | undefined>;
     }[];
 } & {
-    id: string;
+    _id: string;
     shortId: string;
     createdBy: string;
     createdAt: string;
@@ -190,22 +190,22 @@ export declare const JobApplicationSchema: ObjectSchema<{
         status: import("../resume").ResumeStatus.Draft;
         markdown: undefined;
         markdownStyling: import("../resume").ResumeMarkdownStyle.Classic;
-        id: undefined;
+        _id: undefined;
         shortId: undefined;
         createdBy: undefined;
-        createdAt: undefined;
+        createdAt: string;
         updatedBy: undefined;
-        updatedAt: undefined;
+        updatedAt: string;
     };
     status: JobApplicationStatus.Open;
     questionnaire: "";
     history: never[];
-    id: undefined;
+    _id: undefined;
     shortId: undefined;
     createdBy: undefined;
-    createdAt: undefined;
+    createdAt: string;
     updatedBy: undefined;
-    updatedAt: undefined;
+    updatedAt: string;
 }, "">;
 export type TJobApplicationSchema = InferType<typeof JobApplicationSchema>;
 //# sourceMappingURL=job-application.schema.d.ts.map

package/dist/cjs/job-role-template/job-role-template.schema.d.ts

@@ -56,9 +56,8 @@ export declare const JobRoleTemplateSchema: import("yup").ObjectSchema<{
     applicants: "";
     externalApplicants: "";
     description: undefined;
-    descriptionHTML: undefined;
     descriptionMarkdown: undefined;
-    promoted: undefined;
+    descriptionHTML: undefined;
     locations: "";
     educationLevel: undefined;
     validity: any;
@@ -81,13 +80,24 @@ export declare const JobRoleTemplateSchema: import("yup").ObjectSchema<{
     isOwner: undefined;
     hasBookmarked: undefined;
     applicantCount: undefined;
+    ratePerHour: undefined;
     externalApplicantCount: undefined;
-    id: undefined;
+    isPromoted: undefined;
+    salaryRange: {
+        currency: "USD";
+        min: undefined;
+        max: undefined;
+        compensationType: undefined;
+        isNegotiable: false;
+    };
+    reports: "";
+    termsAccepted: undefined;
+    _id: undefined;
     shortId: undefined;
     createdBy: undefined;
-    createdAt: undefined;
+    createdAt: string;
     updatedBy: undefined;
-    updatedAt: undefined;
+    updatedAt: string;
 }, "">;
 export type TJobRoleTemplateSchema = InferType<typeof JobRoleTemplateSchema>;
 //# sourceMappingURL=job-role-template.schema.d.ts.map

package/dist/cjs/job-role-template/job-role-template.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"job-role-template.schema.d.ts","sourceRoot":"","sources":["../../../src/job-role-template/job-role-template.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAQhC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,SAAS,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"job-role-template.schema.d.ts","sourceRoot":"","sources":["../../../src/job-role-template/job-role-template.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAQhC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,SAAS,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/cjs/resume/resume.schema.d.ts

@@ -242,7 +242,7 @@ export declare const ResumeSchema: import("yup").ObjectSchema<{
     markdown: string;
     markdownStyling: ResumeMarkdownStyle;
 } & {
-    id: string;
+    _id: string;
     shortId: string;
     createdBy: string;
     createdAt: string;
@@ -255,12 +255,12 @@ export declare const ResumeSchema: import("yup").ObjectSchema<{
     status: ResumeStatus.Draft;
     markdown: undefined;
     markdownStyling: ResumeMarkdownStyle.Classic;
-    id: undefined;
+    _id: undefined;
     shortId: undefined;
     createdBy: undefined;
-    createdAt: undefined;
+    createdAt: string;
     updatedBy: undefined;
-    updatedAt: undefined;
+    updatedAt: string;
 }, "">;
 export type TResumeSchema = InferType<typeof ResumeSchema>;
 export declare const NewResumePromptSchema: (host?: string) => import("yup").ObjectSchema<{

package/dist/esm/common/common.schema.d.ts

@@ -24,19 +24,19 @@ export declare const TermsAndConditionSchema: import("yup").ObjectSchema<{
 }, "">;
 export type TTermsAndConditionSchema = InferType<typeof TermsAndConditionSchema>;
 export declare const DbDefaultSchema: import("yup").ObjectSchema<{
-    id: string;
+    _id: string;
     shortId: string;
     createdBy: string;
     createdAt: string;
     updatedBy: string | undefined;
     updatedAt: string | undefined;
 }, import("yup").AnyObject, {
-    id: undefined;
+    _id: undefined;
     shortId: undefined;
     createdBy: undefined;
-    createdAt: undefined;
+    createdAt: string;
     updatedBy: undefined;
-    updatedAt: undefined;
+    updatedAt: string;
 }, "">;
 export type TDBDefaultSchema = InferType<typeof DbDefaultSchema>;
 export declare const CompletenessScoreSchema: (minScore?: number) => import("yup").ObjectSchema<{
@@ -49,4 +49,12 @@ export declare const CompletenessScoreSchema: (minScore?: number) => import("yup
     completedSteps: 0;
 }, "">;
 export type TCompletenessScoreSchema = InferType<ReturnType<typeof CompletenessScoreSchema>>;
+export declare const UserIdAndCreatedAtSchema: import("yup").ObjectSchema<{
+    userId: string;
+    createdAt: string;
+}, import("yup").AnyObject, {
+    userId: undefined;
+    createdAt: undefined;
+}, "">;
+export type TUserIdAndCreatedAtSchema = InferType<typeof UserIdAndCreatedAtSchema>;
 //# sourceMappingURL=common.schema.d.ts.map

package/dist/esm/common/common.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.schema.d.ts","sourceRoot":"","sources":["../../../src/common/common.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAOV,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,gBAAgB;;;;;;;;MAOlB,CAAC;AACZ,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEnE,eAAO,MAAM,gBAAgB;;;;;;MAwBlB,CAAC;AACZ,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEnE,eAAO,MAAM,uBAAuB;;;;MAIlC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;MAWjB,CAAC;AAEZ,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,eAAe,CAAC,CAAC;AAEjE,eAAO,MAAM,uBAAuB,GAAI,WAAU,MAAW;;;;;;;;MAKzD,CAAC;AAEL,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAC3C,CAAC"}
+{"version":3,"file":"common.schema.d.ts","sourceRoot":"","sources":["../../../src/common/common.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAQV,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,gBAAgB;;;;;;;;MAOlB,CAAC;AACZ,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEnE,eAAO,MAAM,gBAAgB;;;;;;MAwBlB,CAAC;AACZ,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEnE,eAAO,MAAM,uBAAuB;;;;MAIlC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;MAiBjB,CAAC;AAEZ,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,eAAe,CAAC,CAAC;AAEjE,eAAO,MAAM,uBAAuB,GAAI,WAAU,MAAW;;;;;;;;MAKzD,CAAC;AAEL,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAC3C,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;;;MAGnC,CAAC;AACH,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,wBAAwB,CAChC,CAAC"}

package/dist/esm/common/common.schema.js

@@ -1,4 +1,4 @@
-import { object, string, array, boolean, lazy, number, } from "../yup-extended";
+import { object, string, array, boolean, lazy, number, dateString, } from "../yup-extended";
 export const NameIdLogoSchema = object()
     .shape({
     id: string().objectId().required().label("Id"),
@@ -35,12 +35,18 @@ export const TermsAndConditionSchema = object().shape({
 });
 export const DbDefaultSchema = object()
     .shape({
-    id: string().objectId().required().label("Id"),
+    _id: string().objectId().required().label("Id"),
     shortId: string().required().max(12).label("Short ID"),
     createdBy: string().required().label("Created By"),
-    createdAt: string().required().label("Created At"),
+    createdAt: dateString()
+        .required()
+        .typeError(`Create date must be a valid date`)
+        .label("Created At"),
     updatedBy: string().label("Updated By"),
-    updatedAt: string().optional().label("Updated At"),
+    updatedAt: dateString()
+        .optional()
+        .typeError(`Update date must be a valid date`)
+        .label("Updated At"),
 })
     .label("Db Default Schema")
     .noUnknown()
@@ -50,3 +56,7 @@ export const CompletenessScoreSchema = (minScore = 50) => object().shape({
     totalSteps: number().min(0).default(0).label("Total Steps"),
     completedSteps: number().min(0).default(0).label("Completed Steps"),
 });
+export const UserIdAndCreatedAtSchema = object().shape({
+    userId: string().objectId().required().label("User Id"),
+    createdAt: string().required().label("Created At"),
+});

package/dist/esm/common/constants.d.ts

@@ -185,4 +185,12 @@ export declare enum UserStatus {
 }
 export declare const SupportedUserStatuses: UserStatus[];
 export declare const DefaultUserRoles: UserRole[];
+export declare enum CompensationType {
+    Hourly = "hourly",
+    Monthly = "monthly",
+    Yearly = "yearly",
+    OneTime = "one-time",
+    Other = "other"
+}
+export declare const SupportedCompensationTypes: CompensationType[];
 //# sourceMappingURL=constants.d.ts.map

package/dist/esm/common/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,mBAAmB,aAM/B,CAAC;AAEF,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C,eAAO,MAAM,iBAAiB,OAAO,CAAC;AAEtC,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,QAAQ;IAClB,GAAG,oBAAoB;IACvB,qBAAqB,sCAAsC;IAC3D,mBAAmB,wBAAwB;IAC3C,IAAI,eAAe;IACnB,GAAG,cAAc;IACjB,GAAG,cAAc;IACjB,IAAI,eAAe;IACnB,GAAG,cAAc;IACjB,GAAG,oBAAoB;IACvB,IAAI,qBAAqB;IACzB,GAAG,uBAAuB;IAC1B,IAAI,4EAA4E;IAChF,IAAI,4EAA4E;IAChF,GAAG,aAAa;CACjB;AAED,oBAAY,aAAa;IACvB,IAAI,UAAU;IACd,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,IAAI,UAAU;IACd,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,IAAI,UAAU;IACd,IAAI,UAAU;IACd,GAAG,SAAS;CACb;AAED,oBAAY,gBAAgB;IAC1B,cAAc,oBAAoB;IAClC,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,0BAA0B,oBAMtC,CAAC;AAEF,oBAAY,aAAa;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,uBAAuB,iBAMnC,CAAC;AAEF,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,OAAO,YAAY;IACnB,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,cAAc,mBAAmB;IACjC,SAAS,cAAc;IAEvB,QAAQ,aAAa;CACtB;AAED,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,cAAc,mBAAmB;CAClC;AAED,oBAAY,4BAA4B;IACtC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,eAAe,qBAAqB;CACrC;AAoBD,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,SAAS,eAAe;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,yBAAyB,mBAAiC,CAAC;AAExE,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,oBAAY,cAAc;IACxB,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,OAAO,aAAa;CACrB;AAED,eAAO,MAAM,wBAAwB,kBAOpC,CAAC;AAEF,oBAAY,QAAQ;IAClB,MAAM,YAAY;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,kBAAkB,YAI9B,CAAC;AAEF,oBAAY,cAAc;IACxB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,iBAAiB,wBAAwB;CAC1C;AAED,eAAO,MAAM,wBAAwB,kBAOpC,CAAC;AAEF,oBAAY,aAAa;IACvB,IAAI,kBAAkB;IACtB,KAAK,mBAAmB;IACxB,OAAO,qBAAqB;IAC5B,SAAS,uBAAuB;IAChC,UAAU,wBAAwB;IAClC,WAAW,yBAAyB;IACpC,WAAW,qBAAqB;CACjC;AAED,eAAO,MAAM,uBAAuB,iBAA+B,CAAC;AAEpE,oBAAY,eAAe;IACzB,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,QAAQ,cAAc;IACtB,SAAS,eAAe;IACxB,GAAG,QAAQ;CACZ;AAED,eAAO,MAAM,yBAAyB,mBAAiC,CAAC;AAExE,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,kBAAkB,YAA0B,CAAC;AAE1D,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,qBAAqB,cAA4B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,YAAoB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,mBAAmB,aAM/B,CAAC;AAEF,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C,eAAO,MAAM,iBAAiB,OAAO,CAAC;AAEtC,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,QAAQ;IAClB,GAAG,oBAAoB;IACvB,qBAAqB,sCAAsC;IAC3D,mBAAmB,wBAAwB;IAC3C,IAAI,eAAe;IACnB,GAAG,cAAc;IACjB,GAAG,cAAc;IACjB,IAAI,eAAe;IACnB,GAAG,cAAc;IACjB,GAAG,oBAAoB;IACvB,IAAI,qBAAqB;IACzB,GAAG,uBAAuB;IAC1B,IAAI,4EAA4E;IAChF,IAAI,4EAA4E;IAChF,GAAG,aAAa;CACjB;AAED,oBAAY,aAAa;IACvB,IAAI,UAAU;IACd,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,IAAI,UAAU;IACd,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,GAAG,SAAS;IACZ,IAAI,UAAU;IACd,IAAI,UAAU;IACd,GAAG,SAAS;CACb;AAED,oBAAY,gBAAgB;IAC1B,cAAc,oBAAoB;IAClC,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,0BAA0B,oBAMtC,CAAC;AAEF,oBAAY,aAAa;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,uBAAuB,iBAMnC,CAAC;AAEF,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,OAAO,YAAY;IACnB,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,cAAc,mBAAmB;IACjC,SAAS,cAAc;IAEvB,QAAQ,aAAa;CACtB;AAED,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,cAAc,mBAAmB;CAClC;AAED,oBAAY,4BAA4B;IACtC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,eAAe,qBAAqB;CACrC;AAoBD,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,SAAS,eAAe;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,yBAAyB,mBAAiC,CAAC;AAExE,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,oBAAY,cAAc;IACxB,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,OAAO,aAAa;CACrB;AAED,eAAO,MAAM,wBAAwB,kBAOpC,CAAC;AAEF,oBAAY,QAAQ;IAClB,MAAM,YAAY;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,kBAAkB,YAI9B,CAAC;AAEF,oBAAY,cAAc;IACxB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,iBAAiB,wBAAwB;CAC1C;AAED,eAAO,MAAM,wBAAwB,kBAOpC,CAAC;AAEF,oBAAY,aAAa;IACvB,IAAI,kBAAkB;IACtB,KAAK,mBAAmB;IACxB,OAAO,qBAAqB;IAC5B,SAAS,uBAAuB;IAChC,UAAU,wBAAwB;IAClC,WAAW,yBAAyB;IACpC,WAAW,qBAAqB;CACjC;AAED,eAAO,MAAM,uBAAuB,iBAA+B,CAAC;AAEpE,oBAAY,eAAe;IACzB,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,QAAQ,cAAc;IACtB,SAAS,eAAe;IACxB,GAAG,QAAQ;CACZ;AAED,eAAO,MAAM,yBAAyB,mBAAiC,CAAC;AAExE,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,kBAAkB,YAA0B,CAAC;AAE1D,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,qBAAqB,cAA4B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,YAAoB,CAAC;AAElD,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,aAAa;IACpB,KAAK,UAAU;CAChB;AAED,eAAO,MAAM,0BAA0B,oBAAkC,CAAC"}

package/dist/esm/common/constants.js

@@ -256,3 +256,12 @@ export var UserStatus;
 })(UserStatus || (UserStatus = {}));
 export const SupportedUserStatuses = Object.values(UserStatus);
 export const DefaultUserRoles = [UserRole.Normal];
+export var CompensationType;
+(function (CompensationType) {
+    CompensationType["Hourly"] = "hourly";
+    CompensationType["Monthly"] = "monthly";
+    CompensationType["Yearly"] = "yearly";
+    CompensationType["OneTime"] = "one-time";
+    CompensationType["Other"] = "other";
+})(CompensationType || (CompensationType = {}));
+export const SupportedCompensationTypes = Object.values(CompensationType);