@oaknational/oak-curriculum-schema 2.5.0 → 2.9.2

package/src/schema/published/components/index.ts

@@ -1,2 +1,3 @@
 // Auto-generated by create-schema-indexes.ts — do not edit manually
 export * from "./actions";
+export * from "./assetObject";

package/src/schema/published/index.ts

@@ -1,8 +1,10 @@
 // Auto-generated by create-schema-indexes.ts — do not edit manually
 export * from "./components";
+export * from "./lessonAssets";
 export * from "./lessonContent";
 export * from "./overridesAndExceptions";
 export * from "./programmeListing";
+export * from "./publishedAssets";
 export * from "./syntheticProgrammesByYear";
 export * from "./syntheticUnitvariantLessons";
 export * from "./syntheticUnitvariantLessonsByKs";

package/src/schema/published/lessonAssets/index.ts

@@ -0,0 +1,2 @@
+// Auto-generated by create-schema-indexes.ts — do not edit manually
+export * from "./lessonAssets.schema";

package/src/schema/published/lessonAssets/lessonAssets.schema.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+
+import { bucketSchema } from "@/schema/public/asset/asset.schema";
+import { featuresSchema } from "@/schema/public/components/features/features.schema";
+import { publishedAssetObjectSchema } from "@/schema/published/components/assetObject/assetObject.schema";
+
+const quizObjectSchema = z
+  .object({
+    quiz: z.object({ pdf: bucketSchema.nullish() }).nullish(),
+    quiz_answers: z.object({ pdf: bucketSchema.nullish() }).nullish(),
+  })
+  .nullish();
+
+const lessonAssetQuizSchema = z.object({
+  quiz_uid: z.string(),
+  quiz_object: quizObjectSchema,
+  updated_at: z.string(),
+});
+
+const assetBaseSchema = z.object({
+  asset_uid: z.string(),
+  asset_object: publishedAssetObjectSchema.nullish(),
+  created_at: z.string(),
+  updated_at: z.string(),
+});
+
+const assetSlidedeckSchema = assetBaseSchema.extend({
+  asset_type: z.literal("slidedeck"),
+});
+
+const assetWorksheetSchema = assetBaseSchema.extend({
+  asset_type: z.literal("worksheet"),
+});
+
+const assetWorksheetAnswersSchema = assetBaseSchema.extend({
+  asset_type: z.literal("worksheet_answers"),
+});
+
+const assetSupplementarySchema = assetBaseSchema.extend({
+  asset_type: z.literal("supplementary_resource"),
+});
+
+const assetLessonGuideSchema = assetBaseSchema.extend({
+  asset_type: z.literal("lesson_guide"),
+  url: z.string(),
+});
+
+const tpcDownloadableFileSchema = z.object({
+  asset_id: z.number().nullable(),
+  media_object: z.object({ display_name: z.string() }).loose(),
+});
+
+export const lessonAssetsSchema = z.object({
+  lesson_id: z.number(),
+  slug: z.string(),
+  features: featuresSchema.nullish(),
+  quiz_exit: lessonAssetQuizSchema.nullish(),
+  quiz_starter: lessonAssetQuizSchema.nullish(),
+  asset_slidedeck: assetSlidedeckSchema.nullish(),
+  asset_worksheet: assetWorksheetSchema.nullish(),
+  asset_worksheet_answers: assetWorksheetAnswersSchema.nullish(),
+  asset_supplementary_asset: assetSupplementarySchema.nullish(),
+  asset_lesson_guide: assetLessonGuideSchema.nullish(),
+  tpc_downloadablefiles: z.array(tpcDownloadableFileSchema).nullish(),
+});
+
+export type LessonAssets = z.infer<typeof lessonAssetsSchema>;

package/src/schema/published/publishedAssets/index.ts

@@ -0,0 +1,3 @@
+// Auto-generated by create-schema-indexes.ts — do not edit manually
+export * from "./publishedAssets.fixture";
+export * from "./publishedAssets.schema";

package/src/schema/published/publishedAssets/publishedAssets.fixture.ts

@@ -0,0 +1,26 @@
+import { keysToCamelCase } from "zod-to-camel-case";
+
+import { assetFixture } from "@/schema/public/asset/asset.fixture";
+import type {
+    PublishedAssets,
+    PublishedAssetsCamel,
+} from "@/schema/published/publishedAssets/publishedAssets.schema";
+
+export const publishedAssetsFixture = ({
+    overrides = {},
+}: {
+    overrides?: Partial<PublishedAssets>;
+} = {}): PublishedAssets => {
+    const { asset_id, asset_type, asset_uid, created_at, updated_at, asset_object } =
+        assetFixture();
+    return { asset_id, asset_type, asset_uid, created_at, updated_at, asset_object, ...overrides };
+};
+
+export const publishedAssetsFixtureCamel = ({
+    overrides = {},
+}: {
+    overrides?: Partial<PublishedAssetsCamel>;
+} = {}): PublishedAssetsCamel => ({
+    ...keysToCamelCase(publishedAssetsFixture()),
+    ...overrides,
+});

package/src/schema/published/publishedAssets/publishedAssets.schema.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import zodToCamelCase from "zod-to-camel-case";
+
+import { assetSchema } from "@/schema/public/asset/asset.schema";
+import { publishedAssetObjectSchema } from "@/schema/published/components/assetObject/assetObject.schema";
+
+export const publishedAssetsSchema = assetSchema
+    .pick({
+        asset_id: true,
+        asset_type: true,
+        asset_uid: true,
+        created_at: true,
+        updated_at: true,
+    })
+    .extend({
+        // asset_object JSONB can contain null bucket entries in partially-populated assets
+        asset_object: publishedAssetObjectSchema,
+    });
+export type PublishedAssets = z.infer<typeof publishedAssetsSchema>;
+
+export const publishedAssetsSchemaCamel = zodToCamelCase(publishedAssetsSchema);
+export type PublishedAssetsCamel = z.infer<typeof publishedAssetsSchemaCamel>;

package/src/schema/published/syntheticUnitvariantLessons/syntheticUnitvariantLessons.fixture.ts

@@ -21,6 +21,7 @@ export const syntheticUnitvariantLessonsFixture = ({
   lesson_data: lessonDataFixture(),
   unit_data: unitFixture(),
   null_unitvariant_id: 0,
+  unitvariant_id: 123,
   programme_fields: programmeFieldsFixture(),
   supplementary_data: {
     unit_order: 1,

package/src/schema/published/syntheticUnitvariantLessons/syntheticUnitvariantLessons.schema.ts

@@ -16,7 +16,7 @@ export const syntheticUnitvariantLessonsSchema = z.object({
   lesson_data: lessonDataSchema,
   unit_data: unitSchema,
   null_unitvariant_id: z.number(),
-  unitvariant_id: z.number().nullish(),
+  unitvariant_id: z.number(),
   programme_fields: programmeFieldsSchema,
   supplementary_data: z.object({
     unit_order: z.number(),