@oaknational/oak-curriculum-schema-v2 0.0.17-alpha → 0.0.19-alpha

package/README.md

@@ -39,6 +39,35 @@ service that uses them (for example `mutation-api`).
 - Types are PascalCase with a `Type` suffix, or `CamelType` for the
   camelCase-key type.
 
+## Database enums
+
+Every database enum is exported as a Zod schema, values array and inferred type.
+Values come directly from the Drizzle enum, preserving its labels and order.
+
+```ts
+import {
+  stateSchema,
+  stateValues,
+  type StateType,
+} from "@oaknational/oak-curriculum-schema-v2";
+
+const state: StateType = stateSchema.parse("draft");
+// stateValues contains all permitted database states.
+```
+
+Names follow the conventions `<thing>Schema`, `<thing>Values` and
+`<Thing>Type`.
+
+## Source organisation
+
+- `src/rendered-schema/`: view schemas and their tests.
+- `src/enums/`: one database enum per file.
+- `src/mutation-api/`: shared Mutation API contracts; currently an empty barrel.
+
+Folder barrels feed the package entry point. Consumers import from the package
+root. Service-local Mutation API contracts and validation utilities stay in the
+service package.
+
 ## Row types
 
 The schema declarations in `types.d.ts` are built by `drizzle-zod` and are