markform 0.1.4 → 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,7 +34,7 @@ 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" %}
 
 {% field kind="string" id="movie" label="Movie" role="user" required=true minLength=1 maxLength=300 %}{% /field %}
 
@@ -42,9 +42,9 @@ Standard research form for gathering ratings and key statistics for any film. Pu
 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" %}
 
 {% field kind="string" id="full_title" label="Full Title" role="agent" required=true %}{% /field %}
 
@@ -52,9 +52,9 @@ Enter the movie title (add any details to help identify, like "Barbie 2023" or "
 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" %}
 
 {% field kind="url" id="imdb_url" label="IMDB URL" role="agent" required=true %}{% /field %}
 
@@ -74,9 +74,9 @@ Direct link to the movie's Rotten Tomatoes page.
 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" %}
 
 {% field kind="number" id="year" label="Release Year" role="agent" required=true min=1888 max=2030 %}{% /field %}
 
@@ -97,9 +97,9 @@ One director per line. Most films have one; some have two or more co-directors.
 - [ ] NR/Unrated {% #nr %}
 {% /field %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="imdb_ratings" title="IMDB Ratings" %}
+{% group id="imdb_ratings" title="IMDB Ratings" %}
 
 {% field kind="number" id="imdb_rating" label="IMDB Rating" role="agent" min=1.0 max=10.0 %}{% /field %}
 
@@ -113,9 +113,9 @@ IMDB user rating (1.0-10.0 scale).
 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" %}
 
 {% field kind="number" id="rt_critics_score" label="Tomatometer (Critics)" role="agent" min=0 max=100 %}{% /field %}
 
@@ -131,9 +131,9 @@ Tomatometer percentage (0-100).
 Audience Score percentage (0-100).
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="metacritic_ratings" title="Metacritic Ratings" %}
+{% group id="metacritic_ratings" title="Metacritic Ratings" %}
 
 {% field kind="number" id="metacritic_score" label="Metacritic Score" role="agent" min=0 max=100 %}{% /field %}
 
@@ -141,9 +141,9 @@ Audience Score percentage (0-100).
 Metascore (0-100 scale). Leave empty if not available.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="summary" title="Summary" %}
+{% group id="summary" title="Summary" %}
 
 {% field kind="string" id="logline" label="One-Line Summary" role="agent" maxLength=300 %}{% /field %}
 
@@ -163,6 +163,6 @@ Major awards won.
 Example: Oscar | Best Picture | 1995
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 {% /form %}

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

@@ -45,7 +45,7 @@ markform:
 Comprehensive movie research covering ratings from multiple sources, box office performance, full cast and crew, technical specifications, streaming availability, and cultural impact analysis.
 {% /description %}
 
-{% field-group id="movie_input" title="Movie Identification" %}
+{% group id="movie_input" title="Movie Identification" %}
 
 {% field kind="string" id="movie" label="Movie" role="user" required=true minLength=1 maxLength=300 %}{% /field %}
 
@@ -53,11 +53,11 @@ Comprehensive movie research covering ratings from multiple sources, box office
 Enter the movie title (add any details to help identify, like "Barbie 2023" or "the Batman movie with Robert Pattinson").
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Title Identification
 
-{% field-group id="title_identification" title="Title Identification" %}
+{% group id="title_identification" title="Title Identification" %}
 
 {% field kind="string" id="full_title" label="Full Title" role="agent" required=true %}{% /field %}
 
@@ -67,11 +67,11 @@ Official title including subtitle if any (e.g., "The Lord of the Rings: The Fell
 
 {% field kind="number" id="year" label="Release Year" role="agent" required=true min=1888 max=2030 %}{% /field %}
 
-{% /field-group %}
+{% /group %}
 
 ## Sources
 
-{% field-group id="primary_sources" title="Primary Sources" %}
+{% group id="primary_sources" title="Primary Sources" %}
 
 {% field kind="url" id="imdb_url" label="IMDB URL" role="agent" required=true %}{% /field %}
 
@@ -92,9 +92,9 @@ Direct link to the movie's Rotten Tomatoes page.
 Direct link to the movie's Metacritic page.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="box_office_sources" title="Box Office Sources" %}
+{% group id="box_office_sources" title="Box Office Sources" %}
 
 {% field kind="url" id="boxofficemojo_url" label="Box Office Mojo URL" role="agent" %}{% /field %}
 
@@ -109,9 +109,9 @@ Format: https://www.boxofficemojo.com/title/tt0111161/
 Alternative/supplementary box office data and profitability analysis.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="availability_sources" title="Availability Sources" %}
+{% group id="availability_sources" title="Availability Sources" %}
 
 {% field kind="url" id="justwatch_url" label="JustWatch URL" role="agent" %}{% /field %}
 
@@ -120,9 +120,9 @@ Best source for current streaming availability. Use US region.
 Format: https://www.justwatch.com/us/movie/the-shawshank-redemption
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="additional_sources" title="Additional Sources" %}
+{% group id="additional_sources" title="Additional Sources" %}
 
 {% field kind="url" id="letterboxd_url" label="Letterboxd URL" role="agent" %}{% /field %}
 
@@ -142,11 +142,11 @@ For production history, cultural impact, comprehensive awards list.
 Studio or film's official website, if still active.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Basic Details
 
-{% field-group id="basic_details" title="Basic Details" %}
+{% group id="basic_details" title="Basic Details" %}
 
 {% field kind="string_list" id="directors" label="Director(s)" role="agent" required=true %}{% /field %}
 
@@ -202,11 +202,11 @@ Select all applicable genres from IMDB (up to 5).
 Production countries, one per line.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Cast & Crew
 
-{% field-group id="cast_crew" title="Cast & Crew" %}
+{% group id="cast_crew" title="Cast & Crew" %}
 
 {% field kind="table" id="lead_cast" label="Lead Cast" role="agent" minRows=1 maxRows=10
    columnIds=["actor_name", "character_name"]
@@ -244,11 +244,11 @@ Format: Name (producer type)
 Example: "Emma Thomas (producer)"
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Ratings
 
-{% field-group id="imdb_ratings" title="IMDB Ratings" %}
+{% group id="imdb_ratings" title="IMDB Ratings" %}
 
 {% field kind="number" id="imdb_rating" label="IMDB Rating" role="agent" min=1.0 max=10.0 %}{% /field %}
 
@@ -262,9 +262,9 @@ IMDB user rating (1.0-10.0 scale).
 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" %}
 
 {% field kind="number" id="rt_critics_score" label="Tomatometer (Critics)" role="agent" min=0 max=100 %}{% /field %}
 
@@ -286,9 +286,9 @@ Audience Score percentage (0-100).
 The official Rotten Tomatoes critics consensus statement, if available.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="metacritic_ratings" title="Metacritic Ratings" %}
+{% group id="metacritic_ratings" title="Metacritic Ratings" %}
 
 {% field kind="number" id="metacritic_score" label="Metacritic Score" role="agent" min=0 max=100 %}{% /field %}
 
@@ -296,9 +296,9 @@ The official Rotten Tomatoes critics consensus statement, if available.
 Metascore (0-100 scale). Leave empty if not available.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="additional_ratings" title="Additional Ratings" %}
+{% group id="additional_ratings" title="Additional Ratings" %}
 
 {% field kind="number" id="letterboxd_rating" label="Letterboxd Rating" role="agent" min=0.5 max=5.0 %}{% /field %}
 
@@ -312,11 +312,11 @@ Letterboxd average rating (0.5-5.0 scale, in 0.1 increments).
 Opening weekend audience grade (A+ to F). Only available for theatrical releases.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Box Office
 
-{% field-group id="box_office" title="Box Office" %}
+{% group id="box_office" title="Box Office" %}
 
 {% field kind="number" id="budget_millions" label="Budget ($M)" role="agent" min=0 %}{% /field %}
 
@@ -342,11 +342,11 @@ Global theatrical gross in millions USD.
 US opening weekend gross in millions USD.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Technical Specifications
 
-{% field-group id="technical_specs" title="Technical Specifications" %}
+{% group id="technical_specs" title="Technical Specifications" %}
 
 {% field kind="single_select" id="aspect_ratio" label="Aspect Ratio" role="agent" %}
 - [ ] 1.33:1 (Academy) {% #ratio_133 %}
@@ -381,11 +381,11 @@ Primary sound format (e.g., "Dolby Atmos", "DTS", "Dolby Digital").
 Primary camera system used (e.g., "Arri Alexa 65", "IMAX 15-perf", "Panavision Panaflex").
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Streaming Availability
 
-{% field-group id="streaming_availability" title="Streaming Availability (US)" %}
+{% group id="streaming_availability" title="Streaming Availability (US)" %}
 
 {% field kind="multi_select" id="streaming_subscription" label="Streaming (Subscription)" role="agent" %}
 - [ ] Netflix {% #netflix %}
@@ -414,11 +414,11 @@ Select all platforms where this film is currently available to stream (subscript
 - [ ] 4K UHD available {% #uhd_4k %}
 {% /field %}
 
-{% /field-group %}
+{% /group %}
 
 ## Content & Themes
 
-{% field-group id="content_themes" title="Content & Themes" %}
+{% group id="content_themes" title="Content & Themes" %}
 
 {% field kind="checkboxes" id="content_warnings" label="Content Warnings" role="agent" checkboxMode="simple" %}
 - [ ] Intense violence {% #violence %}
@@ -441,11 +441,11 @@ Check any content warnings that apply. Use IMDB Parents Guide as reference.
 Major themes explored in the film (e.g., "redemption", "family", "identity", "war").
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## Summary & Legacy
 
-{% field-group id="summary" title="Summary" %}
+{% group id="summary" title="Summary" %}
 
 {% field kind="string" id="logline" label="One-Line Summary" role="agent" maxLength=300 %}{% /field %}
 
@@ -476,9 +476,9 @@ Example: Oscar | Best Picture | 1995
 2-3 memorable critic quotes that capture reception.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
-{% field-group id="cultural_legacy" title="Cultural Legacy" %}
+{% group id="cultural_legacy" title="Cultural Legacy" %}
 
 {% field kind="string" id="cultural_impact" label="Cultural Impact" role="agent" maxLength=500 %}{% /field %}
 
@@ -493,6 +493,6 @@ Leave empty for recent releases without established legacy.
 Films with similar themes, style, or appeal. One per line.
 {% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 {% /form %}

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

@@ -16,18 +16,18 @@ markform:
 
 ## Movie Research Example
 
-{% field-group id="movie_input" title="Movie Identification" %}
+{% group id="movie_input" title="Movie Identification" %}
 
 What movie do you want to research? \[*This field is filled in by the user (`role="user"`).*\]
 
 {% field kind="string" id="movie" label="Movie" role="user" required=true minLength=1 maxLength=300 %}{% /field %}
 {% instructions ref="movie" %}Enter the movie title (add year or details for disambiguation).{% /instructions %}
 
-{% /field-group %}
+{% /group %}
 
 ## About the Movie
 
-{% field-group id="about_the_movie" title="About the Movie" %}
+{% group id="about_the_movie" title="About the Movie" %}
 
 **Title:**
 
@@ -63,6 +63,6 @@ What movie do you want to research? \[*This field is filled in by the user (`rol
 {% 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 %}
 
-{% /field-group %}
+{% /group %}
 
 {% /form %}