@digimakers/core 0.2.1 → 0.3.20

package/dist/schemas/lesson.d.ts

@@ -8,31 +8,227 @@ export declare const languageEnum: z.ZodEnum<{
     java: "java";
     c: "c";
 }>;
-export declare const StepWithImageSchema: z.ZodObject<{
-    step: z.ZodString;
-    image: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+export declare const ImageSlotSchema: z.ZodObject<{
+    id: z.ZodString;
+    base64: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const StepsWithCodeBlockSchema: z.ZodObject<{
     steps: z.ZodArray<z.ZodString>;
-    codeBlock: z.ZodPipe<z.ZodDefault<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null>>;
+    codeBlock: z.ZodDefault<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
-export declare const MultipleStepsWithCodeBlockSchema: z.ZodArray<z.ZodObject<{
-    steps: z.ZodArray<z.ZodString>;
-    codeBlock: z.ZodPipe<z.ZodDefault<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null>>;
-}, z.core.$strip>>;
 export declare const ChallengeSchema: z.ZodObject<{
     name: z.ZodString;
     task: z.ZodString;
-    hintCode: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string | null, string | null>>;
+    hintCode: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export declare const NewProjectSchema: z.ZodObject<{
     name: z.ZodString;
     task: z.ZodString;
 }, z.core.$strip>;
-export declare const ParsedLessonSchema: z.ZodObject<{
+export declare const ProgrammingLessonSchema: z.ZodObject<{
+    lessonType: z.ZodLiteral<"text-based (programming) lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        steps: z.ZodArray<z.ZodString>;
+        codeBlock: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export declare const StepWithImageSchema: z.ZodObject<{
+    step: z.ZodString;
+    imageSlot: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const ScratchLessonSchema: z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+    lessonType: z.ZodLiteral<"block-based (scratch) lesson">;
+    addYourCodeSection: z.ZodArray<z.ZodObject<{
+        step: z.ZodString;
+        imageSlot: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            base64: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ScratchLessonLLMSchema: z.ZodObject<{
+    lessonType: z.ZodLiteral<"block-based (scratch) lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodArray<z.ZodObject<{
+        step: z.ZodString;
+    }, z.core.$strip>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export declare const DebugStepSchema: z.ZodObject<{
+    linkToCode: z.ZodURL;
+    issue: z.ZodString;
+}, z.core.$strip>;
+export declare const DebugLessonSchema: z.ZodObject<{
+    lessonType: z.ZodLiteral<"debugging lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    debugSection: z.ZodArray<z.ZodObject<{
+        linkToCode: z.ZodURL;
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const DebugLessonLLMSchema: z.ZodObject<{
+    lessonType: z.ZodLiteral<"debugging lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    debugSection: z.ZodArray<z.ZodObject<{
+        linkToCode: z.ZodURL;
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const LessonSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    lessonType: z.ZodLiteral<"text-based (programming) lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        steps: z.ZodArray<z.ZodString>;
+        codeBlock: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
     topic: z.ZodString;
     project: z.ZodString;
-    description: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
     projectExplainer: z.ZodString;
     programmingLanguage: z.ZodDefault<z.ZodEnum<{
         none: "none";
@@ -43,42 +239,192 @@ export declare const ParsedLessonSchema: z.ZodObject<{
         java: "java";
         c: "c";
     }>>;
-    projectImage: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
     getReadySection: z.ZodArray<z.ZodString>;
-    addYourCodeSection: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+    lessonType: z.ZodLiteral<"block-based (scratch) lesson">;
+    addYourCodeSection: z.ZodArray<z.ZodObject<{
         step: z.ZodString;
-        image: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    }, z.core.$strip>>, z.ZodObject<{
+        imageSlot: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            base64: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    lessonType: z.ZodLiteral<"debugging lesson">;
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    prefaceImageSlots: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    debugSection: z.ZodArray<z.ZodObject<{
+        linkToCode: z.ZodURL;
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "lessonType">;
+export declare const LessonLLMSchema: z.ZodUnion<readonly [z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
         steps: z.ZodArray<z.ZodString>;
-        codeBlock: z.ZodPipe<z.ZodDefault<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null>>;
-    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+        codeBlock: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodArray<z.ZodObject<{
+        step: z.ZodString;
+    }, z.core.$strip>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    programmingLanguage: z.ZodDefault<z.ZodEnum<{
+        none: "none";
+        scratch: "scratch";
+        "small-basic": "small-basic";
+        "javascript or html or css": "javascript or html or css";
+        python: "python";
+        java: "java";
+        c: "c";
+    }>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    debugSection: z.ZodArray<z.ZodObject<{
+        linkToCode: z.ZodURL;
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>]>;
+export declare const LessonLLMSchemaWithoutLanguage: z.ZodUnion<readonly [z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
         steps: z.ZodArray<z.ZodString>;
-        codeBlock: z.ZodPipe<z.ZodDefault<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null>>;
-    }, z.core.$strip>>]>;
-    tryItOutSection: z.ZodDefault<z.ZodNullable<z.ZodArray<z.ZodString>>>;
-    challengeSection: z.ZodArray<z.ZodObject<{
+        codeBlock: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
         name: z.ZodString;
         task: z.ZodString;
-        hintCode: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string | null, string | null>>;
     }, z.core.$strip>>;
-    newProject: z.ZodObject<{
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    projectExplainer: z.ZodString;
+    getReadySection: z.ZodArray<z.ZodString>;
+    addYourCodeSection: z.ZodArray<z.ZodObject<{
+        step: z.ZodString;
+    }, z.core.$strip>>;
+    tryItOutSection: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    challengeSection: z.ZodNullable<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         task: z.ZodString;
-    }, z.core.$strip>;
-    testYourself: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    funFact: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
+        hintCode: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    newProject: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        task: z.ZodString;
+    }, z.core.$strip>>;
+    testYourself: z.ZodNullable<z.ZodString>;
+    funFact: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    topic: z.ZodString;
+    project: z.ZodString;
+    description: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    getReadySection: z.ZodArray<z.ZodString>;
+    debugSection: z.ZodArray<z.ZodObject<{
+        linkToCode: z.ZodURL;
+        issue: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>]>;
 export type ProgrammingLanguage = z.infer<typeof languageEnum>;
-export interface StepWithImage extends z.infer<typeof StepWithImageSchema> {
-}
-export interface StepsWithCodeBlock extends z.infer<typeof StepsWithCodeBlockSchema> {
-}
-export interface MultipleStepsWithCodeBlock extends z.infer<typeof MultipleStepsWithCodeBlockSchema> {
-}
-export interface Challenge extends z.infer<typeof ChallengeSchema> {
-}
-export interface NewProject extends z.infer<typeof NewProjectSchema> {
-}
-export interface ParsedLesson extends z.infer<typeof ParsedLessonSchema> {
-}
+export type ImageSlot = z.infer<typeof ImageSlotSchema>;
+export type StepWithImage = z.infer<typeof StepWithImageSchema>;
+export type StepsWithCodeBlock = z.infer<typeof StepsWithCodeBlockSchema>;
+export type Challenge = z.infer<typeof ChallengeSchema>;
+export type NewProject = z.infer<typeof NewProjectSchema>;
+export type Lesson = z.infer<typeof LessonSchema>;
+export type LessonLLM = z.infer<typeof LessonLLMSchema>;
 //# sourceMappingURL=lesson.d.ts.map

package/dist/schemas/lesson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lesson.d.ts","sourceRoot":"","sources":["../../src/schemas/lesson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,YAAY;;;;;;;;EAQvB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;iBAG9B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;iBAUnC,CAAC;AAEH,eAAO,MAAM,gCAAgC;;;kBAAoC,CAAC;AAElF,eAAO,MAAM,eAAe;;;;iBAc1B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;iBAS3B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoD7B,CAAC;AAGH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAC/D,MAAM,WAAW,aAAc,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC;CAAG;AAC7E,MAAM,WAAW,kBAAmB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC;CAAG;AACvF,MAAM,WAAW,0BAA2B,SAAQ,CAAC,CAAC,KAAK,CACzD,OAAO,gCAAgC,CACxC;CAAG;AACJ,MAAM,WAAW,SAAU,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC;CAAG;AACrE,MAAM,WAAW,UAAW,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC;CAAG;AACvE,MAAM,WAAW,YAAa,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC;CAAG"}
+{"version":3,"file":"lesson.d.ts","sourceRoot":"","sources":["../../src/schemas/lesson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,YAAY;;;;;;;;EAQvB,CAAC;AAKH,eAAO,MAAM,eAAe;;;iBAG1B,CAAC;AACH,eAAO,MAAM,wBAAwB;;;iBAWnC,CAAC;AACH,eAAO,MAAM,eAAe;;;;iBAe1B,CAAC;AACH,eAAO,MAAM,gBAAgB;;;iBAS3B,CAAC;AAKH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmDlC,CAAC;AAOH,eAAO,MAAM,mBAAmB;;;;;;iBAG9B,CAAC;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG9B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIjC,CAAC;AAGH,eAAO,MAAM,eAAe;;;iBAK1B,CAAC;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;iBAW5B,CAAC;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;iBAE/B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAIvB,CAAC;AAoBH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAI1B,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAIzC,CAAC;AAGH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAC/D,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/schemas/lesson.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { normaliseCodeBlock } from '../parsing/normalise.js';
+import { normaliseText } from '../parsing/normalise.js';
 export const languageEnum = z.enum([
     'none',
     'scratch',
@@ -9,9 +9,11 @@ export const languageEnum = z.enum([
     'java',
     'c',
 ]);
-export const StepWithImageSchema = z.object({
-    step: z.string().describe('The instruction text for this step'),
-    image: z.string().nullable().default(null).describe('Image reference if present, otherwise null'),
+// NOTE: Fields with no describe() are assigned using rule-based logic.
+// Reusable pieces that are apart of the standard lesson
+export const ImageSlotSchema = z.object({
+    id: z.string(),
+    base64: z.string().optional(),
 });
 export const StepsWithCodeBlockSchema = z.object({
     steps: z
@@ -21,10 +23,8 @@ export const StepsWithCodeBlockSchema = z.object({
         .string()
         .nullable()
         .default(null)
-        .describe('The code block that students have to write to get started')
-        .transform((val) => normaliseCodeBlock(val)),
+        .describe('The code block that students have to write to get started (white-space and new-lines preserved)'),
 });
-export const MultipleStepsWithCodeBlockSchema = z.array(StepsWithCodeBlockSchema);
 export const ChallengeSchema = z.object({
     name: z
         .string()
@@ -35,8 +35,7 @@ export const ChallengeSchema = z.object({
     hintCode: z
         .string()
         .nullable()
-        .describe('Code that gives a hint on how to complete the challenge (only code allowed)')
-        .transform((val) => normaliseCodeBlock(val)),
+        .describe('Code that gives a hint on how to complete the challenge (only code allowed, perserve whitespace and add line breaks)'),
 });
 export const NewProjectSchema = z.object({
     name: z
@@ -46,7 +45,11 @@ export const NewProjectSchema = z.object({
         .string()
         .describe('The task for the new project, explained as a requirement or new feature to add'),
 });
-export const ParsedLessonSchema = z.object({
+// Representation of any lesson that digimaker provides, dynamic fields that
+// account for all possible variations of input.
+// Programming text-based lessons
+export const ProgrammingLessonSchema = z.object({
+    lessonType: z.literal('text-based (programming) lesson'),
     topic: z
         .string()
         .describe('The main topic/category of the lesson (e.g., "Decisions", "Loops", "Variables")'),
@@ -55,44 +58,103 @@ export const ParsedLessonSchema = z.object({
         .describe('The name of the project being built (e.g., "Crossy Road", "Space Invaders")'),
     description: z
         .string()
-        .describe('A brief description explaining the programming concept being taught'),
+        .describe('A brief description explaining the programming concept being taught')
+        .transform((val) => {
+        return normaliseText(val) ?? val;
+    }),
     projectExplainer: z.string().describe('Explanation of what will be built in this lesson'),
     programmingLanguage: languageEnum
         .default('none')
         .describe('The programming language used in this lesson, figurable through code visible or wording'),
-    projectImage: z
-        .string()
+    prefaceImageSlots: z
+        .array(ImageSlotSchema)
         .nullable()
-        .default(null)
-        .describe('Reference to the main project image if present'),
+        .describe('Image slots for the preface, before the "Get Ready" section'),
     getReadySection: z
         .array(z.string())
         .describe('List of setup steps to prepare for the project (adding sprites, backdrops, etc.)'),
-    addYourCodeSection: z.union([
-        z
-            .array(StepWithImageSchema)
-            .describe('Step-by-step coding instructions, each step may have an associated image'),
-        StepsWithCodeBlockSchema.describe('A block of code given with steps on what it does'),
-        MultipleStepsWithCodeBlockSchema.describe('Multiple steps with a code block directly following each, or some without a code block'),
-    ]),
+    addYourCodeSection: z
+        .array(StepsWithCodeBlockSchema)
+        .describe('Multiple steps with a code block directly following each, or some without a code block. If there is only one step provide it as an array with one item')
+        .nullable()
+        .describe('Section that guides students on adding the base code. Null only when it is a debugging lesson'),
     tryItOutSection: z
         .array(z.string())
         .nullable()
-        .default(null)
-        .describe('Steps to test the project after coding'),
+        .describe('Steps to test the project after coding. Null only when it is a debugging lesson'),
     challengeSection: z
         .array(ChallengeSchema)
-        .describe('Challenge tasks for students to extend the project'),
-    newProject: NewProjectSchema.describe('Suggestion for a new project or extension activity'),
-    testYourself: z
-        .string()
         .nullable()
-        .default(null)
-        .describe('A link to the quiz, found under the "Test Yourself" header'),
-    funFact: z
+        .describe('Challenge tasks for students to extend the project. Null only when it is a debugging lesson'),
+    newProject: NewProjectSchema.nullable().describe('Suggestion for a new project or extension activity. Null only when it is a debugging lesson'),
+    testYourself: z.string().nullable(),
+    funFact: z.string().nullable().describe('An interesting fact related to the lesson topic'),
+}); // LLM version of the same schema
+const StandardLessonLLMSchema = ProgrammingLessonSchema.omit({
+    prefaceImageSlots: true,
+    testYourself: true,
+});
+// Scratch lessons
+export const StepWithImageSchema = z.object({
+    step: z.string().describe('The instruction text for this step'),
+    imageSlot: ImageSlotSchema.nullable().default(null),
+});
+export const ScratchLessonSchema = ProgrammingLessonSchema.extend({
+    lessonType: z.literal('block-based (scratch) lesson'),
+    addYourCodeSection: z.array(StepWithImageSchema),
+}); // LLM version of the same schema
+const StepWithImageLLMSchema = StepWithImageSchema.omit({ imageSlot: true });
+export const ScratchLessonLLMSchema = ScratchLessonSchema.extend({
+    addYourCodeSection: z.array(StepWithImageLLMSchema).describe('Step-by-step coding instructions'),
+}).omit({
+    prefaceImageSlots: true,
+});
+// Dbugging lessons
+export const DebugStepSchema = z.object({
+    linkToCode: z.url().describe('URL link to the static content'),
+    issue: z
         .string()
-        .nullable()
-        .default(null)
-        .describe('An interesting fact related to the lesson topic'),
+        .describe('The issue that must be fixed, preserve all original paragraph breaks and newlines'),
 });
+export const DebugLessonSchema = ProgrammingLessonSchema.extend({
+    lessonType: z.literal('debugging lesson'),
+    debugSection: z.array(DebugStepSchema).describe('Content found under the "Debug" headre'),
+}).omit({
+    projectExplainer: true,
+    addYourCodeSection: true,
+    tryItOutSection: true,
+    challengeSection: true,
+    newProject: true,
+    testYourself: true,
+    funFact: true,
+}); // LLM version of the same schema
+export const DebugLessonLLMSchema = DebugLessonSchema.omit({
+    prefaceImageSlots: true,
+});
+export const LessonSchema = z.discriminatedUnion('lessonType', [
+    ProgrammingLessonSchema,
+    ScratchLessonSchema,
+    DebugLessonSchema,
+]);
+// The fields that the LLM will not be able to see at all, when generating
+// These are populated with rule based logic
+const StandardLessonLLMSchemaNoType = StandardLessonLLMSchema.omit({
+    lessonType: true,
+}).describe('Use this for text-based programming lessons (Python, JS, Java, etc.) that follow a standard "Add your code" and "Challenge" flow.');
+const ScratchLessonLLMSchemaNoType = ScratchLessonLLMSchema.omit({
+    lessonType: true,
+}).describe('Use this ONLY for Scratch/block-based lessons where instructions are tied to visual steps rather than raw code blocks.');
+const DebugLessonLLMSchemaNoType = DebugLessonLLMSchema.omit({
+    lessonType: true,
+}).describe('Use this for debugging exercises where the goal is to fix an existing issues rather than building one from scratch.');
+export const LessonLLMSchema = z.union([
+    StandardLessonLLMSchemaNoType,
+    ScratchLessonLLMSchemaNoType,
+    DebugLessonLLMSchemaNoType,
+]);
+export const LessonLLMSchemaWithoutLanguage = z.union([
+    StandardLessonLLMSchemaNoType.omit({ programmingLanguage: true }),
+    ScratchLessonLLMSchemaNoType.omit({ programmingLanguage: true }),
+    DebugLessonLLMSchemaNoType.omit({ programmingLanguage: true }),
+]);
 //# sourceMappingURL=lesson.js.map