@oaknational/oak-curriculum-schema-v2 0.0.4 → 0.0.5-alpha

package/README.md

@@ -15,23 +15,27 @@ pnpm add @oaknational/oak-curriculum-schema-v2 drizzle-orm zod
 
 ```ts
 import {
-  lessonSelectSchema,
-  lessonInsertSchema,
-  lessonPublishedSchema,
-  type Lesson,
-  type LessonInsert,
-  type LessonPublished,
+  draftLessonWithStatusSelectSchema,
+  type DraftLessonWithStatus,
 } from "@oaknational/oak-curriculum-schema-v2";
 
-// Validate a full row selected from the database
-const lesson = lessonSelectSchema.parse(row);
+// Validate a row selected from the draft_lesson_with_status view
+const draftLesson = draftLessonWithStatusSelectSchema.parse(row);
+```
 
-// Validate a row before inserting
-const newLesson = lessonInsertSchema.parse(payload);
+Raw table schemas are not exported. Schemas for tables live with the
+service that uses them (for example `mutation-api`).
 
-// A schema extended from the derived base to narrow to published rows
-const publishedLesson = lessonPublishedSchema.parse(row);
-```
+## Row types
+
+The schema declarations in `types.d.ts` are built by `drizzle-zod` and are
+hard to read. To see a view's fields, hover (or go to definition on) the
+matching row type, which is `z.infer` of the schema and resolves to a flat
+list of columns.
+
+| Schema | Select type |
+| --- | --- |
+| `draftLessonWithStatusSelectSchema` | `DraftLessonWithStatus` |
 
 ## Links