@thejob/schema 2.3.0 → 2.4.1

package/dist/index.cjs

@@ -109,6 +109,7 @@ __export(index_exports, {
   JobStatus: () => JobStatus,
   JobSubCategory: () => JobSubCategory,
   LanguageFilterSchema: () => LanguageFilterSchema,
+  LiveSubscriptionStatuses: () => LiveSubscriptionStatuses,
   LocationSchema: () => LocationSchema,
   MIN_SALARY_LOWER_BOUND: () => MIN_SALARY_LOWER_BOUND,
   MIN_SALARY_UPPER_BOUND: () => MIN_SALARY_UPPER_BOUND,
@@ -126,6 +127,7 @@ __export(index_exports, {
   PageStatus: () => PageStatus,
   PageType: () => PageType,
   PaginationSchema: () => PaginationSchema,
+  PlanAudience: () => PlanAudience,
   PlanGrantSchema: () => PlanGrantSchema,
   PlanKind: () => PlanKind,
   PlanSchema: () => PlanSchema,
@@ -194,6 +196,7 @@ __export(index_exports, {
   SupportedPaddleEnvironments: () => SupportedPaddleEnvironments,
   SupportedPageStatuses: () => SupportedPageStatuses,
   SupportedPageTypes: () => SupportedPageTypes,
+  SupportedPlanAudiences: () => SupportedPlanAudiences,
   SupportedPlanKinds: () => SupportedPlanKinds,
   SupportedPlanStatuses: () => SupportedPlanStatuses,
   SupportedPostStatuses: () => SupportedPostStatuses,
@@ -3854,6 +3857,14 @@ var PlanStatus = /* @__PURE__ */ ((PlanStatus2) => {
   return PlanStatus2;
 })(PlanStatus || {});
 var SupportedPlanStatuses = Object.values(PlanStatus);
+var PlanAudience = /* @__PURE__ */ ((PlanAudience2) => {
+  PlanAudience2["Employer"] = "employer";
+  PlanAudience2["JobSeeker"] = "job-seeker";
+  PlanAudience2["Recruiter"] = "recruiter";
+  PlanAudience2["Company"] = "company";
+  return PlanAudience2;
+})(PlanAudience || {});
+var SupportedPlanAudiences = Object.values(PlanAudience);
 var GrantType = /* @__PURE__ */ ((GrantType2) => {
   GrantType2["Boolean"] = "boolean";
   GrantType2["Quota"] = "quota";
@@ -3888,6 +3899,10 @@ var EntitlingSubscriptionStatuses = [
   "trialing" /* Trialing */,
   "past_due" /* PastDue */
 ];
+var LiveSubscriptionStatuses = [
+  ...EntitlingSubscriptionStatuses,
+  "paused" /* Paused */
+];
 var TransactionStatus = /* @__PURE__ */ ((TransactionStatus2) => {
   TransactionStatus2["Draft"] = "draft";
   TransactionStatus2["Ready"] = "ready";
@@ -3972,6 +3987,12 @@ var PlanSchema = (0, import_yup40.object)({
   name: (0, import_yup40.string)().required().min(1).max(120).label("Name"),
   description: (0, import_yup40.string)().optional().max(500).label("Description"),
   kind: (0, import_yup40.string)().oneOf(SupportedPlanKinds).required().default("subscription" /* Subscription */).label("Kind"),
+  /**
+   * The line this plan belongs to; a user holds one live subscription per line.
+   * Optional on purpose: absent is the default line, so existing plans need no
+   * migration and together still read as "one plan at a time".
+   */
+  audience: (0, import_yup40.string)().oneOf(SupportedPlanAudiences).optional().label("Audience"),
   status: (0, import_yup40.string)().oneOf(SupportedPlanStatuses).required().default("draft" /* Draft */).label("Status"),
   paddlePriceIds: PaddlePriceIdsSchema.default(
     () => PaddlePriceIdsSchema.getDefault()
@@ -4007,6 +4028,13 @@ var BillingSubscriptionSchema = (0, import_yup40.object)({
   currentPeriodEnd: (0, import_yup40.number)().optional().label("Current Period End"),
   /** Set when a cancellation is scheduled; access continues until the period ends. */
   canceledAt: (0, import_yup40.number)().optional().label("Canceled At"),
+  /**
+   * A downgrade booked for the end of the current period: the plan key it moves
+   * to at renewal. Upgrades never set this; they apply immediately. Mirrored
+   * from the Paddle subscription's own `customData`, so Paddle stays the source
+   * of truth.
+   */
+  pendingPlanKey: (0, import_yup40.string)().optional().label("Pending Plan Key"),
   /** `occurred_at` of the newest Paddle event applied. Guards out-of-order writes. */
   lastEventAt: (0, import_yup40.number)().required().default(0).label("Last Event At"),
   createdAt: (0, import_yup40.number)().optional().label("Created At"),
@@ -4688,6 +4716,7 @@ var StudentCompletenessSchema = UserCompletenessSchema.omit([
   JobStatus,
   JobSubCategory,
   LanguageFilterSchema,
+  LiveSubscriptionStatuses,
   LocationSchema,
   MIN_SALARY_LOWER_BOUND,
   MIN_SALARY_UPPER_BOUND,
@@ -4705,6 +4734,7 @@ var StudentCompletenessSchema = UserCompletenessSchema.omit([
   PageStatus,
   PageType,
   PaginationSchema,
+  PlanAudience,
   PlanGrantSchema,
   PlanKind,
   PlanSchema,
@@ -4773,6 +4803,7 @@ var StudentCompletenessSchema = UserCompletenessSchema.omit([
   SupportedPaddleEnvironments,
   SupportedPageStatuses,
   SupportedPageTypes,
+  SupportedPlanAudiences,
   SupportedPlanKinds,
   SupportedPlanStatuses,
   SupportedPostStatuses,

package/dist/index.d.cts

@@ -3286,6 +3286,21 @@ declare enum PlanStatus {
     Archived = "archived"
 }
 declare const SupportedPlanStatuses: PlanStatus[];
+/**
+ * The product line a plan belongs to. A user holds at most ONE live
+ * subscription per audience: switching within a line updates that subscription,
+ * it never adds a second one. Different audiences may be held side by side.
+ *
+ * A plan with no audience belongs to the single default line, which is every
+ * plan seeded before this existed.
+ */
+declare enum PlanAudience {
+    Employer = "employer",
+    JobSeeker = "job-seeker",
+    Recruiter = "recruiter",
+    Company = "company"
+}
+declare const SupportedPlanAudiences: PlanAudience[];
 /**
  * How a grant gives access to a feature.
  *
@@ -3344,6 +3359,12 @@ declare enum SubscriptionStatus {
 declare const SupportedSubscriptionStatuses: SubscriptionStatus[];
 /** Subscription statuses that currently entitle the holder to their plan's grants. */
 declare const EntitlingSubscriptionStatuses: SubscriptionStatus[];
+/**
+ * Subscription statuses that still occupy the user's slot in a plan audience.
+ * Wider than `EntitlingSubscriptionStatuses`: a paused subscription grants
+ * nothing, but buying again would still leave two subscriptions to one plan.
+ */
+declare const LiveSubscriptionStatuses: SubscriptionStatus[];
 /** Paddle transaction status, verbatim. `completed` is where a one-off is fulfilled. */
 declare enum TransactionStatus {
     Draft = "draft",
@@ -3468,6 +3489,7 @@ declare const PlanSchema: yup.ObjectSchema<{
     name: string;
     description: string | undefined;
     kind: NonNullable<PlanKind | undefined>;
+    audience: PlanAudience | undefined;
     status: NonNullable<PlanStatus | undefined>;
     paddlePriceIds: {
         sandbox: string[];
@@ -3493,6 +3515,7 @@ declare const PlanSchema: yup.ObjectSchema<{
     name: undefined;
     description: undefined;
     kind: PlanKind.Subscription;
+    audience: undefined;
     status: PlanStatus.Draft;
     paddlePriceIds: {
         sandbox: never[];
@@ -3523,6 +3546,7 @@ declare const BillingSubscriptionSchema: yup.ObjectSchema<{
     currentPeriodStart: number | undefined;
     currentPeriodEnd: number | undefined;
     canceledAt: number | undefined;
+    pendingPlanKey: string | undefined;
     lastEventAt: number;
     createdAt: number | undefined;
     updatedAt: number | undefined;
@@ -3536,6 +3560,7 @@ declare const BillingSubscriptionSchema: yup.ObjectSchema<{
     currentPeriodStart: undefined;
     currentPeriodEnd: undefined;
     canceledAt: undefined;
+    pendingPlanKey: undefined;
     lastEventAt: 0;
     createdAt: undefined;
     updatedAt: undefined;
@@ -5316,4 +5341,4 @@ declare const StudentCompletenessSchema: yup.ObjectSchema<{
     };
 }, "">;
 
-export { AnswerChoiceType, ApplicationReceivePreference, BillingPeriod, BillingSubscriptionSchema, BillingTransactionSchema, CAMPAIGN_MAX_RECIPIENTS_CEILING, CONSUME_MAX_UNITS, CampaignDataSourceSchema, CampaignEndKind, CampaignIntervalUnit, CampaignSchema, CampaignStatus, CampaignStatusTransitions, CampaignTriggerKind, CampaignTriggerSchema, ChoiceQuestionSchema, type City, CityFilterSchema, CitySchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, type Country, CountryFilterSchema, CountrySchema, type CountryTimezone, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, EntitlementConsumeSchema, EntitlementDenialReason, EntitlementDenialSchema, EntitlingSubscriptionStatuses, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeatureEntitlementSchema, FeatureKey, FeedbackFilterSchema, FeedbackSchema, FeedbackStatus, FeedbackType, GEO_COLLECTIONS, GEO_SEARCH_MAX, GRANT_MAX_LIMIT, GeneraDetailFields, GeoKind, type GeoSyncCounts, GeoSyncPhase, type GeoSyncRun, GeoSyncRunSchema, GeoSyncStatus, GeoSyncTrigger, type GeoTranslations, GrantType, GroupFilterSchema, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobFilterSchema, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, LanguageFilterSchema, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListFilterSchema, MailingListSchema, MoneySchema, NotificationType, OccurrenceStatus, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PaddleEnvironment, PaddlePriceIdsSchema, PageFilterSchema, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PlanGrantSchema, PlanKind, PlanSchema, PlanStatus, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, type PushSubscriptionRecord, PushSubscriptionSchema, QuestionSchema, QuestionType, QuotaPeriod, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SavedSearchSchema, SavedSearchStatus, SignupContextSource, SkillFilterSchema, SkillSchema, SocialAccount, SocialAccountSchema, type State, StateFilterSchema, StateSchema, StudentCompletenessSchema, StudyType, SubscriptionStatus, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedBillingPeriods, SupportedCampaignEndKinds, SupportedCampaignIntervalUnits, SupportedCampaignStatuses, SupportedCampaignTriggerKinds, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedEntitlementDenialReasons, SupportedExperienceLevels, SupportedFeatureKeys, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedGeoKinds, SupportedGeoSyncPhases, SupportedGeoSyncStatuses, SupportedGeoSyncTriggers, SupportedGrantTypes, SupportedGroupManagedBy, SupportedGroupMembershipStatuses, SupportedGroupStatuses, SupportedGroupVisibilities, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationTypes, SupportedOccurrenceStatuses, SupportedPaddleEnvironments, SupportedPageStatuses, SupportedPageTypes, SupportedPlanKinds, SupportedPlanStatuses, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedQuotaPeriods, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSavedSearchStatuses, SupportedSignupContextSources, SupportedSocialAccounts, SupportedStudyTypes, SupportedSubscriptionStatuses, SupportedTemplateVariableBindingKinds, SupportedTransactionStatuses, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TemplateVariableBindingKind, TemplateVariableBindingSchema, TerminalCampaignStatuses, TerminalGeoSyncStatuses, TermsAcceptedSchema, TransactionStatus, type User, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserFilterSchema, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, canTransitionCampaign, categoryOfIndustry, categoryOfSubCategory, codeTokens, conjunction, currencyBound, dateString, days, deriveIndustry, enumFacet, epoch, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, months, percent, qualified, rejectUnknownKeys, subCategoriesOfIndustry, tokens };
+export { AnswerChoiceType, ApplicationReceivePreference, BillingPeriod, BillingSubscriptionSchema, BillingTransactionSchema, CAMPAIGN_MAX_RECIPIENTS_CEILING, CONSUME_MAX_UNITS, CampaignDataSourceSchema, CampaignEndKind, CampaignIntervalUnit, CampaignSchema, CampaignStatus, CampaignStatusTransitions, CampaignTriggerKind, CampaignTriggerSchema, ChoiceQuestionSchema, type City, CityFilterSchema, CitySchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, type Country, CountryFilterSchema, CountrySchema, type CountryTimezone, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, EntitlementConsumeSchema, EntitlementDenialReason, EntitlementDenialSchema, EntitlingSubscriptionStatuses, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeatureEntitlementSchema, FeatureKey, FeedbackFilterSchema, FeedbackSchema, FeedbackStatus, FeedbackType, GEO_COLLECTIONS, GEO_SEARCH_MAX, GRANT_MAX_LIMIT, GeneraDetailFields, GeoKind, type GeoSyncCounts, GeoSyncPhase, type GeoSyncRun, GeoSyncRunSchema, GeoSyncStatus, GeoSyncTrigger, type GeoTranslations, GrantType, GroupFilterSchema, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobFilterSchema, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, LanguageFilterSchema, LiveSubscriptionStatuses, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListFilterSchema, MailingListSchema, MoneySchema, NotificationType, OccurrenceStatus, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PaddleEnvironment, PaddlePriceIdsSchema, PageFilterSchema, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PlanAudience, PlanGrantSchema, PlanKind, PlanSchema, PlanStatus, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, type PushSubscriptionRecord, PushSubscriptionSchema, QuestionSchema, QuestionType, QuotaPeriod, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SavedSearchSchema, SavedSearchStatus, SignupContextSource, SkillFilterSchema, SkillSchema, SocialAccount, SocialAccountSchema, type State, StateFilterSchema, StateSchema, StudentCompletenessSchema, StudyType, SubscriptionStatus, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedBillingPeriods, SupportedCampaignEndKinds, SupportedCampaignIntervalUnits, SupportedCampaignStatuses, SupportedCampaignTriggerKinds, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedEntitlementDenialReasons, SupportedExperienceLevels, SupportedFeatureKeys, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedGeoKinds, SupportedGeoSyncPhases, SupportedGeoSyncStatuses, SupportedGeoSyncTriggers, SupportedGrantTypes, SupportedGroupManagedBy, SupportedGroupMembershipStatuses, SupportedGroupStatuses, SupportedGroupVisibilities, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationTypes, SupportedOccurrenceStatuses, SupportedPaddleEnvironments, SupportedPageStatuses, SupportedPageTypes, SupportedPlanAudiences, SupportedPlanKinds, SupportedPlanStatuses, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedQuotaPeriods, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSavedSearchStatuses, SupportedSignupContextSources, SupportedSocialAccounts, SupportedStudyTypes, SupportedSubscriptionStatuses, SupportedTemplateVariableBindingKinds, SupportedTransactionStatuses, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TemplateVariableBindingKind, TemplateVariableBindingSchema, TerminalCampaignStatuses, TerminalGeoSyncStatuses, TermsAcceptedSchema, TransactionStatus, type User, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserFilterSchema, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, canTransitionCampaign, categoryOfIndustry, categoryOfSubCategory, codeTokens, conjunction, currencyBound, dateString, days, deriveIndustry, enumFacet, epoch, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, months, percent, qualified, rejectUnknownKeys, subCategoriesOfIndustry, tokens };

package/dist/index.d.ts

@@ -3286,6 +3286,21 @@ declare enum PlanStatus {
     Archived = "archived"
 }
 declare const SupportedPlanStatuses: PlanStatus[];
+/**
+ * The product line a plan belongs to. A user holds at most ONE live
+ * subscription per audience: switching within a line updates that subscription,
+ * it never adds a second one. Different audiences may be held side by side.
+ *
+ * A plan with no audience belongs to the single default line, which is every
+ * plan seeded before this existed.
+ */
+declare enum PlanAudience {
+    Employer = "employer",
+    JobSeeker = "job-seeker",
+    Recruiter = "recruiter",
+    Company = "company"
+}
+declare const SupportedPlanAudiences: PlanAudience[];
 /**
  * How a grant gives access to a feature.
  *
@@ -3344,6 +3359,12 @@ declare enum SubscriptionStatus {
 declare const SupportedSubscriptionStatuses: SubscriptionStatus[];
 /** Subscription statuses that currently entitle the holder to their plan's grants. */
 declare const EntitlingSubscriptionStatuses: SubscriptionStatus[];
+/**
+ * Subscription statuses that still occupy the user's slot in a plan audience.
+ * Wider than `EntitlingSubscriptionStatuses`: a paused subscription grants
+ * nothing, but buying again would still leave two subscriptions to one plan.
+ */
+declare const LiveSubscriptionStatuses: SubscriptionStatus[];
 /** Paddle transaction status, verbatim. `completed` is where a one-off is fulfilled. */
 declare enum TransactionStatus {
     Draft = "draft",
@@ -3468,6 +3489,7 @@ declare const PlanSchema: yup.ObjectSchema<{
     name: string;
     description: string | undefined;
     kind: NonNullable<PlanKind | undefined>;
+    audience: PlanAudience | undefined;
     status: NonNullable<PlanStatus | undefined>;
     paddlePriceIds: {
         sandbox: string[];
@@ -3493,6 +3515,7 @@ declare const PlanSchema: yup.ObjectSchema<{
     name: undefined;
     description: undefined;
     kind: PlanKind.Subscription;
+    audience: undefined;
     status: PlanStatus.Draft;
     paddlePriceIds: {
         sandbox: never[];
@@ -3523,6 +3546,7 @@ declare const BillingSubscriptionSchema: yup.ObjectSchema<{
     currentPeriodStart: number | undefined;
     currentPeriodEnd: number | undefined;
     canceledAt: number | undefined;
+    pendingPlanKey: string | undefined;
     lastEventAt: number;
     createdAt: number | undefined;
     updatedAt: number | undefined;
@@ -3536,6 +3560,7 @@ declare const BillingSubscriptionSchema: yup.ObjectSchema<{
     currentPeriodStart: undefined;
     currentPeriodEnd: undefined;
     canceledAt: undefined;
+    pendingPlanKey: undefined;
     lastEventAt: 0;
     createdAt: undefined;
     updatedAt: undefined;
@@ -5316,4 +5341,4 @@ declare const StudentCompletenessSchema: yup.ObjectSchema<{
     };
 }, "">;
 
-export { AnswerChoiceType, ApplicationReceivePreference, BillingPeriod, BillingSubscriptionSchema, BillingTransactionSchema, CAMPAIGN_MAX_RECIPIENTS_CEILING, CONSUME_MAX_UNITS, CampaignDataSourceSchema, CampaignEndKind, CampaignIntervalUnit, CampaignSchema, CampaignStatus, CampaignStatusTransitions, CampaignTriggerKind, CampaignTriggerSchema, ChoiceQuestionSchema, type City, CityFilterSchema, CitySchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, type Country, CountryFilterSchema, CountrySchema, type CountryTimezone, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, EntitlementConsumeSchema, EntitlementDenialReason, EntitlementDenialSchema, EntitlingSubscriptionStatuses, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeatureEntitlementSchema, FeatureKey, FeedbackFilterSchema, FeedbackSchema, FeedbackStatus, FeedbackType, GEO_COLLECTIONS, GEO_SEARCH_MAX, GRANT_MAX_LIMIT, GeneraDetailFields, GeoKind, type GeoSyncCounts, GeoSyncPhase, type GeoSyncRun, GeoSyncRunSchema, GeoSyncStatus, GeoSyncTrigger, type GeoTranslations, GrantType, GroupFilterSchema, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobFilterSchema, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, LanguageFilterSchema, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListFilterSchema, MailingListSchema, MoneySchema, NotificationType, OccurrenceStatus, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PaddleEnvironment, PaddlePriceIdsSchema, PageFilterSchema, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PlanGrantSchema, PlanKind, PlanSchema, PlanStatus, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, type PushSubscriptionRecord, PushSubscriptionSchema, QuestionSchema, QuestionType, QuotaPeriod, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SavedSearchSchema, SavedSearchStatus, SignupContextSource, SkillFilterSchema, SkillSchema, SocialAccount, SocialAccountSchema, type State, StateFilterSchema, StateSchema, StudentCompletenessSchema, StudyType, SubscriptionStatus, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedBillingPeriods, SupportedCampaignEndKinds, SupportedCampaignIntervalUnits, SupportedCampaignStatuses, SupportedCampaignTriggerKinds, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedEntitlementDenialReasons, SupportedExperienceLevels, SupportedFeatureKeys, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedGeoKinds, SupportedGeoSyncPhases, SupportedGeoSyncStatuses, SupportedGeoSyncTriggers, SupportedGrantTypes, SupportedGroupManagedBy, SupportedGroupMembershipStatuses, SupportedGroupStatuses, SupportedGroupVisibilities, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationTypes, SupportedOccurrenceStatuses, SupportedPaddleEnvironments, SupportedPageStatuses, SupportedPageTypes, SupportedPlanKinds, SupportedPlanStatuses, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedQuotaPeriods, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSavedSearchStatuses, SupportedSignupContextSources, SupportedSocialAccounts, SupportedStudyTypes, SupportedSubscriptionStatuses, SupportedTemplateVariableBindingKinds, SupportedTransactionStatuses, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TemplateVariableBindingKind, TemplateVariableBindingSchema, TerminalCampaignStatuses, TerminalGeoSyncStatuses, TermsAcceptedSchema, TransactionStatus, type User, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserFilterSchema, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, canTransitionCampaign, categoryOfIndustry, categoryOfSubCategory, codeTokens, conjunction, currencyBound, dateString, days, deriveIndustry, enumFacet, epoch, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, months, percent, qualified, rejectUnknownKeys, subCategoriesOfIndustry, tokens };
+export { AnswerChoiceType, ApplicationReceivePreference, BillingPeriod, BillingSubscriptionSchema, BillingTransactionSchema, CAMPAIGN_MAX_RECIPIENTS_CEILING, CONSUME_MAX_UNITS, CampaignDataSourceSchema, CampaignEndKind, CampaignIntervalUnit, CampaignSchema, CampaignStatus, CampaignStatusTransitions, CampaignTriggerKind, CampaignTriggerSchema, ChoiceQuestionSchema, type City, CityFilterSchema, CitySchema, Common, CompensationType, CompletenessScoreSchema, ContactTypes, CoordinatorPageLinkSchema, type Country, CountryFilterSchema, CountrySchema, type CountryTimezone, DISPLAY_DATE_FORMAT, DISPLAY_DATE_FORMAT_SHORT, DateStringSchema, DbDefaultSchema, DefaultPaginatedResponse, DefaultPaginationOptions, DefaultUserRoles, DurationSchema, EMPTY_STRING, EducationLevel, EducationSchema, EmployeeCount, EmploymentType, EntitlementConsumeSchema, EntitlementDenialReason, EntitlementDenialSchema, EntitlingSubscriptionStatuses, ExperienceLevel, FEEDBACK_MESSAGE_MAX, FeatureEntitlementSchema, FeatureKey, FeedbackFilterSchema, FeedbackSchema, FeedbackStatus, FeedbackType, GEO_COLLECTIONS, GEO_SEARCH_MAX, GRANT_MAX_LIMIT, GeneraDetailFields, GeoKind, type GeoSyncCounts, GeoSyncPhase, type GeoSyncRun, GeoSyncRunSchema, GeoSyncStatus, GeoSyncTrigger, type GeoTranslations, GrantType, GroupFilterSchema, GroupManagedBy, GroupMembershipSchema, GroupMembershipStatus, GroupSchema, GroupStatus, GroupTranslationSchema, GroupVisibility, InputQuestionSchema, JOB_TAXONOMY, JobAlertFrequency, JobCategory, JobFilterSchema, JobIndustry, JobSchema, JobSearchUrgency, JobStatus, JobSubCategory, LanguageFilterSchema, LiveSubscriptionStatuses, LocationSchema, MIN_SALARY_LOWER_BOUND, MIN_SALARY_UPPER_BOUND, MailingListFilterSchema, MailingListSchema, MoneySchema, NotificationType, OccurrenceStatus, PREFILL_MIRRORED_KEYS, PRIVATE_PROFILE_FIELDS, PaddleEnvironment, PaddlePriceIdsSchema, PageFilterSchema, PageSchema, PageStatus, PageType, type PaginatedResponse, PaginationSchema, PlanAudience, PlanGrantSchema, PlanKind, PlanSchema, PlanStatus, PostSchema, PostStatus, type PrefillMirroredKey, type PrivateProfileField, ProficiencyLevel, type PushSubscriptionRecord, PushSubscriptionSchema, QuestionSchema, QuestionType, QuotaPeriod, ReadAndAcknowledgeQuestionSchema, RecruiterPageLinkSchema, ReferralSource, ReportReason, ReportSchema, ResourceType, SITEMAP_FORMAT, SYSTEM_DATE_FORMAT, SavedSearchSchema, SavedSearchStatus, SignupContextSource, SkillFilterSchema, SkillSchema, SocialAccount, SocialAccountSchema, type State, StateFilterSchema, StateSchema, StudentCompletenessSchema, StudyType, SubscriptionStatus, SupportedAnswerChoiceTypes, SupportedApplicationReceivePreferences, SupportedBillingPeriods, SupportedCampaignEndKinds, SupportedCampaignIntervalUnits, SupportedCampaignStatuses, SupportedCampaignTriggerKinds, SupportedCompensationTypes, SupportedContactTypes, SupportedEducationLevels, SupportedEmployeeCounts, SupportedEmploymentTypes, SupportedEntitlementDenialReasons, SupportedExperienceLevels, SupportedFeatureKeys, SupportedFeedbackStatuses, SupportedFeedbackTypes, SupportedGeoKinds, SupportedGeoSyncPhases, SupportedGeoSyncStatuses, SupportedGeoSyncTriggers, SupportedGrantTypes, SupportedGroupManagedBy, SupportedGroupMembershipStatuses, SupportedGroupStatuses, SupportedGroupVisibilities, SupportedJobAlertFrequencies, SupportedJobCategories, SupportedJobIndustries, SupportedJobSearchUrgencies, SupportedJobStatuses, SupportedJobSubCategories, SupportedNotificationTypes, SupportedOccurrenceStatuses, SupportedPaddleEnvironments, SupportedPageStatuses, SupportedPageTypes, SupportedPlanAudiences, SupportedPlanKinds, SupportedPlanStatuses, SupportedPostStatuses, SupportedProficiencyLevels, SupportedQuestionTypes, SupportedQuotaPeriods, SupportedReferralSources, SupportedReportReasons, SupportedResourceTypes, SupportedSalaryCurrencies, type SupportedSalaryCurrency, SupportedSavedSearchStatuses, SupportedSignupContextSources, SupportedSocialAccounts, SupportedStudyTypes, SupportedSubscriptionStatuses, SupportedTemplateVariableBindingKinds, SupportedTransactionStatuses, SupportedUserProfileVisibilities, SupportedUserRoles, SupportedUserStatuses, SupportedWorkModes, TAXONOMY_LABELS, type TChoiceQuestionSchema, type TDurationSchema, type TInputQuestionSchema, type TJobSchema, type TPostSchema, type TQuestionSchema, type TReadAndAcknowledgeQuestionSchema, type TUserIdAndCreatedAtSchema, TemplateVariableBindingKind, TemplateVariableBindingSchema, TerminalCampaignStatuses, TerminalGeoSyncStatuses, TermsAcceptedSchema, TransactionStatus, type User, UserAdditionalInfoSchema, UserCertificationSchema, UserCompletenessSchema, UserCoordinatorProfileSchema, UserDetailType, UserFilterSchema, UserGeneralDetailSchema, UserIdAndCreatedAtSchema, UserInterestSchema, UserJobPreferencesSchema, UserLanguageSchema, type UserProfileOverview, UserProfileVisibility, UserProjectSchema, UserRecruiterProfileSchema, UserRole, UserSchema, UserSkillSchema, UserStatus, WorkExperienceSchema, WorkMode, canTransitionCampaign, categoryOfIndustry, categoryOfSubCategory, codeTokens, conjunction, currencyBound, dateString, days, deriveIndustry, enumFacet, epoch, getSchemaByQuestion, industriesOfCategory, industryOfSubCategory, months, percent, qualified, rejectUnknownKeys, subCategoriesOfIndustry, tokens };

package/dist/index.js

@@ -3587,6 +3587,14 @@ var PlanStatus = /* @__PURE__ */ ((PlanStatus2) => {
   return PlanStatus2;
 })(PlanStatus || {});
 var SupportedPlanStatuses = Object.values(PlanStatus);
+var PlanAudience = /* @__PURE__ */ ((PlanAudience2) => {
+  PlanAudience2["Employer"] = "employer";
+  PlanAudience2["JobSeeker"] = "job-seeker";
+  PlanAudience2["Recruiter"] = "recruiter";
+  PlanAudience2["Company"] = "company";
+  return PlanAudience2;
+})(PlanAudience || {});
+var SupportedPlanAudiences = Object.values(PlanAudience);
 var GrantType = /* @__PURE__ */ ((GrantType2) => {
   GrantType2["Boolean"] = "boolean";
   GrantType2["Quota"] = "quota";
@@ -3621,6 +3629,10 @@ var EntitlingSubscriptionStatuses = [
   "trialing" /* Trialing */,
   "past_due" /* PastDue */
 ];
+var LiveSubscriptionStatuses = [
+  ...EntitlingSubscriptionStatuses,
+  "paused" /* Paused */
+];
 var TransactionStatus = /* @__PURE__ */ ((TransactionStatus2) => {
   TransactionStatus2["Draft"] = "draft";
   TransactionStatus2["Ready"] = "ready";
@@ -3705,6 +3717,12 @@ var PlanSchema = object38({
   name: string27().required().min(1).max(120).label("Name"),
   description: string27().optional().max(500).label("Description"),
   kind: string27().oneOf(SupportedPlanKinds).required().default("subscription" /* Subscription */).label("Kind"),
+  /**
+   * The line this plan belongs to; a user holds one live subscription per line.
+   * Optional on purpose: absent is the default line, so existing plans need no
+   * migration and together still read as "one plan at a time".
+   */
+  audience: string27().oneOf(SupportedPlanAudiences).optional().label("Audience"),
   status: string27().oneOf(SupportedPlanStatuses).required().default("draft" /* Draft */).label("Status"),
   paddlePriceIds: PaddlePriceIdsSchema.default(
     () => PaddlePriceIdsSchema.getDefault()
@@ -3740,6 +3758,13 @@ var BillingSubscriptionSchema = object38({
   currentPeriodEnd: number17().optional().label("Current Period End"),
   /** Set when a cancellation is scheduled; access continues until the period ends. */
   canceledAt: number17().optional().label("Canceled At"),
+  /**
+   * A downgrade booked for the end of the current period: the plan key it moves
+   * to at renewal. Upgrades never set this; they apply immediately. Mirrored
+   * from the Paddle subscription's own `customData`, so Paddle stays the source
+   * of truth.
+   */
+  pendingPlanKey: string27().optional().label("Pending Plan Key"),
   /** `occurred_at` of the newest Paddle event applied. Guards out-of-order writes. */
   lastEventAt: number17().required().default(0).label("Last Event At"),
   createdAt: number17().optional().label("Created At"),
@@ -4420,6 +4445,7 @@ export {
   JobStatus,
   JobSubCategory,
   LanguageFilterSchema,
+  LiveSubscriptionStatuses,
   LocationSchema,
   MIN_SALARY_LOWER_BOUND,
   MIN_SALARY_UPPER_BOUND,
@@ -4437,6 +4463,7 @@ export {
   PageStatus,
   PageType,
   PaginationSchema,
+  PlanAudience,
   PlanGrantSchema,
   PlanKind,
   PlanSchema,
@@ -4505,6 +4532,7 @@ export {
   SupportedPaddleEnvironments,
   SupportedPageStatuses,
   SupportedPageTypes,
+  SupportedPlanAudiences,
   SupportedPlanKinds,
   SupportedPlanStatuses,
   SupportedPostStatuses,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thejob/schema",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/src/billing/billing.constant.ts

@@ -34,6 +34,23 @@ export enum PlanStatus {
 
 export const SupportedPlanStatuses = Object.values(PlanStatus);
 
+/**
+ * The product line a plan belongs to. A user holds at most ONE live
+ * subscription per audience: switching within a line updates that subscription,
+ * it never adds a second one. Different audiences may be held side by side.
+ *
+ * A plan with no audience belongs to the single default line, which is every
+ * plan seeded before this existed.
+ */
+export enum PlanAudience {
+  Employer = "employer",
+  JobSeeker = "job-seeker",
+  Recruiter = "recruiter",
+  Company = "company",
+}
+
+export const SupportedPlanAudiences = Object.values(PlanAudience);
+
 /**
  * How a grant gives access to a feature.
  *
@@ -107,6 +124,16 @@ export const EntitlingSubscriptionStatuses = [
   SubscriptionStatus.PastDue,
 ];
 
+/**
+ * Subscription statuses that still occupy the user's slot in a plan audience.
+ * Wider than `EntitlingSubscriptionStatuses`: a paused subscription grants
+ * nothing, but buying again would still leave two subscriptions to one plan.
+ */
+export const LiveSubscriptionStatuses = [
+  ...EntitlingSubscriptionStatuses,
+  SubscriptionStatus.Paused,
+];
+
 /** Paddle transaction status, verbatim. `completed` is where a one-off is fulfilled. */
 export enum TransactionStatus {
   Draft = "draft",

package/src/billing/billing.schema.ts

@@ -9,6 +9,7 @@ import {
   SupportedBillingPeriods,
   SupportedEntitlementDenialReasons,
   SupportedGrantTypes,
+  SupportedPlanAudiences,
   SupportedPlanKinds,
   SupportedPlanStatuses,
   SupportedQuotaPeriods,
@@ -137,6 +138,15 @@ export const PlanSchema = object({
     .required()
     .default(PlanKind.Subscription)
     .label("Kind"),
+  /**
+   * The line this plan belongs to; a user holds one live subscription per line.
+   * Optional on purpose: absent is the default line, so existing plans need no
+   * migration and together still read as "one plan at a time".
+   */
+  audience: string()
+    .oneOf(SupportedPlanAudiences)
+    .optional()
+    .label("Audience"),
   status: string()
     .oneOf(SupportedPlanStatuses)
     .required()
@@ -197,6 +207,13 @@ export const BillingSubscriptionSchema = object({
   currentPeriodEnd: number().optional().label("Current Period End"),
   /** Set when a cancellation is scheduled; access continues until the period ends. */
   canceledAt: number().optional().label("Canceled At"),
+  /**
+   * A downgrade booked for the end of the current period: the plan key it moves
+   * to at renewal. Upgrades never set this; they apply immediately. Mirrored
+   * from the Paddle subscription's own `customData`, so Paddle stays the source
+   * of truth.
+   */
+  pendingPlanKey: string().optional().label("Pending Plan Key"),
   /** `occurred_at` of the newest Paddle event applied. Guards out-of-order writes. */
   lastEventAt: number().required().default(0).label("Last Event At"),
   createdAt: number().optional().label("Created At"),