@lessonkit/cli 1.3.1 → 1.4.0

package/dist/bin.js

@@ -177,8 +177,17 @@ async function applyTemplateSubstitutions(projectDir, projectName, slug) {
   const course = lessonkit.course;
   course.courseId = slug;
   course.title = projectName;
+  const tracking = lessonkit.tracking ?? {};
+  const xapi = tracking.xapi ?? {};
+  xapi.activityIri = `https://example.com/courses/${slug}`;
+  tracking.xapi = xapi;
+  lessonkit.tracking = tracking;
   await writeFile(lessonkitPath, `${JSON.stringify(lessonkit, null, 2)}
 `, "utf8");
+  const courseConfigPath = join(projectDir, "src", "courseConfig.ts");
+  let courseConfigSource = await readFile(courseConfigPath, "utf8");
+  courseConfigSource = courseConfigSource.replace(/courseId: "my-course"/g, `courseId: "${slug}"`);
+  await writeFile(courseConfigPath, courseConfigSource, "utf8");
   const appPath = join(projectDir, "src", "App.tsx");
   let appSource = await readFile(appPath, "utf8");
   appSource = appSource.replace(/courseId="my-course"/g, `courseId="${slug}"`);

package/dist/index.js

@@ -175,8 +175,17 @@ async function applyTemplateSubstitutions(projectDir, projectName, slug) {
   const course = lessonkit.course;
   course.courseId = slug;
   course.title = projectName;
+  const tracking = lessonkit.tracking ?? {};
+  const xapi = tracking.xapi ?? {};
+  xapi.activityIri = `https://example.com/courses/${slug}`;
+  tracking.xapi = xapi;
+  lessonkit.tracking = tracking;
   await writeFile(lessonkitPath, `${JSON.stringify(lessonkit, null, 2)}
 `, "utf8");
+  const courseConfigPath = join(projectDir, "src", "courseConfig.ts");
+  let courseConfigSource = await readFile(courseConfigPath, "utf8");
+  courseConfigSource = courseConfigSource.replace(/courseId: "my-course"/g, `courseId: "${slug}"`);
+  await writeFile(courseConfigPath, courseConfigSource, "utf8");
   const appPath = join(projectDir, "src", "App.tsx");
   let appSource = await readFile(appPath, "utf8");
   appSource = appSource.replace(/courseId="my-course"/g, `courseId="${slug}"`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lessonkit/cli",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "private": false,
   "description": "LessonKit CLI — init, dev, build, and package learning experiences.",
   "license": "Apache-2.0",
@@ -25,7 +25,10 @@
     "lessonkit": "./dist/bin.js"
   },
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
   },
   "files": [
     "dist",
@@ -42,15 +45,15 @@
     "lint": "echo \"(no lint configured yet)\""
   },
   "dependencies": {
-    "@lessonkit/core": "1.3.1",
-    "@lessonkit/lxpack": "1.3.1",
-    "commander": "^14.0.1"
+    "@lessonkit/core": "1.4.0",
+    "@lessonkit/lxpack": "1.4.0",
+    "commander": "^15.0.0"
   },
   "engines": {
     "node": ">=18"
   },
   "devDependencies": {
-    "@types/node": "^24.0.0",
+    "@types/node": "^25.9.2",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "vitest": "^4.1.8"

package/template/vite-react/.env.example

@@ -0,0 +1,5 @@
+# Copy to .env.production before `npm run build`.
+# Point both URLs at your backend proxies — never embed raw LRS credentials in the bundle.
+
+VITE_XAPI_PROXY_URL=
+VITE_ANALYTICS_URL=

package/template/vite-react/README.md

@@ -14,8 +14,14 @@ npm run package:scorm12
 ## Files
 
 - `src/App.tsx` — course UI (IDs match `lessonkit.json`)
+- `src/courseConfig.ts` — production transports, observability hooks, and LMS bridge config
+- `.env.example` — `VITE_XAPI_PROXY_URL` and `VITE_ANALYTICS_URL` for production builds
 - `lessonkit.json` — manifest for CLI and LXPack packaging
 
+## Production
+
+Copy `.env.example` to `.env.production` and set your LRS/analytics proxy URLs before `npm run build`. See the [production checklist](https://lessonkit.readthedocs.io/en/latest/guides/react-developers/production-checklist.html).
+
 ## Docs
 
 [CLI reference](https://lessonkit.readthedocs.io/en/latest/reference/cli.html) · [React quickstart](https://lessonkit.readthedocs.io/en/latest/guides/react-developers/quickstart.html) · [Packaging guide](https://lessonkit.readthedocs.io/en/latest/guides/react-developers/packaging-and-cli.html)

package/template/vite-react/package.json

@@ -7,29 +7,33 @@
     "build": "lessonkit build",
     "preview": "vite preview",
     "package:scorm12": "lessonkit package --target scorm12",
+    "package:scorm2004": "lessonkit package --target scorm2004",
     "package:standalone": "lessonkit package --target standalone",
+    "package:xapi": "lessonkit package --target xapi",
+    "package:cmi5": "lessonkit package --target cmi5",
     "typecheck": "tsc -p tsconfig.json",
     "test": "vitest run --passWithNoTests",
     "test:coverage": "vitest run --coverage --passWithNoTests=false"
   },
   "dependencies": {
-    "@lessonkit/core": "^1.3.1",
-    "@lessonkit/react": "^1.3.1",
-    "@lessonkit/themes": "^1.3.1",
-    "@lessonkit/xapi": "^1.3.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "@lessonkit/core": "^1.4.0",
+    "@lessonkit/react": "^1.4.0",
+    "@lessonkit/themes": "^1.4.0",
+    "@lessonkit/xapi": "^1.4.0",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7"
   },
   "devDependencies": {
-    "@lessonkit/cli": "^1.3.1",
-    "@lessonkit/lxpack": "^1.3.1",
+    "@lessonkit/cli": "^1.4.0",
+    "@lessonkit/lxpack": "^1.4.0",
     "@testing-library/react": "^16.3.0",
-    "@types/react": "^18.3.23",
-    "@types/react-dom": "^18.3.7",
-    "@vitejs/plugin-react": "^4.6.0",
-    "jsdom": "^26.1.0",
+    "@testing-library/dom": "^10.4.1",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.2",
+    "jsdom": "^29.1.1",
     "typescript": "^5.8.3",
-    "vite": "^7.1.3",
+    "vite": "^8.0.11",
     "vitest": "^4.1.8"
   }
 }

package/template/vite-react/src/App.test.tsx

@@ -1,14 +1,14 @@
 import React from "react";
 import { describe, expect, it, vi } from "vitest";
-import { render } from "@testing-library/react";
+import { render, screen } from "@testing-library/react";
 import App from "./App";
 
 describe("template App", () => {
-  it("renders without crashing", () => {
+  it("renders the starter quiz question", () => {
     const spy = vi.spyOn(console, "log").mockImplementation(() => {});
     render(<App />);
+    expect(screen.getByText("Ready to build?")).toBeDefined();
     spy.mockRestore();
-    expect(true).toBe(true);
   });
 });
 

package/template/vite-react/src/App.tsx

@@ -1,20 +1,8 @@
 import React from "react";
 import { Course, Lesson, Quiz, Scenario, ThemeProvider } from "@lessonkit/react";
-import type { TelemetryEvent } from "@lessonkit/core";
-import type { XAPIStatement } from "@lessonkit/xapi";
+import { createCourseConfig } from "./courseConfig";
 
-const courseConfig = {
-  tracking: {
-    sink: (event: TelemetryEvent) => {
-      console.log("[telemetry]", event);
-    },
-  },
-  xapi: {
-    transport: (statement: XAPIStatement) => {
-      console.log("[xapi]", statement);
-    },
-  },
-} as const;
+const courseConfig = createCourseConfig();
 
 export default function App() {
   return (

package/template/vite-react/src/courseConfig.test.ts

@@ -0,0 +1,91 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+import type { TelemetryEvent } from "@lessonkit/core";
+import { createCourseConfig } from "./courseConfig";
+
+describe("createCourseConfig", () => {
+  const originalFetch = globalThis.fetch;
+
+  afterEach(() => {
+    vi.unstubAllEnvs();
+    globalThis.fetch = originalFetch;
+  });
+
+  it("returns dev console sinks when proxy URLs are unset", () => {
+    const log = vi.spyOn(console, "log").mockImplementation(() => undefined);
+    const config = createCourseConfig();
+
+    expect(config.courseId).toBe("my-course");
+    expect(config.lxpack?.bridge).toBe("off");
+    expect(config.observability?.onTelemetrySinkError).toBeTypeOf("function");
+    expect(config.observability?.onLxpackBridgeMiss).toBeTypeOf("function");
+
+    config.tracking?.sink?.({
+      name: "interaction",
+      timestamp: "2026-01-01T00:00:00Z",
+      courseId: "my-course",
+    } as TelemetryEvent);
+    expect(log).toHaveBeenCalledWith("[telemetry]", expect.any(Object));
+
+    log.mockRestore();
+  });
+
+  it("invokes observability hooks without throwing", () => {
+    const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined);
+    const config = createCourseConfig();
+
+    config.observability?.onTelemetrySinkError?.(new Error("sink"), { sinkId: "tracking" });
+    config.observability?.onTelemetryBufferDrop?.();
+    config.observability?.onXapiQueueDepth?.(10);
+    config.observability?.onXapiQueueDepth?.(60);
+    config.observability?.onXapiQueueCap?.();
+    config.observability?.onLxpackBridgeMiss?.({
+      name: "course_completed",
+      timestamp: "2026-01-01T00:00:00Z",
+      courseId: "my-course",
+    } as TelemetryEvent);
+    config.observability?.onXapiTransportError?.(new Error("transport"));
+
+    expect(warn).toHaveBeenCalled();
+    warn.mockRestore();
+  });
+
+  it("uses fetch transports when proxy URLs are set", async () => {
+    vi.stubEnv("VITE_XAPI_PROXY_URL", "https://lrs.example/statements");
+    vi.stubEnv("VITE_ANALYTICS_URL", "https://analytics.example/events");
+    const fetchMock = vi.fn(() => Promise.resolve(new Response(null, { status: 204 })));
+    globalThis.fetch = fetchMock as typeof fetch;
+
+    const config = createCourseConfig();
+
+    expect(config.tracking?.batchSink).toBeTypeOf("function");
+    expect(config.xapi?.transport).toBeTypeOf("function");
+
+    await config.tracking?.batchSink?.([
+      { name: "course_started", timestamp: "t", courseId: "my-course" } as TelemetryEvent,
+    ]);
+    await config.xapi?.transport?.({
+      id: "s1",
+      timestamp: "2026-01-01T00:00:00Z",
+      verb: "http://adlnet.gov/expapi/verbs/completed",
+      object: { id: "https://example.com/a" },
+    });
+
+    expect(fetchMock).toHaveBeenCalled();
+  });
+
+  it("skips production guard when MODE is test even with proxy URLs set", () => {
+    vi.stubEnv("NODE_ENV", "production");
+    vi.stubEnv("MODE", "test");
+    vi.stubEnv("VITE_XAPI_PROXY_URL", "https://lrs.example/statements");
+    vi.stubEnv("VITE_ANALYTICS_URL", "https://analytics.example/events");
+
+    expect(() => createCourseConfig()).not.toThrow();
+  });
+
+  it("throws when production guard is enforced with console sinks", () => {
+    vi.stubEnv("NODE_ENV", "production");
+    vi.stubEnv("MODE", "production");
+
+    expect(() => createCourseConfig()).toThrow(/console telemetry sinks|observability hooks/);
+  });
+});

package/template/vite-react/src/courseConfig.ts

@@ -0,0 +1,117 @@
+import type { TelemetryEvent } from "@lessonkit/core";
+import type { LessonkitConfig } from "@lessonkit/react";
+import { assertProductionCourseConfig, shouldEnforceProductionGuard } from "@lessonkit/react";
+import { createFetchBatchSink, createFetchTransport } from "@lessonkit/xapi";
+import type { XAPIStatement } from "@lessonkit/xapi";
+
+/**
+ * Replace with your backend token proxy. Never ship static LRS passwords in the bundle.
+ * Example: fetch("/api/lrs-token") and return { Authorization: `Bearer ${token}` }.
+ */
+function lrsAuthHeaders(): Record<string, string> {
+  return {};
+}
+
+function createObservability(): NonNullable<LessonkitConfig["observability"]> {
+  const report = (channel: string, detail: unknown) => {
+    if (import.meta.env.DEV) {
+      console.warn(`[lessonkit:${channel}]`, detail);
+      return;
+    }
+    // Wire to your monitoring stack (Sentry, Datadog, etc.).
+    /* v8 ignore next -- production-only; swap for your APM in go-live builds */
+    console.error(`[lessonkit:${channel}]`, detail);
+  };
+
+  return {
+    onTelemetrySinkError: (err, ctx) => report("telemetry-sink", { err, ...ctx }),
+    onTelemetryBufferDrop: () => report("telemetry-buffer-cap", {}),
+    onXapiQueueDepth: (depth) => {
+      if (depth > 50) report("xapi-queue-depth", { depth });
+    },
+    onXapiQueueCap: () => report("xapi-queue-cap", {}),
+    onLxpackBridgeMiss: (event) => report("lxpack-bridge-miss", { event: event.name }),
+    onXapiTransportError: (err) => report("xapi-transport", { err }),
+  };
+}
+
+function readProxyUrls(): { xapiProxyUrl?: string; analyticsUrl?: string } {
+  return {
+    xapiProxyUrl: import.meta.env.VITE_XAPI_PROXY_URL as string | undefined,
+    analyticsUrl: import.meta.env.VITE_ANALYTICS_URL as string | undefined,
+  };
+}
+
+function devConsoleTracking(): LessonkitConfig["tracking"] {
+  return {
+    sink: (event: TelemetryEvent) => {
+      console.log("[telemetry]", event);
+    },
+  };
+}
+
+function devConsoleXapi(): LessonkitConfig["xapi"] {
+  return {
+    enabled: true,
+    transport: (statement: XAPIStatement) => {
+      console.log("[xapi]", statement);
+      return Promise.resolve();
+    },
+  };
+}
+
+function productionTracking(analyticsUrl: string | undefined): LessonkitConfig["tracking"] {
+  if (!analyticsUrl) {
+    /* v8 ignore next */
+    throw new Error(
+      "VITE_ANALYTICS_URL is required in production. Point it at your analytics ingest proxy.",
+    );
+  }
+  const { batchSink, exitBatchSink } = createFetchBatchSink({
+    url: analyticsUrl,
+    headers: lrsAuthHeaders,
+  });
+  return {
+    enabled: true,
+    batchSink,
+    exitBatchSink,
+    batch: { enabled: true },
+  };
+}
+
+function productionXapi(xapiProxyUrl: string | undefined): LessonkitConfig["xapi"] {
+  if (!xapiProxyUrl) {
+    /* v8 ignore next */
+    throw new Error(
+      "VITE_XAPI_PROXY_URL is required in production. Point it at your LRS proxy (never the raw LRS with embedded secrets).",
+    );
+  }
+  const { transport, exitTransport, abortInFlight } = createFetchTransport({
+    url: xapiProxyUrl,
+    headers: lrsAuthHeaders,
+  });
+  return {
+    enabled: true,
+    transport,
+    exitTransport,
+    abortInFlight,
+  };
+}
+
+export function createCourseConfig(): LessonkitConfig {
+  const { xapiProxyUrl, analyticsUrl } = readProxyUrls();
+  const useProductionTransports = import.meta.env.PROD || (xapiProxyUrl && analyticsUrl);
+
+  const config: LessonkitConfig = {
+    courseId: "my-course",
+    lxpack: { bridge: "off" },
+    observability: createObservability(),
+    tracking: useProductionTransports ? productionTracking(analyticsUrl) : devConsoleTracking(),
+    xapi: useProductionTransports ? productionXapi(xapiProxyUrl) : devConsoleXapi(),
+  };
+
+  if (shouldEnforceProductionGuard()) {
+    assertProductionCourseConfig(config);
+  }
+  return config;
+}

package/template/vite-react/vitest.config.ts

@@ -8,7 +8,7 @@ export default defineConfig({
       provider: "v8",
       include: ["src/**/*.{ts,tsx}"],
       exclude: ["dist/**", "node_modules/**", "**/*.d.ts", "**/*.d.cts"],
-      thresholds: { statements: 85, branches: 85, functions: 85, lines: 85 },
+      thresholds: { statements: 85, branches: 80, functions: 85, lines: 85 },
     },
   },
 });