@gusto/embedded-react-sdk 0.55.1 → 0.55.3

package/dist/partner-hook-utils/form/buildFormSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildFormSchema.js","sources":["../../../src/partner-hook-utils/form/buildFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport type { FieldMetadata } from '../types'\n\n// ── Types ────────────────────────────────────────────────────────────\n\n/**\n * Form lifecycle mode used to vary requiredness and validation rules.\n *\n * @internal\n */\ntype FormMode = 'create' | 'update'\n\n/**\n * Per-field requiredness rule.\n *\n * String values apply requiredness in a fixed mode (`'always'`, `'create'`,\n * `'update'`, or `'never'`). A function form receives the current form data\n * and mode so requiredness can depend on other field values at runtime.\n *\n * @typeParam TData - The shape of the form data passed to predicate rules.\n * @internal\n */\ntype RequiredFieldRule<TData = Record<string, unknown>> =\n  'create' | 'update' | 'always' | 'never' | ((data: TData, mode: FormMode) => boolean)\n\n/**\n * Mapping from each field name in a schema to its {@link RequiredFieldRule}.\n *\n * @typeParam TSchema - The map of field names to their Zod validators.\n * @internal\n */\nexport type RequiredFieldConfig<TSchema extends Record<string, z.ZodType>> = Partial<{\n  [K in keyof TSchema & string]: RequiredFieldRule<{\n    [F in keyof TSchema]: z.infer<TSchema[F]>\n  }>\n}>\n\n/**\n * A predicate (value-conditional) requiredness rule. Matches any function\n * signature so predicate rules are recognized regardless of their parameter or\n * return types. Such fields are never statically required in a given mode, so\n * they're eligible for promotion — see {@link OptionalOnCreate}.\n */\ntype PredicateRule = (...args: never[]) => unknown\n\n/**\n * Union of field names in `TConfig` that are not statically required in create\n * mode and are therefore eligible to be promoted to required in create mode:\n * fields whose base rule is `'update'`, `'never'`, or a predicate. Promoting a\n * predicate field upgrades it from conditionally required to always required.\n *\n * The template-literal wrapper \\`\\` `${...}` \\`\\` is intentional: wrapping a\n * conditional-mapped-type index access in a template literal forces TypeScript\n * to eagerly evaluate and materialize the string union rather than deferring\n * it. Without the wrapper, TypeScript preserves the alias name in hover\n * tooltips and generated docs (`OptionalOnCreate<{ ... }>`), making the type\n * opaque to callers. With it, both IntelliSense and TypeDoc display the\n * resolved concrete union (e.g. `\"stateWcCovered\" | \"twoPercentShareholder\"`).\n */\ntype OptionalOnCreate<TConfig> = `${{\n  [K in keyof TConfig & string]: TConfig[K] extends 'update' | 'never' | PredicateRule ? K : never\n}[keyof TConfig & string]}`\n\n/**\n * Union of field names in `TConfig` that are not statically required in update\n * mode and are therefore eligible to be promoted to required in update mode:\n * fields whose base rule is `'create'`, `'never'`, or a predicate.\n *\n * See {@link OptionalOnCreate} for why the template-literal wrapper is here.\n */\ntype OptionalOnUpdate<TConfig> = `${{\n  [K in keyof TConfig & string]: TConfig[K] extends 'create' | 'never' | PredicateRule ? K : never\n}[keyof TConfig & string]}`\n\n/**\n * Per-mode list of optional fields a caller can promote to required.\n *\n * Only fields whose base rule allows the override appear in the `create` /\n * `update` arrays — fields that are already required in a given mode are\n * excluded from that mode's list at the type level. Value-conditional\n * (predicate) fields are eligible in both modes; listing one promotes it from\n * conditionally required to always required for that mode.\n *\n * @typeParam TConfig - The {@link RequiredFieldConfig} that constrains which fields are eligible.\n * @internal\n * @interface\n */\nexport type OptionalFieldsToRequire<TConfig> = {\n  /** Fields that can be required in create mode */\n  create?: Array<OptionalOnCreate<TConfig>>\n  /** Fields that can be required in update mode */\n  update?: Array<OptionalOnUpdate<TConfig>>\n}\n\n// ── buildFormSchema ──────────────────────────────────────────────────\n\ninterface BuildFormSchemaOptions<\n  T extends Record<string, z.ZodType>,\n  TConfig extends RequiredFieldConfig<T>,\n> {\n  requiredFieldsConfig?: TConfig\n  requiredErrorCode?: string\n  mode: FormMode\n  optionalFieldsToRequire?: OptionalFieldsToRequire<TConfig>\n  /**\n   * Fields that don't apply and should be dropped from required validation.\n   *\n   * An **array** removes the fields at build time — they're absent from the\n   * schema shape entirely (use when applicability is fixed by a config flag).\n   *\n   * A **function** is evaluated against the values under validation, so a field\n   * can flip in/out of applicability as other values change. The field stays in\n   * the schema (validated as optional) but its required check is skipped while\n   * the function reports it as excluded.\n   */\n  excludeFields?:\n    | Array<keyof T & string>\n    | ((data: { [K in keyof T]: z.infer<T[K]> }, mode: FormMode) => Array<keyof T & string>)\n  /** Fields with existing server-side values that are redacted in the API response\n   *  (e.g. SSN, EIN). These fields remain in the schema for format validation and\n   *  appear in metadata (with `hasRedactedValue: true`) but are exempt from required\n   *  validation — an empty submission is valid because a value already exists. */\n  fieldsWithRedactedValues?: Array<keyof T & string>\n  superRefine?: (data: { [K in keyof T]: z.infer<T[K]> }, ctx: z.RefinementCtx) => void\n}\n\n/**\n * Companion config returned alongside a built schema, used to derive per-field\n * metadata and to identify which form values predicate-based rules depend on.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @internal\n */\nexport interface FieldsMetadataConfig<T extends Record<string, z.ZodType>> {\n  getFieldsMetadata: (data?: Record<string, unknown>) => Record<keyof T, FieldMetadata>\n  /** Form field names that predicate-based requiredness rules read at runtime. */\n  predicateDeps: string[]\n}\n\ntype FormDataFromValidators<T extends Record<string, z.ZodType>> = {\n  [K in keyof T]: z.infer<T[K]>\n}\n\n/**\n * Tuple returned by {@link buildFormSchema}: the composed Zod schema followed\n * by its {@link FieldsMetadataConfig}.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @internal\n */\nexport type BuildFormSchemaResult<T extends Record<string, z.ZodType>> = [\n  schema: z.ZodType<FormDataFromValidators<T>, FormDataFromValidators<T>>,\n  metadataConfig: FieldsMetadataConfig<T>,\n]\n\n/**\n * Composes a Zod object schema and matching metadata config from a map of\n * per-field validators, applying mode-aware requiredness rules.\n *\n * @remarks\n * Every field is wrapped to coerce empty strings, `null`, `undefined`, and\n * `NaN` to `undefined` before validation, so blank inputs surface as missing\n * rather than as type-mismatch errors. Required-field checks run in a\n * `superRefine` pass that emits an issue keyed by `requiredErrorCode` (defaults\n * to `REQUIRED`) for each unfilled required field.\n *\n * Fields listed in `fieldsWithRedactedValues` remain in the schema for format\n * validation and appear in metadata with `hasRedactedValue: true`, but are\n * exempt from required-field validation because a server-side value already\n * exists.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @typeParam TConfig - The shape of the requiredness configuration.\n * @param fieldValidators - Map from field name to the validator that runs when a value is present.\n * @param options - Mode, required-field config, redaction list, and optional `superRefine`.\n * @returns A {@link BuildFormSchemaResult} tuple: the schema and its metadata config.\n * @internal\n */\nexport function buildFormSchema<\n  T extends Record<string, z.ZodType>,\n  TConfig extends RequiredFieldConfig<T>,\n>(fieldValidators: T, options: BuildFormSchemaOptions<T, TConfig>): BuildFormSchemaResult<T> {\n  const {\n    mode,\n    requiredFieldsConfig = {} as Record<string, RequiredFieldRule>,\n    requiredErrorCode = 'REQUIRED',\n    excludeFields = [],\n  } = options\n  // The array form removes fields at build time; the function form is resolved\n  // per-validation in the superRefine pass below.\n  const excludeFieldsFn = typeof excludeFields === 'function' ? excludeFields : undefined\n  const staticExcluded = new Set((Array.isArray(excludeFields) ? excludeFields : []).map(String))\n  const redacted = new Set((options.fieldsWithRedactedValues ?? []).map(String))\n  const partnerRequired = new Set(\n    resolveOptionalFieldsToRequire(options.optionalFieldsToRequire, mode),\n  )\n\n  const shape: Record<string, z.ZodType> = {}\n  const dynamicRequired: Array<{\n    name: string\n    predicate: (data: Record<string, unknown>, mode: FormMode) => boolean\n  }> = []\n  const includedFieldNames: string[] = []\n  const config = requiredFieldsConfig as Record<string, RequiredFieldRule>\n\n  for (const [name, validator] of Object.entries(fieldValidators)) {\n    if (staticExcluded.has(name)) continue\n    includedFieldNames.push(name)\n\n    const effectiveRule = config[name] ?? 'always'\n\n    shape[name] = makeOptional(validator)\n\n    if (!redacted.has(name)) {\n      const isPartnerRequired = partnerRequired.has(name)\n\n      if (typeof effectiveRule === 'function') {\n        dynamicRequired.push({\n          name,\n          predicate: isPartnerRequired ? () => true : effectiveRule,\n        })\n      } else {\n        const isRequired = effectiveRule === 'always' || effectiveRule === mode || isPartnerRequired\n        if (isRequired) {\n          dynamicRequired.push({ name, predicate: () => true })\n        }\n      }\n    }\n  }\n\n  const hasSuperRefine = dynamicRequired.length > 0 || options.superRefine\n  let schema: z.ZodType = z.object(shape)\n\n  if (hasSuperRefine) {\n    schema = (schema as z.ZodObject).superRefine(\n      (data: Record<string, unknown>, ctx: z.RefinementCtx) => {\n        const typedData = data as FormDataFromValidators<T>\n        const excludedNow = excludeFieldsFn\n          ? new Set(excludeFieldsFn(typedData, mode).map(String))\n          : undefined\n\n        for (const { name, predicate } of dynamicRequired) {\n          if (excludedNow?.has(name)) continue\n          if (predicate(data, mode) && isEmpty(data[name])) {\n            ctx.addIssue({\n              code: z.ZodIssueCode.custom,\n              path: [name],\n              message: requiredErrorCode,\n            })\n          }\n        }\n\n        options.superRefine?.(typedData, ctx)\n      },\n    )\n  }\n\n  const predicateDeps = detectPredicateDeps(dynamicRequired, mode)\n\n  function getFieldsMetadata(data?: Record<string, unknown>) {\n    const metadata: Record<string, FieldMetadata> = {}\n\n    for (const name of includedFieldNames) {\n      const effectiveRule = config[name] ?? 'always'\n\n      if (partnerRequired.has(name)) {\n        metadata[name] = { name, isRequired: true }\n      } else if (typeof effectiveRule === 'function') {\n        metadata[name] = { name, isRequired: data ? effectiveRule(data, mode) : false }\n      } else {\n        metadata[name] = {\n          name,\n          isRequired: effectiveRule === 'always' || effectiveRule === mode,\n        }\n      }\n\n      if (redacted.has(name)) {\n        metadata[name].hasRedactedValue = true\n      }\n    }\n\n    return metadata as Record<keyof T, FieldMetadata>\n  }\n\n  // makeOptional wraps fields with z.preprocess, which causes z.input to infer\n  // `unknown`. Cast the schema to carry the original field types so zodResolver\n  // infers correct form data types — consumers don't need per-hook casts.\n  return [\n    schema as z.ZodType<FormDataFromValidators<T>, FormDataFromValidators<T>>,\n    { getFieldsMetadata, predicateDeps },\n  ]\n}\n\n// ── Internal helpers ─────────────────────────────────────────────────\n\nfunction resolveOptionalFieldsToRequire<TConfig>(\n  value: OptionalFieldsToRequire<TConfig> | undefined,\n  mode: FormMode,\n): string[] {\n  if (!value) return []\n  return ((mode === 'create' ? value.create : value.update) ?? []) as string[]\n}\n\nfunction makeOptional(validator: z.ZodType): z.ZodType {\n  return z.preprocess(v => (isEmpty(v) ? undefined : v), validator.optional())\n}\n\nfunction isEmpty(value: unknown): boolean {\n  if (value === undefined || value === null) return true\n  if (typeof value === 'string' && value.trim() === '') return true\n  if (typeof value === 'number' && Number.isNaN(value)) return true\n  return false\n}\n\n/**\n * Determines which form field names are read by predicate-based requiredness\n * rules. This enables `useDeriveFieldsMetadata` to watch only the specific\n * fields that predicates depend on, rather than subscribing to every form\n * value change (which defeats react-hook-form's per-field render optimization).\n *\n * Works by running each predicate against a recording Proxy. The Proxy\n * intercepts property access and logs the keys, giving us the dependency list\n * without requiring manual declaration.\n *\n * Limitation: JavaScript short-circuit evaluation (`a && b`) can prevent the\n * Proxy from seeing later operands when earlier ones are falsy. In practice\n * this is acceptable — our predicate rules read a single form value each\n * (e.g. `data => data.adjustForMinimumWage`). Multi-field predicates with\n * equality guards should be expressed as `superRefine` rules instead.\n */\nfunction detectPredicateDeps(\n  dynamicRequired: Array<{\n    name: string\n    predicate: (data: Record<string, unknown>, mode: FormMode) => boolean\n  }>,\n  mode: FormMode,\n): string[] {\n  const deps = new Set<string>()\n\n  for (const { predicate } of dynamicRequired) {\n    if (isConstantPredicate(predicate)) continue\n\n    const accessed: string[] = []\n    const proxy = new Proxy({} as Record<string, unknown>, {\n      get(_target, prop) {\n        if (typeof prop === 'string') accessed.push(prop)\n        return undefined\n      },\n    })\n\n    try {\n      predicate(proxy, mode)\n    } catch {\n      /* Predicate may throw on undefined values — that's fine, we already captured the property accesses */\n    }\n\n    for (const key of accessed) deps.add(key)\n  }\n\n  return [...deps]\n}\n\n/**\n * Static predicates (e.g. `() => true` from 'always' / mode rules / partner\n * overrides) don't access form data, so we skip them during dependency\n * detection. We identify them by running against an empty proxy and checking\n * whether any properties were accessed.\n */\nfunction isConstantPredicate(\n  predicate: (data: Record<string, unknown>, mode: FormMode) => boolean,\n): boolean {\n  const accessed: string[] = []\n  const proxy = new Proxy({} as Record<string, unknown>, {\n    get(_target, prop) {\n      if (typeof prop === 'string') accessed.push(prop)\n      return undefined\n    },\n  })\n  try {\n    predicate(proxy, 'create')\n  } catch {\n    /* ignore */\n  }\n  return accessed.length === 0\n}\n"],"names":["buildFormSchema","fieldValidators","options","mode","requiredFieldsConfig","requiredErrorCode","excludeFields","excludeFieldsFn","staticExcluded","redacted","partnerRequired","resolveOptionalFieldsToRequire","shape","dynamicRequired","includedFieldNames","config","name","validator","effectiveRule","makeOptional","isPartnerRequired","hasSuperRefine","schema","z","data","ctx","typedData","excludedNow","predicate","isEmpty","predicateDeps","detectPredicateDeps","getFieldsMetadata","metadata","value","v","deps","isConstantPredicate","accessed","proxy","_target","prop","key"],"mappings":";AAkLO,SAASA,EAGdC,GAAoBC,GAAuE;AAC3F,QAAM;AAAA,IACJ,MAAAC;AAAA,IACA,sBAAAC,IAAuB,CAAA;AAAA,IACvB,mBAAAC,IAAoB;AAAA,IACpB,eAAAC,IAAgB,CAAA;AAAA,EAAC,IACfJ,GAGEK,IAAkB,OAAOD,KAAkB,aAAaA,IAAgB,QACxEE,IAAiB,IAAI,KAAK,MAAM,QAAQF,CAAa,IAAIA,IAAgB,CAAA,GAAI,IAAI,MAAM,CAAC,GACxFG,IAAW,IAAI,KAAKP,EAAQ,4BAA4B,CAAA,GAAI,IAAI,MAAM,CAAC,GACvEQ,IAAkB,IAAI;AAAA,IAC1BC,EAA+BT,EAAQ,yBAAyBC,CAAI;AAAA,EAAA,GAGhES,IAAmC,CAAA,GACnCC,IAGD,CAAA,GACCC,IAA+B,CAAA,GAC/BC,IAASX;AAEf,aAAW,CAACY,GAAMC,CAAS,KAAK,OAAO,QAAQhB,CAAe,GAAG;AAC/D,QAAIO,EAAe,IAAIQ,CAAI,EAAG;AAC9B,IAAAF,EAAmB,KAAKE,CAAI;AAE5B,UAAME,IAAgBH,EAAOC,CAAI,KAAK;AAItC,QAFAJ,EAAMI,CAAI,IAAIG,EAAaF,CAAS,GAEhC,CAACR,EAAS,IAAIO,CAAI,GAAG;AACvB,YAAMI,IAAoBV,EAAgB,IAAIM,CAAI;AAElD,MAAI,OAAOE,KAAkB,aAC3BL,EAAgB,KAAK;AAAA,QACnB,MAAAG;AAAA,QACA,WAAWI,IAAoB,MAAM,KAAOF;AAAA,MAAA,CAC7C,KAEkBA,MAAkB,YAAYA,MAAkBf,KAAQiB,MAEzEP,EAAgB,KAAK,EAAE,MAAAG,GAAM,WAAW,MAAM,IAAM;AAAA,IAG1D;AAAA,EACF;AAEA,QAAMK,IAAiBR,EAAgB,SAAS,KAAKX,EAAQ;AAC7D,MAAIoB,IAAoBC,EAAE,OAAOX,CAAK;AAEtC,EAAIS,MACFC,IAAUA,EAAuB;AAAA,IAC/B,CAACE,GAA+BC,MAAyB;AACvD,YAAMC,IAAYF,GACZG,IAAcpB,IAChB,IAAI,IAAIA,EAAgBmB,GAAWvB,CAAI,EAAE,IAAI,MAAM,CAAC,IACpD;AAEJ,iBAAW,EAAE,MAAAa,GAAM,WAAAY,EAAA,KAAef;AAChC,QAAIc,GAAa,IAAIX,CAAI,KACrBY,EAAUJ,GAAMrB,CAAI,KAAK0B,EAAQL,EAAKR,CAAI,CAAC,KAC7CS,EAAI,SAAS;AAAA,UACX,MAAMF,EAAE,aAAa;AAAA,UACrB,MAAM,CAACP,CAAI;AAAA,UACX,SAASX;AAAA,QAAA,CACV;AAIL,MAAAH,EAAQ,cAAcwB,GAAWD,CAAG;AAAA,IACtC;AAAA,EAAA;AAIJ,QAAMK,IAAgBC,EAAoBlB,GAAiBV,CAAI;AAE/D,WAAS6B,EAAkBR,GAAgC;AACzD,UAAMS,IAA0C,CAAA;AAEhD,eAAWjB,KAAQF,GAAoB;AACrC,YAAMI,IAAgBH,EAAOC,CAAI,KAAK;AAEtC,MAAIN,EAAgB,IAAIM,CAAI,IAC1BiB,EAASjB,CAAI,IAAI,EAAE,MAAAA,GAAM,YAAY,GAAA,IAC5B,OAAOE,KAAkB,aAClCe,EAASjB,CAAI,IAAI,EAAE,MAAAA,GAAM,YAAYQ,IAAON,EAAcM,GAAMrB,CAAI,IAAI,GAAA,IAExE8B,EAASjB,CAAI,IAAI;AAAA,QACf,MAAAA;AAAA,QACA,YAAYE,MAAkB,YAAYA,MAAkBf;AAAA,MAAA,GAI5DM,EAAS,IAAIO,CAAI,MACnBiB,EAASjB,CAAI,EAAE,mBAAmB;AAAA,IAEtC;AAEA,WAAOiB;AAAA,EACT;AAKA,SAAO;AAAA,IACLX;AAAA,IACA,EAAE,mBAAAU,GAAmB,eAAAF,EAAA;AAAA,EAAc;AAEvC;AAIA,SAASnB,EACPuB,GACA/B,GACU;AACV,SAAK+B,KACI/B,MAAS,WAAW+B,EAAM,SAASA,EAAM,WAAW,CAAA,IAD1C,CAAA;AAErB;AAEA,SAASf,EAAaF,GAAiC;AACrD,SAAOM,EAAE,WAAW,CAAAY,MAAMN,EAAQM,CAAC,IAAI,SAAYA,GAAIlB,EAAU,SAAA,CAAU;AAC7E;AAEA,SAASY,EAAQK,GAAyB;AAGxC,SAFI,GAAuBA,KAAU,QACjC,OAAOA,KAAU,YAAYA,EAAM,KAAA,MAAW,MAC9C,OAAOA,KAAU,YAAY,OAAO,MAAMA,CAAK;AAErD;AAkBA,SAASH,EACPlB,GAIAV,GACU;AACV,QAAMiC,wBAAW,IAAA;AAEjB,aAAW,EAAE,WAAAR,EAAA,KAAef,GAAiB;AAC3C,QAAIwB,EAAoBT,CAAS,EAAG;AAEpC,UAAMU,IAAqB,CAAA,GACrBC,IAAQ,IAAI,MAAM,IAA+B;AAAA,MACrD,IAAIC,GAASC,GAAM;AACjB,QAAI,OAAOA,KAAS,YAAUH,EAAS,KAAKG,CAAI;AAAA,MAElD;AAAA,IAAA,CACD;AAED,QAAI;AACF,MAAAb,EAAUW,GAAOpC,CAAI;AAAA,IACvB,QAAQ;AAAA,IAER;AAEA,eAAWuC,KAAOJ,EAAU,CAAAF,EAAK,IAAIM,CAAG;AAAA,EAC1C;AAEA,SAAO,CAAC,GAAGN,CAAI;AACjB;AAQA,SAASC,EACPT,GACS;AACT,QAAMU,IAAqB,CAAA,GACrBC,IAAQ,IAAI,MAAM,IAA+B;AAAA,IACrD,IAAIC,GAASC,GAAM;AACjB,MAAI,OAAOA,KAAS,YAAUH,EAAS,KAAKG,CAAI;AAAA,IAElD;AAAA,EAAA,CACD;AACD,MAAI;AACF,IAAAb,EAAUW,GAAO,QAAQ;AAAA,EAC3B,QAAQ;AAAA,EAER;AACA,SAAOD,EAAS,WAAW;AAC7B;"}
+{"version":3,"file":"buildFormSchema.js","sources":["../../../src/partner-hook-utils/form/buildFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport type { FieldMetadata } from '../types'\n\n// ── Types ────────────────────────────────────────────────────────────\n\n/**\n * Form lifecycle mode used to vary requiredness and validation rules.\n *\n * @internal\n */\ntype FormMode = 'create' | 'update'\n\n/**\n * Per-field requiredness rule.\n *\n * String values apply requiredness in a fixed mode (`'always'`, `'create'`,\n * `'update'`, or `'never'`). A function form receives the current form data\n * and mode so requiredness can depend on other field values at runtime.\n *\n * @typeParam TData - The shape of the form data passed to predicate rules.\n * @internal\n */\ntype RequiredFieldRule<TData = Record<string, unknown>> =\n  'create' | 'update' | 'always' | 'never' | ((data: TData, mode: FormMode) => boolean)\n\n/**\n * Mapping from each field name in a schema to its {@link RequiredFieldRule}.\n *\n * @typeParam TSchema - The map of field names to their Zod validators.\n * @internal\n */\nexport type RequiredFieldConfig<TSchema extends Record<string, z.ZodType>> = Partial<{\n  [K in keyof TSchema & string]: RequiredFieldRule<{\n    [F in keyof TSchema]: z.infer<TSchema[F]>\n  }>\n}>\n\n/**\n * A predicate (value-conditional) requiredness rule. Matches any function\n * signature so predicate rules are recognized regardless of their parameter or\n * return types. Such fields are never statically required in a given mode, so\n * they're eligible for promotion — see {@link OptionalOnCreate}.\n */\ntype PredicateRule = (...args: never[]) => unknown\n\n/**\n * Union of field names in `TConfig` that are not statically required in create\n * mode and are therefore eligible to be promoted to required in create mode:\n * fields whose base rule is `'update'`, `'never'`, or a predicate. Promoting a\n * predicate field upgrades it from conditionally required to always required.\n *\n * The template-literal wrapper \\`\\` `${...}` \\`\\` is intentional: wrapping a\n * conditional-mapped-type index access in a template literal forces TypeScript\n * to eagerly evaluate and materialize the string union rather than deferring\n * it. Without the wrapper, TypeScript preserves the alias name in hover\n * tooltips and generated docs (`OptionalOnCreate<{ ... }>`), making the type\n * opaque to callers. With it, both IntelliSense and TypeDoc display the\n * resolved concrete union (e.g. `\"stateWcCovered\" | \"twoPercentShareholder\"`).\n */\ntype OptionalOnCreate<TConfig> = `${{\n  [K in keyof TConfig & string]: TConfig[K] extends 'update' | 'never' | PredicateRule ? K : never\n}[keyof TConfig & string]}`\n\n/**\n * Union of field names in `TConfig` that are not statically required in update\n * mode and are therefore eligible to be promoted to required in update mode:\n * fields whose base rule is `'create'`, `'never'`, or a predicate.\n *\n * See {@link OptionalOnCreate} for why the template-literal wrapper is here.\n */\ntype OptionalOnUpdate<TConfig> = `${{\n  [K in keyof TConfig & string]: TConfig[K] extends 'create' | 'never' | PredicateRule ? K : never\n}[keyof TConfig & string]}`\n\n/**\n * Per-mode list of optional fields a caller can promote to required.\n *\n * Only fields whose base rule allows the override appear in the `create` /\n * `update` arrays — fields that are already required in a given mode are\n * excluded from that mode's list at the type level. Value-conditional\n * (predicate) fields are eligible in both modes; listing one promotes it from\n * conditionally required to always required for that mode.\n *\n * @typeParam TConfig - The {@link RequiredFieldConfig} that constrains which fields are eligible.\n * @internal\n * @interface\n */\nexport type OptionalFieldsToRequire<TConfig> = {\n  /** Fields that can be required in create mode */\n  create?: Array<OptionalOnCreate<TConfig>>\n  /** Fields that can be required in update mode */\n  update?: Array<OptionalOnUpdate<TConfig>>\n}\n\n// ── buildFormSchema ──────────────────────────────────────────────────\n\ninterface BuildFormSchemaOptions<\n  T extends Record<string, z.ZodType>,\n  TConfig extends RequiredFieldConfig<T>,\n> {\n  requiredFieldsConfig?: TConfig\n  requiredErrorCode?: string\n  mode: FormMode\n  optionalFieldsToRequire?: OptionalFieldsToRequire<TConfig>\n  /**\n   * Fields that don't apply and should be dropped from required validation.\n   *\n   * An **array** removes the fields at build time — they're absent from the\n   * schema shape entirely (use when applicability is fixed by a config flag).\n   *\n   * A **function** is evaluated against the values under validation, so a field\n   * can flip in/out of applicability as other values change. The field stays in\n   * the schema (validated as optional) but its required check is skipped while\n   * the function reports it as excluded.\n   */\n  excludeFields?:\n    | Array<keyof T & string>\n    | ((data: { [K in keyof T]: z.infer<T[K]> }, mode: FormMode) => Array<keyof T & string>)\n  /** Fields with existing server-side values that are redacted in the API response\n   *  (e.g. SSN, EIN). These fields remain in the schema for format validation and\n   *  appear in metadata (with `hasRedactedValue: true`) but are exempt from required\n   *  validation — an empty submission is valid because a value already exists. */\n  fieldsWithRedactedValues?: Array<keyof T & string>\n  superRefine?: (data: { [K in keyof T]: z.infer<T[K]> }, ctx: z.RefinementCtx) => void\n}\n\n/**\n * Companion config returned alongside a built schema, used to derive per-field\n * metadata and to identify which form values predicate-based rules depend on.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @internal\n */\nexport interface FieldsMetadataConfig<T extends Record<string, z.ZodType>> {\n  getFieldsMetadata: (data?: Record<string, unknown>) => Record<keyof T, FieldMetadata>\n  /** Form field names that predicate-based requiredness rules read at runtime. */\n  predicateDeps: string[]\n}\n\ntype FormDataFromValidators<T extends Record<string, z.ZodType>> = {\n  [K in keyof T]: z.infer<T[K]>\n}\n\n/**\n * Tuple returned by {@link buildFormSchema}: the composed Zod schema followed\n * by its {@link FieldsMetadataConfig}.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @internal\n */\nexport type BuildFormSchemaResult<T extends Record<string, z.ZodType>> = [\n  schema: z.ZodType<FormDataFromValidators<T>, FormDataFromValidators<T>>,\n  metadataConfig: FieldsMetadataConfig<T>,\n]\n\n/**\n * Composes a Zod object schema and matching metadata config from a map of\n * per-field validators, applying mode-aware requiredness rules.\n *\n * @remarks\n * Every field is wrapped to coerce empty strings, `null`, `undefined`, and\n * `NaN` to `undefined` before validation, so blank inputs surface as missing\n * rather than as type-mismatch errors. Required-field checks run in a\n * `superRefine` pass that emits an issue keyed by `requiredErrorCode` (defaults\n * to `REQUIRED`) for each unfilled required field.\n *\n * Fields listed in `fieldsWithRedactedValues` remain in the schema for format\n * validation and appear in metadata with `hasRedactedValue: true`, but are\n * exempt from required-field validation because a server-side value already\n * exists.\n *\n * @typeParam T - The map of field names to their Zod validators.\n * @typeParam TConfig - The shape of the requiredness configuration.\n * @param fieldValidators - Map from field name to the validator that runs when a value is present.\n * @param options - Mode, required-field config, redaction list, and optional `superRefine`.\n * @returns A {@link BuildFormSchemaResult} tuple: the schema and its metadata config.\n * @internal\n */\nexport function buildFormSchema<\n  T extends Record<string, z.ZodType>,\n  TConfig extends RequiredFieldConfig<T>,\n>(fieldValidators: T, options: BuildFormSchemaOptions<T, TConfig>): BuildFormSchemaResult<T> {\n  const {\n    mode,\n    requiredFieldsConfig = {} as Record<string, RequiredFieldRule>,\n    requiredErrorCode = 'REQUIRED',\n    excludeFields = [],\n  } = options\n  // The array form removes fields at build time; the function form is resolved\n  // per-validation in the superRefine pass below.\n  const excludeFieldsFn = typeof excludeFields === 'function' ? excludeFields : undefined\n  const staticExcluded = new Set((Array.isArray(excludeFields) ? excludeFields : []).map(String))\n  const redacted = new Set((options.fieldsWithRedactedValues ?? []).map(String))\n  const partnerRequired = new Set(\n    resolveOptionalFieldsToRequire(options.optionalFieldsToRequire, mode),\n  )\n\n  const shape: Record<string, z.ZodType> = {}\n  const dynamicRequired: Array<{\n    name: string\n    predicate: (data: Record<string, unknown>, mode: FormMode) => boolean\n  }> = []\n  const includedFieldNames: string[] = []\n  const config = requiredFieldsConfig as Record<string, RequiredFieldRule>\n\n  for (const [name, validator] of Object.entries(fieldValidators)) {\n    if (staticExcluded.has(name)) continue\n    includedFieldNames.push(name)\n\n    const effectiveRule = config[name] ?? 'always'\n\n    shape[name] = makeOptional(validator)\n\n    if (!redacted.has(name)) {\n      const isPartnerRequired = partnerRequired.has(name)\n\n      if (typeof effectiveRule === 'function') {\n        dynamicRequired.push({\n          name,\n          predicate: isPartnerRequired ? () => true : effectiveRule,\n        })\n      } else {\n        const isRequired = effectiveRule === 'always' || effectiveRule === mode || isPartnerRequired\n        if (isRequired) {\n          dynamicRequired.push({ name, predicate: () => true })\n        }\n      }\n    }\n  }\n\n  const hasSuperRefine = dynamicRequired.length > 0 || options.superRefine\n  const objectSchema = z.object(shape)\n\n  let schema: z.ZodType = excludeFieldsFn\n    ? z.preprocess((val: unknown) => {\n        if (typeof val !== 'object' || val === null) return val\n        const data = { ...(val as Record<string, unknown>) }\n        for (const key of excludeFieldsFn(data as FormDataFromValidators<T>, mode)) {\n          data[key as string] = undefined\n        }\n        return data\n      }, objectSchema)\n    : objectSchema\n\n  if (hasSuperRefine) {\n    schema = (schema as z.ZodObject).superRefine(\n      (data: Record<string, unknown>, ctx: z.RefinementCtx) => {\n        const typedData = data as FormDataFromValidators<T>\n        const excludedNow = excludeFieldsFn\n          ? new Set(excludeFieldsFn(typedData, mode).map(String))\n          : undefined\n\n        for (const { name, predicate } of dynamicRequired) {\n          if (excludedNow?.has(name)) continue\n          if (predicate(data, mode) && isEmpty(data[name])) {\n            ctx.addIssue({\n              code: z.ZodIssueCode.custom,\n              path: [name],\n              message: requiredErrorCode,\n            })\n          }\n        }\n\n        options.superRefine?.(typedData, ctx)\n      },\n    )\n  }\n\n  const predicateDeps = detectPredicateDeps(dynamicRequired, mode)\n\n  function getFieldsMetadata(data?: Record<string, unknown>) {\n    const metadata: Record<string, FieldMetadata> = {}\n\n    for (const name of includedFieldNames) {\n      const effectiveRule = config[name] ?? 'always'\n\n      if (partnerRequired.has(name)) {\n        metadata[name] = { name, isRequired: true }\n      } else if (typeof effectiveRule === 'function') {\n        metadata[name] = { name, isRequired: data ? effectiveRule(data, mode) : false }\n      } else {\n        metadata[name] = {\n          name,\n          isRequired: effectiveRule === 'always' || effectiveRule === mode,\n        }\n      }\n\n      if (redacted.has(name)) {\n        metadata[name].hasRedactedValue = true\n      }\n    }\n\n    return metadata as Record<keyof T, FieldMetadata>\n  }\n\n  // makeOptional wraps fields with z.preprocess, which causes z.input to infer\n  // `unknown`. Cast the schema to carry the original field types so zodResolver\n  // infers correct form data types — consumers don't need per-hook casts.\n  return [\n    schema as z.ZodType<FormDataFromValidators<T>, FormDataFromValidators<T>>,\n    { getFieldsMetadata, predicateDeps },\n  ]\n}\n\n// ── Internal helpers ─────────────────────────────────────────────────\n\nfunction resolveOptionalFieldsToRequire<TConfig>(\n  value: OptionalFieldsToRequire<TConfig> | undefined,\n  mode: FormMode,\n): string[] {\n  if (!value) return []\n  return ((mode === 'create' ? value.create : value.update) ?? []) as string[]\n}\n\nfunction makeOptional(validator: z.ZodType): z.ZodType {\n  return z.preprocess(v => (isEmpty(v) ? undefined : v), validator.optional())\n}\n\nfunction isEmpty(value: unknown): boolean {\n  if (value === undefined || value === null) return true\n  if (typeof value === 'string' && value.trim() === '') return true\n  if (typeof value === 'number' && Number.isNaN(value)) return true\n  return false\n}\n\n/**\n * Determines which form field names are read by predicate-based requiredness\n * rules. This enables `useDeriveFieldsMetadata` to watch only the specific\n * fields that predicates depend on, rather than subscribing to every form\n * value change (which defeats react-hook-form's per-field render optimization).\n *\n * Works by running each predicate against a recording Proxy. The Proxy\n * intercepts property access and logs the keys, giving us the dependency list\n * without requiring manual declaration.\n *\n * Limitation: JavaScript short-circuit evaluation (`a && b`) can prevent the\n * Proxy from seeing later operands when earlier ones are falsy. In practice\n * this is acceptable — our predicate rules read a single form value each\n * (e.g. `data => data.adjustForMinimumWage`). Multi-field predicates with\n * equality guards should be expressed as `superRefine` rules instead.\n */\nfunction detectPredicateDeps(\n  dynamicRequired: Array<{\n    name: string\n    predicate: (data: Record<string, unknown>, mode: FormMode) => boolean\n  }>,\n  mode: FormMode,\n): string[] {\n  const deps = new Set<string>()\n\n  for (const { predicate } of dynamicRequired) {\n    if (isConstantPredicate(predicate)) continue\n\n    const accessed: string[] = []\n    const proxy = new Proxy({} as Record<string, unknown>, {\n      get(_target, prop) {\n        if (typeof prop === 'string') accessed.push(prop)\n        return undefined\n      },\n    })\n\n    try {\n      predicate(proxy, mode)\n    } catch {\n      /* Predicate may throw on undefined values — that's fine, we already captured the property accesses */\n    }\n\n    for (const key of accessed) deps.add(key)\n  }\n\n  return [...deps]\n}\n\n/**\n * Static predicates (e.g. `() => true` from 'always' / mode rules / partner\n * overrides) don't access form data, so we skip them during dependency\n * detection. We identify them by running against an empty proxy and checking\n * whether any properties were accessed.\n */\nfunction isConstantPredicate(\n  predicate: (data: Record<string, unknown>, mode: FormMode) => boolean,\n): boolean {\n  const accessed: string[] = []\n  const proxy = new Proxy({} as Record<string, unknown>, {\n    get(_target, prop) {\n      if (typeof prop === 'string') accessed.push(prop)\n      return undefined\n    },\n  })\n  try {\n    predicate(proxy, 'create')\n  } catch {\n    /* ignore */\n  }\n  return accessed.length === 0\n}\n"],"names":["buildFormSchema","fieldValidators","options","mode","requiredFieldsConfig","requiredErrorCode","excludeFields","excludeFieldsFn","staticExcluded","redacted","partnerRequired","resolveOptionalFieldsToRequire","shape","dynamicRequired","includedFieldNames","config","name","validator","effectiveRule","makeOptional","isPartnerRequired","hasSuperRefine","objectSchema","z","schema","val","data","key","ctx","typedData","excludedNow","predicate","isEmpty","predicateDeps","detectPredicateDeps","getFieldsMetadata","metadata","value","v","deps","isConstantPredicate","accessed","proxy","_target","prop"],"mappings":";AAkLO,SAASA,EAGdC,GAAoBC,GAAuE;AAC3F,QAAM;AAAA,IACJ,MAAAC;AAAA,IACA,sBAAAC,IAAuB,CAAA;AAAA,IACvB,mBAAAC,IAAoB;AAAA,IACpB,eAAAC,IAAgB,CAAA;AAAA,EAAC,IACfJ,GAGEK,IAAkB,OAAOD,KAAkB,aAAaA,IAAgB,QACxEE,IAAiB,IAAI,KAAK,MAAM,QAAQF,CAAa,IAAIA,IAAgB,CAAA,GAAI,IAAI,MAAM,CAAC,GACxFG,IAAW,IAAI,KAAKP,EAAQ,4BAA4B,CAAA,GAAI,IAAI,MAAM,CAAC,GACvEQ,IAAkB,IAAI;AAAA,IAC1BC,EAA+BT,EAAQ,yBAAyBC,CAAI;AAAA,EAAA,GAGhES,IAAmC,CAAA,GACnCC,IAGD,CAAA,GACCC,IAA+B,CAAA,GAC/BC,IAASX;AAEf,aAAW,CAACY,GAAMC,CAAS,KAAK,OAAO,QAAQhB,CAAe,GAAG;AAC/D,QAAIO,EAAe,IAAIQ,CAAI,EAAG;AAC9B,IAAAF,EAAmB,KAAKE,CAAI;AAE5B,UAAME,IAAgBH,EAAOC,CAAI,KAAK;AAItC,QAFAJ,EAAMI,CAAI,IAAIG,EAAaF,CAAS,GAEhC,CAACR,EAAS,IAAIO,CAAI,GAAG;AACvB,YAAMI,IAAoBV,EAAgB,IAAIM,CAAI;AAElD,MAAI,OAAOE,KAAkB,aAC3BL,EAAgB,KAAK;AAAA,QACnB,MAAAG;AAAA,QACA,WAAWI,IAAoB,MAAM,KAAOF;AAAA,MAAA,CAC7C,KAEkBA,MAAkB,YAAYA,MAAkBf,KAAQiB,MAEzEP,EAAgB,KAAK,EAAE,MAAAG,GAAM,WAAW,MAAM,IAAM;AAAA,IAG1D;AAAA,EACF;AAEA,QAAMK,IAAiBR,EAAgB,SAAS,KAAKX,EAAQ,aACvDoB,IAAeC,EAAE,OAAOX,CAAK;AAEnC,MAAIY,IAAoBjB,IACpBgB,EAAE,WAAW,CAACE,MAAiB;AAC7B,QAAI,OAAOA,KAAQ,YAAYA,MAAQ,KAAM,QAAOA;AACpD,UAAMC,IAAO,EAAE,GAAID,EAAA;AACnB,eAAWE,KAAOpB,EAAgBmB,GAAmCvB,CAAI;AACvE,MAAAuB,EAAKC,CAAa,IAAI;AAExB,WAAOD;AAAA,EACT,GAAGJ,CAAY,IACfA;AAEJ,EAAID,MACFG,IAAUA,EAAuB;AAAA,IAC/B,CAACE,GAA+BE,MAAyB;AACvD,YAAMC,IAAYH,GACZI,IAAcvB,IAChB,IAAI,IAAIA,EAAgBsB,GAAW1B,CAAI,EAAE,IAAI,MAAM,CAAC,IACpD;AAEJ,iBAAW,EAAE,MAAAa,GAAM,WAAAe,EAAA,KAAelB;AAChC,QAAIiB,GAAa,IAAId,CAAI,KACrBe,EAAUL,GAAMvB,CAAI,KAAK6B,EAAQN,EAAKV,CAAI,CAAC,KAC7CY,EAAI,SAAS;AAAA,UACX,MAAML,EAAE,aAAa;AAAA,UACrB,MAAM,CAACP,CAAI;AAAA,UACX,SAASX;AAAA,QAAA,CACV;AAIL,MAAAH,EAAQ,cAAc2B,GAAWD,CAAG;AAAA,IACtC;AAAA,EAAA;AAIJ,QAAMK,IAAgBC,EAAoBrB,GAAiBV,CAAI;AAE/D,WAASgC,EAAkBT,GAAgC;AACzD,UAAMU,IAA0C,CAAA;AAEhD,eAAWpB,KAAQF,GAAoB;AACrC,YAAMI,IAAgBH,EAAOC,CAAI,KAAK;AAEtC,MAAIN,EAAgB,IAAIM,CAAI,IAC1BoB,EAASpB,CAAI,IAAI,EAAE,MAAAA,GAAM,YAAY,GAAA,IAC5B,OAAOE,KAAkB,aAClCkB,EAASpB,CAAI,IAAI,EAAE,MAAAA,GAAM,YAAYU,IAAOR,EAAcQ,GAAMvB,CAAI,IAAI,GAAA,IAExEiC,EAASpB,CAAI,IAAI;AAAA,QACf,MAAAA;AAAA,QACA,YAAYE,MAAkB,YAAYA,MAAkBf;AAAA,MAAA,GAI5DM,EAAS,IAAIO,CAAI,MACnBoB,EAASpB,CAAI,EAAE,mBAAmB;AAAA,IAEtC;AAEA,WAAOoB;AAAA,EACT;AAKA,SAAO;AAAA,IACLZ;AAAA,IACA,EAAE,mBAAAW,GAAmB,eAAAF,EAAA;AAAA,EAAc;AAEvC;AAIA,SAAStB,EACP0B,GACAlC,GACU;AACV,SAAKkC,KACIlC,MAAS,WAAWkC,EAAM,SAASA,EAAM,WAAW,CAAA,IAD1C,CAAA;AAErB;AAEA,SAASlB,EAAaF,GAAiC;AACrD,SAAOM,EAAE,WAAW,CAAAe,MAAMN,EAAQM,CAAC,IAAI,SAAYA,GAAIrB,EAAU,SAAA,CAAU;AAC7E;AAEA,SAASe,EAAQK,GAAyB;AAGxC,SAFI,GAAuBA,KAAU,QACjC,OAAOA,KAAU,YAAYA,EAAM,KAAA,MAAW,MAC9C,OAAOA,KAAU,YAAY,OAAO,MAAMA,CAAK;AAErD;AAkBA,SAASH,EACPrB,GAIAV,GACU;AACV,QAAMoC,wBAAW,IAAA;AAEjB,aAAW,EAAE,WAAAR,EAAA,KAAelB,GAAiB;AAC3C,QAAI2B,EAAoBT,CAAS,EAAG;AAEpC,UAAMU,IAAqB,CAAA,GACrBC,IAAQ,IAAI,MAAM,IAA+B;AAAA,MACrD,IAAIC,GAASC,GAAM;AACjB,QAAI,OAAOA,KAAS,YAAUH,EAAS,KAAKG,CAAI;AAAA,MAElD;AAAA,IAAA,CACD;AAED,QAAI;AACF,MAAAb,EAAUW,GAAOvC,CAAI;AAAA,IACvB,QAAQ;AAAA,IAER;AAEA,eAAWwB,KAAOc,EAAU,CAAAF,EAAK,IAAIZ,CAAG;AAAA,EAC1C;AAEA,SAAO,CAAC,GAAGY,CAAI;AACjB;AAQA,SAASC,EACPT,GACS;AACT,QAAMU,IAAqB,CAAA,GACrBC,IAAQ,IAAI,MAAM,IAA+B;AAAA,IACrD,IAAIC,GAASC,GAAM;AACjB,MAAI,OAAOA,KAAS,YAAUH,EAAS,KAAKG,CAAI;AAAA,IAElD;AAAA,EAAA,CACD;AACD,MAAI;AACF,IAAAb,EAAUW,GAAO,QAAQ;AAAA,EAC3B,QAAQ;AAAA,EAER;AACA,SAAOD,EAAS,WAAW;AAC7B;"}

package/dist/shared/constants.d.ts

@@ -333,6 +333,7 @@ export declare const payScheduleEvents: {
 export declare const runPayrollEvents: {
     readonly RUN_PAYROLL_BACK: "runPayroll/back";
     readonly RUN_PAYROLL_CALCULATED: "runPayroll/calculated";
+    readonly RUN_PAYROLL_ALREADY_PROCESSED: "runPayroll/alreadyProcessed";
     readonly RUN_PAYROLL_CANCELLED: "runPayroll/cancelled";
     readonly RUN_PAYROLL_CANCELLED_ALERT_DISMISSED: "runPayroll/cancelled/alertDismissed";
     readonly RUN_PAYROLL_EDIT: "runPayroll/edit";
@@ -413,6 +414,25 @@ export declare const recoveryCasesEvents: {
     readonly RECOVERY_CASE_RESUBMIT_CANCEL: "recoveryCase/resubmit/cancel";
     readonly RECOVERY_CASE_RESUBMIT_DONE: "recoveryCase/resubmit/done";
 };
+/**
+ * Event keys emitted by the print-checks component.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of the print-checks component and compare against the
+ * value of an entry on this object.
+ *
+ * @public
+ */
+export declare const printChecksEvents: {
+    readonly PRINT_CHECKS_START: "payroll/printChecks/start";
+    readonly PRINT_CHECKS_GENERATE_START: "payroll/printChecks/generate/start";
+    readonly PRINT_CHECKS_GENERATE_SUCCEEDED: "payroll/printChecks/generate/succeeded";
+    readonly PRINT_CHECKS_GENERATE_FAILED: "payroll/printChecks/generate/failed";
+    readonly PRINT_CHECKS_RETRY: "payroll/printChecks/retry";
+    readonly PRINT_CHECKS_CANCEL: "payroll/printChecks/cancel";
+    readonly PRINT_CHECKS_CLOSE: "payroll/printChecks/close";
+};
 /**
  * Event keys emitted by off-cycle payroll and transition components.
  *
@@ -561,6 +581,13 @@ export declare const componentEvents: {
     readonly CONTRACTOR_PAYMENT_CANCEL: "contractor/payments/cancel";
     readonly CONTRACTOR_PAYMENT_EXIT: "contractor/payments/exit";
     readonly CONTRACTOR_PAYMENT_RFI_RESPOND: "contractor/payments/rfi/respond";
+    readonly PRINT_CHECKS_START: "payroll/printChecks/start";
+    readonly PRINT_CHECKS_GENERATE_START: "payroll/printChecks/generate/start";
+    readonly PRINT_CHECKS_GENERATE_SUCCEEDED: "payroll/printChecks/generate/succeeded";
+    readonly PRINT_CHECKS_GENERATE_FAILED: "payroll/printChecks/generate/failed";
+    readonly PRINT_CHECKS_RETRY: "payroll/printChecks/retry";
+    readonly PRINT_CHECKS_CANCEL: "payroll/printChecks/cancel";
+    readonly PRINT_CHECKS_CLOSE: "payroll/printChecks/close";
     readonly RECOVERY_CASE_RESOLVE: "recoveryCase/resolve";
     readonly RECOVERY_CASE_RESUBMIT: "recoveryCase/resubmit";
     readonly RECOVERY_CASE_RESUBMIT_CANCEL: "recoveryCase/resubmit/cancel";
@@ -577,6 +604,7 @@ export declare const componentEvents: {
     readonly PAYROLL_WIRE_FORM_CANCEL: "payroll/wire/form/cancel";
     readonly RUN_PAYROLL_BACK: "runPayroll/back";
     readonly RUN_PAYROLL_CALCULATED: "runPayroll/calculated";
+    readonly RUN_PAYROLL_ALREADY_PROCESSED: "runPayroll/alreadyProcessed";
     readonly RUN_PAYROLL_CANCELLED: "runPayroll/cancelled";
     readonly RUN_PAYROLL_CANCELLED_ALERT_DISMISSED: "runPayroll/cancelled/alertDismissed";
     readonly RUN_PAYROLL_EDIT: "runPayroll/edit";

package/dist/shared/constants.js

@@ -246,6 +246,7 @@ const t = {
 }, M = {
   RUN_PAYROLL_BACK: "runPayroll/back",
   RUN_PAYROLL_CALCULATED: "runPayroll/calculated",
+  RUN_PAYROLL_ALREADY_PROCESSED: "runPayroll/alreadyProcessed",
   RUN_PAYROLL_CANCELLED: "runPayroll/cancelled",
   RUN_PAYROLL_CANCELLED_ALERT_DISMISSED: "runPayroll/cancelled/alertDismissed",
   RUN_PAYROLL_EDIT: "runPayroll/edit",
@@ -293,12 +294,20 @@ const t = {
   RECOVERY_CASE_RESUBMIT_CANCEL: "recoveryCase/resubmit/cancel",
   RECOVERY_CASE_RESUBMIT_DONE: "recoveryCase/resubmit/done"
 }, d = {
+  PRINT_CHECKS_START: "payroll/printChecks/start",
+  PRINT_CHECKS_GENERATE_START: "payroll/printChecks/generate/start",
+  PRINT_CHECKS_GENERATE_SUCCEEDED: "payroll/printChecks/generate/succeeded",
+  PRINT_CHECKS_GENERATE_FAILED: "payroll/printChecks/generate/failed",
+  PRINT_CHECKS_RETRY: "payroll/printChecks/retry",
+  PRINT_CHECKS_CANCEL: "payroll/printChecks/cancel",
+  PRINT_CHECKS_CLOSE: "payroll/printChecks/close"
+}, C = {
   OFF_CYCLE_CREATED: "offCycle/created",
   DISMISSAL_PAY_PERIOD_SELECTED: "dismissal/payPeriod/selected",
   TRANSITION_CREATED: "transition/created",
   RUN_TRANSITION_PAYROLL: "transition/runPayroll",
   TRANSITION_PAYROLL_SKIPPED: "transition/payrollSkipped"
-}, C = {
+}, c = {
   TIME_OFF_CREATE_POLICY: "timeOff/createPolicy",
   TIME_OFF_VIEW_POLICY: "timeOff/viewPolicy",
   TIME_OFF_POLICY_TYPE_SELECTED: "timeOff/policyTypeSelected",
@@ -326,7 +335,7 @@ const t = {
   TIME_OFF_EDIT_HOLIDAY_POLICY: "timeOff/editHolidayPolicy",
   TIME_OFF_HOLIDAY_SELECTION_EDIT_DONE: "timeOff/holidaySelection/editDone",
   TIME_OFF_DELETE_POLICY_DONE: "timeOff/deletePolicy/done"
-}, p = {
+}, y = {
   ROBOT_MACHINE_DONE: "done",
   //This is internal Robot event thrown when machine transitions to final state
   ERROR: "ERROR",
@@ -340,11 +349,12 @@ const t = {
   ...D,
   ...r,
   ...m,
+  ...d,
   ...n,
   ...a,
-  ...d,
+  ...C,
   ...N,
-  ...C
+  ...c
 }, A = {
   ADMIN_ONBOARDING_INCOMPLETE: E.AdminOnboardingIncomplete,
   SELF_ONBOARDING_PENDING_INVITE: E.SelfOnboardingPendingInvite,
@@ -366,23 +376,23 @@ const t = {
   SELF_ONBOARDING_STARTED: e.SelfOnboardingStarted,
   SELF_ONBOARDING_REVIEW: e.SelfOnboardingReview,
   ONBOARDING_COMPLETED: e.OnboardingCompleted
-}, y = /* @__PURE__ */ new Set([
+}, U = /* @__PURE__ */ new Set([
   _.SELF_ONBOARDING_NOT_INVITED,
   _.SELF_ONBOARDING_INVITED,
   _.SELF_ONBOARDING_STARTED,
   _.SELF_ONBOARDING_REVIEW
-]), U = {
+]), u = {
   EXEMPT: "Exempt",
   SALARIED_NONEXEMPT: "Salaried Nonexempt",
   NONEXEMPT: "Nonexempt",
   OWNER: "Owner",
   COMMISSION_ONLY_EXEMPT: "Commission Only Exempt",
   COMMISSION_ONLY_NONEXEMPT: "Commission Only Nonexempt"
-}, u = {
+}, F = {
   REGULAR_HOURS_NAME: "regular hours",
   OVERTIME_NAME: "overtime",
   DOUBLE_OVERTIME_NAME: "double overtime"
-}, F = 35568, g = 40, G = 173.333333, f = 2080, B = "US_I-9", b = [
+}, g = 35568, G = 40, f = 173.333333, B = 2080, b = "US_I-9", H = [
   "AL",
   "AK",
   "AZ",
@@ -434,7 +444,7 @@ const t = {
   "WV",
   "WI",
   "WY"
-], H = {
+], h = {
   OWNER: "owner",
   PRESIDENT: "president",
   VICE_PRESIDENT: "vice_president",
@@ -442,7 +452,7 @@ const t = {
   CORPORATE_OFFICER: "corporate_officer",
   PARTNER: "partner",
   MEMBER: "member"
-}, h = {
+}, v = {
   HOUR: "Hour",
   WEEK: "Week",
   MONTH: "Month",
@@ -453,82 +463,83 @@ const t = {
   SMALL: "small",
   MEDIUM: "medium",
   LARGE: "large"
-}, v = {
+}, V = {
   [O.BASE]: "0rem",
   [O.SMALL]: "40rem",
   [O.MEDIUM]: "48rem",
   [O.LARGE]: "64rem"
-}, V = {
+}, W = {
   check: "Check",
   directDeposit: "Direct Deposit"
-}, W = {
+}, K = {
   percentage: "Percentage",
   amount: "Amount"
 }, w = {
   BUSINESS: "Business"
-}, c = "Regular Hours", I = "Overtime", s = "Double overtime", K = [
-  c,
+}, s = "Regular Hours", I = "Overtime", P = "Double overtime", k = [
+  s,
   I,
-  s
-], k = "Bonus", x = "Paycheck Tips", X = "Correction Payment", q = "Commission", Q = "Cash Tips", L = "Reimbursement", P = "Owner's Draw", S = "Minimum Wage Adjustment", J = [
-  P,
+  P
+], x = "Bonus", X = "Paycheck Tips", q = "Correction Payment", Q = "Commission", J = "Cash Tips", L = "Reimbursement", S = "Owner's Draw", l = "Minimum Wage Adjustment", j = [
   S,
+  l,
   L
-], j = {
+], Z = {
   submitting: "submitting",
   submit_success: "submit_success",
   processing_failed: "processing_failed"
-}, Z = [
+}, $ = [
   "fast_ach_threshold_exceeded",
   "needs_earned_access_for_fast_ach"
-], $ = ["AK", "CA", "MN", "NV", "OR", "WA"];
+], z = ["AK", "CA", "MN", "NV", "OR", "WA"];
 export {
   O as BREAKPOINTS,
-  v as BREAKPOINTS_VALUES,
-  k as COMPENSATION_NAME_BONUS,
-  Q as COMPENSATION_NAME_CASH_TIPS,
-  q as COMPENSATION_NAME_COMMISSION,
-  X as COMPENSATION_NAME_CORRECTION_PAYMENT,
-  s as COMPENSATION_NAME_DOUBLE_OVERTIME,
+  V as BREAKPOINTS_VALUES,
+  x as COMPENSATION_NAME_BONUS,
+  J as COMPENSATION_NAME_CASH_TIPS,
+  Q as COMPENSATION_NAME_COMMISSION,
+  q as COMPENSATION_NAME_CORRECTION_PAYMENT,
+  P as COMPENSATION_NAME_DOUBLE_OVERTIME,
   I as COMPENSATION_NAME_OVERTIME,
-  x as COMPENSATION_NAME_PAYCHECK_TIPS,
-  c as COMPENSATION_NAME_REGULAR_HOURS,
+  X as COMPENSATION_NAME_PAYCHECK_TIPS,
+  s as COMPENSATION_NAME_REGULAR_HOURS,
   L as COMPENSATION_NAME_REIMBURSEMENT,
   w as CONTRACTOR_TYPE,
   _ as ContractorOnboardingStatus,
-  y as ContractorSelfOnboardingStatuses,
-  J as EXCLUDED_ADDITIONAL_EARNINGS,
+  U as ContractorSelfOnboardingStatuses,
+  j as EXCLUDED_ADDITIONAL_EARNINGS,
   A as EmployeeOnboardingStatus,
   Y as EmployeeSelfOnboardingStatuses,
-  F as FLSA_OVERTIME_SALARY_LIMIT,
-  U as FlsaStatus,
-  K as HOURS_COMPENSATION_NAMES,
-  f as HOURS_PER_PAY_PERIOD_ANNUALLY,
-  G as HOURS_PER_PAY_PERIOD_MONTHLY,
-  g as HOURS_PER_PAY_PERIOD_WEEKLY,
-  B as I9_FORM_NAME,
-  V as PAYMENT_METHODS,
-  j as PAYROLL_PROCESSING_STATUS,
-  Z as PAYROLL_RESOLVABLE_SUBMISSION_BLOCKER_TYPES,
-  h as PAY_PERIODS,
-  H as SIGNATORY_TITLES,
-  W as SPLIT_BY,
-  b as STATES_ABBR,
-  $ as TIP_CREDITS_UNSUPPORTED_STATES,
+  g as FLSA_OVERTIME_SALARY_LIMIT,
+  u as FlsaStatus,
+  k as HOURS_COMPENSATION_NAMES,
+  B as HOURS_PER_PAY_PERIOD_ANNUALLY,
+  f as HOURS_PER_PAY_PERIOD_MONTHLY,
+  G as HOURS_PER_PAY_PERIOD_WEEKLY,
+  b as I9_FORM_NAME,
+  W as PAYMENT_METHODS,
+  Z as PAYROLL_PROCESSING_STATUS,
+  $ as PAYROLL_RESOLVABLE_SUBMISSION_BLOCKER_TYPES,
+  v as PAY_PERIODS,
+  h as SIGNATORY_TITLES,
+  K as SPLIT_BY,
+  H as STATES_ABBR,
+  z as TIP_CREDITS_UNSUPPORTED_STATES,
   o as companyEvents,
-  u as compensationTypeLabels,
-  p as componentEvents,
+  F as compensationTypeLabels,
+  y as componentEvents,
   T as contractorEvents,
   a as contractorHistoricalPaymentEvents,
   n as contractorPaymentEvents,
   t as employeeEvents,
   r as informationRequestEvents,
-  d as offCycleEvents,
+  C as offCycleEvents,
   R as payScheduleEvents,
   D as payrollWireEvents,
+  d as printChecksEvents,
   m as recoveryCasesEvents,
   M as runPayrollEvents,
   N as terminationEvents,
-  C as timeOffEvents
+  c as timeOffEvents
 };
 //# sourceMappingURL=constants.js.map