@morscherlab/mld-sdk 0.6.4 → 0.7.0

package/src/components/FormActions.vue

@@ -0,0 +1,92 @@
+<script setup lang="ts">
+/**
+ * Action bar rendered at the bottom of a FormBuilder.
+ *
+ * Supports two modes:
+ * - Flat form: shows an optional Cancel button and a Submit button.
+ * - Wizard (`isWizard=true`): shows Back / Next on intermediate steps and
+ *   Submit only on the last step. Back is hidden on the first step.
+ *
+ * The `canProceed` prop gates the primary action (Next or Submit) to prevent
+ * advancing when the current step has validation errors.
+ */
+import BaseButton from './BaseButton.vue'
+
+interface Props {
+  isWizard?: boolean
+  isFirst?: boolean
+  isLast?: boolean
+  canProceed?: boolean
+  loading?: boolean
+  disabled?: boolean
+  submitLabel?: string
+  cancelLabel?: string
+  showCancel?: boolean
+}
+
+withDefaults(defineProps<Props>(), {
+  isWizard: false,
+  isFirst: true,
+  isLast: true,
+  canProceed: true,
+  loading: false,
+  disabled: false,
+  submitLabel: 'Submit',
+  cancelLabel: 'Cancel',
+  showCancel: false,
+})
+
+const emit = defineEmits<{
+  submit: []
+  cancel: []
+  back: []
+  next: []
+}>()
+</script>
+
+<template>
+  <div class="mld-form-actions">
+    <BaseButton
+      v-if="showCancel"
+      variant="ghost"
+      :disabled="loading || disabled"
+      @click="emit('cancel')"
+    >
+      {{ cancelLabel }}
+    </BaseButton>
+
+    <div style="flex: 1" />
+
+    <BaseButton
+      v-if="isWizard && !isFirst"
+      variant="secondary"
+      :disabled="loading || disabled"
+      @click="emit('back')"
+    >
+      Back
+    </BaseButton>
+
+    <BaseButton
+      v-if="isWizard && !isLast"
+      variant="primary"
+      :disabled="!canProceed || loading || disabled"
+      @click="emit('next')"
+    >
+      Next
+    </BaseButton>
+
+    <BaseButton
+      v-if="!isWizard || isLast"
+      variant="primary"
+      :loading="loading"
+      :disabled="!canProceed || loading || disabled"
+      @click="emit('submit')"
+    >
+      {{ submitLabel }}
+    </BaseButton>
+  </div>
+</template>
+
+<style>
+@import '../styles/components/form-builder.css';
+</style>

package/src/components/FormBuilder.vue

@@ -0,0 +1,214 @@
+<script setup lang="ts">
+/**
+ * Schema-driven form component that renders flat or multi-step wizard forms.
+ *
+ * Pass a `FormSchema` with either `sections` (flat) or `steps` (wizard).
+ * Use `v-model` for two-way binding of the form data; the `submit` event
+ * carries only the data for currently-visible fields. Supply `enhancements`
+ * for dynamic options, custom validators, a submit handler, and field-change
+ * callbacks that cannot be expressed in JSON.
+ *
+ * Exposes `form`, `validate`, `reset`, `goNext`, `goBack`, `goToStep`, and
+ * `builder` for imperative control via template refs.
+ *
+ * Slots:
+ * - `field:<name>` — override a single field's input component
+ * - `section:<id>` — replace an entire section body
+ * - `section:<id>:after` — inject content after a section
+ * - `actions` — replace the default FormActions bar
+ */
+import { ref, computed, watch } from 'vue'
+import type { FormSchema, FormEnhancements, UseFormBuilderReturn } from '../types/form-builder'
+import type { WizardStep } from '../types'
+import { useFormBuilder } from '../composables/useFormBuilder'
+import StepWizard from './StepWizard.vue'
+import FormSection from './FormSection.vue'
+import FormActions from './FormActions.vue'
+
+interface Props {
+  schema: FormSchema
+  modelValue?: Record<string, unknown>
+  enhancements?: FormEnhancements<Record<string, unknown>>
+  loading?: boolean
+  disabled?: boolean
+  size?: 'sm' | 'md' | 'lg'
+  readonly?: boolean
+}
+
+const props = withDefaults(defineProps<Props>(), {
+  loading: false,
+  disabled: false,
+  readonly: false,
+})
+
+const emit = defineEmits<{
+  'update:modelValue': [data: Record<string, unknown>]
+  submit: [data: Record<string, unknown>]
+  cancel: []
+}>()
+
+const builder = useFormBuilder(
+  props.schema,
+  props.modelValue,
+  props.enhancements,
+)
+
+// Sync modelValue changes back to parent
+watch(
+  () => ({ ...builder.form.data }),
+  (data) => emit('update:modelValue', data as Record<string, unknown>),
+  { deep: true },
+)
+
+// Wizard support
+const isWizard = computed(() => !!props.schema.steps)
+const wizardRef = ref<InstanceType<typeof StepWizard> | null>(null)
+
+const wizardSteps = computed<WizardStep[]>(() => {
+  if (!props.schema.steps) return []
+  return props.schema.steps.map((step) => ({
+    id: step.id,
+    label: step.label,
+    description: step.description,
+    icon: step.icon,
+    optional: step.optional,
+  }))
+})
+
+// Sync step validation state with StepWizard
+watch(
+  () => builder.isCurrentStepValid.value,
+  (valid) => {
+    wizardRef.value?.setStepValid(builder.currentStep.value, valid)
+  },
+)
+
+function handleNext() {
+  const success = builder.goNext()
+  if (success) {
+    wizardRef.value?.setStepValid(builder.currentStep.value - 1, true)
+  }
+}
+
+async function handleSubmit() {
+  await builder.submit()
+  const formData = builder.form.data as Record<string, unknown>
+  const visibleData = Object.fromEntries(
+    builder.fields
+      .filter((f) => builder.isFieldVisible(f.name))
+      .map((f) => [f.name, formData[f.name]]),
+  )
+  emit('submit', visibleData)
+}
+
+function handleCancel() {
+  emit('cancel')
+}
+
+defineExpose({
+  form: builder.form,
+  validate: builder.validate,
+  reset: builder.reset,
+  goNext: builder.goNext,
+  goBack: builder.goBack,
+  goToStep: builder.goToStep,
+  builder,
+})
+</script>
+
+<template>
+  <div :class="['mld-form-builder', size ? `mld-form-builder--${size}` : '']">
+    <!-- Wizard mode -->
+    <template v-if="isWizard && schema.steps">
+      <StepWizard
+        ref="wizardRef"
+        :steps="wizardSteps"
+        :model-value="builder.currentStep.value"
+        @update:model-value="builder.goToStep($event)"
+      >
+        <template v-for="step in schema.steps" :key="step.id" #[`step-${step.id}`]>
+          <div class="mld-form-builder__step">
+            <template v-for="section in step.sections" :key="section.id">
+              <FormSection
+                v-if="builder.isSectionVisible(section.id)"
+                :section="section"
+                :builder="(builder as UseFormBuilderReturn<Record<string, unknown>>)"
+              >
+                <!-- Forward field slots -->
+                <template v-for="field in section.fields" :key="field.name" #[`field:${field.name}`]="slotProps">
+                  <slot :name="`field:${field.name}`" v-bind="slotProps" />
+                </template>
+                <!-- Forward section slots -->
+                <template #[`section:${section.id}`]="slotProps">
+                  <slot :name="`section:${section.id}`" v-bind="slotProps" />
+                </template>
+                <template #[`section:${section.id}:after`]="slotProps">
+                  <slot :name="`section:${section.id}:after`" v-bind="slotProps" />
+                </template>
+              </FormSection>
+            </template>
+          </div>
+        </template>
+
+        <template #navigation="{ isFirst, isLast }">
+          <slot name="actions" :form="builder.form" :builder="builder">
+            <FormActions
+              is-wizard
+              :is-first="isFirst"
+              :is-last="isLast"
+              :can-proceed="builder.isCurrentStepValid.value"
+              :loading="loading || builder.form.isSubmitting.value"
+              :disabled="disabled"
+              :submit-label="schema.submitLabel ?? 'Submit'"
+              :cancel-label="schema.cancelLabel ?? 'Cancel'"
+              :show-cancel="schema.showCancel ?? false"
+              @next="handleNext"
+              @back="builder.goBack"
+              @submit="handleSubmit"
+              @cancel="handleCancel"
+            />
+          </slot>
+        </template>
+      </StepWizard>
+    </template>
+
+    <!-- Flat mode -->
+    <template v-else-if="schema.sections">
+      <template v-for="section in schema.sections" :key="section.id">
+        <FormSection
+          v-if="builder.isSectionVisible(section.id)"
+          :section="section"
+          :builder="(builder as UseFormBuilderReturn<Record<string, unknown>>)"
+        >
+          <!-- Forward field slots -->
+          <template v-for="field in section.fields" :key="field.name" #[`field:${field.name}`]="slotProps">
+            <slot :name="`field:${field.name}`" v-bind="slotProps" />
+          </template>
+          <!-- Forward section slots -->
+          <template #[`section:${section.id}`]="slotProps">
+            <slot :name="`section:${section.id}`" v-bind="slotProps" />
+          </template>
+          <template #[`section:${section.id}:after`]="slotProps">
+            <slot :name="`section:${section.id}:after`" v-bind="slotProps" />
+          </template>
+        </FormSection>
+      </template>
+
+      <slot name="actions" :form="builder.form" :builder="builder">
+        <FormActions
+          :loading="loading || builder.form.isSubmitting.value"
+          :disabled="disabled"
+          :submit-label="schema.submitLabel ?? 'Submit'"
+          :cancel-label="schema.cancelLabel ?? 'Cancel'"
+          :show-cancel="schema.showCancel ?? false"
+          @submit="handleSubmit"
+          @cancel="handleCancel"
+        />
+      </slot>
+    </template>
+  </div>
+</template>
+
+<style>
+@import '../styles/components/form-builder.css';
+</style>

package/src/components/FormFieldRenderer.vue

@@ -0,0 +1,58 @@
+<script setup lang="ts">
+/**
+ * Renders a single form field inside a FormField wrapper.
+ *
+ * Resolves the SDK component for the field type from the registry, shows
+ * validation errors only after the field has been touched, and handles the
+ * FileUploader's event-based upload pattern via `handleUpload`. Consumers can
+ * override rendering via the `field:<name>` slot.
+ */
+import { computed } from 'vue'
+import type { FormFieldSchema } from '../types/form-builder'
+import type { UseFormReturn } from '../composables/useForm'
+import { getFieldRegistryEntry } from '../composables/formBuilderRegistry'
+import FormField from './FormField.vue'
+
+interface Props {
+  field: FormFieldSchema
+  resolvedProps: Record<string, unknown>
+  form: UseFormReturn<Record<string, unknown>>
+}
+
+const props = defineProps<Props>()
+
+const entry = computed(() => getFieldRegistryEntry(props.field.type))
+
+const errorMessage = computed(() => {
+  const name = props.field.name
+  return props.form.touched[name] ? props.form.errors[name] : null
+})
+
+function handleUpload(files: File[]) {
+  props.form.setFieldValue(props.field.name, files)
+}
+</script>
+
+<template>
+  <FormField
+    :label="field.label"
+    :error="errorMessage ?? undefined"
+    :hint="field.hint"
+    :required="!!field.validation?.required"
+    :html-for="field.name"
+  >
+    <slot :name="`field:${field.name}`" :field="field" :form="form" :field-props="form.getFieldProps(field.name)">
+      <component
+        :is="entry.component"
+        v-if="entry.vModel"
+        v-bind="resolvedProps"
+      />
+      <component
+        :is="entry.component"
+        v-else
+        v-bind="resolvedProps"
+        @upload="handleUpload"
+      />
+    </slot>
+  </FormField>
+</template>

package/src/components/FormSection.vue

@@ -0,0 +1,90 @@
+<script setup lang="ts">
+/**
+ * Renders a single `FormSectionSchema` inside a FormBuilder.
+ *
+ * Filters out hidden fields before rendering, applies the section's column
+ * grid and per-field `colSpan`, and switches between a collapsible
+ * (`CollapsibleCard`) and a static layout based on `section.collapsible`.
+ * The entire section is hidden when all its fields are hidden. Consumers can
+ * replace the section body via `section:<id>` or inject content after it via
+ * `section:<id>:after`, and override individual fields via `field:<name>`.
+ */
+import { computed } from 'vue'
+import type { FormSectionSchema, UseFormBuilderReturn } from '../types/form-builder'
+import CollapsibleCard from './CollapsibleCard.vue'
+import FormFieldRenderer from './FormFieldRenderer.vue'
+
+interface Props {
+  section: FormSectionSchema
+  builder: UseFormBuilderReturn<Record<string, unknown>>
+}
+
+const props = defineProps<Props>()
+
+const visibleFields = computed(() =>
+  props.section.fields.filter((f) => props.builder.isFieldVisible(f.name)),
+)
+
+const gridStyle = computed(() => ({
+  gridTemplateColumns: `repeat(${props.section.columns ?? 1}, 1fr)`,
+}))
+</script>
+
+<template>
+  <div v-if="visibleFields.length > 0" class="mld-form-section">
+    <slot :name="`section:${section.id}`" :section="section" :form="builder.form">
+      <!-- Collapsible variant -->
+      <CollapsibleCard
+        v-if="section.collapsible"
+        :title="section.title"
+        :subtitle="section.description"
+        :default-open="section.defaultOpen ?? true"
+      >
+        <div class="mld-form-section__grid" :style="gridStyle">
+          <div
+            v-for="field in visibleFields"
+            :key="field.name"
+            :style="field.colSpan ? { gridColumn: `span ${field.colSpan}` } : undefined"
+          >
+            <slot :name="`field:${field.name}`" :field="field" :form="builder.form" :field-props="builder.form.getFieldProps(field.name)">
+              <FormFieldRenderer
+                :field="field"
+                :resolved-props="builder.getResolvedFieldProps(field)"
+                :form="builder.form"
+              />
+            </slot>
+          </div>
+        </div>
+      </CollapsibleCard>
+
+      <!-- Static variant -->
+      <div v-else class="mld-form-section--static">
+        <div v-if="section.title || section.description" class="mld-form-section__header">
+          <h3 v-if="section.title" class="mld-form-section__title">{{ section.title }}</h3>
+          <p v-if="section.description" class="mld-form-section__description">{{ section.description }}</p>
+        </div>
+        <div class="mld-form-section__grid" :style="gridStyle">
+          <div
+            v-for="field in visibleFields"
+            :key="field.name"
+            :style="field.colSpan ? { gridColumn: `span ${field.colSpan}` } : undefined"
+          >
+            <slot :name="`field:${field.name}`" :field="field" :form="builder.form" :field-props="builder.form.getFieldProps(field.name)">
+              <FormFieldRenderer
+                :field="field"
+                :resolved-props="builder.getResolvedFieldProps(field)"
+                :form="builder.form"
+              />
+            </slot>
+          </div>
+        </div>
+      </div>
+    </slot>
+
+    <slot :name="`section:${section.id}:after`" :form="builder.form" />
+  </div>
+</template>
+
+<style>
+@import '../styles/components/form-builder.css';
+</style>

package/src/components/index.ts

@@ -89,6 +89,12 @@ export { default as StepWizard } from './StepWizard.vue'
 export { default as AuditTrail } from './AuditTrail.vue'
 export { default as BatchProgressList } from './BatchProgressList.vue'
 
+// Form builder components
+export { default as FormBuilder } from './FormBuilder.vue'
+export { default as FormSection } from './FormSection.vue'
+export { default as FormActions } from './FormActions.vue'
+export { default as FormFieldRenderer } from './FormFieldRenderer.vue'
+
 // Scheduling / booking components
 export { default as DateTimePicker } from './DateTimePicker.vue'
 export { default as TimeRangeInput } from './TimeRangeInput.vue'

package/src/composables/formBuilderRegistry.ts

@@ -0,0 +1,79 @@
+import type { Component } from 'vue'
+import type { FormFieldType } from '../types/form-builder'
+
+import BaseInput from '../components/BaseInput.vue'
+import BaseTextarea from '../components/BaseTextarea.vue'
+import BaseSelect from '../components/BaseSelect.vue'
+import MultiSelect from '../components/MultiSelect.vue'
+import BaseCheckbox from '../components/BaseCheckbox.vue'
+import BaseToggle from '../components/BaseToggle.vue'
+import BaseRadioGroup from '../components/BaseRadioGroup.vue'
+import BaseSlider from '../components/BaseSlider.vue'
+import TagsInput from '../components/TagsInput.vue'
+import NumberInput from '../components/NumberInput.vue'
+import DatePicker from '../components/DatePicker.vue'
+import TimePicker from '../components/TimePicker.vue'
+import DateTimePicker from '../components/DateTimePicker.vue'
+import FileUploader from '../components/FileUploader.vue'
+import FormulaInput from '../components/FormulaInput.vue'
+import SequenceInput from '../components/SequenceInput.vue'
+import MoleculeInput from '../components/MoleculeInput.vue'
+import ConcentrationInput from '../components/ConcentrationInput.vue'
+import UnitInput from '../components/UnitInput.vue'
+
+export interface RegistryEntry {
+  component: Component
+  /** Default props applied to the component. */
+  defaults: Record<string, unknown>
+  /** Whether the component uses v-model (false for event-only components like FileUploader). */
+  vModel: boolean
+}
+
+const registry: Record<FormFieldType, RegistryEntry> = {
+  text: { component: BaseInput, defaults: { type: 'text' }, vModel: true },
+  email: { component: BaseInput, defaults: { type: 'email' }, vModel: true },
+  password: { component: BaseInput, defaults: { type: 'password' }, vModel: true },
+  tel: { component: BaseInput, defaults: { type: 'tel' }, vModel: true },
+  url: { component: BaseInput, defaults: { type: 'url' }, vModel: true },
+  search: { component: BaseInput, defaults: { type: 'search' }, vModel: true },
+  number: { component: NumberInput, defaults: {}, vModel: true },
+  textarea: { component: BaseTextarea, defaults: {}, vModel: true },
+  select: { component: BaseSelect, defaults: {}, vModel: true },
+  multiselect: { component: MultiSelect, defaults: {}, vModel: true },
+  checkbox: { component: BaseCheckbox, defaults: {}, vModel: true },
+  toggle: { component: BaseToggle, defaults: {}, vModel: true },
+  radio: { component: BaseRadioGroup, defaults: {}, vModel: true },
+  slider: { component: BaseSlider, defaults: {}, vModel: true },
+  tags: { component: TagsInput, defaults: {}, vModel: true },
+  date: { component: DatePicker, defaults: {}, vModel: true },
+  time: { component: TimePicker, defaults: {}, vModel: true },
+  datetime: { component: DateTimePicker, defaults: {}, vModel: true },
+  file: { component: FileUploader, defaults: {}, vModel: false },
+  formula: { component: FormulaInput, defaults: {}, vModel: true },
+  sequence: { component: SequenceInput, defaults: {}, vModel: true },
+  molecule: { component: MoleculeInput, defaults: {}, vModel: true },
+  concentration: { component: ConcentrationInput, defaults: {}, vModel: true },
+  unit: { component: UnitInput, defaults: {}, vModel: true },
+}
+
+/** Return the registry entry for a given field type. Throws if the type is unregistered. */
+export function getFieldRegistryEntry(type: FormFieldType): RegistryEntry {
+  return registry[type]
+}
+
+/** Get the default empty value for a given field type. */
+export function getTypeDefault(type: FormFieldType): unknown {
+  switch (type) {
+    case 'checkbox':
+    case 'toggle':
+      return false
+    case 'number':
+    case 'slider':
+      return undefined
+    case 'multiselect':
+    case 'tags':
+      return []
+    default:
+      return ''
+  }
+}

package/src/composables/index.ts

@@ -85,3 +85,9 @@ export {
   compareTime,
 } from './useTimeUtils'
 export { useScheduleDrag } from './useScheduleDrag'
+export { useFormBuilder, evaluateCondition } from './useFormBuilder'
+export {
+  getFieldRegistryEntry,
+  getTypeDefault,
+  type RegistryEntry,
+} from './formBuilderRegistry'