@thejob/schema 2.0.8 → 2.0.9

package/package.json

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

package/src/index.ts

@@ -50,6 +50,12 @@ export * from "./location/location.schema.js";
 export * from "./page/page.schema.js";
 export * from "./page/page.constant.js";
 
+/**
+ * Marketing schemas and constants (mailing lists, campaigns).
+ */
+export * from "./marketing/marketing.schema.js";
+export * from "./marketing/marketing.constant.js";
+
 /**
  * Pagination schemas and constants.
  */

package/src/marketing/marketing.constant.ts

@@ -0,0 +1,8 @@
+export enum CampaignStatus {
+  Draft = "draft",
+  Sending = "sending",
+  Sent = "sent",
+  Failed = "failed",
+}
+
+export const SupportedCampaignStatuses = Object.values(CampaignStatus);

package/src/marketing/marketing.schema.ts

@@ -0,0 +1,130 @@
+import { array, boolean, number, object, string } from "yup";
+import {
+  SupportedExperienceLevels,
+  SupportedStudyTypes,
+} from "../common/common.constant.js";
+import { SupportedSocialAccounts } from "../social-account/social-account.constant.js";
+import {
+  SupportedJobSearchUrgencies,
+  SupportedProficiencyLevels,
+  SupportedReferralSources,
+  SupportedSalaryCurrencies,
+  SupportedUserProfileVisibilities,
+  SupportedUserRoles,
+  SupportedUserStatuses,
+} from "../user/user.constant.js";
+
+// ─── Audience filter ─────────────────────────────────────────────────────────
+// The saved query a mailing list resolves against the users collection. Every
+// clause is optional and AND-ed; empty groups match everyone.
+//
+// Two kinds of clause:
+//   • Enum facets (`.oneOf(...)`) — closed vocabularies rendered as chip pickers.
+//   • Free-text token facets — open vocabularies (skills, companies, institutes,
+//     …) matched case-insensitively against a nested array/field. Any token in
+//     the list matches (OR within a facet), facets AND together.
+
+const tokens = (label: string) =>
+  array().of(string().trim().required()).optional().default([]).label(label);
+
+const enumFacet = (values: readonly string[], label: string) =>
+  array()
+    .of(string().oneOf(values).required())
+    .optional()
+    .default([])
+    .label(label);
+
+export const ListFilterSchema = object({
+  // ── Enum facets (closed vocabularies, chip pickers) ─────────────────────────
+  countries: array().of(string().required()).optional().default([]).label("Countries"),
+  roles: enumFacet(SupportedUserRoles, "Roles"),
+  // The user's own current seniority (UserSchema.experienceLevel).
+  experienceLevels: enumFacet(SupportedExperienceLevels, "Experience Levels"),
+  // Levels the user is *targeting* (distinct from their current experienceLevel).
+  targetExperienceLevels: enumFacet(
+    SupportedExperienceLevels,
+    "Target Experience Levels",
+  ),
+  jobSearchUrgencies: enumFacet(SupportedJobSearchUrgencies, "Job Search Urgency"),
+  referralSources: enumFacet(SupportedReferralSources, "Referral Source"),
+  statuses: enumFacet(SupportedUserStatuses, "Account Status"),
+  profileVisibilities: enumFacet(
+    SupportedUserProfileVisibilities,
+    "Profile Visibility",
+  ),
+  // Proficiency held on any skill entry (skills[].proficiencyLevel).
+  skillProficiencyLevels: enumFacet(
+    SupportedProficiencyLevels,
+    "Skill Proficiency",
+  ),
+  // Proficiency held on any language entry (languages[].proficiencyLevel).
+  languageProficiencyLevels: enumFacet(
+    SupportedProficiencyLevels,
+    "Language Proficiency",
+  ),
+  // Mode of any education entry (educations[].studyType).
+  studyTypes: enumFacet(SupportedStudyTypes, "Study Type"),
+  // Platforms the user linked a social account for (socialAccounts[].type).
+  socialAccountTypes: enumFacet(SupportedSocialAccounts, "Social Accounts"),
+  // Currency of the user's salary floor (minSalaryCurrency).
+  salaryCurrencies: enumFacet(SupportedSalaryCurrencies, "Salary Currency"),
+
+  // ── Free-text token facets (nested profile arrays) ──────────────────────────
+  skills: tokens("Skills"),
+  languages: tokens("Languages"),
+  interests: tokens("Interests"),
+  companies: tokens("Companies"),
+  designations: tokens("Job Titles / Designations"),
+  institutes: tokens("Institutes"),
+  courses: tokens("Courses"),
+  fieldsOfStudy: tokens("Fields of Study"),
+  certifications: tokens("Certifications"),
+  certificationAuthorities: tokens("Certification Authorities"),
+  projects: tokens("Projects"),
+  jobRoles: tokens("Target Roles"),
+  jobLocations: tokens("Preferred Job Locations"),
+  // Companies a recruiter is hiring for (recruiterProfile.hiringFor[].page.name).
+  hiringForCompanies: tokens("Hiring For (Companies)"),
+  // Institutes a coordinator works at (coordinatorProfile.coordinatesAt[].page.name).
+  coordinatesAtInstitutes: tokens("Coordinates At (Institutes)"),
+  // Case-insensitive keyword match against headline + aboutMe.
+  keywords: tokens("Profile Keywords"),
+
+  // ── Range / boolean facets ──────────────────────────────────────────────────
+  minSalaryFloor: number().integer().min(0).optional().label("Min Salary ≥"),
+  minSalaryCeil: number().integer().min(0).optional().label("Min Salary ≤"),
+  openToWorkOnly: boolean().optional().default(false).label("Open to Work Only"),
+  remoteExperienceOnly: boolean()
+    .optional()
+    .default(false)
+    .label("Has Remote Experience"),
+  hasResumeOnly: boolean().optional().default(false).label("Has Resume"),
+  onboardingCompletedOnly: boolean()
+    .optional()
+    .default(false)
+    .label("Onboarding Completed"),
+  emailVerifiedOnly: boolean().optional().default(false).label("Email Verified Only"),
+  mobileVerifiedOnly: boolean()
+    .optional()
+    .default(false)
+    .label("Mobile Verified Only"),
+}).label("Audience Filter");
+
+// ─── Mailing list ────────────────────────────────────────────────────────────
+
+export const MailingListSchema = object({
+  name: string().required().min(1).max(120).label("Name"),
+  description: string().optional().max(500).label("Description"),
+  filter: ListFilterSchema.default(() => ListFilterSchema.getDefault()),
+}).label("Mailing List");
+
+// ─── Campaign ────────────────────────────────────────────────────────────────
+
+export const CampaignSchema = object({
+  name: string().required().min(1).max(200).label("Campaign Name"),
+  subject: string().required().min(1).max(255).label("Subject"),
+  // HTML body; may contain a {{unsubscribe_url}} placeholder.
+  html: string().required().min(1).label("HTML Body"),
+  text: string().optional().label("Plain-text Body"),
+  listId: string().required().label("Mailing List"),
+}).label("Campaign");