@thejob/schema 2.1.7 → 2.1.9

package/dist/index.js

@@ -1929,7 +1929,7 @@ var PostSchema = object17({
 }).concat(DbDefaultSchema).noUnknown().label("Post");
 
 // src/marketing/marketing.schema.ts
-import { array as array10, boolean as boolean11, number as number7, object as object18, string as string15 } from "yup";
+import { array as array10, boolean as boolean11, lazy as lazy2, mixed as mixed4, number as number7, object as object18, string as string15 } from "yup";
 
 // src/user/user.constant.ts
 var UserRole = /* @__PURE__ */ ((UserRole2) => {
@@ -2048,10 +2048,79 @@ var PRIVATE_PROFILE_FIELDS = [
   "additionalInfo"
 ];
 
+// src/marketing/marketing.constant.ts
+var CampaignStatus = /* @__PURE__ */ ((CampaignStatus2) => {
+  CampaignStatus2["Draft"] = "draft";
+  CampaignStatus2["Sending"] = "sending";
+  CampaignStatus2["Sent"] = "sent";
+  CampaignStatus2["Failed"] = "failed";
+  return CampaignStatus2;
+})(CampaignStatus || {});
+var SupportedCampaignStatuses = Object.values(CampaignStatus);
+var CampaignTriggerKind = /* @__PURE__ */ ((CampaignTriggerKind2) => {
+  CampaignTriggerKind2["Manual"] = "manual";
+  CampaignTriggerKind2["Once"] = "once";
+  CampaignTriggerKind2["Schedule"] = "schedule";
+  CampaignTriggerKind2["Lifecycle"] = "lifecycle";
+  return CampaignTriggerKind2;
+})(CampaignTriggerKind || {});
+var SupportedCampaignTriggerKinds = Object.values(CampaignTriggerKind);
+var CampaignIntervalUnit = /* @__PURE__ */ ((CampaignIntervalUnit2) => {
+  CampaignIntervalUnit2["Day"] = "day";
+  CampaignIntervalUnit2["Week"] = "week";
+  CampaignIntervalUnit2["Month"] = "month";
+  return CampaignIntervalUnit2;
+})(CampaignIntervalUnit || {});
+var SupportedCampaignIntervalUnits = Object.values(CampaignIntervalUnit);
+var CampaignEndKind = /* @__PURE__ */ ((CampaignEndKind2) => {
+  CampaignEndKind2["Never"] = "never";
+  CampaignEndKind2["AfterOccurrences"] = "afterOccurrences";
+  CampaignEndKind2["OnDate"] = "onDate";
+  return CampaignEndKind2;
+})(CampaignEndKind || {});
+var SupportedCampaignEndKinds = Object.values(CampaignEndKind);
+var CampaignAnchorField = /* @__PURE__ */ ((CampaignAnchorField2) => {
+  CampaignAnchorField2["CreatedAt"] = "createdAt";
+  CampaignAnchorField2["OnboardingCompletedAt"] = "onboardingCompletedAt";
+  CampaignAnchorField2["MarketingConsentUpdatedAt"] = "marketingConsent.updatedAt";
+  return CampaignAnchorField2;
+})(CampaignAnchorField || {});
+var SupportedCampaignAnchorFields = Object.values(CampaignAnchorField);
+var BindingKind = /* @__PURE__ */ ((BindingKind2) => {
+  BindingKind2["Static"] = "static";
+  BindingKind2["Recipient"] = "recipient";
+  BindingKind2["Url"] = "url";
+  BindingKind2["Source"] = "source";
+  return BindingKind2;
+})(BindingKind || {});
+var SupportedBindingKinds = Object.values(BindingKind);
+var OccurrenceStatus = /* @__PURE__ */ ((OccurrenceStatus2) => {
+  OccurrenceStatus2["Pending"] = "pending";
+  OccurrenceStatus2["Running"] = "running";
+  OccurrenceStatus2["Sent"] = "sent";
+  OccurrenceStatus2["Skipped"] = "skipped";
+  OccurrenceStatus2["Failed"] = "failed";
+  return OccurrenceStatus2;
+})(OccurrenceStatus || {});
+var SupportedOccurrenceStatuses = Object.values(OccurrenceStatus);
+var CAMPAIGN_MAX_RECIPIENTS_CEILING = 5e3;
+
 // src/marketing/marketing.schema.ts
 var tokens = (label) => array10().of(string15().trim().required()).optional().default([]).label(label);
 var enumFacet = (values, label) => array10().of(string15().oneOf(values).required()).optional().default([]).label(label);
-var ListFilterSchema = object18({
+var days = (label) => number7().integer().min(0).max(3650).optional().default(void 0).label(label);
+var months = (label) => number7().integer().min(0).max(1200).optional().default(void 0).label(label);
+var percent = (label) => number7().integer().min(0).max(100).optional().default(void 0).label(label);
+var epoch = (label) => number7().integer().min(0).optional().default(void 0).label(label);
+var salaryBound = (label) => number7().integer().min(0).optional().default(void 0).label(label).when("salaryCurrencies", {
+  is: (v) => !Array.isArray(v) || v.length !== 1,
+  then: (s) => s.test(
+    "requires-single-currency",
+    "Pick exactly one salary currency to filter by salary",
+    (value) => value === void 0 || value === null
+  )
+});
+var ListFilterBranchSchema = object18({
   // ── Enum facets (closed vocabularies, chip pickers) ─────────────────────────
   countries: array10().of(string15().required()).optional().default([]).label("Countries"),
   roles: enumFacet(SupportedUserRoles, "Roles"),
@@ -2106,39 +2175,285 @@ var ListFilterSchema = object18({
   // Case-insensitive keyword match against headline + aboutMe.
   keywords: tokens("Profile Keywords"),
   // ── Range / boolean facets ──────────────────────────────────────────────────
-  minSalaryFloor: number7().integer().min(0).optional().label("Min Salary \u2265"),
-  minSalaryCeil: number7().integer().min(0).optional().label("Min Salary \u2264"),
+  // A salary bound is meaningless without a currency: `minSalary` is a raw
+  // integer and 50000 SEK is not 50000 USD, so an un-currencied range matches
+  // across currencies and quietly means nothing. Requiring exactly one currency
+  // alongside a bound is what makes the comparison sound.
+  minSalaryFloor: salaryBound("Min Salary \u2265"),
+  minSalaryCeil: salaryBound("Min Salary \u2264"),
   openToWorkOnly: boolean11().optional().default(false).label("Open to Work Only"),
   remoteExperienceOnly: boolean11().optional().default(false).label("Has Remote Experience"),
   hasResumeOnly: boolean11().optional().default(false).label("Has Resume"),
   onboardingCompletedOnly: boolean11().optional().default(false).label("Onboarding Completed"),
   emailVerifiedOnly: boolean11().optional().default(false).label("Email Verified Only"),
-  mobileVerifiedOnly: boolean11().optional().default(false).label("Mobile Verified Only")
-}).label("Audience Filter");
+  mobileVerifiedOnly: boolean11().optional().default(false).label("Mobile Verified Only"),
+  // ── Lifecycle windows ───────────────────────────────────────────────────────
+  // Relative, because a saved list is resolved fresh on every send: a stored
+  // absolute epoch would freeze at authoring time and the audience would decay
+  // to nothing. The absolute forms below exist for one-shot sends; when both are
+  // present the relative form wins.
+  lastSeenBeforeDays: days("Inactive For (days) \u2265"),
+  lastSeenAfterDays: days("Active Within (days)"),
+  createdAtWithinDays: days("Signed Up Within (days)"),
+  createdAtOlderThanDays: days("Signed Up Before (days ago)"),
+  completenessMin: percent("Profile Completeness \u2265"),
+  completenessMax: percent("Profile Completeness \u2264"),
+  // Absolute epoch-ms forms. Prefer the relative fields above for anything that
+  // repeats.
+  lastSeenBefore: epoch("Last Seen Before"),
+  lastSeenAfter: epoch("Last Seen After"),
+  createdAtFrom: epoch("Signed Up After"),
+  createdAtBefore: epoch("Signed Up Before"),
+  // ── Geography ───────────────────────────────────────────────────────────────
+  // `countries` above matches location.countryCode. These narrow within it.
+  // NOTE: stateCodes are stored bare (`KA`, not `IN-KA`) — see the pending
+  // @todo STATE-CODE-ISO-PREFIX migration. Match the stored form, do not prefix.
+  states: tokens("States"),
+  stateCodes: tokens("State Codes"),
+  cities: tokens("Cities"),
+  // Radius search around a point, against location.geo. All three required
+  // together; validated as a group rather than field-by-field so a half-filled
+  // radius cannot silently match everyone.
+  withinRadius: object18({
+    lat: number7().min(-90).max(90).required().label("Latitude"),
+    lng: number7().min(-180).max(180).required().label("Longitude"),
+    km: number7().moreThan(0).max(2e4).required().label("Radius (km)")
+  }).optional().default(void 0).label("Within Radius"),
+  // ── Signup context (immutable market / locale) ──────────────────────────────
+  signupCountries: tokens("Signup Countries"),
+  signupLocales: tokens("Signup Locales"),
+  signupSources: enumFacet(SupportedSignupContextSources, "Signup Source"),
+  // ── Attainment ──────────────────────────────────────────────────────────────
+  // Absent on users who predate the field. Absent means "unknown", never a
+  // match — filtering on this necessarily excludes them.
+  educationLevels: enumFacet(SupportedEducationLevels, "Education Level"),
+  // ── Consent metadata ────────────────────────────────────────────────────────
+  // `marketingConsent.subscribed` is NOT a facet: it is a hard opt-in gate
+  // applied unconditionally by user-service and is not relaxable from here.
+  jobAlertFrequencies: enumFacet(
+    SupportedJobAlertFrequencies,
+    "Job Alert Frequency"
+  ),
+  consentSources: tokens("Consent Source"),
+  consentUpdatedWithinDays: days("Consent Updated Within (days)"),
+  // ── Notification preferences ────────────────────────────────────────────────
+  // Read as opt-IN (`=== true`), matching marketingConsent and NOT the `!== false`
+  // reading used for transactional notification routing. A campaign is bulk mail,
+  // so a channel the user never affirmatively enabled does not count as consent.
+  // `productUpdates` defaults to false on the user document, so targeting it
+  // selects only people who deliberately turned it on.
+  notificationChannelsEnabled: enumFacet(
+    SupportedNotificationChannels,
+    "Notification Channels Enabled"
+  ),
+  // ── Tenure / recency ────────────────────────────────────────────────────────
+  // Against workExperiences[].duration and educations[].duration ("YYYY-MM").
+  currentlyEmployed: boolean11().optional().default(false).label("Currently Employed"),
+  graduatedWithinMonths: months("Graduated Within (months)"),
+  skillUsedWithinMonths: months("Skill Used Within (months)"),
+  // ── Profile richness ────────────────────────────────────────────────────────
+  hasImage: boolean11().optional().default(false).label("Has Photo"),
+  hasHeadline: boolean11().optional().default(false).label("Has Headline"),
+  hasAboutMe: boolean11().optional().default(false).label("Has About Me"),
+  hasMobile: boolean11().optional().default(false).label("Has Mobile Number"),
+  // Segment by WHICH profile section is missing (profileCompleteness.missing[]),
+  // rather than only by the overall percentage.
+  missingSections: tokens("Missing Profile Sections"),
+  // ── Employer / institute taxonomy ───────────────────────────────────────────
+  companyTypes: enumFacet(SupportedPageTypes, "Company Type"),
+  instituteTypes: enumFacet(SupportedPageTypes, "Institute Type"),
+  // ── Activity ────────────────────────────────────────────────────────────────
+  // Backed by denormalised counters on the user document, because the source
+  // data lives in other services' collections. Tri-state: `false` is a real
+  // filter ("has NO job alert"), which is the audience an alert nudge wants, so
+  // these are `undefined` when unset rather than defaulting to false.
+  hasJobAlert: boolean11().optional().default(void 0).label("Has a Job Alert"),
+  hasApplied: boolean11().optional().default(void 0).label("Has Applied"),
+  appliedWithinDays: days("Applied Within (days)"),
+  // ── Free-text search (name / email) ─────────────────────────────────────────
+  search: string15().trim().optional().label("Search")
+}).label("Audience Filter Branch");
+var rejectUnknownKeys = (schema, allowed) => schema.test(
+  "no-unknown-filter-keys",
+  ({ value, label }) => {
+    const known = new Set(allowed());
+    const bad = Object.keys(value ?? {}).filter(
+      (k) => !known.has(k)
+    );
+    return `${label} has unsupported keys: ${bad.join(", ")}`;
+  },
+  (value) => {
+    if (value == null) return true;
+    const known = new Set(allowed());
+    return Object.keys(value).every(
+      (k) => known.has(k)
+    );
+  }
+);
+var BRANCH_KEYS = Object.keys(ListFilterBranchSchema.fields);
+var ListFilterBranch = rejectUnknownKeys(
+  ListFilterBranchSchema,
+  () => BRANCH_KEYS
+);
+var ListFilterSchema = rejectUnknownKeys(
+  ListFilterBranchSchema.shape({
+    or: array10().of(ListFilterBranch).optional().default([]).label("Or Any Of")
+  }).label("Audience Filter"),
+  () => [...BRANCH_KEYS, "or"]
+);
 var MailingListSchema = object18({
   name: string15().required().min(1).max(120).label("Name"),
   description: string15().optional().max(500).label("Description"),
   filter: ListFilterSchema.default(() => ListFilterSchema.getDefault())
 }).label("Mailing List");
+var CampaignTriggerSchema = object18({
+  kind: string15().oneOf(SupportedCampaignTriggerKinds).required().default("manual" /* Manual */).label("Trigger"),
+  // IANA zone, e.g. "Asia/Kolkata". Local wall-clock times are interpreted in it,
+  // so occurrences land at the intended hour across DST rather than drifting.
+  timezone: string15().optional().default("UTC").label("Timezone").when("kind", {
+    is: (k) => k !== "manual" /* Manual */,
+    then: (s) => s.required()
+  }),
+  // kind: once
+  runAt: epoch("Send At").when("kind", {
+    is: "once" /* Once */,
+    then: (s) => s.required()
+  }),
+  // kind: schedule
+  startAt: epoch("Starts").when("kind", {
+    is: "schedule" /* Schedule */,
+    then: (s) => s.required()
+  }),
+  interval: object18({
+    every: number7().integer().min(1).max(365).required().label("Every"),
+    unit: string15().oneOf(SupportedCampaignIntervalUnits).required().label("Unit")
+  }).optional().default(void 0).label("Repeats").when("kind", {
+    is: "schedule" /* Schedule */,
+    then: (s) => s.required()
+  }),
+  /** Local wall-clock send time, "HH:mm" in `timezone`. */
+  timeOfDay: string15().matches(/^([01]\d|2[0-3]):[0-5]\d$/, "Use HH:mm").optional().default("09:00").label("Time of Day"),
+  /** For weekly intervals: ISO weekdays, 1 = Monday .. 7 = Sunday. */
+  byWeekday: array10().of(number7().integer().min(1).max(7).required()).optional().default([]).label("On Days"),
+  /**
+   * For monthly intervals: 1-31, or -1 meaning "last day of the month". A month
+   * shorter than the chosen day is clamped to its last day, so 31 in February
+   * fires on the 28th/29th rather than being skipped.
+   */
+  byMonthday: number7().integer().min(-1).max(31).notOneOf([0]).optional().default(void 0).label("Day of Month"),
+  end: object18({
+    kind: string15().oneOf(SupportedCampaignEndKinds).required().label("Ends"),
+    occurrences: number7().integer().min(1).max(1e4).optional().default(void 0).label("After N Sends").when("kind", {
+      is: "afterOccurrences" /* AfterOccurrences */,
+      then: (s) => s.required()
+    }),
+    date: epoch("End Date").when("kind", {
+      is: "onDate" /* OnDate */,
+      then: (s) => s.required()
+    })
+  }).optional().default(() => ({ kind: "never" /* Never */ })).label("End Condition"),
+  // kind: lifecycle
+  anchorField: string15().oneOf(SupportedCampaignAnchorFields).optional().default(void 0).label("Anchor Date").when("kind", {
+    is: "lifecycle" /* Lifecycle */,
+    then: (s) => s.required()
+  }),
+  /** Days after the anchor at which this user becomes eligible. */
+  offsetDays: number7().integer().min(0).max(3650).optional().default(void 0).label("Days After Anchor").when("kind", {
+    is: "lifecycle" /* Lifecycle */,
+    then: (s) => s.required()
+  }),
+  /**
+   * How long a user stays eligible after crossing the offset. Needed because the
+   * scheduler samples periodically and a zero-width window would miss anyone not
+   * observed on the exact day. A user inside the window on several ticks is still
+   * mailed once: the permanent idempotency key, not this value, guarantees that.
+   */
+  windowDays: number7().integer().min(1).max(90).optional().default(2).label("Eligibility Window (days)")
+}).label("Trigger");
+var BindingSchema = object18({
+  kind: string15().oneOf(SupportedBindingKinds).required().label("Source"),
+  value: string15().required().min(1).max(2e3).label("Value")
+}).label("Binding");
 var CampaignSchema = object18({
   name: string15().required().min(1).max(200).label("Campaign Name"),
-  subject: string15().required().min(1).max(255).label("Subject"),
-  // HTML body; may contain a {{unsubscribe_url}} placeholder.
-  html: string15().required().min(1).label("HTML Body"),
+  // The template renders its own subject; an override is only needed for the
+  // inline-HTML path, hence not required when a template is chosen.
+  subject: string15().optional().max(255).label("Subject").when("templateKey", {
+    is: (v) => !v,
+    then: (s) => s.required().min(1)
+  }),
+  /**
+   * Inline HTML body; may contain {{unsubscribe_url}}. Optional now that a
+   * campaign can instead name a registry template — exactly one of the two is
+   * required. Scheduled and lifecycle campaigns must use a template: the
+   * registry path is the one with a compliance-checked footer and a render test,
+   * and hand-pasted HTML that repeats forever is a mistake that repeats forever.
+   */
+  html: string15().optional().label("HTML Body").when("templateKey", {
+    is: (v) => !v,
+    then: (s) => s.required().min(1)
+  }),
   text: string15().optional().label("Plain-text Body"),
-  listId: string15().required().label("Mailing List")
+  listId: string15().required().label("Mailing List"),
+  /** Key from email-service's template registry. Mutually exclusive with `html`. */
+  templateKey: string15().optional().label("Email Template"),
+  /**
+   * One entry per variable the chosen template declares. Validated at save time
+   * against the template's own `variables`, so a missing required binding is a
+   * rejected save rather than a broken send.
+   */
+  /**
+   * A DICTIONARY keyed by template variable name, which Yup has no native type
+   * for. It must be built with `lazy` from the keys actually present: a bare
+   * `object()` has no known keys, so under `stripUnknown: true` (which the
+   * consumers' validate helper passes) every binding is "unknown" and the whole
+   * map arrives as `{}` — silently turning a fully-configured campaign into one
+   * whose required variables all appear unbound. Shaping each entry also means a
+   * malformed binding is rejected here rather than at send time.
+   */
+  bindings: lazy2((value) => {
+    const keys = value && typeof value === "object" ? Object.keys(value) : [];
+    return object18(
+      Object.fromEntries(keys.map((k) => [k, BindingSchema.required()]))
+    ).optional().default(() => ({})).label("Template Data");
+  }),
+  /** Registered data source supplying per-recipient content, plus its params. */
+  dataSource: object18({
+    id: string15().required().label("Data Source"),
+    /**
+     * A free-form bag whose keys are defined by the chosen source's OWN
+     * `paramsSchema`, which this package cannot see. Same `lazy` treatment as
+     * `bindings` above, and for the same reason: a bare `object()` has no known
+     * keys, so under `stripUnknown: true` every param is "unknown" and the bag
+     * arrives as `{}` — a campaign configured to mail remote Python roles in
+     * Bangalore silently saves as an unfiltered platform-wide digest.
+     *
+     * Values stay unvalidated here on purpose; the marketing service validates
+     * them against the real source schema in `checkCampaignConfig`, which is the
+     * only place that knows what a given source accepts.
+     */
+    params: lazy2((value) => {
+      const keys = value && typeof value === "object" ? Object.keys(value) : [];
+      return object18(
+        Object.fromEntries(keys.map((k) => [k, mixed4().optional()]))
+      ).optional().default(() => ({})).label("Parameters");
+    })
+  }).optional().default(void 0).label("Data Source"),
+  trigger: CampaignTriggerSchema.default(
+    () => CampaignTriggerSchema.getDefault()
+  ),
+  // ── Safety ──────────────────────────────────────────────────────────────────
+  // Both default to the safe position: a new campaign neither runs nor sends
+  // until someone deliberately says so, and says so twice.
+  enabled: boolean11().optional().default(false).label("Enabled"),
+  dryRun: boolean11().optional().default(true).label("Dry Run"),
+  maxRecipients: number7().integer().min(1).max(CAMPAIGN_MAX_RECIPIENTS_CEILING).optional().default(void 0).label("Max Recipients"),
+  utm: object18({
+    campaign: string15().optional().max(120).label("utm_campaign"),
+    content: string15().optional().max(120).label("utm_content")
+  }).optional().default(void 0).label("Link Tagging")
 }).label("Campaign");
 
-// src/marketing/marketing.constant.ts
-var CampaignStatus = /* @__PURE__ */ ((CampaignStatus2) => {
-  CampaignStatus2["Draft"] = "draft";
-  CampaignStatus2["Sending"] = "sending";
-  CampaignStatus2["Sent"] = "sent";
-  CampaignStatus2["Failed"] = "failed";
-  return CampaignStatus2;
-})(CampaignStatus || {});
-var SupportedCampaignStatuses = Object.values(CampaignStatus);
-
 // src/pagination/pagination.schema.ts
 import { number as number8, object as object19, string as string16 } from "yup";
 var PaginationSchema = object19().shape({
@@ -2224,7 +2539,7 @@ var SavedSearchSchema = object20({
 }).noUnknown().strict();
 
 // src/report/report.schema.ts
-import { mixed as mixed4, object as object21, string as string18 } from "yup";
+import { mixed as mixed5, object as object21, string as string18 } from "yup";
 
 // src/report/report.constant.ts
 var ResourceType = /* @__PURE__ */ ((ResourceType3) => {
@@ -2249,14 +2564,14 @@ var SupportedReportReasons = Object.values(ReportReason);
 
 // src/report/report.schema.ts
 var ReportSchema = object21({
-  type: mixed4().oneOf(SupportedResourceTypes).required().label("Type"),
+  type: mixed5().oneOf(SupportedResourceTypes).required().label("Type"),
   resourceId: string18().required().label("Resource ID"),
-  reason: mixed4().oneOf(SupportedReportReasons).required("Please choose a reason").label("Reason"),
+  reason: mixed5().oneOf(SupportedReportReasons).required("Please choose a reason").label("Reason"),
   comment: string18().max(1e3).optional().label("Comment")
 }).label("Report Schema");
 
 // src/feedback/feedback.schema.ts
-import { mixed as mixed5, object as object22, string as string19 } from "yup";
+import { mixed as mixed6, object as object22, string as string19 } from "yup";
 
 // src/feedback/feedback.constant.ts
 var FeedbackType = /* @__PURE__ */ ((FeedbackType3) => {
@@ -2280,11 +2595,11 @@ var FEEDBACK_MESSAGE_MAX = 4e3;
 
 // src/feedback/feedback.schema.ts
 var FeedbackSchema = object22({
-  type: mixed5().oneOf(SupportedFeedbackTypes).required().label("Type"),
+  type: mixed6().oneOf(SupportedFeedbackTypes).required().label("Type"),
   message: string19().trim().required("Please enter a message").max(FEEDBACK_MESSAGE_MAX).label("Message"),
   email: string19().email().optional().label("Email"),
   pageUrl: string19().optional().label("Page URL"),
-  status: mixed5().oneOf(SupportedFeedbackStatuses).optional().label("Status")
+  status: mixed6().oneOf(SupportedFeedbackStatuses).optional().label("Status")
 }).label("Feedback Schema");
 
 // src/user/user.schema.ts
@@ -2386,6 +2701,13 @@ var UserGeneralDetailSchema = object30({
   }).required().label("Name"),
   headline: string28().trim().max(200).optional().label("Headline"),
   image: string28().optional().label("Image"),
+  // The DISPLAYED avatar (`image`) is a flattened export with any status frame
+  // ("#OpenToWork", …) already burned into the pixels. `imageOriginal` keeps the
+  // un-framed source the user uploaded, so the image builder can reopen it and
+  // apply a DIFFERENT frame instead of stacking a second one on top of the first.
+  // Optional and absent on every pre-existing user: treat a missing value as
+  // "only the flattened image is available".
+  imageOriginal: string28().optional().label("Original Image"),
   aboutMe: string28().trim().max(3e3).optional().label("About Me"),
   email: string28().required().label("Email"),
   mobile: string28().nullable().optional().label("Mobile"),
@@ -2712,8 +3034,16 @@ var StudentCompletenessSchema = UserCompletenessSchema.omit([
 export {
   AnswerChoiceType,
   ApplicationReceivePreference,
+  BindingKind,
+  BindingSchema,
+  CAMPAIGN_MAX_RECIPIENTS_CEILING,
+  CampaignAnchorField,
+  CampaignEndKind,
+  CampaignIntervalUnit,
   CampaignSchema,
   CampaignStatus,
+  CampaignTriggerKind,
+  CampaignTriggerSchema,
   ChoiceQuestionSchema,
   Common,
   CompensationType,
@@ -2755,12 +3085,15 @@ export {
   JobSearchUrgency,
   JobStatus,
   JobSubCategory,
+  ListFilterBranch,
+  ListFilterBranchSchema,
   ListFilterSchema,
   LocationSchema,
   MIN_SALARY_LOWER_BOUND,
   MIN_SALARY_UPPER_BOUND,
   MailingListSchema,
   NotificationChannel,
+  OccurrenceStatus,
   PREFILL_MIRRORED_KEYS,
   PRIVATE_PROFILE_FIELDS,
   PageSchema,
@@ -2790,7 +3123,12 @@ export {
   StudyType,
   SupportedAnswerChoiceTypes,
   SupportedApplicationReceivePreferences,
+  SupportedBindingKinds,
+  SupportedCampaignAnchorFields,
+  SupportedCampaignEndKinds,
+  SupportedCampaignIntervalUnits,
   SupportedCampaignStatuses,
+  SupportedCampaignTriggerKinds,
   SupportedCompensationTypes,
   SupportedContactTypes,
   SupportedEducationLevels,
@@ -2806,6 +3144,7 @@ export {
   SupportedJobStatuses,
   SupportedJobSubCategories,
   SupportedNotificationChannels,
+  SupportedOccurrenceStatuses,
   SupportedPageStatuses,
   SupportedPageTypes,
   SupportedPostStatuses,

package/package.json

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

package/src/marketing/marketing.constant.ts

@@ -6,3 +6,101 @@ export enum CampaignStatus {
 }
 
 export const SupportedCampaignStatuses = Object.values(CampaignStatus);
+
+/**
+ * How a campaign decides when to send.
+ *
+ * The two scheduled kinds dedupe differently, and that difference is the reason
+ * they are separate kinds rather than one kind with a flag:
+ *
+ *  • `Schedule` fires on a wall clock. Every occurrence is a shared moment, so
+ *    its identity is the occurrence itself and a recipient may legitimately be
+ *    mailed again next occurrence.
+ *  • `Lifecycle` fires relative to each user's own anchor date (signup, …), so
+ *    there is no shared moment. Identity is the user, permanently: a lifecycle
+ *    campaign mails a given person at most once, ever.
+ */
+export enum CampaignTriggerKind {
+  /** Admin presses send. Also the dry-run test path. */
+  Manual = "manual",
+  /** One send, at one future instant. */
+  Once = "once",
+  /** Repeats on a wall-clock schedule until its end condition. */
+  Schedule = "schedule",
+  /** Fires per user, N days after that user's anchor date. Once per user ever. */
+  Lifecycle = "lifecycle",
+}
+
+export const SupportedCampaignTriggerKinds = Object.values(CampaignTriggerKind);
+
+/** Repeat unit for a `schedule` trigger. */
+export enum CampaignIntervalUnit {
+  Day = "day",
+  Week = "week",
+  Month = "month",
+}
+
+export const SupportedCampaignIntervalUnits = Object.values(CampaignIntervalUnit);
+
+/** How a repeating campaign stops. `Never` runs until disabled. */
+export enum CampaignEndKind {
+  Never = "never",
+  AfterOccurrences = "afterOccurrences",
+  OnDate = "onDate",
+}
+
+export const SupportedCampaignEndKinds = Object.values(CampaignEndKind);
+
+/**
+ * The user-document date a `lifecycle` trigger counts its offset from. A closed
+ * list because each value must be a real, indexed, immutable-enough date on the
+ * user: an anchor that moves would re-fire the campaign for someone already
+ * mailed, which the permanent idempotency key would then silently suppress.
+ */
+export enum CampaignAnchorField {
+  CreatedAt = "createdAt",
+  OnboardingCompletedAt = "onboardingCompletedAt",
+  MarketingConsentUpdatedAt = "marketingConsent.updatedAt",
+}
+
+export const SupportedCampaignAnchorFields = Object.values(CampaignAnchorField);
+
+/**
+ * Where a single template variable's value comes from. The admin picks one per
+ * variable the chosen template declares.
+ *
+ * Whether a campaign is *personalised* is derived from these, not stored: it is
+ * personalised iff any binding is `Recipient` or `Source`. A stored flag could
+ * disagree with the bindings it describes.
+ */
+export enum BindingKind {
+  /** A literal typed by the admin. Same for everyone. */
+  Static = "static",
+  /** A field of the resolved recipient, e.g. `name`. */
+  Recipient = "recipient",
+  /** A URL, UTM-tagged at send time. */
+  Url = "url",
+  /** A field of the campaign's data source output, e.g. `matchedJobs`. */
+  Source = "source",
+}
+
+export const SupportedBindingKinds = Object.values(BindingKind);
+
+/** Lifecycle of one materialised occurrence of a scheduled campaign. */
+export enum OccurrenceStatus {
+  Pending = "pending",
+  Running = "running",
+  Sent = "sent",
+  Skipped = "skipped",
+  Failed = "failed",
+}
+
+export const SupportedOccurrenceStatuses = Object.values(OccurrenceStatus);
+
+/**
+ * Hard ceiling on recipients per scheduled/lifecycle send, enforced in code and
+ * not overridable by config. Distinct from the one-shot audience cap: a campaign
+ * that repeats forever gets the tighter bound, because a misconfigured filter
+ * that mails too many people does it again every occurrence.
+ */
+export const CAMPAIGN_MAX_RECIPIENTS_CEILING = 5000;