@zaowu-labs/teach 1.0.1

package/README.md

@@ -0,0 +1,12 @@
+# @zaowu-labs/teach
+
+Teaching workflow package for ZaoWu.
+
+This package provides deterministic local teaching-plan and quiz generation for
+the first CLI foundation.
+
+Safety:
+
+- It does not call external AI services.
+- Future AI-backed teaching behavior should go through `@zaowu-labs/ai`.
+- User-facing commands should keep output readable before adding complexity.

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { type DomainDefinition } from '@zaowu-labs/core';
+export interface TeachPlanResult {
+    schemaVersion: 1;
+    status: 'ok';
+    topic: string;
+    outline: string[];
+}
+export interface TeachQuizResult {
+    schemaVersion: 1;
+    status: 'ok';
+    topic: string;
+    questionCount: number;
+    questions: string[];
+    format?: string;
+    content?: string;
+}
+export declare const TEACH_DOMAIN: DomainDefinition;
+export declare const createTeachingPlan: (input: string) => Promise<TeachPlanResult>;
+export declare const createTeachingQuiz: (input: string, options?: {
+    format?: string;
+    count?: number;
+}) => Promise<TeachQuizResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE7F,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,CAAC,CAAC;IACjB,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,CAAC,CAAC;IACjB,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,eAAO,MAAM,YAAY,EAAE,gBAkB1B,CAAC;AA8CF,eAAO,MAAM,kBAAkB,GAAU,OAAO,MAAM,KAAG,OAAO,CAAC,eAAe,CA6B/E,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EACb,UAAS;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,KAChD,OAAO,CAAC,eAAe,CA0CzB,CAAC"}

package/dist/index.js

@@ -0,0 +1,124 @@
+import { readFile } from 'node:fs/promises';
+import { createCapabilityLedger, ZaoWuError } from '@zaowu-labs/core';
+const DEFAULT_QUIZ_COUNT = 3;
+const MAX_QUIZ_COUNT = 20;
+export const TEACH_DOMAIN = {
+    name: 'teach',
+    summary: 'Teaching workflows for lesson planning and practice materials',
+    capabilities: createCapabilityLedger({
+        readsFiles: true,
+    }),
+    commands: [
+        {
+            name: 'plan',
+            summary: 'Create a teaching plan',
+            status: 'available',
+        },
+        {
+            name: 'quiz',
+            summary: 'Create practice questions from provided material',
+            status: 'available',
+        },
+    ],
+};
+const readTopicOrFile = async (input) => {
+    if (!input.trim()) {
+        throw new ZaoWuError({
+            code: 'TEACH_INPUT_REQUIRED',
+            message: 'Teaching input is required.',
+            why: '`zw teach` needs a topic, text, or readable file path.',
+            fix: 'Run `zw teach plan "TypeScript basics"`.',
+        });
+    }
+    try {
+        return await readFile(input, 'utf8');
+    }
+    catch {
+        // Not a readable file path — treat the input as a literal topic string.
+        return input;
+    }
+};
+const getTopic = (content) => {
+    const firstLine = content
+        .split(/\r?\n/)
+        .map((line) => line.replace(/^#+\s*/, '').trim())
+        .find(Boolean);
+    return firstLine ?? 'Untitled topic';
+};
+const getSentences = (content) => content
+    .split(/[.!?\n。！？]+/)
+    .map((sentence) => sentence.trim())
+    .filter(Boolean);
+/**
+ * Extract heading lines from markdown-like content.
+ * Returns bare heading text without the leading # characters.
+ */
+const getHeadings = (content) => content
+    .split(/\r?\n/)
+    .filter((line) => /^#{1,6}\s/.test(line))
+    .map((line) => line.replace(/^#+\s*/, '').trim())
+    .filter(Boolean);
+export const createTeachingPlan = async (input) => {
+    const content = await readTopicOrFile(input);
+    const topic = getTopic(content);
+    const headings = getHeadings(content);
+    // Build a richer outline when the content has discoverable section headings.
+    const outline = headings.length > 1
+        ? [
+            `Goal: understand ${topic}.`,
+            'Warm-up: ask what the learner already knows.',
+            ...headings.slice(1).map((h, i) => `Section ${i + 1}: ${h}`),
+            'Practice: complete a short guided exercise.',
+            'Check: summarize the key point and one common mistake.',
+        ]
+        : [
+            `Goal: understand ${topic}.`,
+            'Warm-up: ask what the learner already knows.',
+            'Explain: introduce the core idea with one concrete example.',
+            'Practice: complete a short guided exercise.',
+            'Check: summarize the key point and one common mistake.',
+        ];
+    return {
+        schemaVersion: 1,
+        status: 'ok',
+        topic,
+        outline,
+    };
+};
+export const createTeachingQuiz = async (input, options = {}) => {
+    const rawCount = options.count ?? DEFAULT_QUIZ_COUNT;
+    if (!Number.isInteger(rawCount) || rawCount < 1 || rawCount > MAX_QUIZ_COUNT) {
+        throw new ZaoWuError({
+            code: 'TEACH_INPUT_REQUIRED',
+            message: 'Quiz count is out of range.',
+            why: `Question count must be a whole number between 1 and ${MAX_QUIZ_COUNT}, but got ${rawCount}.`,
+            fix: 'Run `zw teach quiz --count 5 "your topic"` to generate 5 questions.',
+        });
+    }
+    const count = rawCount;
+    const content = await readTopicOrFile(input);
+    const topic = getTopic(content);
+    const sentences = getSentences(content).slice(0, count);
+    const questions = sentences.length > 0
+        ? sentences.map((sentence, index) => `Q${index + 1}: Explain this idea in your own words: ${sentence}.`)
+        : [`Q1: What is the main idea of ${topic}?`];
+    const format = options.format === 'canvas-csv' ? 'canvas-csv' : 'text';
+    let resultCsv = '';
+    if (format === 'canvas-csv') {
+        const lines = [
+            'Type,Question Text,Points',
+            ...questions.map((q) => `E,"${q.replaceAll('"', '""')}",1`),
+        ];
+        resultCsv = lines.join('\n') + '\n';
+    }
+    return {
+        schemaVersion: 1,
+        status: 'ok',
+        topic,
+        questionCount: questions.length,
+        questions,
+        format,
+        content: format === 'canvas-csv' ? resultCsv : undefined,
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AAmB7F,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,cAAc,GAAG,EAAE,CAAC;AAE1B,MAAM,CAAC,MAAM,YAAY,GAAqB;IAC5C,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,+DAA+D;IACxE,YAAY,EAAE,sBAAsB,CAAC;QACnC,UAAU,EAAE,IAAI;KACjB,CAAC;IACF,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,wBAAwB;YACjC,MAAM,EAAE,WAAW;SACpB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,kDAAkD;YAC3D,MAAM,EAAE,WAAW;SACpB;KACF;CACF,CAAC;AAEF,MAAM,eAAe,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;IAC/D,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAClB,MAAM,IAAI,UAAU,CAAC;YACnB,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,6BAA6B;YACtC,GAAG,EAAE,wDAAwD;YAC7D,GAAG,EAAE,0CAA0C;SAChD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,wEAAwE;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,OAAe,EAAU,EAAE;IAC3C,MAAM,SAAS,GAAG,OAAO;SACtB,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;SAChD,IAAI,CAAC,OAAO,CAAC,CAAC;IAEjB,OAAO,SAAS,IAAI,gBAAgB,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAe,EAAY,EAAE,CACjD,OAAO;KACJ,KAAK,CAAC,aAAa,CAAC;KACpB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;KAClC,MAAM,CAAC,OAAO,CAAC,CAAC;AAErB;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,OAAe,EAAY,EAAE,CAChD,OAAO;KACJ,KAAK,CAAC,OAAO,CAAC;KACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACxC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;KAChD,MAAM,CAAC,OAAO,CAAC,CAAC;AAErB,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,KAAa,EAA4B,EAAE;IAClF,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEtC,6EAA6E;IAC7E,MAAM,OAAO,GACX,QAAQ,CAAC,MAAM,GAAG,CAAC;QACjB,CAAC,CAAC;YACE,oBAAoB,KAAK,GAAG;YAC5B,8CAA8C;YAC9C,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,6CAA6C;YAC7C,wDAAwD;SACzD;QACH,CAAC,CAAC;YACE,oBAAoB,KAAK,GAAG;YAC5B,8CAA8C;YAC9C,6DAA6D;YAC7D,6CAA6C;YAC7C,wDAAwD;SACzD,CAAC;IAER,OAAO;QACL,aAAa,EAAE,CAAC;QAChB,MAAM,EAAE,IAAI;QACZ,KAAK;QACL,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EACrC,KAAa,EACb,UAA+C,EAAE,EACvB,EAAE;IAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC;IAErD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,cAAc,EAAE,CAAC;QAC7E,MAAM,IAAI,UAAU,CAAC;YACnB,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,6BAA6B;YACtC,GAAG,EAAE,uDAAuD,cAAc,aAAa,QAAQ,GAAG;YAClG,GAAG,EAAE,qEAAqE;SAC3E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC;IACvB,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACxD,MAAM,SAAS,GACb,SAAS,CAAC,MAAM,GAAG,CAAC;QAClB,CAAC,CAAC,SAAS,CAAC,GAAG,CACX,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,0CAA0C,QAAQ,GAAG,CACxF;QACH,CAAC,CAAC,CAAC,gCAAgC,KAAK,GAAG,CAAC,CAAC;IAEjD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;IACvE,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG;YACZ,2BAA2B;YAC3B,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;SAC5D,CAAC;QACF,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACtC,CAAC;IAED,OAAO;QACL,aAAa,EAAE,CAAC;QAChB,MAAM,EAAE,IAAI;QACZ,KAAK;QACL,aAAa,EAAE,SAAS,CAAC,MAAM;QAC/B,SAAS;QACT,MAAM;QACN,OAAO,EAAE,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;KACzD,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@zaowu-labs/teach",
+  "version": "1.0.1",
+  "description": "ZaoWu teaching workflows",
+  "type": "module",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -b --pretty false",
+    "typecheck": "tsc -b --pretty false",
+    "dev": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@zaowu-labs/core": "workspace:*"
+  },
+  "keywords": [
+    "zaowu",
+    "teaching"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zaowu-labs/zaowu.git",
+    "directory": "packages/teach"
+  },
+  "homepage": "https://github.com/zaowu-labs/zaowu",
+  "bugs": "https://github.com/zaowu-labs/zaowu/issues"
+}