@lxpack/validators 0.2.2 → 0.3.0

package/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/github/license/eddiethedean/lxpack)](https://github.com/eddiethedean/lxpack/blob/main/LICENSE)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](https://nodejs.org/)
 
-Zod schemas and filesystem validation for LXPack course manifests — including flow, variables, and component lessons (v0.2.2).
+Zod schemas and filesystem validation for LXPack course manifests — including flow, variables, component lessons, and xAPI tracking (v0.3.0).
 
 Part of [LXPack](https://github.com/eddiethedean/lxpack) — an AI-native learning experience compiler and runtime.
 
@@ -90,6 +90,8 @@ isPathContained(courseDir, abs); // true if inside course root
 | Export | Description |
 |--------|-------------|
 | `validateCourse(dir)` | Parse `course.yaml`, validate schema, flow, files, symlink containment |
+| `validateXapiTracking(manifest)` | Require HTTPS `tracking.xapi.activityIri` for xapi/cmi5 exports |
+| `getCourseActivityIri(manifest)` | Read course activity IRI from manifest |
 | `loadManifest(courseDir)` | Load and parse `course.yaml` |
 | `buildRuntimeAssessmentBundle(dir, manifest)` | Load assessments; split learner view, keys, configs, feedback |
 | `toLearnerAssessment(assessment)` | Strip `correct` from choices; extract config and feedback maps |

package/dist/index.d.ts

@@ -343,6 +343,16 @@ declare const variableDefSchema: z.ZodEffects<z.ZodObject<{
     default: string | number | boolean;
     type?: "string" | "number" | "boolean" | undefined;
 }>;
+declare const xapiTrackingSchema: z.ZodObject<{
+    activityIri: z.ZodEffects<z.ZodString, string, string>;
+    displayName: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    activityIri: string;
+    displayName?: string | undefined;
+}, {
+    activityIri: string;
+    displayName?: string | undefined;
+}>;
 declare const trackingSchema: z.ZodOptional<z.ZodObject<{
     completion: z.ZodOptional<z.ZodObject<{
         threshold: z.ZodDefault<z.ZodNumber>;
@@ -351,15 +361,34 @@ declare const trackingSchema: z.ZodOptional<z.ZodObject<{
     }, {
         threshold?: number | undefined;
     }>>;
+    xapi: z.ZodOptional<z.ZodObject<{
+        activityIri: z.ZodEffects<z.ZodString, string, string>;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        activityIri: string;
+        displayName?: string | undefined;
+    }, {
+        activityIri: string;
+        displayName?: string | undefined;
+    }>>;
 }, "strict", z.ZodTypeAny, {
     completion?: {
         threshold: number;
     } | undefined;
+    xapi?: {
+        activityIri: string;
+        displayName?: string | undefined;
+    } | undefined;
 }, {
     completion?: {
         threshold?: number | undefined;
     } | undefined;
+    xapi?: {
+        activityIri: string;
+        displayName?: string | undefined;
+    } | undefined;
 }>>;
+type XapiTrackingConfig = z.infer<typeof xapiTrackingSchema>;
 declare const runtimeConfigSchema: z.ZodOptional<z.ZodObject<{
     theme: z.ZodDefault<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
@@ -387,14 +416,32 @@ declare const courseManifestSchema: z.ZodObject<{
         }, {
             threshold?: number | undefined;
         }>>;
+        xapi: z.ZodOptional<z.ZodObject<{
+            activityIri: z.ZodEffects<z.ZodString, string, string>;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            activityIri: string;
+            displayName?: string | undefined;
+        }, {
+            activityIri: string;
+            displayName?: string | undefined;
+        }>>;
     }, "strict", z.ZodTypeAny, {
         completion?: {
             threshold: number;
         } | undefined;
+        xapi?: {
+            activityIri: string;
+            displayName?: string | undefined;
+        } | undefined;
     }, {
         completion?: {
             threshold?: number | undefined;
         } | undefined;
+        xapi?: {
+            activityIri: string;
+            displayName?: string | undefined;
+        } | undefined;
     }>>;
     variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
         default: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
@@ -509,6 +556,10 @@ declare const courseManifestSchema: z.ZodObject<{
         completion?: {
             threshold: number;
         } | undefined;
+        xapi?: {
+            activityIri: string;
+            displayName?: string | undefined;
+        } | undefined;
     } | undefined;
     variables?: Record<string, {
         default: string | number | boolean;
@@ -550,6 +601,10 @@ declare const courseManifestSchema: z.ZodObject<{
         completion?: {
             threshold?: number | undefined;
         } | undefined;
+        xapi?: {
+            activityIri: string;
+            displayName?: string | undefined;
+        } | undefined;
     } | undefined;
     variables?: Record<string, {
         default: string | number | boolean;
@@ -675,4 +730,7 @@ declare function enumerateActivities(manifest: CourseManifest): CourseActivity[]
 
 declare function escapeHtml(text: string): string;
 
-export { type Assessment, type AssessmentRef, type AssessmentRuntimeConfig, BUILTIN_COMPONENT_IDS, type BuiltinComponentId, type ComponentLesson, type Condition, type CourseActivity, type CourseManifest, type FlowRule, type LearnerAssessment, type LearnerChoice, type LearnerQuestion, type Lesson, type QuestionFeedback, type RuntimeAssessmentBundle, type ShowFeedback, type ValidationIssue, type ValidationResult, type VariableDef, activityIdSchema, assertResolvedPathContained, assessmentQuestionSchema, assessmentRefSchema, assessmentSchema, buildActivityOrder, buildRuntimeAssessmentBundle, buildRuntimeAssessmentBundleFromParsed, collectActivityIds, collectAssessmentIds, collectInteractionIds, componentLessonSchema, conditionSchema, courseManifestSchema, detectFlowCycles, enumerateActivities, escapeHtml, flowRuleSchema, formatErrorMessage, formatIssuePath, htmlLessonSchema, isBuiltinComponentId, isPathContained, lessonSchema, loadManifest, loadParsedAssessments, markdownLessonSchema, resolveCoursePath, runtimeConfigSchema, showFeedbackSchema, toLearnerAssessment, trackingSchema, validateCourse, validateFlow, variableDefSchema };
+declare function validateXapiTracking(manifest: CourseManifest): ValidationIssue[];
+declare function getCourseActivityIri(manifest: CourseManifest): string | undefined;
+
+export { type Assessment, type AssessmentRef, type AssessmentRuntimeConfig, BUILTIN_COMPONENT_IDS, type BuiltinComponentId, type ComponentLesson, type Condition, type CourseActivity, type CourseManifest, type FlowRule, type LearnerAssessment, type LearnerChoice, type LearnerQuestion, type Lesson, type QuestionFeedback, type RuntimeAssessmentBundle, type ShowFeedback, type ValidationIssue, type ValidationResult, type VariableDef, type XapiTrackingConfig, activityIdSchema, assertResolvedPathContained, assessmentQuestionSchema, assessmentRefSchema, assessmentSchema, buildActivityOrder, buildRuntimeAssessmentBundle, buildRuntimeAssessmentBundleFromParsed, collectActivityIds, collectAssessmentIds, collectInteractionIds, componentLessonSchema, conditionSchema, courseManifestSchema, detectFlowCycles, enumerateActivities, escapeHtml, flowRuleSchema, formatErrorMessage, formatIssuePath, getCourseActivityIri, htmlLessonSchema, isBuiltinComponentId, isPathContained, lessonSchema, loadManifest, loadParsedAssessments, markdownLessonSchema, resolveCoursePath, runtimeConfigSchema, showFeedbackSchema, toLearnerAssessment, trackingSchema, validateCourse, validateFlow, validateXapiTracking, variableDefSchema, xapiTrackingSchema };

package/dist/index.js

@@ -150,10 +150,17 @@ var variableDefSchema = z2.object({
     });
   }
 });
+var xapiTrackingSchema = z2.object({
+  activityIri: z2.string().url().refine((u) => u.startsWith("https://"), {
+    message: "activityIri must be an https URL"
+  }),
+  displayName: z2.string().min(1).optional()
+}).strict();
 var trackingSchema = z2.object({
   completion: z2.object({
     threshold: z2.number().min(0).max(1).default(0.9)
-  }).strict().optional()
+  }).strict().optional(),
+  xapi: xapiTrackingSchema.optional()
 }).strict().optional();
 var runtimeConfigSchema = z2.object({
   theme: z2.string().default("modern")
@@ -612,8 +619,30 @@ function validateMarkdownLesson(courseDir, lesson) {
 // src/validate/lesson-html.ts
 import { existsSync as existsSync3, statSync as statSync3 } from "fs";
 import { join } from "path";
+var HTML_LESSON_PATH_PATTERN = /^[a-zA-Z0-9][a-zA-Z0-9_./-]*$/;
+function validateHtmlLessonPath(path) {
+  if (/["'<>]/.test(path) || /\s/.test(path)) {
+    return "HTML interaction path contains invalid characters (quotes, angle brackets, or whitespace)";
+  }
+  if (path.includes("..")) {
+    return "HTML interaction path must not contain '..' segments";
+  }
+  if (!HTML_LESSON_PATH_PATTERN.test(path)) {
+    return "HTML interaction path must start with a letter and use only letters, numbers, /, _, ., and -";
+  }
+  return null;
+}
 function validateHtmlLesson(courseDir, lesson) {
   const issues = [];
+  const pathError = validateHtmlLessonPath(lesson.path);
+  if (pathError) {
+    issues.push({
+      path: `lessons.${lesson.id}.path`,
+      message: pathError,
+      severity: "error"
+    });
+    return issues;
+  }
   const resolved = resolveCoursePath(courseDir, lesson.path);
   if (!resolved.ok) {
     issues.push({
@@ -860,6 +889,40 @@ function enumerateActivities(manifest) {
 function escapeHtml(text) {
   return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
 }
+
+// src/xapi-validate.ts
+function validateXapiTracking(manifest) {
+  const issues = [];
+  const xapi = manifest.tracking?.xapi;
+  if (!xapi) {
+    issues.push({
+      path: "tracking.xapi",
+      message: "tracking.xapi.activityIri is required for xapi/cmi5 export targets",
+      severity: "error"
+    });
+    return issues;
+  }
+  try {
+    const url = new URL(xapi.activityIri);
+    if (url.protocol !== "https:") {
+      issues.push({
+        path: "tracking.xapi.activityIri",
+        message: "activityIri must use https",
+        severity: "error"
+      });
+    }
+  } catch {
+    issues.push({
+      path: "tracking.xapi.activityIri",
+      message: "activityIri must be a valid URL",
+      severity: "error"
+    });
+  }
+  return issues;
+}
+function getCourseActivityIri(manifest) {
+  return manifest.tracking?.xapi?.activityIri;
+}
 export {
   BUILTIN_COMPONENT_IDS,
   activityIdSchema,
@@ -882,6 +945,7 @@ export {
   flowRuleSchema,
   formatErrorMessage,
   formatIssuePath,
+  getCourseActivityIri,
   htmlLessonSchema,
   isBuiltinComponentId,
   isPathContained,
@@ -896,5 +960,7 @@ export {
   trackingSchema,
   validateCourse,
   validateFlow,
-  variableDefSchema
+  validateXapiTracking,
+  variableDefSchema,
+  xapiTrackingSchema
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lxpack/validators",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Course manifest validation for LXPack",
   "license": "Apache-2.0",
   "repository": {