@thejob/schema 1.0.1 → 1.0.3

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

@@ -0,0 +1,207 @@
+import { InferType } from "../yup-extended";
+export declare const UserSchema: import("yup").ObjectSchema<{
+    socialAccounts: {
+        type: NonNullable<import("..").SocialAccount | undefined>;
+        url: string;
+        isNew: boolean;
+    }[];
+    workExperiences: {
+        description?: string | undefined;
+        duration: {
+            startDate: string;
+            endDate: string;
+            isActive: boolean;
+        };
+        location: {
+            state?: string | undefined;
+            stateCode?: string | undefined;
+            country: string;
+            countryCode: string;
+            city: string;
+            address: string;
+            latLong: {
+                country?: (number | undefined)[] | undefined;
+                state?: number[] | undefined;
+                city?: number[] | undefined;
+            };
+        };
+        company: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        designation: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        isRemote: boolean;
+    }[];
+    educations: {
+        description?: string | undefined;
+        institute: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        course: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        fieldOfStudy: NonNullable<NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>>;
+        isDistanceLearning: boolean;
+        studyType: NonNullable<import("..").StudyType | undefined>;
+        duration: {
+            startDate: string;
+            endDate: string;
+            isActive: boolean;
+        };
+        location: {
+            state?: string | undefined;
+            stateCode?: string | undefined;
+            country: string;
+            countryCode: string;
+            city: string;
+            address: string;
+            latLong: {
+                country?: (number | undefined)[] | undefined;
+                state?: number[] | undefined;
+                city?: number[] | undefined;
+            };
+        };
+    }[];
+    skills: {
+        skill: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        proficiencyLevel: NonNullable<import("..").ProficiencyLevel | undefined>;
+        lastUsed: string;
+    }[];
+    projects: {
+        url?: string | undefined;
+        name: string;
+        description: string;
+        duration: {
+            startDate: string;
+            endDate: string;
+            isActive: boolean;
+        };
+    }[];
+    certifications: {
+        url?: string | undefined;
+        licenseNumber?: string | undefined;
+        name: string;
+        duration: {
+            startDate: string;
+            endDate: string;
+            isActive: boolean;
+        };
+        authority: string;
+    }[];
+    interests: {
+        logo?: string | undefined;
+        name: string;
+        id: string;
+    }[];
+    languages: {
+        language: NonNullable<{
+            logo?: string | undefined;
+            name: string;
+            id: string;
+        } | {
+            value: "others" | (string | undefined)[];
+            otherValue: string | string[];
+        } | undefined>;
+        isNew: boolean;
+        proficiencyLevel: NonNullable<import("..").ProficiencyLevel | undefined>;
+    }[];
+    additionalInfo: {
+        description: string;
+        isNew: boolean;
+        title: string;
+    }[];
+} & {
+    id: string | undefined;
+    name: {
+        first: string;
+        last: string;
+    };
+    headline: string | undefined;
+    image: string | undefined;
+    aboutMe: string | undefined;
+    email: string;
+    mobile: {
+        number: string;
+        country: {
+            locale?: string | undefined;
+            name: string;
+            dial_code: string;
+            code: string;
+        };
+    };
+    emailVerified: string | null | undefined;
+    experienceLevel: NonNullable<import("..").ExperienceLevel | undefined>;
+    location: {
+        state?: string | undefined;
+        stateCode?: string | undefined;
+        country: string;
+        countryCode: string;
+        city: string;
+        address: string;
+        latLong: {
+            country?: (number | undefined)[] | undefined;
+            state?: number[] | undefined;
+            city?: number[] | undefined;
+        };
+    };
+}, import("yup").AnyObject, {
+    socialAccounts: never[];
+    workExperiences: never[];
+    educations: never[];
+    skills: never[];
+    projects: never[];
+    certifications: never[];
+    interests: never[];
+    languages: never[];
+    additionalInfo: never[];
+    id: undefined;
+    name: {
+        first: undefined;
+        last: undefined;
+    };
+    headline: undefined;
+    image: undefined;
+    aboutMe: undefined;
+    email: undefined;
+    mobile: undefined;
+    emailVerified: undefined;
+    experienceLevel: undefined;
+    location: any;
+}, "">;
+export type TUserSchema = InferType<typeof UserSchema>;
+//# sourceMappingURL=user.schema.d.ts.map

package/dist/cjs/user/user.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.schema.d.ts","sourceRoot":"","sources":["../../../src/user/user.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,MAAM,iBAAiB,CAAC;AAW3D,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAmEA,CAAC;AAExB,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/dist/cjs/user/user.schema.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserSchema = void 0;
+const yup_extended_1 = require("../yup-extended");
+const education_1 = require("./education");
+const general_detail_schema_1 = require("./general-detail/general-detail.schema");
+const project_1 = require("./project");
+const social_account_1 = require("./social-account");
+const user_additional_info_1 = require("./user-additional-info");
+const user_certification_1 = require("./user-certification");
+const user_interest_1 = require("./user-interest");
+const user_language_1 = require("./user-language");
+const user_skill_schema_1 = require("./user-skill/user-skill.schema");
+const work_experience_1 = require("./work-experience");
+exports.UserSchema = (0, yup_extended_1.object)()
+    .shape({
+    /**
+     * Social media information about the user (e.g. LinkedIn, GitHub, etc.)
+     */
+    socialAccounts: (0, yup_extended_1.array)()
+        .of(social_account_1.SocialAccountSchema)
+        .default([])
+        .label("Social Accounts"),
+    /**
+     * Work experience information about the user
+     */
+    workExperiences: (0, yup_extended_1.array)()
+        .of(work_experience_1.WorkExperienceSchema)
+        .required()
+        .default([])
+        .label("Work Experiences"),
+    /**
+     * Education information about the user
+     */
+    educations: (0, yup_extended_1.array)()
+        .of(education_1.EducationSchema)
+        .required()
+        .default([])
+        .label("Educations"),
+    /**
+     * Skills information about the user
+     */
+    skills: (0, yup_extended_1.array)().of(user_skill_schema_1.UserSkillSchema).required().default([]).label("Skills"),
+    /**
+     * Projects information about the user
+     */
+    projects: (0, yup_extended_1.array)().of(project_1.UserProjectSchema).default([]).label("Projects"),
+    /**
+     * Certifications information about the user
+     */
+    certifications: (0, yup_extended_1.array)()
+        .of(user_certification_1.UserCertificationSchema)
+        .default([])
+        .label("Certifications"),
+    /**
+     * Interests information about the user.
+     */
+    interests: (0, yup_extended_1.array)()
+        .of(user_interest_1.UserInterestSchema)
+        .required()
+        .default([])
+        .label("Interests"),
+    /**
+     * Languages information about the user
+     */
+    languages: (0, yup_extended_1.array)()
+        .of(user_language_1.UserLanguageSchema)
+        .required()
+        .default([])
+        .label("Languages"),
+    /**
+     * Additional information about the user
+     */
+    additionalInfo: (0, yup_extended_1.array)()
+        .of(user_additional_info_1.UserAdditionalInfoSchema)
+        .default([])
+        .label("Additional Information"),
+})
+    .concat(general_detail_schema_1.UserGeneralDetailSchema)
+    .noUnknown()
+    .strict()
+    .label("User Schema");
+{
+    /**
+     * /**
+     * Generate a function to calculate data completeness against a Yup schema.
+     *
+     * Requirements:
+     * 1. Handle primitives, nested objects, and arrays.
+     * 2. For objects:
+     *    a. Score based on required fields (include optional fields if `includeOptionals=true`).
+     *    b. Return 100% if no required fields, has optional fields or doesn't have optional field and `includeOptionals=false`.
+     *    c. Track completed/incomplete fields in `meta`.
+     *    d. Track all fields in `meta.steps` contributing to the score.
+     * 3. For arrays:
+     *    a. Calculate average score of items (store individual scores in `children`).
+     *    b. Empty array scores:
+     *       - 100% if schema doesn’t require it.
+     *       - 0% if schema requires it.
+     *       - Override with `options.emptyArrayScore` if provided.
+     * 4. Recursively score nested structures.
+     * 5. Return a `CompletenessScore` object with:
+     *    - `score` (0-100) Score Clamping.
+     *    - `completedSteps`/`totalSteps`
+     *    - `children` for array items
+     *    - `meta` with field lists for objects.
+     *
+     * Edge Cases:
+     * - Empty object: Score 0% if missing required fields.
+     * - Schema with no required fields: Return 100% if `includeOptionals=false`.
+     * - Nested arrays/objects: Propagate scores recursively.
+     */
+}

package/dist/cjs/user/user.types.d.ts

@@ -0,0 +1,19 @@
+import { ExperienceLevel } from "../common";
+import { TLocationSchema } from "../location";
+import { TMobileNumberSchema } from "../phone";
+import { TEducationSchema } from "./education";
+import { TWorkExperienceSchema } from "./work-experience";
+export type UserProfileOverview = {
+    name: {
+        first: string;
+        last: string;
+    };
+    email: string;
+    experienceLevel: ExperienceLevel;
+    location?: TLocationSchema;
+    emailVerified?: boolean;
+    mobile?: TMobileNumberSchema;
+    recentWork?: TWorkExperienceSchema;
+    recentEducation?: TEducationSchema;
+};
+//# sourceMappingURL=user.types.d.ts.map

package/dist/cjs/user/user.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.types.d.ts","sourceRoot":"","sources":["../../../src/user/user.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,eAAe,CAAC,EAAE,gBAAgB,CAAC;CACpC,CAAC"}

package/dist/cjs/user/user.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/user/work-experience/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./work-experience.schema";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/user/work-experience/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/user/work-experience/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/cjs/user/work-experience/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./work-experience.schema"), exports);

package/dist/cjs/user/work-experience/work-experience.schema.d.ts

@@ -0,0 +1,48 @@
+import { InferType, ObjectSchema } from "../../yup-extended";
+export declare const WorkExperienceSchema: ObjectSchema<{
+    company: NonNullable<{
+        logo?: string | undefined;
+        name: string;
+        id: string;
+    } | {
+        value: "others" | (string | undefined)[];
+        otherValue: string | string[];
+    } | undefined>;
+    designation: NonNullable<{
+        logo?: string | undefined;
+        name: string;
+        id: string;
+    } | {
+        value: "others" | (string | undefined)[];
+        otherValue: string | string[];
+    } | undefined>;
+    duration: {
+        startDate: string;
+        endDate: string;
+        isActive: boolean;
+    };
+    description: string | undefined;
+    location: {
+        state?: string | undefined;
+        stateCode?: string | undefined;
+        country: string;
+        countryCode: string;
+        city: string;
+        address: string;
+        latLong: {
+            country?: (number | undefined)[] | undefined;
+            state?: number[] | undefined;
+            city?: number[] | undefined;
+        };
+    };
+    isRemote: boolean;
+}, import("yup").AnyObject, {
+    company: undefined;
+    designation: undefined;
+    duration: any;
+    description: undefined;
+    location: any;
+    isRemote: false;
+}, "">;
+export type TWorkExperienceSchema = InferType<typeof WorkExperienceSchema>;
+//# sourceMappingURL=work-experience.schema.d.ts.map

package/dist/cjs/user/work-experience/work-experience.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"work-experience.schema.d.ts","sourceRoot":"","sources":["../../../../src/user/work-experience/work-experience.schema.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,SAAS,EAGT,YAAY,EAEb,MAAM,oBAAoB,CAAC;AAE5B,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAyBN,CAAC;AAE5B,MAAM,MAAM,qBAAqB,GAAG,SAAS,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/cjs/user/work-experience/work-experience.schema.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkExperienceSchema = void 0;
+const common_1 = require("../../common");
+const duration_1 = require("../../duration");
+const location_1 = require("../../location");
+const yup_extended_1 = require("../../yup-extended");
+exports.WorkExperienceSchema = (0, yup_extended_1.object)()
+    .shape({
+    company: (0, yup_extended_1.mixed)()
+        .oneOfSchema([common_1.NameIdLogoSchema, common_1.OtherValueSchema])
+        .required()
+        .label("Company"),
+    designation: (0, yup_extended_1.mixed)()
+        .oneOfSchema([common_1.NameIdLogoSchema, common_1.OtherValueSchema])
+        .required()
+        .label("Designation"),
+    duration: (0, duration_1.DurationSchema)({
+        format: "YYYY-MM-DD",
+        startLabel: "Start Date",
+        endLabel: "End Date",
+    })
+        .required()
+        .label("Duration"),
+    description: (0, yup_extended_1.string)().trim().max(1000).optional().label("Description"),
+    location: (location_1.LocationSchema.required().label("Location")),
+    isRemote: (0, yup_extended_1.boolean)().oneOf([true, false]).default(false).label("Is Remote"),
+})
+    .noUnknown()
+    .strict()
+    .label("Work Experience");

package/dist/cjs/yup-extended.d.ts

@@ -0,0 +1,41 @@
+import { AnyObject, Maybe, MixedSchema, Reference, Schema } from "yup";
+declare class FileSchema<TType extends Maybe<File> = File, TContext extends AnyObject = AnyObject, TOut extends TType = TType> extends MixedSchema<TType, TContext, TOut> {
+    constructor();
+    private isFile;
+    mimeType(types: Array<unknown>, message?: string): this;
+    maxSize(limit: number, message?: string): this;
+}
+declare class DateStringSchema<TType extends Maybe<string> = string, TContext extends AnyObject = AnyObject, TOut extends TType = TType> extends MixedSchema<TType, TContext, TOut> {
+    constructor();
+    private isValidDateString;
+    format(format?: string, message?: string): this;
+    min(minDate: unknown | Reference<string>, message?: string): this;
+    max(maxDate: unknown | Reference<string>, message?: string): this;
+}
+export declare const file: () => FileSchema<File, AnyObject, File>;
+export declare const dateString: () => DateStringSchema<string, AnyObject, string>;
+declare module "yup" {
+    interface FileSchema<T extends File = File> extends Schema<T> {
+        mimeType(types: string[], message?: string): this;
+        maxSize(limit: number, message?: string): this;
+    }
+    interface DateStringSchema extends Schema {
+        min(minDate: string, message?: string): this;
+        max(maxDate: string, message?: string): this;
+        format(format?: string): this;
+    }
+    interface ObjectSchemaDefinition {
+        file(): FileSchema;
+        dateString(): DateStringSchema;
+    }
+    interface MixedSchema {
+        oneOfSchema(schemas: Schema[], message?: string): this;
+    }
+    interface StringSchema {
+        emailStrict(message?: string, additionalCheck?: (value: string) => boolean): this;
+        urlStrict(message?: string, additionalCheck?: (value: string) => boolean): this;
+        objectId(message?: string): this;
+    }
+}
+export * from "yup";
+//# sourceMappingURL=yup-extended.d.ts.map

package/dist/cjs/yup-extended.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yup-extended.d.ts","sourceRoot":"","sources":["../../src/yup-extended.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,SAAS,EACT,KAAK,EAEL,WAAW,EACX,SAAS,EACT,MAAM,EAEP,MAAM,KAAK,CAAC;AAoCb,cAAM,UAAU,CACd,KAAK,SAAS,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,EAChC,QAAQ,SAAS,SAAS,GAAG,SAAS,EACtC,IAAI,SAAS,KAAK,GAAG,KAAK,CAC1B,SAAQ,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC;;IAW1C,OAAO,CAAC,MAAM;IAoBd,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,SAA0B;IAcjE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,SAAsB;CAOrD;AAED,cAAM,gBAAgB,CACpB,KAAK,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,EACpC,QAAQ,SAAS,SAAS,GAAG,SAAS,EACtC,IAAI,SAAS,KAAK,GAAG,KAAK,CAC1B,SAAQ,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC;;IAuB1C,OAAO,CAAC,iBAAiB;IAIzB,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,SAAwB;IAWvD,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,SAAsB;IAiBvE,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,SAAqB;CAgBvE;AAED,eAAO,MAAM,IAAI,yCAAyB,CAAC;AAC3C,eAAO,MAAM,UAAU,mDAA+B,CAAC;AA+IvD,OAAO,QAAQ,KAAK,CAAC;IAEnB,UAAU,UAAU,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,CAAE,SAAQ,MAAM,CAAC,CAAC,CAAC;QAC3D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAClD,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChD;IAED,UAAU,gBAAiB,SAAQ,MAAM;QACvC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7C,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAU,sBAAsB;QAC9B,IAAI,IAAI,UAAU,CAAC;QACnB,UAAU,IAAI,gBAAgB,CAAC;KAChC;IAED,UAAU,WAAW;QACnB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxD;IAED,UAAU,YAAY;QACpB,WAAW,CACT,OAAO,CAAC,EAAE,MAAM,EAChB,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,GAC3C,IAAI,CAAC;QACR,SAAS,CACP,OAAO,CAAC,EAAE,MAAM,EAChB,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,GAC3C,IAAI,CAAC;QACR,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAGD,cAAc,KAAK,CAAC"}