@mdxui/services 0.1.0

package/dist/schemas/index.js

@@ -0,0 +1,591 @@
+// src/schemas/index.ts
+import { z } from "zod";
+import {
+  TextInputPropsSchema,
+  SelectInputPropsSchema,
+  RadioGroupInputPropsSchema,
+  FileInputPropsSchema
+} from "mdxui";
+var CatalogHeroSchema = z.object({
+  /** Main landing-page headline. Falls back to `service.name` when unset. */
+  headline: z.string().optional(),
+  /** Sub-headline. Falls back to `service.promise` when unset. */
+  subheadline: z.string().optional(),
+  /** Asset reference for a visual element resolved by the renderer.
+   *  Today Carriage uses per-product HeroGlyph SVGs keyed by slug. */
+  visual: z.string().optional()
+});
+var PricingSummarySchema = z.enum([
+  "starting-at",
+  "per-call",
+  "tier-comparison",
+  "contact-us"
+]);
+var CatalogShapeSchema = z.object({
+  hero: CatalogHeroSchema.optional(),
+  pricingSummary: PricingSummarySchema
+});
+var TextInputSchema = TextInputPropsSchema.extend({
+  source: z.string().optional()
+});
+var SelectInputSchema = SelectInputPropsSchema.extend({
+  source: z.string().optional()
+});
+var RadioGroupInputSchema = RadioGroupInputPropsSchema.extend({
+  source: z.string().optional()
+});
+var FileInputSchema = FileInputPropsSchema.extend({
+  source: z.string().optional()
+});
+var OrderFlowSchema = z.enum([
+  "instant",
+  "guided",
+  "consultation-first"
+]);
+var OrderFieldSchema = z.object({
+  name: z.string(),
+  type: z.enum(["string", "number", "integer", "boolean"]),
+  required: z.boolean(),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  enum: z.array(z.union([z.string(), z.number(), z.boolean()])).readonly().optional(),
+  pattern: z.string().optional(),
+  format: z.enum(["date", "date-time", "email", "uri"]).optional(),
+  minimum: z.number().optional(),
+  maximum: z.number().optional(),
+  widget: z.enum(["vin-decoder", "image-upload"]).optional(),
+  row: z.number().optional(),
+  placeholder: z.string().optional(),
+  autocomplete: z.string().optional(),
+  options: z.array(z.object({
+    value: z.union([z.string(), z.number(), z.boolean()]),
+    label: z.string().optional(),
+    sub: z.string().optional()
+  })).readonly().optional(),
+  tiers: z.array(z.string()).readonly().optional(),
+  /** Phase 1b multi-substrate (Carriage Iter / master 2026-05-26):
+   *  forwarded from JSON Schema's `x-connect` vendor annotation. When
+   *  set, the chassis form renders `<ConnectFlow>` instead of a
+   *  TextField. upstream-proposal: §PR11-theme + §x-connect. */
+  xConnect: z.object({
+    providerId: z.string(),
+    resourceType: z.enum([
+      "channel",
+      "crm-record",
+      "sequence",
+      "phone-number",
+      "voice-line",
+      "webhook-event",
+      "database-table",
+      "folder",
+      "mailbox",
+      "account"
+    ])
+  }).optional(),
+  /** Phase 1b multi-substrate: forwarded from JSON Schema's
+   *  `x-derived-from` vendor annotation. When set, the chassis form
+   *  suppresses input UI and auto-populates from connection metadata.
+   *  upstream-proposal: §PR11-theme + §x-derived-from. */
+  xDerivedFrom: z.object({
+    providerId: z.string(),
+    metadataKey: z.string()
+  }).optional()
+});
+var OrderGroupSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  description: z.string().optional(),
+  fields: z.array(OrderFieldSchema).readonly()
+});
+var OrderStepSchema = z.object({
+  id: z.string(),
+  title: z.string().optional(),
+  fields: z.array(OrderFieldSchema).readonly(),
+  groups: z.array(OrderGroupSchema).readonly()
+});
+var OrderLegalSchema = z.object({
+  termsRequired: z.boolean(),
+  privacyRequired: z.boolean()
+});
+var OrderShapeSchema = z.object({
+  flow: OrderFlowSchema,
+  steps: z.array(OrderStepSchema).readonly().optional(),
+  legal: OrderLegalSchema.optional()
+});
+var DeliveryUxSchema = z.enum([
+  "sync-result-card",
+  "document-download",
+  "async-batch-status"
+]);
+var PreviewModeSchema = z.enum([
+  "first-page",
+  "first-row",
+  "inline-summary",
+  "none"
+]);
+var DeliveryShapeSchema = z.object({
+  ux: DeliveryUxSchema,
+  previewMode: PreviewModeSchema,
+  /** Whether to show a step-by-step progress timeline while the cascade runs. */
+  progressTimeline: z.boolean(),
+  /** Optional SLA echo — ISO 8601 duration (e.g. "PT2M"). */
+  estimatedDelivery: z.string().optional(),
+  /** Optional outcome predicate lifted from outcomeContract. */
+  outcomePredicate: z.string().optional()
+});
+var PortalColumnTypeSchema = z.enum([
+  "identifier",
+  "timestamp",
+  "currency",
+  "duration",
+  "status",
+  "text",
+  "evaluator"
+]);
+var PortalColumnSchema = z.object({
+  id: z.string(),
+  label: z.string(),
+  type: PortalColumnTypeSchema
+});
+var PortalActionKindSchema = z.enum([
+  "view-deliverable",
+  "reissue",
+  "refund",
+  "flag-for-review"
+]);
+var PortalActionSchema = z.object({
+  id: z.string(),
+  label: z.string(),
+  kind: PortalActionKindSchema
+});
+var PortalFilterSchema = z.object({
+  id: z.string(),
+  field: z.string(),
+  label: z.string()
+});
+var PortalShapeSchema = z.object({
+  columns: z.array(PortalColumnSchema),
+  filters: z.array(PortalFilterSchema).optional(),
+  actions: z.array(PortalActionSchema).optional()
+});
+var SiteActionSchema = z.object({
+  label: z.string(),
+  href: z.string(),
+  external: z.boolean().optional()
+});
+var HeroVariantSchema = z.enum([
+  "split-illustration-right",
+  "stacked-illustration-below"
+]);
+var HeroPropsExtendedSchema = z.object({
+  eyebrow: z.string(),
+  headline: z.string(),
+  body: z.string(),
+  primary: SiteActionSchema,
+  secondary: SiteActionSchema.optional(),
+  showGlyph: z.boolean().optional(),
+  /** When true, the glyph also renders below `lg` (stacked beneath
+   *  the hero text on mobile). When false (default), the glyph is
+   *  hidden below `lg`. Services opt in via `publicCopy.hero.glyphOnMobile`.
+   *  upstream-proposal: docs/patterns/upstream-proposals.md §PR11-theme */
+  glyphOnMobile: z.boolean().optional(),
+  illustration: z.any().optional(),
+  /** Hero composition variant. Routes the `<Hero>` dispatcher to
+   *  `HeroSplit` (default) or `HeroStacked`. Sourced from
+   *  `ServiceDefinition.branding.heroVariant`.
+   *  upstream-proposal: docs/patterns/upstream-proposals.md §PR12-hero-variant */
+  variant: HeroVariantSchema.optional()
+});
+var PriceTierSchema = z.object({
+  tierKey: z.string(),
+  tier: z.string(),
+  price: z.string(),
+  audience: z.string(),
+  features: z.array(z.string()),
+  featured: z.boolean().optional(),
+  cta: z.object({ label: z.string(), href: z.string() }),
+  sku: z.string(),
+  amountCents: z.number(),
+  currency: z.enum(["usd", "eur", "gbp"]),
+  stripeName: z.string(),
+  minimumAmountCents: z.number().optional(),
+  priceSuffix: z.string().optional()
+});
+var PricingPropsExtendedSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  tiers: z.array(PriceTierSchema).readonly(),
+  footnote: z.string().optional()
+});
+var FaqItemSchema = z.object({
+  q: z.string(),
+  a: z.string()
+});
+var FaqPropsExtendedSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  items: z.array(FaqItemSchema)
+});
+var HowItWorksStepSchema = z.object({
+  n: z.string(),
+  title: z.string(),
+  body: z.string()
+});
+var HowItWorksPropsSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  steps: z.array(HowItWorksStepSchema),
+  /** Optional mini-illustration per step. When provided and length
+   *  matches `steps.length`, each step renders its illustration in
+   *  a row above the number. All-or-none — if length doesn't match,
+   *  the prop is silently ignored and the text-only layout renders
+   *  (per opt-in-only semantics in illustrations.md §2).
+   *
+   *  Sourced from the per-service illustration manifest at
+   *  `src/services/<slug>/illustration.tsx`.
+   *
+   *  Each element is a React `ComponentType` (zero-arg renderer).
+   *  Zod can't validate component identity at runtime; type-level
+   *  contract carries via `z.custom`.
+   *
+   *  upstream-proposal: docs/patterns/upstream-proposals.md §PR12-step-illustrations
+   *  (master 2026-05-26 — illustration abstraction Phase 4). */
+  stepIllustrations: z.array(z.custom()).optional()
+});
+var WhatYouGetItemSchema = z.object({
+  n: z.string(),
+  title: z.string(),
+  body: z.string()
+});
+var WhatYouGetPropsSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  sections: z.array(WhatYouGetItemSchema)
+});
+var FinalCtaPropsSchema = z.object({
+  eyebrow: z.string(),
+  headline: z.string(),
+  primary: SiteActionSchema,
+  secondary: SiteActionSchema.optional()
+});
+var MastheadPropsSchema = z.object({
+  brand: z.object({
+    primary: z.string(),
+    secondary: z.string().optional(),
+    href: z.string()
+  }),
+  cta: z.object({ label: z.string(), href: z.string() }).optional(),
+  eyebrow: z.string().optional(),
+  narrow: z.boolean().optional()
+});
+var SiteFooterLinkSchema = z.object({
+  label: z.string(),
+  href: z.string()
+});
+var SiteFooterPropsSchema = z.object({
+  text: z.string(),
+  links: z.array(SiteFooterLinkSchema).optional()
+});
+var TextFieldPropsSchema = z.object({
+  label: z.string(),
+  value: z.string(),
+  onChange: z.custom(),
+  placeholder: z.string().optional(),
+  /** Helper text shown below the field. `invalid=true` renders it in error colour. */
+  hint: z.string().optional(),
+  type: z.enum(["text", "date", "number", "email"]).optional(),
+  /** Right-edge suffix label (e.g. "miles", "%"). */
+  suffix: z.string().optional(),
+  /** Renders the input in a monospace typeface (e.g. VIN, code). */
+  mono: z.boolean().optional(),
+  /** Renders the field in error state (red border + hint text). */
+  invalid: z.boolean().optional(),
+  inputRef: z.custom().optional(),
+  /** HTML `autocomplete` attribute for browser autofill. */
+  autoComplete: z.string().optional()
+});
+var SelectFieldPropsSchema = z.object({
+  label: z.string(),
+  value: z.string(),
+  onChange: z.custom(),
+  options: z.array(z.object({ value: z.string(), label: z.string() })),
+  /** HTML `autocomplete` attribute for browser autofill. */
+  autoComplete: z.string().optional()
+});
+var RadioGroupOptionSchema = z.object({
+  value: z.string(),
+  label: z.string(),
+  /** Optional secondary descriptor line rendered inside the card. */
+  sub: z.string().optional()
+});
+var RadioGroupPropsSchema = z.object({
+  label: z.string(),
+  name: z.string(),
+  value: z.string(),
+  onChange: z.custom(),
+  options: z.array(RadioGroupOptionSchema)
+});
+var FieldRowPropsSchema = z.object({
+  children: z.custom()
+});
+var StepHeadingPropsSchema = z.object({
+  /** Numeric step indicator, e.g. "01", "02". Rendered in tabular mono. */
+  index: z.string(),
+  /** Short action-verb eyebrow label. e.g. "Connect", "Compose". */
+  eyebrow: z.string(),
+  /** Primary section heading. */
+  title: z.string(),
+  /** Supporting body copy below the heading. */
+  body: z.string(),
+  className: z.string().optional()
+});
+var LogoUploadPropsSchema = z.object({
+  /** Resolved Vercel-Blob URL, or null when no logo is set. */
+  value: z.string().nullable(),
+  /** True while the upload network call is in-flight. */
+  uploading: z.boolean(),
+  /** Error message from the last failed upload attempt, or null. */
+  error: z.string().nullable(),
+  onChange: z.custom(),
+  onClear: z.custom(),
+  /** Widget label override (default: "Firm logo (optional)"). */
+  label: z.string().optional(),
+  /** Body copy override below the preview thumbnail. */
+  bodyText: z.string().optional()
+});
+var ImageUploadFieldPropsSchema = z.object({
+  /** Renderer label — sourced from `OrderField.title`. */
+  label: z.string(),
+  /** Helper text — sourced from `OrderField.description`. */
+  description: z.string().optional(),
+  /** Current value (resolved Vercel-Blob URL, or null). */
+  value: z.string().nullable(),
+  /** Called with the new URL after a successful upload, or null on clear. */
+  onChange: z.custom()
+});
+var PricingSectionChromeSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  footnote: z.string().optional(),
+  currency: z.enum(["usd", "eur", "gbp"])
+});
+var PricingTieredSchema = PricingSectionChromeSchema.extend({
+  kind: z.literal("tiered"),
+  tiers: z.array(PriceTierSchema).readonly()
+});
+var PricingUnitSchema = PricingSectionChromeSchema.extend({
+  kind: z.literal("unit"),
+  perUnit: z.number(),
+  billingCadence: z.string()
+});
+var PricingSchema = z.union([PricingTieredSchema, PricingUnitSchema]);
+var ServiceFormPropsSchema = z.object({
+  /** Service slug — used in the `/api/checkout` body + return-URL construction. */
+  slug: z.string(),
+  /** Derived order shape from `deriveOrder(svc)`. */
+  order: OrderShapeSchema,
+  /** Service pricing — from `ServiceDefinition.pricing`. Mirrors the `Pricing` union. */
+  pricing: PricingSchema,
+  /** Form-phase headline (h1 above the fields). Optional — omit in unit tests. */
+  formHeadline: z.string().optional(),
+  /** Form-phase intro paragraph. Optional. */
+  formIntro: z.string().optional(),
+  /** Product-name eyebrow (e.g. "Carriage Donation") rendered above the h1. */
+  productName: z.string().optional(),
+  /** Payment-phase h1. Defaults to "Generate your report" when unset. */
+  paymentHeadline: z.string().optional()
+});
+var CheckoutPanelPropsSchema = z.object({
+  /** Stripe PaymentIntent client secret from /api/checkout. */
+  clientSecret: z.string(),
+  /** Payment amount in cents — displayed as "Pay $X.XX & {ctaSuffix}". */
+  amountCents: z.number(),
+  /** Email pre-fill passed to Stripe as receipt email. */
+  email: z.string().optional(),
+  /** Where Stripe redirects after a successful payment (redirect flow). */
+  returnUrl: z.string().optional(),
+  /** Optional inline-confirmation callback (inline flow — bulk products). */
+  onSuccess: z.custom().optional(),
+  /** Custom CTA suffix on the Pay button. Default: "generate report". */
+  ctaSuffix: z.string().optional(),
+  /** "Edit details" callback — re-shows the form. */
+  onCancel: z.custom()
+});
+var DefensibilityColumnSchema = z.object({
+  heading: z.string(),
+  /** Array of bullet content. Each bullet is a ReactNode — strings in
+   *  practice today; rich content possible in future JSON upgrades. */
+  bullets: z.array(z.custom())
+});
+var DefensibilityPropsSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  /** Tuple of exactly two columns (left = "what it is", right = "what it isn't"). */
+  columns: z.tuple([DefensibilityColumnSchema, DefensibilityColumnSchema]),
+  /** Optional closing caveat paragraph. */
+  caveat: z.custom().optional()
+});
+var UpsellBannerPropsSchema = z.object({
+  /** Display-serif hook line. Often phrased as a question. */
+  headline: z.string(),
+  /** Optional one-line explanation below the headline. */
+  body: z.string().optional(),
+  /** Activation pill content — ReactNode for inline price transitions. */
+  cta: z.custom(),
+  onActivate: z.custom()
+});
+var UpsellCardPropsSchema = z.object({
+  eyebrow: z.string(),
+  /** Card body — ReactNode for future rich-text upgrades. */
+  body: z.custom(),
+  ctaLabel: z.string(),
+  onActivate: z.custom()
+});
+var CtaSchema = z.object({
+  label: z.string(),
+  href: z.string()
+});
+var BreadcrumbSchema = z.object({
+  name: z.string(),
+  href: z.string()
+});
+var ServiceSchemaSpecSchema = z.object({
+  name: z.string(),
+  serviceType: z.string(),
+  url: z.string(),
+  areaServed: z.string()
+});
+var ProblemItemSchema = z.object({
+  label: z.string(),
+  cost: z.string(),
+  outcome: z.string(),
+  body: z.string()
+});
+var ProblemPropsSchema = z.object({
+  eyebrow: z.string(),
+  heading: z.string(),
+  items: z.array(ProblemItemSchema)
+});
+var ServiceBrandingSchema = z.object({
+  primary: z.string(),
+  secondary: z.string().optional(),
+  productName: z.string(),
+  /** SERP title default for the landing page. */
+  defaultTitle: z.string(),
+  /** OG/SERP description default. */
+  defaultDescription: z.string(),
+  heroGlyph: z.string().optional(),
+  showHeroGlyph: z.boolean().optional(),
+  og: z.object({ headline: z.string() })
+});
+var LandingPublicCopySchema = z.object({
+  pageTitle: z.string(),
+  pageDescription: z.string(),
+  headerCta: CtaSchema,
+  hero: HeroPropsExtendedSchema,
+  problem: ProblemPropsSchema,
+  whatYouGet: WhatYouGetPropsSchema,
+  howItWorks: HowItWorksPropsSchema,
+  defensibility: DefensibilityPropsSchema,
+  faq: FaqPropsExtendedSchema,
+  finalCta: FinalCtaPropsSchema,
+  footerText: z.string(),
+  serviceSchema: ServiceSchemaSpecSchema,
+  breadcrumbs: z.array(BreadcrumbSchema).optional()
+});
+var LandingPricingSchema = z.object({
+  kind: z.enum(["tiered", "unit"]),
+  eyebrow: z.string(),
+  heading: z.string(),
+  footnote: z.string().optional(),
+  currency: z.enum(["usd", "eur", "gbp"]).optional(),
+  tiers: z.array(PriceTierSchema).readonly().optional(),
+  /** unit pricing fields — optional; only present when kind='unit' */
+  perUnit: z.number().optional(),
+  billingCadence: z.string().optional()
+});
+var ServiceArchetypeIdSchema = z.enum([
+  "service-archetype-document-extraction",
+  "service-archetype-data-enrichment",
+  "service-archetype-transactional-action",
+  "service-archetype-sourced-comparative-analysis",
+  "service-archetype-form-preparation",
+  "service-archetype-compliance-check",
+  "service-archetype-market-intelligence",
+  "service-archetype-communication-automation"
+]);
+var CatalogShapeFullSchema = CatalogShapeSchema.extend({
+  /** Full landing-page section copy. Present for all fully-absorbed services. */
+  publicCopy: LandingPublicCopySchema.optional(),
+  /** Product branding (wordmark + heroGlyph + og headline). */
+  branding: ServiceBrandingSchema.optional(),
+  /** Commercial pricing — section chrome + tiers. */
+  pricing: LandingPricingSchema.optional(),
+  /** Service archetype id — drives MIME/totalTime defaults at render time. */
+  archetype: ServiceArchetypeIdSchema.optional()
+});
+export {
+  BreadcrumbSchema,
+  CatalogHeroSchema,
+  CatalogShapeFullSchema,
+  CatalogShapeSchema,
+  CheckoutPanelPropsSchema,
+  CtaSchema,
+  DefensibilityColumnSchema,
+  DefensibilityPropsSchema,
+  DeliveryShapeSchema,
+  DeliveryUxSchema,
+  FaqItemSchema,
+  FaqPropsExtendedSchema,
+  FieldRowPropsSchema,
+  FileInputSchema,
+  FinalCtaPropsSchema,
+  HeroPropsExtendedSchema,
+  HeroVariantSchema,
+  HowItWorksPropsSchema,
+  HowItWorksStepSchema,
+  ImageUploadFieldPropsSchema,
+  LandingPricingSchema,
+  LandingPublicCopySchema,
+  LogoUploadPropsSchema,
+  MastheadPropsSchema,
+  OrderFieldSchema,
+  OrderFlowSchema,
+  OrderGroupSchema,
+  OrderLegalSchema,
+  OrderShapeSchema,
+  OrderStepSchema,
+  PortalActionKindSchema,
+  PortalActionSchema,
+  PortalColumnSchema,
+  PortalColumnTypeSchema,
+  PortalFilterSchema,
+  PortalShapeSchema,
+  PreviewModeSchema,
+  PriceTierSchema,
+  PricingPropsExtendedSchema,
+  PricingSchema,
+  PricingSummarySchema,
+  ProblemItemSchema,
+  ProblemPropsSchema,
+  RadioGroupInputSchema,
+  RadioGroupOptionSchema,
+  RadioGroupPropsSchema,
+  SelectFieldPropsSchema,
+  SelectInputSchema,
+  ServiceArchetypeIdSchema,
+  ServiceBrandingSchema,
+  ServiceFormPropsSchema,
+  ServiceSchemaSpecSchema,
+  SiteActionSchema,
+  SiteFooterLinkSchema,
+  SiteFooterPropsSchema,
+  StepHeadingPropsSchema,
+  TextFieldPropsSchema,
+  TextInputSchema,
+  UpsellBannerPropsSchema,
+  UpsellCardPropsSchema,
+  WhatYouGetItemSchema,
+  WhatYouGetPropsSchema
+};
+//# sourceMappingURL=index.js.map