markform 0.1.7 → 0.1.9

package/examples/simple/simple-mock-filled.schema.json

@@ -0,0 +1,374 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "simple_test",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "title": "Name",
+      "minLength": 2,
+      "maxLength": 50,
+      "x-markform": {
+        "role": "user",
+        "group": "basic_fields",
+        "placeholder": "Enter your name",
+        "examples": ["John Smith", "Jane Doe"]
+      }
+    },
+    "email": {
+      "type": "string",
+      "title": "Email",
+      "pattern": "^[^@]+@[^@]+\\.[^@]+$",
+      "x-markform": {
+        "role": "user",
+        "group": "basic_fields",
+        "placeholder": "email@example.com",
+        "examples": ["alice@company.com", "bob@example.org"]
+      }
+    },
+    "age": {
+      "type": "integer",
+      "title": "Age",
+      "minimum": 0,
+      "maximum": 150,
+      "x-markform": {
+        "role": "user",
+        "group": "basic_fields",
+        "placeholder": "25",
+        "examples": ["18", "30", "45"]
+      }
+    },
+    "score": {
+      "type": "number",
+      "title": "Score",
+      "minimum": 0,
+      "maximum": 100,
+      "x-markform": {
+        "role": "user",
+        "group": "basic_fields",
+        "placeholder": "85.5",
+        "examples": ["75.0", "90.5", "100.0"]
+      }
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 2
+      },
+      "title": "Tags",
+      "minItems": 1,
+      "maxItems": 5,
+      "uniqueItems": true,
+      "x-markform": {
+        "role": "user",
+        "group": "list_fields"
+      }
+    },
+    "priority": {
+      "type": "string",
+      "enum": ["low", "medium", "high"],
+      "title": "Priority",
+      "x-markform": {
+        "role": "user",
+        "group": "selection_fields"
+      }
+    },
+    "categories": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["frontend", "backend", "database", "devops"]
+      },
+      "title": "Categories",
+      "minItems": 1,
+      "maxItems": 3,
+      "x-markform": {
+        "role": "user",
+        "group": "selection_fields"
+      }
+    },
+    "tasks_multi": {
+      "type": "object",
+      "properties": {
+        "research": {
+          "type": "string",
+          "enum": ["todo", "done", "incomplete", "active", "na"],
+          "title": "Research"
+        },
+        "design": {
+          "type": "string",
+          "enum": ["todo", "done", "incomplete", "active", "na"],
+          "title": "Design"
+        },
+        "implement": {
+          "type": "string",
+          "enum": ["todo", "done", "incomplete", "active", "na"],
+          "title": "Implement"
+        },
+        "test": {
+          "type": "string",
+          "enum": ["todo", "done", "incomplete", "active", "na"],
+          "title": "Test"
+        }
+      },
+      "title": "Tasks (Multi Mode)",
+      "x-markform": {
+        "role": "user",
+        "group": "checkbox_fields",
+        "checkboxMode": "multi"
+      }
+    },
+    "tasks_simple": {
+      "type": "object",
+      "properties": {
+        "read_guidelines": {
+          "type": "string",
+          "enum": ["todo", "done"],
+          "title": "I have read the guidelines"
+        },
+        "agree_terms": {
+          "type": "string",
+          "enum": ["todo", "done"],
+          "title": "I agree to the terms"
+        }
+      },
+      "title": "Agreements (Simple Mode)",
+      "x-markform": {
+        "role": "user",
+        "group": "checkbox_fields",
+        "checkboxMode": "simple"
+      }
+    },
+    "confirmations": {
+      "type": "object",
+      "properties": {
+        "backed_up": {
+          "type": "string",
+          "enum": ["unfilled", "yes", "no"],
+          "title": "Data has been backed up"
+        },
+        "notified": {
+          "type": "string",
+          "enum": ["unfilled", "yes", "no"],
+          "title": "Stakeholders notified"
+        }
+      },
+      "title": "Confirmations (Explicit Mode)",
+      "x-markform": {
+        "role": "user",
+        "group": "checkbox_fields",
+        "checkboxMode": "explicit"
+      }
+    },
+    "website": {
+      "type": "string",
+      "format": "uri",
+      "title": "Website",
+      "x-markform": {
+        "role": "user",
+        "group": "url_fields",
+        "placeholder": "https://example.com",
+        "examples": ["https://github.com/user/repo", "https://company.com"]
+      }
+    },
+    "references": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uri"
+      },
+      "title": "References",
+      "minItems": 1,
+      "maxItems": 5,
+      "uniqueItems": true,
+      "x-markform": {
+        "role": "user",
+        "group": "url_fields",
+        "placeholder": "https://docs.example.com",
+        "examples": ["https://wikipedia.org/wiki/Example", "https://docs.github.com/en"]
+      }
+    },
+    "event_date": {
+      "type": "string",
+      "format": "date",
+      "title": "Event Date",
+      "formatMinimum": "2020-01-01",
+      "formatMaximum": "2030-12-31",
+      "x-markform": {
+        "role": "user",
+        "group": "date_fields",
+        "minDate": "2020-01-01",
+        "maxDate": "2030-12-31"
+      }
+    },
+    "founded_year": {
+      "type": "integer",
+      "title": "Founded Year",
+      "minimum": 1900,
+      "maximum": 2030,
+      "x-markform": {
+        "role": "user",
+        "group": "date_fields"
+      }
+    },
+    "team_members": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "title": "Name",
+            "type": "string"
+          },
+          "role": {
+            "title": "Role",
+            "type": "string"
+          },
+          "start_date": {
+            "title": "Start Date",
+            "type": "string",
+            "format": "date"
+          }
+        },
+        "required": ["name"]
+      },
+      "title": "Team Members",
+      "minItems": 0,
+      "maxItems": 5,
+      "x-markform": {
+        "role": "user",
+        "group": "table_fields"
+      }
+    },
+    "project_tasks": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "task": {
+            "title": "Task",
+            "type": "string"
+          },
+          "estimate_hrs": {
+            "title": "Estimate (hrs)",
+            "type": "number"
+          },
+          "link": {
+            "title": "Link",
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "required": ["task"]
+      },
+      "title": "Project Tasks",
+      "minItems": 0,
+      "maxItems": 10,
+      "x-markform": {
+        "role": "user",
+        "group": "table_fields"
+      }
+    },
+    "notes": {
+      "type": "string",
+      "title": "Notes",
+      "x-markform": {
+        "role": "user",
+        "group": "optional_fields"
+      }
+    },
+    "optional_number": {
+      "type": "number",
+      "title": "Optional Number",
+      "x-markform": {
+        "role": "user",
+        "group": "optional_fields"
+      }
+    },
+    "related_url": {
+      "type": "string",
+      "format": "uri",
+      "title": "Related URL",
+      "x-markform": {
+        "role": "user",
+        "group": "optional_fields"
+      }
+    },
+    "optional_date": {
+      "type": "string",
+      "format": "date",
+      "title": "Optional Date",
+      "x-markform": {
+        "role": "user",
+        "group": "optional_fields"
+      }
+    },
+    "optional_year": {
+      "type": "integer",
+      "title": "Optional Year",
+      "x-markform": {
+        "role": "user",
+        "group": "optional_fields"
+      }
+    }
+  },
+  "title": "Simple Test Form",
+  "description": "A fully interactive form demonstrating all Markform v0.1 field types.\nFill all fields using interactive prompts - no LLM API key needed.",
+  "required": [
+    "name",
+    "email",
+    "age",
+    "tags",
+    "priority",
+    "categories",
+    "tasks_multi",
+    "tasks_simple",
+    "confirmations",
+    "website",
+    "event_date",
+    "founded_year"
+  ],
+  "x-markform": {
+    "spec": "MF/0.1",
+    "roles": ["user", "agent"],
+    "roleInstructions": {
+      "user": "Fill in the fields you have direct knowledge of.",
+      "agent": "Complete the remaining fields based on the provided context."
+    },
+    "groups": [
+      {
+        "id": "basic_fields",
+        "title": "Basic Fields"
+      },
+      {
+        "id": "list_fields",
+        "title": "List Fields"
+      },
+      {
+        "id": "selection_fields",
+        "title": "Selection Fields"
+      },
+      {
+        "id": "checkbox_fields",
+        "title": "Checkbox Fields"
+      },
+      {
+        "id": "url_fields",
+        "title": "URL Fields"
+      },
+      {
+        "id": "date_fields",
+        "title": "Date and Year Fields"
+      },
+      {
+        "id": "table_fields",
+        "title": "Table Fields"
+      },
+      {
+        "id": "optional_fields",
+        "title": "Optional Fields"
+      }
+    ]
+  }
+}

package/examples/simple/simple-mock-filled.yml

@@ -0,0 +1,87 @@
+values:
+  name:
+    state: answered
+    value: Alice Johnson
+  email:
+    state: answered
+    value: alice@example.com
+  age:
+    state: answered
+    value: 32
+  score:
+    state: answered
+    value: 87.5
+  tags:
+    state: answered
+    value:
+      - typescript
+      - testing
+      - forms
+  priority:
+    state: answered
+    value: medium
+  categories:
+    state: answered
+    value:
+      - frontend
+      - backend
+  tasks_multi:
+    state: answered
+    value:
+      research: done
+      design: done
+      implement: done
+      test: na
+  tasks_simple:
+    state: answered
+    value:
+      read_guidelines: done
+      agree_terms: done
+  confirmations:
+    state: answered
+    value:
+      backed_up: yes
+      notified: no
+  website:
+    state: answered
+    value: https://alice.dev
+  references:
+    state: answered
+    value:
+      - https://docs.example.com/guide
+      - https://github.com/example/project
+      - https://medium.com/article-about-forms
+  event_date:
+    state: answered
+    value: 2025-06-15
+  founded_year:
+    state: answered
+    value: 2020
+  team_members:
+    state: answered
+    value:
+      - name: Alice
+        role: Engineer
+        start_date: 2024-01-15
+      - name: Bob
+        role: Designer
+        start_date: 2023-06-01
+  project_tasks:
+    state: unanswered
+  notes:
+    state: answered
+    value: This is a test note.
+  optional_number:
+    state: unanswered
+  related_url:
+    state: answered
+    value: https://markform.dev/docs
+  optional_date:
+    state: unanswered
+  optional_year:
+    state: unanswered
+notes:
+  - id: note-review
+    ref: simple_test
+    role: user
+    text: Form completed with all required fields.

package/examples/simple/simple-skipped-filled.report.md

@@ -0,0 +1,90 @@
+# Simple Test Form
+
+A fully interactive form demonstrating all Markform v0.1 field types.
+Fill all fields using interactive prompts - no LLM API key needed.
+
+## Basic Fields
+
+**Name:**
+Test User
+
+**Email:**
+test@example.com
+
+**Age:**
+25
+
+**Score:**
+_(empty)_
+
+## List Fields
+
+**Tags:**
+- typescript
+- testing
+
+## Selection Fields
+
+**Priority:**
+High
+
+**Categories:**
+- Frontend
+- Backend
+
+## Checkbox Fields
+
+**Tasks (Multi Mode):**
+- [x] Research
+- [x] Design
+- [x] Implement
+- [-] Test
+
+**Agreements (Simple Mode):**
+- [x] I have read the guidelines
+- [x] I agree to the terms
+
+**Confirmations (Explicit Mode):**
+- [x] Data has been backed up
+- [ ] Stakeholders notified
+
+## URL Fields
+
+**Website:**
+https://test.example.com
+
+**References:**
+- https://docs.example.com
+
+## Date and Year Fields
+
+**Event Date:**
+2025-03-15
+
+**Founded Year:**
+2021
+
+## Table Fields
+
+**Team Members:**
+_(empty)_
+
+**Project Tasks:**
+_(empty)_
+
+## Optional Fields
+
+**Notes:**
+_(empty)_
+
+**Optional Number:**
+_(empty)_
+
+**Related URL:**
+_(empty)_
+
+**Optional Date:**
+_(empty)_
+
+**Optional Year:**
+_(empty)_