@oaknational/oak-curriculum-schema 1.1.2 → 1.1.4

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@oaknational/oak-curriculum-schema",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Contract tests to ensure data integrity between  Oak apps and their data",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist/cjs",
+    "dist/esm",
+    "dist/types.d.ts",
+    "dist/src"
   ],
   "scripts": {
     "test": "vitest",
@@ -40,6 +42,7 @@
     "husky": "^9.0.11",
     "prettier": "3.2.5",
     "rollup": "^4.14.3",
+    "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-dts": "^6.1.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-typescript-paths": "^1.5.0",

package/src/fixtures/index.ts

@@ -1,3 +0,0 @@
-export * from "./lessonData.fixture";
-export * from "./programmeFields.fixture";
-export * from "./unitData.fixture";

package/src/fixtures/lessonData.fixture.ts

@@ -1,30 +0,0 @@
-import { LessonData } from "@/schema/lessonData.schema";
-
-export const lessonDataFixture = (
-  overrides?: Partial<LessonData>,
-): LessonData => ({
-  lesson_id: 1,
-  lesson_uid: "lesson-uid",
-  title: "lesson-title",
-  description: "lesson-description",
-  slug: "lesson-slug",
-  pupil_lesson_outcome: "pupil-lesson-outcome",
-  key_learning_points: [{}],
-  equipment_and_resources: null,
-  content_guidance_details: null,
-  content_guidance: null,
-  supervision_level: null,
-  thirdpartycontent_list: null,
-  misconceptions_and_common_mistakes: null,
-  keywords: null,
-  video_id: null,
-  sign_language_video_id: null,
-  quiz_id_starter: null,
-  quiz_id_exit: null,
-  asset_id_slidedeck: null,
-  asset_id_worksheet: null,
-  copyright_content: null,
-  _state: "published",
-  _cohort: "2023-2024",
-  deprecated_fields: null,
-});

package/src/fixtures/programmeFields.fixture.ts

@@ -1,34 +0,0 @@
-import { ProgrammeFields } from "@/schema/programmeFields.schema";
-
-export const programmeFieldsFixture = (): ProgrammeFields => ({
-  tier: null,
-  tier_id: null,
-  tier_slug: null,
-  tier_description: null,
-  tier_display_order: null,
-  examboard: null,
-  examboard_id: null,
-  examboard_slug: null,
-  examboard_description: null,
-  examboard_display_order: null,
-  year: "year",
-  year_slug: "year-1",
-  year_id: 1,
-  year_description: "year-description",
-  year_display_order: 1,
-  keystage: "KS1",
-  keystage_id: 1,
-  keystage_slug: "ks1",
-  keystage_description: "Key Stage 1",
-  keystage_display_order: 1,
-  phase: "primary",
-  phase_id: 0,
-  phase_slug: "primary",
-  phase_description: "primary",
-  phase_display_order: 1,
-  subject: "subject",
-  subject_id: 1,
-  subject_slug: "subject-slug",
-  subject_description: "subject-description",
-  subject_display_order: 1,
-});

package/src/fixtures/unitData.fixture.ts

@@ -1,12 +0,0 @@
-import { UnitData } from "@/schema/unitData.schema";
-
-export const unitDataFixture = (): UnitData => ({
-  unit_id: 0,
-  unit_uid: "unit-uid",
-  description: null,
-  slug: "unit-slug",
-  tags: null,
-  title: "unit-title",
-  _state: "published",
-  _cohort: "2023-2024",
-});

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from "./schema";
-export * from "./fixtures";

package/src/schema/base.schema.ts

@@ -1,19 +0,0 @@
-import { z } from "zod";
-
-export const _stateSchema = z.enum(["published", "new", "migration"]);
-export const _cohortSchema = z.enum(["2020-2023", "2023-2024", "0"]);
-export const keystages = z.enum(["KS1", "KS2", "KS3", "KS4", "EYFS"]);
-export const keystageSlugs = z.enum([
-  "ks1",
-  "ks2",
-  "ks3",
-  "ks4",
-  "early-years-foundation-stage",
-]);
-export const keystageDescriptions = z.enum([
-  "Key Stage 1",
-  "Key Stage 2",
-  "Key Stage 3",
-  "Key Stage 4",
-  "Early Years Foundation Stage",
-]);

package/src/schema/index.ts

@@ -1,4 +0,0 @@
-export * from "./base.schema";
-export * from "./lessonData.schema";
-export * from "./programmeFields.schema";
-export * from "./unitData.schema";

package/src/schema/lessonData.schema.ts

@@ -1,32 +0,0 @@
-import { z } from "zod";
-
-import { _stateSchema, _cohortSchema } from "./base.schema";
-
-export const lessonDataSchema = z.object({
-  lesson_id: z.number(),
-  lesson_uid: z.string(),
-  slug: z.string(),
-  title: z.string(),
-  description: z.string(),
-  pupil_lesson_outcome: z.string(),
-  key_learning_points: z.array(z.object({})),
-  equipment_and_resources: z.array(z.object({})).nullable(),
-  content_guidance_details: z.array(z.object({})).nullable(),
-  content_guidance: z.array(z.number()).nullable(),
-  copyright_content: z.array(z.object({})).nullable(),
-  supervision_level: z.string().nullable(),
-  thirdpartycontent_list: z.array(z.number()).nullable(),
-  misconceptions_and_common_mistakes: z.array(z.object({})).nullable(),
-  keywords: z.array(z.object({})).nullable(),
-  video_id: z.number().nullable(),
-  sign_language_video_id: z.number().nullable(),
-  quiz_id_starter: z.number().nullable(),
-  quiz_id_exit: z.number().nullable(),
-  asset_id_slidedeck: z.number().nullable(),
-  asset_id_worksheet: z.number().nullable(),
-  deprecated_fields: z.record(z.unknown()).nullable(),
-  _state: _stateSchema,
-  _cohort: _cohortSchema,
-});
-
-export type LessonData = z.infer<typeof lessonDataSchema>;

package/src/schema/programmeFields.schema.ts

@@ -1,45 +0,0 @@
-import { z } from "zod";
-import { keystages, keystageSlugs, keystageDescriptions } from "./base.schema";
-
-export const programmeFieldsSchema = z.object({
-  tier: z.string().nullable(),
-  tier_id: z.number().nullable(),
-  tier_slug: z.string().nullable(),
-  tier_description: z.string().nullable(),
-  tier_display_order: z.number().nullable(),
-
-  examboard: z.string().nullable(),
-  examboard_id: z.number().nullable(),
-  examboard_slug: z.string().nullable(),
-  examboard_description: z.string().nullable(),
-  examboard_display_order: z.number().nullable(),
-
-  year: z.string(),
-  year_slug: z.string(),
-  year_id: z.number(),
-  year_description: z.string(),
-  year_display_order: z.number(),
-
-  keystage: keystages,
-  keystage_id: z.number(),
-  keystage_slug: keystageSlugs,
-  keystage_description: keystageDescriptions,
-  keystage_display_order: z.number(),
-
-  phase: z.string(),
-  phase_id: z.number(),
-  phase_slug: z.string(),
-  phase_description: z.string(),
-  phase_display_order: z.number(),
-
-  subject: z.string(),
-  subject_id: z.number(),
-  subject_slug: z.string(),
-  subject_description: z.string(),
-  subject_display_order: z.number(),
-
-  legacy: z.string().optional(),
-  dataset: z.string().optional(),
-});
-
-export type ProgrammeFields = z.infer<typeof programmeFieldsSchema>;

package/src/schema/unitData.schema.ts

@@ -1,16 +0,0 @@
-import { z } from "zod";
-
-import { _stateSchema, _cohortSchema } from "./base.schema";
-
-export const unitDataSchema = z.object({
-  unit_id: z.number(),
-  unit_uid: z.string(),
-  description: z.string().nullable(),
-  slug: z.string(),
-  tags: z.array(z.number()).nullable(),
-  title: z.string(),
-  _state: _stateSchema,
-  _cohort: _cohortSchema,
-});
-
-export type UnitData = z.infer<typeof unitDataSchema>;

package/src/test/lessonData.test.ts

@@ -1,11 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import { lessonDataFixture } from "@/fixtures/lessonData.fixture";
-import { lessonDataSchema } from "@/schema/lessonData.schema";
-
-describe("lessonData", () => {
-  it("conforms to the schema", () => {
-    const l = lessonDataFixture();
-    expect(() => lessonDataSchema.parse(l)).not.toThrow();
-  });
-});

package/src/test/programmeFields.test.ts

@@ -1,11 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import { programmeFieldsFixture } from "@/fixtures/programmeFields.fixture";
-import { programmeFieldsSchema } from "@/schema/programmeFields.schema";
-
-describe("programmeFields", () => {
-  it("conforms to the schema", () => {
-    const l = programmeFieldsFixture();
-    expect(() => programmeFieldsSchema.parse(l)).not.toThrow();
-  });
-});