@thanh01.pmt/curriculum-kit 1.0.13 → 1.0.15

package/dist/gateSettings-DKXRztJy.d.cts

@@ -0,0 +1,119 @@
+type ArtifactType = 'lesson' | 'slide' | 'act' | 'quiz' | 'guide' | 'handout' | 'worksheet' | 'rubric' | 'ext' | 'glossary' | 'codelab' | 'bom' | 'exit_ticket' | 'tiered_practice' | 'choice_board' | 'science_lab' | 'task_cards' | 'station_rotation' | 'bell_ringer' | 'review_game' | 'graphic_organizer';
+type ScaffoldingLevel = 'foundation' | 'balanced' | 'advanced';
+interface SingleArtifactRequest {
+    artifactType: ArtifactType;
+    topic: string;
+    lessonId?: string;
+    lessonTitle?: string;
+    pedagogy?: '5e' | 'edp' | 'pbl' | 'general';
+    targetAge?: string;
+    scaffoldingLevel?: ScaffoldingLevel;
+    hardwarePlatform?: string[];
+    gradeLevel?: string;
+    studentCount?: string;
+    language?: string;
+    extraContext?: string;
+    config?: Record<string, any>;
+    contextSot?: {
+        framework?: string;
+        learnerProfile?: string;
+        lessonPlan?: string;
+        handout?: string;
+    };
+    /**
+     * Media Ledger policy (nếu có): agent chèn placeholder [IMAGE: slug], Curator duyệt,
+     * Fulfiller thực thi (search Pexels / gen AI). Không truyền → không planning ảnh.
+     */
+    mediaPolicy?: {
+        maxGenImagesPerArtifact: number;
+        autoFulfill?: boolean;
+        preferredProvider?: 'openai' | 'gemini';
+        mode?: 'search_only' | 'gen_only' | 'auto';
+    };
+    /**
+     * Nghiên cứu nền (từ research-kit harvest hoặc preliminary research) — bối cảnh
+     * fact-grounded để giảm outdate/hallucination khi sinh artifact standalone.
+     */
+    researchContext?: string;
+    /**
+     * Gate settings thô (vd gateModes từ project.config.json của Composer —
+     * scratch dùng config của chính nó). Kit tự chuẩn hoá; thiếu key = OFF
+     * (không kiểm). LLM_JUDGE → judge sau khi sinh + repair 1 vòng, fail-closed.
+     * HITL → chờ human duyệt (caller xử lý pause/resume).
+     */
+    gateSettings?: unknown;
+    options?: {
+        model?: string;
+        temperature?: number;
+        openrouterKey?: string;
+        alibabaKey?: string;
+        deepseekKey?: string;
+        geminiKey?: string;
+        nvidiaKey?: string;
+        openaiKey?: string;
+        anthropicKey?: string;
+    };
+    onChunk?: (chunk: string, type: 'content' | 'thought') => void;
+}
+interface SingleArtifactResult {
+    artifactType: ArtifactType;
+    filename: string;
+    content: string;
+    persona: string;
+    thought?: string;
+    /** Gate outcome: HITL đang chờ người duyệt; judge_needs_revision → bị từ chối sau repair; judge_error → fail-closed. */
+    pausedForReview?: boolean;
+    gateStatus?: 'awaiting_approval' | 'judge_needs_revision' | 'judge_error';
+    judgeScore?: number;
+    judgeCritique?: string;
+}
+/**
+ * Maps artifact type to default canonical filename and responsible agent persona
+ */
+declare function getArtifactMetadata(type: ArtifactType, lessonId?: string, pedagogy?: string): {
+    filename: string;
+    persona: string;
+    templateFile: string;
+};
+/**
+ * Universal Single Artifact Generator Service for all 21 Pedagogical JTBD Artifacts
+ */
+declare function generateSingleArtifact(req: SingleArtifactRequest): Promise<SingleArtifactResult>;
+
+/**
+ * Gate Settings — toàn bộ logic "ai kiểm artifact nào" nằm ở đây, trong kit.
+ * Composer chỉ gọi: resolveGateSettings(projectConfig.gateModes) rồi dùng kết quả.
+ *
+ * Vocabulary chuẩn (duy nhất, không có biến thể thứ hai):
+ *   'OFF'       — không kiểm
+ *   'LLM_JUDGE' — Agent kiểm (LLM-as-Judge)
+ *   'HITL'      — Human kiểm (human-in-the-loop)
+ *
+ * Phạm vi phủ: SOT foundation (Learner Profile, Framework, Style Guide — duyệt trước khi
+ * sinh content) + toàn bộ content artifacts.
+ */
+type CurriculumGateMode = 'OFF' | 'LLM_JUDGE' | 'HITL';
+type CurriculumArtifactType = 'LEARNER_PROFILE' | 'PROJECT_BRIEF' | 'REFERENCE_PACK' | 'CURRICULUM_FRAMEWORK' | 'KNOWLEDGE_EXPOSITION' | 'STYLE_GUIDE' | 'ART_DIRECTION' | 'LESSON' | 'ACT' | 'QUIZ' | 'SLIDE' | 'GUIDE' | 'WKS' | 'HANDOUT' | 'EXT' | 'CODE' | 'MEDIA_SCRIPT' | 'EXIT_TICKET';
+type GateSettings = Partial<Record<CurriculumArtifactType, CurriculumGateMode>>;
+type ResolvedGateSettings = Readonly<Record<CurriculumArtifactType, CurriculumGateMode>>;
+/**
+ * Mặc định: KHÔNG KIỂM (all-OFF) — triết lý "config là nguồn duy nhất".
+ * Không gate nào được hồi sinh ngầm khi thiếu key trong project.config.json.
+ * Composer (apps/web) ghi gateModes đầy đủ tường minh lúc tạo project / lưu settings,
+ * và user toàn quyền đổi qua Settings cho project/scratch đang chạy.
+ */
+declare const DEFAULT_GATE_SETTINGS: ResolvedGateSettings;
+/**
+ * Chuẩn hoá config thô (vd: gateModes đọc từ project.config.json của Composer) thành GateSettings.
+ * Key/value không nhận diện được bị bỏ qua — config sai không bao giờ làm workflow chết.
+ */
+declare function parseGateSettings(raw: unknown): GateSettings;
+/**
+ * Điểm vào DUY NHẤT: raw config (hoặc đã chuẩn hoá) → settings đầy đủ cho mọi artifact type.
+ * Key không có trong config nhận DEFAULT_GATE_SETTINGS.
+ */
+declare function resolveGateSettings(raw?: unknown): ResolvedGateSettings;
+/** Mode đã resolve cho 1 artifact type. */
+declare function gateModeFor(resolved: ResolvedGateSettings, type: CurriculumArtifactType): CurriculumGateMode;
+
+export { type ArtifactType as A, type CurriculumGateMode as C, DEFAULT_GATE_SETTINGS as D, type GateSettings as G, type ResolvedGateSettings as R, type SingleArtifactRequest as S, type SingleArtifactResult as a, type CurriculumArtifactType as b, type ScaffoldingLevel as c, getArtifactMetadata as d, generateSingleArtifact as e, gateModeFor as g, parseGateSettings as p, resolveGateSettings as r };

package/dist/gateSettings-DKXRztJy.d.ts

@@ -0,0 +1,119 @@
+type ArtifactType = 'lesson' | 'slide' | 'act' | 'quiz' | 'guide' | 'handout' | 'worksheet' | 'rubric' | 'ext' | 'glossary' | 'codelab' | 'bom' | 'exit_ticket' | 'tiered_practice' | 'choice_board' | 'science_lab' | 'task_cards' | 'station_rotation' | 'bell_ringer' | 'review_game' | 'graphic_organizer';
+type ScaffoldingLevel = 'foundation' | 'balanced' | 'advanced';
+interface SingleArtifactRequest {
+    artifactType: ArtifactType;
+    topic: string;
+    lessonId?: string;
+    lessonTitle?: string;
+    pedagogy?: '5e' | 'edp' | 'pbl' | 'general';
+    targetAge?: string;
+    scaffoldingLevel?: ScaffoldingLevel;
+    hardwarePlatform?: string[];
+    gradeLevel?: string;
+    studentCount?: string;
+    language?: string;
+    extraContext?: string;
+    config?: Record<string, any>;
+    contextSot?: {
+        framework?: string;
+        learnerProfile?: string;
+        lessonPlan?: string;
+        handout?: string;
+    };
+    /**
+     * Media Ledger policy (nếu có): agent chèn placeholder [IMAGE: slug], Curator duyệt,
+     * Fulfiller thực thi (search Pexels / gen AI). Không truyền → không planning ảnh.
+     */
+    mediaPolicy?: {
+        maxGenImagesPerArtifact: number;
+        autoFulfill?: boolean;
+        preferredProvider?: 'openai' | 'gemini';
+        mode?: 'search_only' | 'gen_only' | 'auto';
+    };
+    /**
+     * Nghiên cứu nền (từ research-kit harvest hoặc preliminary research) — bối cảnh
+     * fact-grounded để giảm outdate/hallucination khi sinh artifact standalone.
+     */
+    researchContext?: string;
+    /**
+     * Gate settings thô (vd gateModes từ project.config.json của Composer —
+     * scratch dùng config của chính nó). Kit tự chuẩn hoá; thiếu key = OFF
+     * (không kiểm). LLM_JUDGE → judge sau khi sinh + repair 1 vòng, fail-closed.
+     * HITL → chờ human duyệt (caller xử lý pause/resume).
+     */
+    gateSettings?: unknown;
+    options?: {
+        model?: string;
+        temperature?: number;
+        openrouterKey?: string;
+        alibabaKey?: string;
+        deepseekKey?: string;
+        geminiKey?: string;
+        nvidiaKey?: string;
+        openaiKey?: string;
+        anthropicKey?: string;
+    };
+    onChunk?: (chunk: string, type: 'content' | 'thought') => void;
+}
+interface SingleArtifactResult {
+    artifactType: ArtifactType;
+    filename: string;
+    content: string;
+    persona: string;
+    thought?: string;
+    /** Gate outcome: HITL đang chờ người duyệt; judge_needs_revision → bị từ chối sau repair; judge_error → fail-closed. */
+    pausedForReview?: boolean;
+    gateStatus?: 'awaiting_approval' | 'judge_needs_revision' | 'judge_error';
+    judgeScore?: number;
+    judgeCritique?: string;
+}
+/**
+ * Maps artifact type to default canonical filename and responsible agent persona
+ */
+declare function getArtifactMetadata(type: ArtifactType, lessonId?: string, pedagogy?: string): {
+    filename: string;
+    persona: string;
+    templateFile: string;
+};
+/**
+ * Universal Single Artifact Generator Service for all 21 Pedagogical JTBD Artifacts
+ */
+declare function generateSingleArtifact(req: SingleArtifactRequest): Promise<SingleArtifactResult>;
+
+/**
+ * Gate Settings — toàn bộ logic "ai kiểm artifact nào" nằm ở đây, trong kit.
+ * Composer chỉ gọi: resolveGateSettings(projectConfig.gateModes) rồi dùng kết quả.
+ *
+ * Vocabulary chuẩn (duy nhất, không có biến thể thứ hai):
+ *   'OFF'       — không kiểm
+ *   'LLM_JUDGE' — Agent kiểm (LLM-as-Judge)
+ *   'HITL'      — Human kiểm (human-in-the-loop)
+ *
+ * Phạm vi phủ: SOT foundation (Learner Profile, Framework, Style Guide — duyệt trước khi
+ * sinh content) + toàn bộ content artifacts.
+ */
+type CurriculumGateMode = 'OFF' | 'LLM_JUDGE' | 'HITL';
+type CurriculumArtifactType = 'LEARNER_PROFILE' | 'PROJECT_BRIEF' | 'REFERENCE_PACK' | 'CURRICULUM_FRAMEWORK' | 'KNOWLEDGE_EXPOSITION' | 'STYLE_GUIDE' | 'ART_DIRECTION' | 'LESSON' | 'ACT' | 'QUIZ' | 'SLIDE' | 'GUIDE' | 'WKS' | 'HANDOUT' | 'EXT' | 'CODE' | 'MEDIA_SCRIPT' | 'EXIT_TICKET';
+type GateSettings = Partial<Record<CurriculumArtifactType, CurriculumGateMode>>;
+type ResolvedGateSettings = Readonly<Record<CurriculumArtifactType, CurriculumGateMode>>;
+/**
+ * Mặc định: KHÔNG KIỂM (all-OFF) — triết lý "config là nguồn duy nhất".
+ * Không gate nào được hồi sinh ngầm khi thiếu key trong project.config.json.
+ * Composer (apps/web) ghi gateModes đầy đủ tường minh lúc tạo project / lưu settings,
+ * và user toàn quyền đổi qua Settings cho project/scratch đang chạy.
+ */
+declare const DEFAULT_GATE_SETTINGS: ResolvedGateSettings;
+/**
+ * Chuẩn hoá config thô (vd: gateModes đọc từ project.config.json của Composer) thành GateSettings.
+ * Key/value không nhận diện được bị bỏ qua — config sai không bao giờ làm workflow chết.
+ */
+declare function parseGateSettings(raw: unknown): GateSettings;
+/**
+ * Điểm vào DUY NHẤT: raw config (hoặc đã chuẩn hoá) → settings đầy đủ cho mọi artifact type.
+ * Key không có trong config nhận DEFAULT_GATE_SETTINGS.
+ */
+declare function resolveGateSettings(raw?: unknown): ResolvedGateSettings;
+/** Mode đã resolve cho 1 artifact type. */
+declare function gateModeFor(resolved: ResolvedGateSettings, type: CurriculumArtifactType): CurriculumGateMode;
+
+export { type ArtifactType as A, type CurriculumGateMode as C, DEFAULT_GATE_SETTINGS as D, type GateSettings as G, type ResolvedGateSettings as R, type SingleArtifactRequest as S, type SingleArtifactResult as a, type CurriculumArtifactType as b, type ScaffoldingLevel as c, getArtifactMetadata as d, generateSingleArtifact as e, gateModeFor as g, parseGateSettings as p, resolveGateSettings as r };