markform 0.1.3 → 0.1.5

package/examples/earnings-analysis/earnings-analysis.valid.ts

@@ -4,9 +4,9 @@
  * These validators demonstrate parameterized validation patterns.
  * Parameters are passed via ctx.params from the validate attribute:
  *
- *   validate=[{id: "min_words", min: 50}]
+ *   validate=[{id: "min_words", min: 20}]
  *
- * The validator receives { min: 50 } in ctx.params.
+ * The validator receives { min: 20 } in ctx.params.
  */
 
 import type { ValidatorContext, ValidationIssue } from 'markform';
@@ -28,27 +28,17 @@ function getStringValue(values: Record<string, unknown>, fieldId: string): strin
   return field?.kind === 'string' && field.value ? field.value : null;
 }
 
-function getNumberValue(values: Record<string, unknown>, fieldId: string): number | null {
-  const field = values[fieldId] as { kind: string; value?: number | null } | undefined;
-  return field?.kind === 'number' && field.value != null ? field.value : null;
-}
-
 function getStringListItems(values: Record<string, unknown>, fieldId: string): string[] {
   const field = values[fieldId] as { kind: string; items?: string[] } | undefined;
   return field?.kind === 'string_list' && field.items ? field.items : [];
 }
 
-function getMultiSelectSelections(values: Record<string, unknown>, fieldId: string): string[] {
-  const field = values[fieldId] as { kind: string; selected?: string[] } | undefined;
-  return field?.kind === 'multi_select' && field.selected ? field.selected : [];
-}
-
 function getSingleSelectValue(values: Record<string, unknown>, fieldId: string): string | null {
   const field = values[fieldId] as { kind: string; selected?: string | null } | undefined;
   return field?.kind === 'single_select' && field.selected ? field.selected : null;
 }
 
-// Parameterized Validators
+// Validators
 
 /**
  * Validate minimum word count.
@@ -118,45 +108,6 @@ function maxWords(ctx: ValidatorContext): ValidationIssue[] {
   return [];
 }
 
-/**
- * Validate that specified number fields sum to a target.
- * Params: { fields: string[], target?: number, tolerance?: number }
- */
-function sumTo(ctx: ValidatorContext): ValidationIssue[] {
-  const fields = ctx.params.fields as string[];
-  const target = (ctx.params.target as number) ?? 100;
-  const tolerance = (ctx.params.tolerance as number) ?? 0.1;
-
-  if (!Array.isArray(fields)) {
-    return [
-      {
-        severity: 'error',
-        message: 'sum_to requires "fields" array parameter',
-        ref: ctx.targetId,
-        source: 'code',
-      },
-    ];
-  }
-
-  const values = fields.map((fieldId) => getNumberValue(ctx.values, fieldId) ?? 0);
-  const sum = values.reduce((a, b) => a + b, 0);
-
-  // Only validate if at least one value is set
-  if (values.every((v) => v === 0)) return [];
-
-  if (Math.abs(sum - target) > tolerance) {
-    return [
-      {
-        severity: 'error',
-        message: `Fields must sum to ${target}% (currently ${sum.toFixed(1)}%)`,
-        ref: fields[0],
-        source: 'code',
-      },
-    ];
-  }
-  return [];
-}
-
 /**
  * Validate that string-list items with "Label: XX%" format sum to target.
  * Params: { target?: number }
@@ -197,117 +148,38 @@ function sumToPercentList(ctx: ValidatorContext): ValidationIssue[] {
 }
 
 /**
- * Require field when another field has a value.
- * Params: { when: string, then?: string }
+ * Require field when another field has any value set.
+ * Params: { when: string }
  */
-function requiredIf(ctx: ValidatorContext): ValidationIssue[] {
+function requiredIfSet(ctx: ValidatorContext): ValidationIssue[] {
   const triggerField = ctx.params.when as string;
-  const targetField = (ctx.params.then as string) ?? ctx.targetId;
 
   if (!triggerField) {
     return [
       {
         severity: 'error',
-        message: 'required_if requires "when" parameter',
+        message: 'required_if_set requires "when" parameter',
         ref: ctx.targetId,
         source: 'code',
       },
     ];
   }
 
-  const trigger = ctx.values[triggerField] as Record<string, unknown> | undefined;
-  const target = ctx.values[targetField] as Record<string, unknown> | undefined;
-
+  // Check if trigger field has a value
   const triggerHasValue =
-    (trigger?.kind === 'string' && (trigger.value as string)?.trim()) ||
-    (trigger?.kind === 'number' && trigger.value != null) ||
-    (trigger?.kind === 'multi_select' && (trigger.selected as string[])?.length > 0);
+    getStringValue(ctx.values, triggerField) !== null ||
+    getSingleSelectValue(ctx.values, triggerField) !== null ||
+    getStringListItems(ctx.values, triggerField).length > 0;
 
-  const targetEmpty =
-    !target ||
-    (target.kind === 'string' && !(target.value as string)?.trim()) ||
-    (target.kind === 'number' && target.value == null);
+  // Check if target field is empty
+  const targetValue = getStringValue(ctx.values, ctx.targetId);
+  const targetEmpty = !targetValue || targetValue.trim().length === 0;
 
   if (triggerHasValue && targetEmpty) {
     return [
       {
         severity: 'error',
-        message: `This field is required when ${triggerField} has a value`,
-        ref: targetField,
-        source: 'code',
-      },
-    ];
-  }
-  return [];
-}
-
-/**
- * Require field when another field equals a specific value.
- * Params: { when: string, equals: string, then?: string }
- */
-function requiredIfEquals(ctx: ValidatorContext): ValidationIssue[] {
-  const triggerField = ctx.params.when as string;
-  const expectedValue = ctx.params.equals as string;
-  const targetField = (ctx.params.then as string) ?? ctx.targetId;
-
-  if (!triggerField || expectedValue === undefined) {
-    return [
-      {
-        severity: 'error',
-        message: 'required_if_equals requires "when" and "equals" parameters',
-        ref: ctx.targetId,
-        source: 'code',
-      },
-    ];
-  }
-
-  const triggerValue = getSingleSelectValue(ctx.values, triggerField);
-  const target = getStringValue(ctx.values, targetField);
-
-  if (triggerValue === expectedValue && (!target || target.trim().length === 0)) {
-    return [
-      {
-        severity: 'error',
-        message: `This field is required when ${triggerField} is "${expectedValue}"`,
-        ref: targetField,
-        source: 'code',
-      },
-    ];
-  }
-  return [];
-}
-
-/**
- * Validate that list items match a regex pattern.
- * Params: { pattern: string, example?: string }
- */
-function itemFormat(ctx: ValidatorContext): ValidationIssue[] {
-  const pattern = ctx.params.pattern as string;
-  const example = (ctx.params.example as string) ?? '';
-
-  if (!pattern) {
-    return [
-      {
-        severity: 'error',
-        message: 'item_format requires "pattern" parameter',
-        ref: ctx.targetId,
-        source: 'code',
-      },
-    ];
-  }
-
-  const items = getStringListItems(ctx.values, ctx.targetId);
-  if (items.length === 0) return [];
-
-  const regex = new RegExp(pattern);
-  const malformed = items.filter((item) => !regex.test(item));
-
-  if (malformed.length > 0) {
-    const hint = example ? ` Expected format: "${example}"` : '';
-    return [
-      {
-        severity: 'warning',
-        message: `${malformed.length} item(s) don't match expected format.${hint}`,
+        message: `This field is required when "${triggerField}" has a value`,
         ref: ctx.targetId,
         source: 'code',
       },
@@ -319,12 +191,8 @@ function itemFormat(ctx: ValidatorContext): ValidationIssue[] {
 // Exported Validators Registry
 
 export const validators: Record<string, (ctx: ValidatorContext) => ValidationIssue[]> = {
-  // Parameterized validators
   min_words: minWords,
   max_words: maxWords,
-  sum_to: sumTo,
   sum_to_percent_list: sumToPercentList,
-  required_if: requiredIf,
-  required_if_equals: requiredIfEquals,
-  item_format: itemFormat,
+  required_if_set: requiredIfSet,
 };

package/examples/movie-research/movie-research-basic.form.md

@@ -34,131 +34,135 @@ markform:
 Standard research form for gathering ratings and key statistics for any film. Pulls from IMDB, Rotten Tomatoes, and Metacritic.
 {% /description %}
 
-{% field-group id="movie_input" title="Movie Identification" %}
+{% group id="movie_input" title="Movie Identification" %}
 
-{% string-field id="movie" label="Movie" role="user" required=true minLength=1 maxLength=300 %}{% /string-field %}
+{% field kind="string" id="movie" label="Movie" role="user" required=true minLength=1 maxLength=300 %}{% /field %}
 
 {% instructions ref="movie" %}
 Enter the movie title (add any details to help identify, like "Barbie 2023" or "the Batman movie with Robert Pattinson")
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="title_identification" title="Title Identification" %}
+{% group id="title_identification" title="Title Identification" %}
 
-{% string-field id="full_title" label="Full Title" role="agent" required=true %}{% /string-field %}
+{% field kind="string" id="full_title" label="Full Title" role="agent" required=true %}{% /field %}
 
 {% instructions ref="full_title" %}
 Look up what film the user had in mind and fill in the official title including subtitle if any (e.g., "The Lord of the Rings: The Fellowship of the Ring").
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="sources" title="Sources" %}
+{% group id="sources" title="Sources" %}
 
-{% url-field id="imdb_url" label="IMDB URL" role="agent" required=true %}{% /url-field %}
+{% field kind="url" id="imdb_url" label="IMDB URL" role="agent" required=true %}{% /field %}
 
 {% instructions ref="imdb_url" %}
 Direct link to the movie's IMDB page (e.g., https://www.imdb.com/title/tt0111161/).
 {% /instructions %}
 
-{% url-field id="rt_url" label="Rotten Tomatoes URL" role="agent" %}{% /url-field %}
+{% field kind="url" id="rt_url" label="Rotten Tomatoes URL" role="agent" %}{% /field %}
 
 {% instructions ref="rt_url" %}
 Direct link to the movie's Rotten Tomatoes page.
 {% /instructions %}
 
-{% url-field id="metacritic_url" label="Metacritic URL" role="agent" %}{% /url-field %}
+{% field kind="url" id="metacritic_url" label="Metacritic URL" role="agent" %}{% /field %}
 
 {% instructions ref="metacritic_url" %}
 Direct link to the movie's Metacritic page.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="basic_details" title="Basic Details" %}
+{% group id="basic_details" title="Basic Details" %}
 
-{% number-field id="year" label="Release Year" role="agent" required=true min=1888 max=2030 %}{% /number-field %}
+{% field kind="number" id="year" label="Release Year" role="agent" required=true min=1888 max=2030 %}{% /field %}
 
-{% string-list id="directors" label="Director(s)" role="agent" required=true %}{% /string-list %}
+{% field kind="string_list" id="directors" label="Director(s)" role="agent" required=true %}{% /field %}
 
 {% instructions ref="directors" %}
 One director per line. Most films have one; some have two or more co-directors.
 {% /instructions %}
 
-{% number-field id="runtime_minutes" label="Runtime (minutes)" role="agent" min=1 max=1000 %}{% /number-field %}
+{% field kind="number" id="runtime_minutes" label="Runtime (minutes)" role="agent" min=1 max=1000 %}{% /field %}
 
-{% single-select id="mpaa_rating" label="MPAA Rating" role="agent" %}
+{% field kind="single_select" id="mpaa_rating" label="MPAA Rating" role="agent" %}
 - [ ] G {% #g %}
 - [ ] PG {% #pg %}
 - [ ] PG-13 {% #pg_13 %}
 - [ ] R {% #r %}
 - [ ] NC-17 {% #nc_17 %}
 - [ ] NR/Unrated {% #nr %}
-{% /single-select %}
+{% /field %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="imdb_ratings" title="IMDB Ratings" %}
+{% group id="imdb_ratings" title="IMDB Ratings" %}
 
-{% number-field id="imdb_rating" label="IMDB Rating" role="agent" min=1.0 max=10.0 %}{% /number-field %}
+{% field kind="number" id="imdb_rating" label="IMDB Rating" role="agent" min=1.0 max=10.0 %}{% /field %}
 
 {% instructions ref="imdb_rating" %}
 IMDB user rating (1.0-10.0 scale).
 {% /instructions %}
 
-{% number-field id="imdb_votes" label="IMDB Vote Count" role="agent" min=0 %}{% /number-field %}
+{% field kind="number" id="imdb_votes" label="IMDB Vote Count" role="agent" min=0 %}{% /field %}
 
 {% instructions ref="imdb_votes" %}
 Number of IMDB user votes (e.g., 2800000 for a popular film).
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="rotten_tomatoes_ratings" title="Rotten Tomatoes Ratings" %}
+{% group id="rotten_tomatoes_ratings" title="Rotten Tomatoes Ratings" %}
 
-{% number-field id="rt_critics_score" label="Tomatometer (Critics)" role="agent" min=0 max=100 %}{% /number-field %}
+{% field kind="number" id="rt_critics_score" label="Tomatometer (Critics)" role="agent" min=0 max=100 %}{% /field %}
 
 {% instructions ref="rt_critics_score" %}
 Tomatometer percentage (0-100).
 {% /instructions %}
 
-{% number-field id="rt_critics_count" label="Critics Review Count" role="agent" min=0 %}{% /number-field %}
+{% field kind="number" id="rt_critics_count" label="Critics Review Count" role="agent" min=0 %}{% /field %}
 
-{% number-field id="rt_audience_score" label="Audience Score" role="agent" min=0 max=100 %}{% /number-field %}
+{% field kind="number" id="rt_audience_score" label="Audience Score" role="agent" min=0 max=100 %}{% /field %}
 
 {% instructions ref="rt_audience_score" %}
 Audience Score percentage (0-100).
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="metacritic_ratings" title="Metacritic Ratings" %}
+{% group id="metacritic_ratings" title="Metacritic Ratings" %}
 
-{% number-field id="metacritic_score" label="Metacritic Score" role="agent" min=0 max=100 %}{% /number-field %}
+{% field kind="number" id="metacritic_score" label="Metacritic Score" role="agent" min=0 max=100 %}{% /field %}
 
 {% instructions ref="metacritic_score" %}
 Metascore (0-100 scale). Leave empty if not available.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="summary" title="Summary" %}
+{% group id="summary" title="Summary" %}
 
-{% string-field id="logline" label="One-Line Summary" role="agent" maxLength=300 %}{% /string-field %}
+{% field kind="string" id="logline" label="One-Line Summary" role="agent" maxLength=300 %}{% /field %}
 
 {% instructions ref="logline" %}
 Brief plot summary in 1-2 sentences, no spoilers.
 {% /instructions %}
 
-{% string-list id="notable_awards" label="Notable Awards" role="agent" %}{% /string-list %}
+{% field kind="table" id="notable_awards" label="Notable Awards" role="agent"
+   columnIds=["award", "category", "year"]
+   columnTypes=["string", "string", "year"] %}
+| Award | Category | Year |
+|-------|----------|------|
+{% /field %}
 
 {% instructions ref="notable_awards" %}
-Major awards won. One per line.
-Format: Award | Category | Year
-Example: "Oscar | Best Picture | 1995"
+Major awards won.
+Example: Oscar | Best Picture | 1995
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 {% /form %}