@thejob/schema 2.1.3 → 2.1.5

package/dist/index.d.ts

@@ -1474,6 +1474,198 @@ declare const DefaultPaginationOptions: {
     limit: number;
 };
 
+declare enum UserRole {
+    Admin = "admin",
+    Moderator = "moderator",
+    Manager = "manager",
+    Recruiter = "recruiter",
+    JobSeeker = "job_seeker",
+    Coordinator = "coordinator",
+    System = "system",
+    Normal = "normal"
+}
+declare const SupportedUserRoles: UserRole[];
+declare enum UserStatus {
+    Active = "active",
+    Blocked = "blocked",
+    Pending = "pending",
+    Deleted = "deleted",
+    MarkedForDeletion = "marked_for_deletion"
+}
+declare const SupportedUserStatuses: UserStatus[];
+declare const DefaultUserRoles: UserRole[];
+declare enum UserProfileVisibility {
+    Public = "public",
+    Private = "private",
+    Hidden = "hidden"
+}
+declare const SupportedUserProfileVisibilities: UserProfileVisibility[];
+/**
+ * How a user's `signupContext` was obtained. Stored on the document, so these
+ * strings are data: lowercase, and a rename is a migration.
+ *
+ * The distinction is deliberate. Only `CfHeader` is measured; the other two are
+ * inferred, and `Default` is a bare presumption with no signal behind it at all.
+ * Collapsing them would make an assumed country indistinguishable from an
+ * observed one, which is precisely what a compliance record must not do.
+ */
+declare enum SignupContextSource {
+    /** Measured from Cloudflare's `cf-ipcountry` header at sign-up. */
+    CfHeader = "cf-header",
+    /** Derived from the user's self-entered profile location (backfill). */
+    Location = "location",
+    /** Assumed; no signal was available. A presumption, not evidence. */
+    Default = "default"
+}
+declare const SupportedSignupContextSources: SignupContextSource[];
+declare enum UserDetailType {
+    Overview = "overview",
+    AdditionalInfo = "additionalInfo",
+    General = "general",
+    SocialAccounts = "socialAccounts",
+    WorkExperiences = "workExperiences",
+    Educations = "educations",
+    Skills = "skills",
+    Languages = "languages",
+    Certifications = "certifications",
+    Interests = "interests",
+    Projects = "projects"
+}
+declare enum ProficiencyLevel {
+    BasicAwareness = "basic_awareness",
+    Beginner = "beginner",
+    Intermediate = "intermediate",
+    Advanced = "advanced",
+    Expert = "expert"
+}
+declare const SupportedProficiencyLevels: ProficiencyLevel[];
+declare enum JobSearchUrgency {
+    Asap = "asap",
+    WithinThreeMonths = "within_3_months",
+    WithinSixMonths = "within_6_months",
+    PassivelyBrowsing = "passively_browsing"
+}
+declare const SupportedJobSearchUrgencies: JobSearchUrgency[];
+/**
+ * How the user heard about the platform - captured at the end of onboarding
+ * for marketing attribution.
+ */
+declare enum ReferralSource {
+    Recruiter = "recruiter",
+    LinkedIn = "linkedin",
+    TikTokInstagram = "tiktok_instagram",
+    Google = "google",
+    Reddit = "reddit",
+    ChatGptGemini = "chatgpt_gemini",
+    Friend = "friend",
+    Other = "other"
+}
+declare const SupportedReferralSources: ReferralSource[];
+/**
+ * How often a subscribed user receives job-alert emails. `Off` disables job
+ * alerts specifically while leaving other marketing (newsletters, product
+ * updates) governed by `marketingConsent.subscribed`.
+ */
+declare enum JobAlertFrequency {
+    Off = "off",
+    Daily = "daily",
+    Weekly = "weekly"
+}
+declare const SupportedJobAlertFrequencies: JobAlertFrequency[];
+/**
+ * Channels of NOTIFICATION email — mail about activity on the user's own
+ * account (a group invite, a job of theirs expiring). Distinct from marketing:
+ * notifications are opt-OUT (default on, see `notificationPrefs`), marketing is
+ * opt-IN (`marketingConsent.subscribed`). Transactional mail (magic-link,
+ * verification) is governed by neither and always sends.
+ *
+ * Deliberately coarse: four channels a user will actually reason about, rather
+ * than one toggle per email template.
+ */
+declare enum NotificationChannel {
+    /** Group invites, join requests, membership approved/rejected. */
+    GroupActivity = "groupActivity",
+    /** Activity on jobs the user posted, e.g. a listing expiring. */
+    JobActivity = "jobActivity",
+    /** Status changes on jobs the user applied to. */
+    ApplicationUpdates = "applicationUpdates",
+    /** Product announcements and feature news. */
+    ProductUpdates = "productUpdates"
+}
+declare const SupportedNotificationChannels: NotificationChannel[];
+/** ISO-4217 currency codes accepted for the salary preference (extend as needed). */
+declare const SupportedSalaryCurrencies: readonly ["USD", "EUR", "GBP", "SEK", "INR"];
+type SupportedSalaryCurrency = (typeof SupportedSalaryCurrencies)[number];
+/** Bounds enforced server-side on the minimum-salary slider. */
+declare const MIN_SALARY_LOWER_BOUND = 0;
+declare const MIN_SALARY_UPPER_BOUND = 1000000;
+/**
+ * Profile fields whose confirmed write should drain the resume-parser's
+ * suggestion. When the user accepts/edits one of these, the matching
+ * `pendingPrefill.<key>` is unset in the same write so the "Suggestion"
+ * affordance disappears on the next load ("confirmed beats prefill").
+ */
+declare const PREFILL_MIRRORED_KEYS: readonly ["headline", "aboutMe", "mobile", "location", "experienceLevel", "socialAccounts", "workExperiences", "educations"];
+type PrefillMirroredKey = (typeof PREFILL_MIRRORED_KEYS)[number];
+/**
+ * Fields stripped from a public (non-owner) profile read. A public profile must
+ * never expose these regardless of the caller's requested `fields`.
+ */
+declare const PRIVATE_PROFILE_FIELDS: readonly ["email", "emailVerified", "mobile", "additionalInfo"];
+type PrivateProfileField = (typeof PRIVATE_PROFILE_FIELDS)[number];
+
+/**
+ * Lifecycle of a saved search. Lowercase values, like every other enum in this
+ * package: the string is stored in Mongo and compared as a literal across
+ * services, so its casing is data rather than style.
+ */
+declare enum SavedSearchStatus {
+    /** Matching runs and alerts may be sent. */
+    Active = "active",
+    /**
+     * Kept for the user to see and re-enable, but skipped by the matching sweep.
+     * Distinct from deleting: a user pausing alerts should not lose the query they
+     * spent time building.
+     */
+    Paused = "paused"
+}
+declare const SupportedSavedSearchStatuses: SavedSearchStatus[];
+
+/**
+ * A search a user asked to be kept, and optionally to be alerted about.
+ *
+ * Two jobs in one document, deliberately: the query the user built, and the
+ * cadence at which they want it re-run for them. Splitting them would mean a
+ * user with three saved searches and one alert preference has no way to say
+ * which search the alert is for.
+ *
+ * The stored query mirrors what `GET /jobs/search-v3` accepts — a free-text
+ * `search` plus a `filter` map — so replaying a saved search is running the same
+ * search the user originally ran, not a second, subtly different implementation
+ * that drifts from it.
+ */
+declare const SavedSearchSchema: yup.ObjectSchema<{
+    shortId: string | undefined;
+    ownerUserId: string | undefined;
+    label: string;
+    search: string | undefined;
+    filter: {};
+    frequency: JobAlertFrequency;
+    status: SavedSearchStatus;
+    lastNotifiedAt: number | undefined;
+    lastMatchedAt: number | undefined;
+}, yup.AnyObject, {
+    shortId: undefined;
+    ownerUserId: undefined;
+    label: undefined;
+    search: undefined;
+    filter: {};
+    frequency: JobAlertFrequency.Off;
+    status: SavedSearchStatus.Active;
+    lastNotifiedAt: undefined;
+    lastMatchedAt: undefined;
+}, "">;
+
 declare enum ResourceType {
     Job = "job",
     User = "user",
@@ -1609,128 +1801,6 @@ declare const SocialAccountSchema: yup.ObjectSchema<{
     url: undefined;
 }, "">;
 
-declare enum UserRole {
-    Admin = "admin",
-    Moderator = "moderator",
-    Manager = "manager",
-    Recruiter = "recruiter",
-    JobSeeker = "job_seeker",
-    Coordinator = "coordinator",
-    System = "system",
-    Normal = "normal"
-}
-declare const SupportedUserRoles: UserRole[];
-declare enum UserStatus {
-    Active = "active",
-    Blocked = "blocked",
-    Pending = "pending",
-    Deleted = "deleted",
-    MarkedForDeletion = "marked_for_deletion"
-}
-declare const SupportedUserStatuses: UserStatus[];
-declare const DefaultUserRoles: UserRole[];
-declare enum UserProfileVisibility {
-    Public = "public",
-    Private = "private",
-    Hidden = "hidden"
-}
-declare const SupportedUserProfileVisibilities: UserProfileVisibility[];
-declare enum UserDetailType {
-    Overview = "overview",
-    AdditionalInfo = "additionalInfo",
-    General = "general",
-    SocialAccounts = "socialAccounts",
-    WorkExperiences = "workExperiences",
-    Educations = "educations",
-    Skills = "skills",
-    Languages = "languages",
-    Certifications = "certifications",
-    Interests = "interests",
-    Projects = "projects"
-}
-declare enum ProficiencyLevel {
-    BasicAwareness = "basic_awareness",
-    Beginner = "beginner",
-    Intermediate = "intermediate",
-    Advanced = "advanced",
-    Expert = "expert"
-}
-declare const SupportedProficiencyLevels: ProficiencyLevel[];
-declare enum JobSearchUrgency {
-    Asap = "asap",
-    WithinThreeMonths = "within_3_months",
-    WithinSixMonths = "within_6_months",
-    PassivelyBrowsing = "passively_browsing"
-}
-declare const SupportedJobSearchUrgencies: JobSearchUrgency[];
-/**
- * How the user heard about the platform - captured at the end of onboarding
- * for marketing attribution.
- */
-declare enum ReferralSource {
-    Recruiter = "recruiter",
-    LinkedIn = "linkedin",
-    TikTokInstagram = "tiktok_instagram",
-    Google = "google",
-    Reddit = "reddit",
-    ChatGptGemini = "chatgpt_gemini",
-    Friend = "friend",
-    Other = "other"
-}
-declare const SupportedReferralSources: ReferralSource[];
-/**
- * How often a subscribed user receives job-alert emails. `Off` disables job
- * alerts specifically while leaving other marketing (newsletters, product
- * updates) governed by `marketingConsent.subscribed`.
- */
-declare enum JobAlertFrequency {
-    Off = "off",
-    Daily = "daily",
-    Weekly = "weekly"
-}
-declare const SupportedJobAlertFrequencies: JobAlertFrequency[];
-/**
- * Channels of NOTIFICATION email — mail about activity on the user's own
- * account (a group invite, a job of theirs expiring). Distinct from marketing:
- * notifications are opt-OUT (default on, see `notificationPrefs`), marketing is
- * opt-IN (`marketingConsent.subscribed`). Transactional mail (magic-link,
- * verification) is governed by neither and always sends.
- *
- * Deliberately coarse: four channels a user will actually reason about, rather
- * than one toggle per email template.
- */
-declare enum NotificationChannel {
-    /** Group invites, join requests, membership approved/rejected. */
-    GroupActivity = "groupActivity",
-    /** Activity on jobs the user posted, e.g. a listing expiring. */
-    JobActivity = "jobActivity",
-    /** Status changes on jobs the user applied to. */
-    ApplicationUpdates = "applicationUpdates",
-    /** Product announcements and feature news. */
-    ProductUpdates = "productUpdates"
-}
-declare const SupportedNotificationChannels: NotificationChannel[];
-/** ISO-4217 currency codes accepted for the salary preference (extend as needed). */
-declare const SupportedSalaryCurrencies: readonly ["USD", "EUR", "GBP", "SEK", "INR"];
-type SupportedSalaryCurrency = (typeof SupportedSalaryCurrencies)[number];
-/** Bounds enforced server-side on the minimum-salary slider. */
-declare const MIN_SALARY_LOWER_BOUND = 0;
-declare const MIN_SALARY_UPPER_BOUND = 1000000;
-/**
- * Profile fields whose confirmed write should drain the resume-parser's
- * suggestion. When the user accepts/edits one of these, the matching
- * `pendingPrefill.<key>` is unset in the same write so the "Suggestion"
- * affordance disappears on the next load ("confirmed beats prefill").
- */
-declare const PREFILL_MIRRORED_KEYS: readonly ["headline", "aboutMe", "mobile", "location", "experienceLevel", "socialAccounts", "workExperiences", "educations"];
-type PrefillMirroredKey = (typeof PREFILL_MIRRORED_KEYS)[number];
-/**
- * Fields stripped from a public (non-owner) profile read. A public profile must
- * never expose these regardless of the caller's requested `fields`.
- */
-declare const PRIVATE_PROFILE_FIELDS: readonly ["email", "emailVerified", "mobile", "additionalInfo"];
-type PrivateProfileField = (typeof PRIVATE_PROFILE_FIELDS)[number];
-
 declare const UserSchema: yup.ObjectSchema<{
     authAccountId: string;
     socialAccounts: {
@@ -1880,9 +1950,11 @@ declare const UserSchema: yup.ObjectSchema<{
             coordinates: number[];
         };
     };
-    region: {
+    signupContext: {
         country: string;
-        lang: string;
+        at: number;
+        locale: string;
+        source: NonNullable<SignupContextSource | undefined>;
     } | undefined;
     profileVisibility: UserProfileVisibility;
     openToWork: boolean;
@@ -2085,7 +2157,7 @@ declare const UserSchema: yup.ObjectSchema<{
             coordinates: "";
         };
     };
-    region: undefined;
+    signupContext: undefined;
     profileVisibility: UserProfileVisibility.Public;
     openToWork: false;
     jobSearchUrgency: undefined;
@@ -2137,9 +2209,11 @@ declare const UserGeneralDetailSchema: yup.ObjectSchema<{
             coordinates: number[];
         };
     };
-    region: {
+    signupContext: {
         country: string;
-        lang: string;
+        at: number;
+        locale: string;
+        source: NonNullable<SignupContextSource | undefined>;
     } | undefined;
     profileVisibility: UserProfileVisibility;
 }, yup.AnyObject, {
@@ -2169,7 +2243,7 @@ declare const UserGeneralDetailSchema: yup.ObjectSchema<{
             coordinates: "";
         };
     };
-    region: undefined;
+    signupContext: undefined;
     profileVisibility: UserProfileVisibility.Public;
 }, "">;
 
@@ -2943,4 +3017,4 @@ declare const StudentCompletenessSchema: yup.ObjectSchema<{
     };
 }, "">;
 
-export { AnswerChoiceType, ApplicationReceivePreference, CampaignSchema, CampaignStatus, ChoiceQuestionSchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeedbackSchema, FeedbackStatus, FeedbackType, GeneraDetailFields, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, ListFilterSchema, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListSchema, NotificationChannel, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, QuestionSchema, QuestionType, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SkillSchema, SocialAccount, SocialAccountSchema, StudentCompletenessSchema, StudyType, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedCampaignStatuses, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedExperienceLevels, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationChannels, SupportedPageStatuses, SupportedPageTypes, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSocialAccounts, SupportedStudyTypes, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TermsAcceptedSchema, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, categoryOfIndustry, categoryOfSubCategory, dateString, deriveIndustry, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, subCategoriesOfIndustry };
+export { AnswerChoiceType, ApplicationReceivePreference, CampaignSchema, CampaignStatus, ChoiceQuestionSchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeedbackSchema, FeedbackStatus, FeedbackType, GeneraDetailFields, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, ListFilterSchema, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListSchema, NotificationChannel, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, QuestionSchema, QuestionType, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SavedSearchSchema, SavedSearchStatus, SignupContextSource, SkillSchema, SocialAccount, SocialAccountSchema, StudentCompletenessSchema, StudyType, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedCampaignStatuses, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedExperienceLevels, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationChannels, SupportedPageStatuses, SupportedPageTypes, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSavedSearchStatuses, SupportedSignupContextSources, SupportedSocialAccounts, SupportedStudyTypes, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TermsAcceptedSchema, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, categoryOfIndustry, categoryOfSubCategory, dateString, deriveIndustry, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, subCategoriesOfIndustry };