@lxpack/cli 0.1.1 → 0.2.0

package/README.md

@@ -7,13 +7,14 @@
 
 Command-line tool for scaffolding, previewing, validating, and packaging LXPack courses.
 
-Part of [LXPack](https://github.com/eddiethedean/lxpack) — an AI-native learning experience compiler and runtime.
+Part of [LXPack](https://github.com/eddiethedean/lxpack) — an AI-native learning experience compiler and runtime (**v0.2.0**).
 
 | Related | Package |
 |---------|---------|
 | Validation | [`@lxpack/validators`](../validators/README.md) |
 | Browser runtime | [`@lxpack/runtime`](../runtime/README.md) |
 | Export / ZIP | [`@lxpack/scorm`](../scorm/README.md) |
+| Lesson widgets | [`@lxpack/components`](../components/README.md) |
 
 ## Install
 
@@ -32,6 +33,7 @@ cd my-course
 lxpack preview          # http://127.0.0.1:3847 by default
 lxpack validate
 lxpack build --target scorm12
+lxpack build --target scorm2004
 ```
 
 Output lands in `.lxpack/` unless overridden by `-o` or `lxpack.config.json`.
@@ -49,12 +51,16 @@ Output lands in `.lxpack/` unless overridden by `-o` or `lxpack.config.json`.
 
 | Option | Description |
 |--------|-------------|
-| `-t, --target <target>` | `scorm12` (default) or `standalone` |
+| `-t, --target <target>` | `scorm12` (default), `scorm2004`, or `standalone` |
 | `-o, --output <path>` | Output ZIP file or directory |
 | `--dir` | Write an unpacked directory instead of a ZIP |
 
 `build` and `preview` use the same validation rules: errors fail the command (exit code 1). `build` reuses the validated manifest and bakes a sanitized [assessment bundle](../validators/README.md#assessment-packaging) into the exported HTML config.
 
+**SCORM 2004** builds produce a multi-SCO ZIP: one launch page per activity under `sco/<activityId>/index.html`, plus shared `lxpack-runtime.js` and `lxpack-components.js`.
+
+**Preview** serves the runtime client, optional components bundle at `/runtime/components.js`, and installs SCORM API simulators (1.2 and 2004) for local testing.
+
 ### Course discovery
 
 Commands walk up from the current working directory until they find `course.yaml`. Run them from inside your course project (or a subdirectory).
@@ -73,10 +79,13 @@ my-course/
   lessons/
   interactions/
   assessments/         # authoring only — omitted from export ZIPs
+  components/          # optional widget overrides
   assets/
   .lxpack/             # build output (generated)
 ```
 
+`init` scaffolds commented examples for `variables`, `flow`, and `type: component` lessons. See [branching-demo](https://github.com/eddiethedean/lxpack/tree/main/examples/branching-demo) for a full v0.2 course.
+
 ### `lxpack.config.json`
 
 ```json
@@ -88,11 +97,13 @@ my-course/
 }
 ```
 
+Use `"defaultTarget": "scorm2004"` when your LMS expects SCORM 2004 4th Edition packages.
+
 See the [root README](https://github.com/eddiethedean/lxpack#course-structure) for a full `course.yaml` example.
 
 ## Programmatic use
 
-The CLI is built with [Commander](https://github.com/tj/commander.js). For library integration, import from the built package or depend on `@lxpack/validators`, `@lxpack/scorm`, and `@lxpack/runtime` directly.
+The CLI is built with [Commander](https://github.com/tj/commander.js). For library integration, import from the built package or depend on `@lxpack/validators`, `@lxpack/scorm`, `@lxpack/runtime`, and `@lxpack/components` directly.
 
 ## Development
 
@@ -107,6 +118,8 @@ pnpm --filter @lxpack/cli typecheck
 ## Links
 
 - [LXPack repository](https://github.com/eddiethedean/lxpack)
+- [Documentation index](https://github.com/eddiethedean/lxpack/blob/main/docs/README.md)
+- [Roadmap & phases](https://github.com/eddiethedean/lxpack/blob/main/docs/ROADMAP.md)
 - [Changelog](https://github.com/eddiethedean/lxpack/blob/main/CHANGELOG.md)
 
 ## License

package/dist/cli.d.ts

@@ -3,11 +3,11 @@ import { z } from 'zod';
 
 declare const lxpackConfigSchema: z.ZodObject<{
     exports: z.ZodOptional<z.ZodObject<{
-        defaultTarget: z.ZodOptional<z.ZodEnum<["scorm12", "standalone"]>>;
+        defaultTarget: z.ZodOptional<z.ZodEnum<["scorm12", "scorm2004", "standalone"]>>;
     }, "strip", z.ZodTypeAny, {
-        defaultTarget?: "scorm12" | "standalone" | undefined;
+        defaultTarget?: "scorm12" | "scorm2004" | "standalone" | undefined;
     }, {
-        defaultTarget?: "scorm12" | "standalone" | undefined;
+        defaultTarget?: "scorm12" | "scorm2004" | "standalone" | undefined;
     }>>;
     output: z.ZodOptional<z.ZodObject<{
         dir: z.ZodOptional<z.ZodString>;
@@ -18,14 +18,14 @@ declare const lxpackConfigSchema: z.ZodObject<{
     }>>;
 }, "strict", z.ZodTypeAny, {
     exports?: {
-        defaultTarget?: "scorm12" | "standalone" | undefined;
+        defaultTarget?: "scorm12" | "scorm2004" | "standalone" | undefined;
     } | undefined;
     output?: {
         dir?: string | undefined;
     } | undefined;
 }, {
     exports?: {
-        defaultTarget?: "scorm12" | "standalone" | undefined;
+        defaultTarget?: "scorm12" | "scorm2004" | "standalone" | undefined;
     } | undefined;
     output?: {
         dir?: string | undefined;

package/dist/cli.js

@@ -66,9 +66,17 @@ async function readRuntimeBundle(assetsDir = getRuntimeAssetsDir()) {
   }
   return { clientJs, css };
 }
+async function readComponentsBundle() {
+  try {
+    const bundlePath = require2.resolve("@lxpack/components/bundle");
+    return await readFile(bundlePath, "utf-8");
+  } catch {
+    return void 0;
+  }
+}
 var lxpackConfigSchema = z.object({
   exports: z.object({
-    defaultTarget: z.enum(["scorm12", "standalone"]).optional()
+    defaultTarget: z.enum(["scorm12", "scorm2004", "standalone"]).optional()
   }).optional(),
   output: z.object({
     dir: z.string().optional()
@@ -157,6 +165,17 @@ lessons:
 assessments:
   - id: final_quiz
     file: assessments/final.yaml
+
+# Optional Phase 2 features (see examples/branching-demo):
+# variables:
+#   path:
+#     default: intro
+#     type: string
+# flow:
+#   - when:
+#       variable:
+#         eq: [path, advanced]
+#     goto: component_lesson
 `;
 var WELCOME_MD = `# Welcome
 
@@ -269,7 +288,8 @@ async function initCommand(projectName, options = {}) {
     join2(targetDir, "interactions", "phishing-lab"),
     join2(targetDir, "assets"),
     join2(targetDir, "assessments"),
-    join2(targetDir, "theme")
+    join2(targetDir, "theme"),
+    join2(targetDir, "components")
   ];
   for (const dir of dirs) {
     await mkdir(dir, { recursive: true });
@@ -286,6 +306,7 @@ async function initCommand(projectName, options = {}) {
   await writeFile(join2(targetDir, "assessments", "final.yaml"), FINAL_ASSESSMENT);
   await writeFile(join2(targetDir, "lxpack.config.json"), LXPACK_CONFIG);
   await writeFile(join2(targetDir, "theme", ".gitkeep"), "");
+  await writeFile(join2(targetDir, "components", ".gitkeep"), "");
   console.log(pc.green(`\u2713 Created LXPack course: ${targetDir}`));
   console.log();
   console.log("Next steps:");
@@ -311,7 +332,9 @@ function buildPreviewConfig(manifest, assessmentBundle) {
     mode: "preview",
     ...assessmentBundle ? {
       assessments: assessmentBundle.assessments,
-      answerKeys: assessmentBundle.answerKeys
+      answerKeys: assessmentBundle.answerKeys,
+      assessmentConfigs: assessmentBundle.configs,
+      assessmentFeedback: assessmentBundle.feedback
     } : {}
   });
 }
@@ -330,6 +353,12 @@ async function createPreviewServer(courseDir, manifest, assessmentBundle) {
   });
   const stylesCss = await loadPreviewStyles(runtimeDir);
   const config = buildPreviewConfig(manifest, assessmentBundle);
+  const componentsJs = await readComponentsBundle();
+  if (componentsJs) {
+    app.get("/runtime/components.js", async (_req, reply) => {
+      return reply.type("application/javascript").send(componentsJs);
+    });
+  }
   app.get("/", async (_req, reply) => {
     const html = `<!DOCTYPE html>
 <html lang="en">
@@ -345,6 +374,7 @@ async function createPreviewServer(courseDir, manifest, assessmentBundle) {
   <script>
     window.__LXPACK_CONFIG__ = JSON.parse(document.getElementById('lxpack-config').textContent);
   </script>
+  ${componentsJs ? '<script type="module" src="/runtime/components.js"></script>' : ""}
   <script type="module" src="/runtime/client.js"></script>
 </body>
 </html>`;
@@ -456,7 +486,7 @@ import {
   buildRuntimeAssessmentBundle as buildRuntimeAssessmentBundle2
 } from "@lxpack/validators";
 import pc4 from "picocolors";
-var VALID_TARGETS = ["scorm12", "standalone"];
+var VALID_TARGETS = ["scorm12", "scorm2004", "standalone"];
 async function buildCommand(options) {
   const courseDir = findCourseDir();
   const config = await loadLxpackConfig(courseDir);
@@ -482,7 +512,10 @@ async function buildCommand(options) {
     courseDir,
     manifest
   );
-  const { clientJs, css } = await readRuntimeBundle();
+  const [{ clientJs, css }, componentsBundleJs] = await Promise.all([
+    readRuntimeBundle(),
+    readComponentsBundle()
+  ]);
   const slug = courseSlug(manifest);
   const outputBase = config?.output?.dir ?? ".lxpack";
   const outputRoot = resolveOutputDir(courseDir, outputBase);
@@ -493,6 +526,7 @@ async function buildCommand(options) {
     target,
     runtimeClientJs: clientJs,
     runtimeCss: css,
+    componentsBundleJs,
     assessmentBundle
   };
   if (options.dir) {
@@ -505,7 +539,7 @@ async function buildCommand(options) {
     console.log(`  Output: ${result.outputDir}`);
     console.log(`  Files: ${result.fileCount}`);
   } else {
-    const defaultName = target === "standalone" ? `${slug}-standalone.zip` : `${slug}-scorm12.zip`;
+    const defaultName = target === "standalone" ? `${slug}-standalone.zip` : target === "scorm2004" ? `${slug}-scorm2004.zip` : `${slug}-scorm12.zip`;
     const outputPath = options.output ?? join3(outputRoot, defaultName);
     const result = await packageCourse({
       ...packageOptions,
@@ -537,7 +571,7 @@ function createCliProgram() {
   });
   program.command("build").description("Build LMS-compatible package").option(
     "-t, --target <target>",
-    "Export target: scorm12, standalone",
+    "Export target: scorm12, scorm2004, standalone",
     void 0
   ).option("-o, --output <path>", "Output file or directory path").option("--dir", "Output as directory instead of ZIP").action(
     async (options) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lxpack/cli",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "CLI for building, validating, and packaging LXPack courses",
   "license": "Apache-2.0",
   "repository": {
@@ -39,9 +39,10 @@
     "picocolors": "^1.1.1",
     "yaml": "^2.7.0",
     "zod": "^3.24.2",
-    "@lxpack/runtime": "0.1.1",
-    "@lxpack/scorm": "0.1.1",
-    "@lxpack/validators": "0.1.1"
+    "@lxpack/runtime": "0.2.0",
+    "@lxpack/components": "0.2.0",
+    "@lxpack/scorm": "0.2.0",
+    "@lxpack/validators": "0.2.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",