@thanh01.pmt/curriculum-kit 1.0.0

package/dist/pipeline/index.d.cts

@@ -0,0 +1,161 @@
+import { LessonPlan, ActivityLab, CodeLab, Handout, ProjectInstruction, SelfLab, DiagnosticQuiz, RoadmapInput, ProjectGraph, MilestoneInput, SelfPacedBundle } from '../schemas/index.cjs';
+import { B as BundleTier, M as MilestoneCurriculumBundle, a as AutoRepairResult } from '../milestoneBundleGenerator-DrBtHzBO.cjs';
+export { A as AutoRepairOptions, G as GenerateMilestoneBundleOptions, g as generateMilestoneCurriculumBundle, w as withAutoRepair } from '../milestoneBundleGenerator-DrBtHzBO.cjs';
+import { M as ModelResolutionOptions } from '../provider-factory-DH3udYlN.cjs';
+import { I as ICurriculumStorage, P as ProjectStatusReport } from '../types-BUJGYiep.cjs';
+import 'zod';
+import 'ai';
+
+/**
+ * Serializes a LessonPlan object into canonical LESSON.md (5E Model & Deep Technical Standards)
+ */
+declare function serializeLessonToMarkdown(lesson: LessonPlan): string;
+/**
+ * Serializes an ActivityLab object into canonical ACT.md (Inquiry-Based & Computational Thinking)
+ */
+declare function serializeActivityToMarkdown(act: ActivityLab): string;
+/**
+ * Serializes CodeLab object into canonical LAB.md (LAB_TEMPLATE standard)
+ */
+declare function serializeCodeLabToMarkdown(codeLab: CodeLab): string;
+/**
+ * Serializes Handout to HANDOUT.md (5-Second Rule Cheat Sheet standard)
+ */
+declare function serializeHandoutToMarkdown(handout: Handout): string;
+/**
+ * Serializes ProjectInstruction to Instructable-style INSTRUCTION.md
+ */
+declare function serializeProjectInstructionToMarkdown(instruction: ProjectInstruction): string;
+
+/**
+ * Serializes SelfLab object into canonical SELF_LAB.md with Progressive Hints (Accordion / Spoilers)
+ */
+declare function serializeSelfLabToMarkdown(lab: SelfLab): string;
+/**
+ * Serializes DiagnosticQuiz object into canonical QUIZ.md
+ */
+declare function serializeDiagnosticQuizToMarkdown(quiz: DiagnosticQuiz): string;
+
+interface GenerateRoadmapCurriculumOptions {
+    roadmap: RoadmapInput;
+    language?: string;
+    bundleTier?: BundleTier;
+    concurrency?: number;
+    enableJudgeRepair?: boolean;
+    modelOptions?: ModelResolutionOptions;
+    onMilestoneProgress?: (milestoneId: string, current: number, total: number) => void;
+}
+interface RoadmapCurriculumOutput {
+    projectTitle: string;
+    language: string;
+    totalMilestones: number;
+    bundles: MilestoneCurriculumBundle[];
+}
+/**
+ * Generates curriculum bundles for an entire Roadmap from knowledge-tree
+ */
+declare function generateRoadmapCurriculum(options: GenerateRoadmapCurriculumOptions): Promise<RoadmapCurriculumOutput>;
+
+interface GenerateProjectInstructionOptions {
+    projectGraph?: ProjectGraph;
+    milestone: MilestoneInput;
+    roadmapContext?: {
+        projectTitle?: string;
+        techStack?: string[];
+        phaseTitle?: string;
+    };
+    researchNotes?: string;
+    externalResources?: string[];
+    language?: string;
+    difficulty?: 'beginner' | 'intermediate' | 'advanced';
+    enableJudgeRepair?: boolean;
+    modelOptions?: ModelResolutionOptions;
+}
+interface ProjectInstructionResult {
+    instruction: ProjectInstruction;
+    instructionMarkdown: string;
+    judgeResult?: AutoRepairResult<ProjectInstruction>;
+}
+/**
+ * Generates an Instructable-style Step-by-Step Project Instruction / Tutorial
+ * adhering to researcher/prompts/tutorial.md methodology.
+ */
+declare function generateProjectInstruction(options: GenerateProjectInstructionOptions): Promise<ProjectInstructionResult>;
+
+interface GenerateSelfPacedBundleInput {
+    milestone: MilestoneInput;
+    projectGraph?: ProjectGraph;
+    language?: string;
+    targetTechStack?: string[];
+    contextContinuity?: string;
+    outputDirectory?: string;
+    modelOptions?: ModelResolutionOptions;
+}
+interface SelfPacedBundleOutput {
+    bundle: SelfPacedBundle;
+    markdown: {
+        instructionMd: string;
+        selfLabMd: string;
+        quizMd: string;
+        cheatSheetMd: string;
+        codeLabMd?: string;
+    };
+    outputDirectory?: string;
+}
+/**
+ * Orchestrates generation of a complete Autonomous Self-Learner Bundle
+ */
+declare function generateSelfPacedBundle(input: GenerateSelfPacedBundleInput): Promise<SelfPacedBundleOutput>;
+
+interface ConvertedSotBundle {
+    learnerProfile: string;
+    projectBrief: string;
+    referencePack: string;
+    curriculumFramework: string;
+    contentStyleGuide: string;
+    artDirection: string;
+    projectStatus: string;
+}
+/**
+ * Normalizes and converts Roadmap JSON and Project Graph JSON from knowledge-tree into 7 Canonical SOT Foundation Files.
+ */
+declare function convertRoadmapToFoundationSot(roadmapInput: any, projectGraphInput?: any): ConvertedSotBundle;
+/**
+ * High-level function to import Roadmap JSON and Project Graph JSON into storage as a fully initialized SOT project.
+ */
+declare function importRoadmapToProject(storage: ICurriculumStorage, projectId: string, roadmapInput: any, projectGraphInput?: any): Promise<ProjectStatusReport>;
+
+interface LintIssue {
+    line?: number;
+    type: 'PREAMBLE' | 'POSTAMBLE' | 'CODE_FENCE' | 'TABLE' | 'MERMAID' | 'FRONTMATTER' | 'PLACEHOLDER' | 'MATH';
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    autoFixable: boolean;
+}
+interface ArtifactLintReport {
+    filePath?: string;
+    isValid: boolean;
+    issues: LintIssue[];
+    autoFixedContent: string;
+    fixedCount: number;
+}
+/**
+ * Validates Mermaid diagram blocks for common syntax errors
+ */
+declare function validateMermaidSyntax(code: string): {
+    valid: boolean;
+    error?: string;
+};
+/**
+ * Validates and repairs markdown tables for column parity
+ */
+declare function validateMarkdownTables(raw: string): {
+    issues: LintIssue[];
+    fixedContent: string;
+};
+/**
+ * Scans, lints, and automatically sanitizes an artifact markdown document.
+ */
+declare function lintAndSanitizeArtifact(rawContent: string, filePath?: string): ArtifactLintReport;
+
+export { type ArtifactLintReport, AutoRepairResult, BundleTier, type ConvertedSotBundle, type GenerateProjectInstructionOptions, type GenerateRoadmapCurriculumOptions, type GenerateSelfPacedBundleInput, type LintIssue, MilestoneCurriculumBundle, type ProjectInstructionResult, type RoadmapCurriculumOutput, type SelfPacedBundleOutput, convertRoadmapToFoundationSot, generateProjectInstruction, generateRoadmapCurriculum, generateSelfPacedBundle, importRoadmapToProject, lintAndSanitizeArtifact, serializeActivityToMarkdown, serializeCodeLabToMarkdown, serializeDiagnosticQuizToMarkdown, serializeHandoutToMarkdown, serializeLessonToMarkdown, serializeProjectInstructionToMarkdown, serializeSelfLabToMarkdown, validateMarkdownTables, validateMermaidSyntax };

package/dist/pipeline/index.d.ts

@@ -0,0 +1,161 @@
+import { LessonPlan, ActivityLab, CodeLab, Handout, ProjectInstruction, SelfLab, DiagnosticQuiz, RoadmapInput, ProjectGraph, MilestoneInput, SelfPacedBundle } from '../schemas/index.js';
+import { B as BundleTier, M as MilestoneCurriculumBundle, a as AutoRepairResult } from '../milestoneBundleGenerator-CbXhs1CP.js';
+export { A as AutoRepairOptions, G as GenerateMilestoneBundleOptions, g as generateMilestoneCurriculumBundle, w as withAutoRepair } from '../milestoneBundleGenerator-CbXhs1CP.js';
+import { M as ModelResolutionOptions } from '../provider-factory-DH3udYlN.js';
+import { I as ICurriculumStorage, P as ProjectStatusReport } from '../types-BUJGYiep.js';
+import 'zod';
+import 'ai';
+
+/**
+ * Serializes a LessonPlan object into canonical LESSON.md (5E Model & Deep Technical Standards)
+ */
+declare function serializeLessonToMarkdown(lesson: LessonPlan): string;
+/**
+ * Serializes an ActivityLab object into canonical ACT.md (Inquiry-Based & Computational Thinking)
+ */
+declare function serializeActivityToMarkdown(act: ActivityLab): string;
+/**
+ * Serializes CodeLab object into canonical LAB.md (LAB_TEMPLATE standard)
+ */
+declare function serializeCodeLabToMarkdown(codeLab: CodeLab): string;
+/**
+ * Serializes Handout to HANDOUT.md (5-Second Rule Cheat Sheet standard)
+ */
+declare function serializeHandoutToMarkdown(handout: Handout): string;
+/**
+ * Serializes ProjectInstruction to Instructable-style INSTRUCTION.md
+ */
+declare function serializeProjectInstructionToMarkdown(instruction: ProjectInstruction): string;
+
+/**
+ * Serializes SelfLab object into canonical SELF_LAB.md with Progressive Hints (Accordion / Spoilers)
+ */
+declare function serializeSelfLabToMarkdown(lab: SelfLab): string;
+/**
+ * Serializes DiagnosticQuiz object into canonical QUIZ.md
+ */
+declare function serializeDiagnosticQuizToMarkdown(quiz: DiagnosticQuiz): string;
+
+interface GenerateRoadmapCurriculumOptions {
+    roadmap: RoadmapInput;
+    language?: string;
+    bundleTier?: BundleTier;
+    concurrency?: number;
+    enableJudgeRepair?: boolean;
+    modelOptions?: ModelResolutionOptions;
+    onMilestoneProgress?: (milestoneId: string, current: number, total: number) => void;
+}
+interface RoadmapCurriculumOutput {
+    projectTitle: string;
+    language: string;
+    totalMilestones: number;
+    bundles: MilestoneCurriculumBundle[];
+}
+/**
+ * Generates curriculum bundles for an entire Roadmap from knowledge-tree
+ */
+declare function generateRoadmapCurriculum(options: GenerateRoadmapCurriculumOptions): Promise<RoadmapCurriculumOutput>;
+
+interface GenerateProjectInstructionOptions {
+    projectGraph?: ProjectGraph;
+    milestone: MilestoneInput;
+    roadmapContext?: {
+        projectTitle?: string;
+        techStack?: string[];
+        phaseTitle?: string;
+    };
+    researchNotes?: string;
+    externalResources?: string[];
+    language?: string;
+    difficulty?: 'beginner' | 'intermediate' | 'advanced';
+    enableJudgeRepair?: boolean;
+    modelOptions?: ModelResolutionOptions;
+}
+interface ProjectInstructionResult {
+    instruction: ProjectInstruction;
+    instructionMarkdown: string;
+    judgeResult?: AutoRepairResult<ProjectInstruction>;
+}
+/**
+ * Generates an Instructable-style Step-by-Step Project Instruction / Tutorial
+ * adhering to researcher/prompts/tutorial.md methodology.
+ */
+declare function generateProjectInstruction(options: GenerateProjectInstructionOptions): Promise<ProjectInstructionResult>;
+
+interface GenerateSelfPacedBundleInput {
+    milestone: MilestoneInput;
+    projectGraph?: ProjectGraph;
+    language?: string;
+    targetTechStack?: string[];
+    contextContinuity?: string;
+    outputDirectory?: string;
+    modelOptions?: ModelResolutionOptions;
+}
+interface SelfPacedBundleOutput {
+    bundle: SelfPacedBundle;
+    markdown: {
+        instructionMd: string;
+        selfLabMd: string;
+        quizMd: string;
+        cheatSheetMd: string;
+        codeLabMd?: string;
+    };
+    outputDirectory?: string;
+}
+/**
+ * Orchestrates generation of a complete Autonomous Self-Learner Bundle
+ */
+declare function generateSelfPacedBundle(input: GenerateSelfPacedBundleInput): Promise<SelfPacedBundleOutput>;
+
+interface ConvertedSotBundle {
+    learnerProfile: string;
+    projectBrief: string;
+    referencePack: string;
+    curriculumFramework: string;
+    contentStyleGuide: string;
+    artDirection: string;
+    projectStatus: string;
+}
+/**
+ * Normalizes and converts Roadmap JSON and Project Graph JSON from knowledge-tree into 7 Canonical SOT Foundation Files.
+ */
+declare function convertRoadmapToFoundationSot(roadmapInput: any, projectGraphInput?: any): ConvertedSotBundle;
+/**
+ * High-level function to import Roadmap JSON and Project Graph JSON into storage as a fully initialized SOT project.
+ */
+declare function importRoadmapToProject(storage: ICurriculumStorage, projectId: string, roadmapInput: any, projectGraphInput?: any): Promise<ProjectStatusReport>;
+
+interface LintIssue {
+    line?: number;
+    type: 'PREAMBLE' | 'POSTAMBLE' | 'CODE_FENCE' | 'TABLE' | 'MERMAID' | 'FRONTMATTER' | 'PLACEHOLDER' | 'MATH';
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    autoFixable: boolean;
+}
+interface ArtifactLintReport {
+    filePath?: string;
+    isValid: boolean;
+    issues: LintIssue[];
+    autoFixedContent: string;
+    fixedCount: number;
+}
+/**
+ * Validates Mermaid diagram blocks for common syntax errors
+ */
+declare function validateMermaidSyntax(code: string): {
+    valid: boolean;
+    error?: string;
+};
+/**
+ * Validates and repairs markdown tables for column parity
+ */
+declare function validateMarkdownTables(raw: string): {
+    issues: LintIssue[];
+    fixedContent: string;
+};
+/**
+ * Scans, lints, and automatically sanitizes an artifact markdown document.
+ */
+declare function lintAndSanitizeArtifact(rawContent: string, filePath?: string): ArtifactLintReport;
+
+export { type ArtifactLintReport, AutoRepairResult, BundleTier, type ConvertedSotBundle, type GenerateProjectInstructionOptions, type GenerateRoadmapCurriculumOptions, type GenerateSelfPacedBundleInput, type LintIssue, MilestoneCurriculumBundle, type ProjectInstructionResult, type RoadmapCurriculumOutput, type SelfPacedBundleOutput, convertRoadmapToFoundationSot, generateProjectInstruction, generateRoadmapCurriculum, generateSelfPacedBundle, importRoadmapToProject, lintAndSanitizeArtifact, serializeActivityToMarkdown, serializeCodeLabToMarkdown, serializeDiagnosticQuizToMarkdown, serializeHandoutToMarkdown, serializeLessonToMarkdown, serializeProjectInstructionToMarkdown, serializeSelfLabToMarkdown, validateMarkdownTables, validateMermaidSyntax };