@duffcloudservices/site-forms 0.1.0

package/src/types.ts

@@ -0,0 +1,140 @@
+/**
+ * Form type definitions — vendored snapshot of the canonical form types
+ * generated from `contracts/spec/domains/portal-site-forms.yaml` (see
+ * `contracts/generated/typescript/types.gen.ts`).
+ *
+ * This is an intentional fork of the generated types so the published
+ * package has zero runtime/peer dependency on the (workspace-internal,
+ * never published) `@dcs/contracts` package. When the form schema in
+ * `contracts/spec/domains/portal-site-forms.yaml` changes, refresh both
+ * this file and `src/schema/form-definition.schema.json`.
+ *
+ * Consumers should import these types from `@duffcloudservices/site-forms`
+ * so the package remains the single import surface for managed-form
+ * runtime code on customer sites.
+ */
+
+export type PortalFormFieldType =
+  | 'text'
+  | 'email'
+  | 'tel'
+  | 'textarea'
+  | 'select'
+  | 'multiselect'
+  | 'radio'
+  | 'checkbox'
+  | 'checkbox-group'
+  | 'date'
+  | 'file'
+  | 'hidden'
+  | 'section-heading'
+  | 'html-block'
+
+export type PortalFormFieldWidth = 'full' | 'half' | 'third'
+
+export interface PortalFormFieldOption {
+  value: string
+  label: string
+}
+
+export interface PortalFormFieldValidation {
+  regex?: string
+  minLength?: number
+  maxLength?: number
+  min?: number
+  max?: number
+  accept?: string[]
+}
+
+export interface PortalFormFieldVisibleIf {
+  fieldId: string
+  equals: string | number | boolean
+}
+
+export interface PortalFormField {
+  id: string
+  type: PortalFormFieldType
+  label: string
+  helpText?: string
+  placeholder?: string
+  defaultValue?: string | number | boolean | string[]
+  required?: boolean
+  width?: PortalFormFieldWidth
+  options?: PortalFormFieldOption[]
+  validation?: PortalFormFieldValidation
+  visibleIf?: PortalFormFieldVisibleIf
+  /**
+   * Marks the field as collecting Protected Health Information.
+   * When true the value must never appear in notification emails
+   * or logs and the owning site must be in the Medical category
+   * (see `compliance.instructions.md`).
+   */
+  phi?: boolean
+  html?: string
+}
+
+export interface PortalFormStep {
+  id: string
+  title: string
+  description?: string
+  fieldIds: string[]
+}
+
+export interface PortalFormSubmissionLeadConfig {
+  kind: 'lead'
+  category?: string
+}
+
+export interface PortalFormSubmissionEmailConfig {
+  kind: 'email'
+  to: string[]
+  subjectTemplate?: string
+}
+
+export interface PortalFormSubmissionWebhookConfig {
+  kind: 'webhook'
+  url: string
+  signingSecretRef?: string
+}
+
+export type PortalFormSubmissionConfig =
+  | PortalFormSubmissionLeadConfig
+  | PortalFormSubmissionEmailConfig
+  | PortalFormSubmissionWebhookConfig
+
+export interface PortalFormDefinition {
+  formId: string
+  title: string
+  description?: string
+  submitLabel?: string
+  successMessage?: string
+  submission: PortalFormSubmissionConfig
+  steps?: PortalFormStep[]
+  fields: PortalFormField[]
+  version?: number
+  createdAt?: string
+  updatedAt?: string
+}
+
+/** Map of field id -> current value held by the form. */
+export type FormValues = Record<string, unknown>
+
+/** Per-field validation errors keyed by field id. */
+export type FormErrors = Record<string, string | undefined>
+
+export interface DcsFormSubmitPayload {
+  formId: string
+  values: FormValues
+  captchaToken?: string
+}
+
+export interface DcsFormSubmitSuccess {
+  payload: DcsFormSubmitPayload
+  response: unknown
+}
+
+export interface DcsFormSubmitError {
+  payload: DcsFormSubmitPayload
+  error: Error
+  status?: number
+}