Colorado Homeschool Attendance
@mgreten/colorado-homeschool-attendancev2026.06.27.1
01README
Colorado homeschool attendance and learning session tracker backed by Grist. Tracks students, school years, subjects, capture events, and generates compliance summaries with test-entry isolation.
02Models
@mgreten/colorado-homeschool-attendancev2026.06.27.1colorado_homeschool_attendance.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| gristBaseUrl | string | Grist base URL (e.g. https://grist.example.com) |
| gristDocId | string | Grist document ID |
| gristApiToken | string | Grist API token — use vault expression |
| timezone | string | |
| defaultSchoolYear? | string | Default school year (e.g. 2026-2027) |
fn validateConfig()
Verify Grist base URL, API token, and document accessibility. Does not mutate data.
fn ensureSchema(dryRun: boolean, createMissing: boolean)
Verify or create the required Grist tables and columns. Use dryRun=true to preview without changes.
| Argument | Type | Description |
|---|---|---|
| dryRun | boolean | |
| createMissing | boolean |
fn addCaptureEvent(source: string, sourceMessageId?: string, capturedBy?: string, capturedAt?: string, eventDate?: string, rawText?: string, transcript?: string, audioUrl?: string, status: string, isTest: boolean, testReason?: string, dryRun: boolean, notes?: string)
Add a capture event from any source. Use isTest=true for smoke testing. Use dryRun=true to preview.
| Argument | Type | Description |
|---|---|---|
| source | string | |
| sourceMessageId? | string | |
| capturedBy? | string | |
| capturedAt? | string | |
| eventDate? | string | |
| rawText? | string | |
| transcript? | string | |
| audioUrl? | string | |
| status | string | |
| isTest | boolean | |
| testReason? | string | |
| dryRun | boolean | |
| notes? | string |
fn addLearningSessions(sessions: array, defaultIsTest: boolean, testReason?: string, dryRun: boolean)
Add learning sessions in bulk. isTest and dryRun are supported. School year is inferred from dates when possible.
| Argument | Type | Description |
|---|---|---|
| sessions | array | |
| defaultIsTest | boolean | |
| testReason? | string | |
| dryRun | boolean |
fn computeAttendanceDays(schoolYear?: string, student?: string, fromDate?: string, toDate?: string, includeTests: boolean, dryRun: boolean, minMinutesForDay: number)
Aggregate learning sessions into per-student per-day attendance records. Excludes test entries by default.
| Argument | Type | Description |
|---|---|---|
| schoolYear? | string | |
| student? | string | |
| fromDate? | string | |
| toDate? | string | |
| includeTests | boolean | |
| dryRun | boolean | |
| minMinutesForDay | number | Minimum total minutes to count as an instructional day |
fn summarizeProgress(schoolYear?: string, student?: string, includeTests: boolean)
Summarize attendance progress for a school year. Excludes test entries by default. Also saves a ComplianceSnapshot to Grist.
| Argument | Type | Description |
|---|---|---|
| schoolYear? | string | |
| student? | string | |
| includeTests | boolean |
fn exportSchoolYear(schoolYear?: string, student?: string, includeTests: boolean, format: enum)
Export learning sessions and attendance for a school year. Test entries excluded by default. Produces a downloadable file artifact.
| Argument | Type | Description |
|---|---|---|
| schoolYear? | string | |
| student? | string | |
| includeTests | boolean | |
| format | enum |
fn addTestEntries(schoolYear: string, students: array, testReason: string, dryRun: boolean)
Create test entries for smoke testing the pipeline. All entries have isTest=true and are excluded from progress summaries and exports by default.
| Argument | Type | Description |
|---|---|---|
| schoolYear | string | |
| students | array | |
| testReason | string | |
| dryRun | boolean |
fn listTestEntries(schoolYear?: string)
List all records marked isTest=true across CaptureEvents, LearningSessions, and AttendanceDays.
| Argument | Type | Description |
|---|---|---|
| schoolYear? | string |
Resources
configValidation(infinite)— Grist connectivity and doc validation result
schemaValidation(infinite)— Grist schema check and setup result
captureEvent(infinite)— Last capture event written
learningSessions(infinite)— Last batch of learning sessions written
attendanceDays(infinite)— Last attendance day computation result
progressSummary(infinite)— School year progress summary
schoolYearExport(infinite)— School year export metadata
testEntries(infinite)— Test entry management result
Files
export(application/json)— Exported school year data file (JSON/markdown/CSV)
03Previous Versions
2026.06.18.1Jun 18, 2026
04Stats
A
100 / 100
Downloads
0
Archive size
26.2 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels