@lessonkit/lxpack 0.8.0 → 0.9.0

package/dist/index.d.cts

@@ -1,7 +1,11 @@
 import { CheckId, CourseId, LessonId } from '@lessonkit/core';
 import { ThemePresetName, LessonkitThemeV1 } from '@lessonkit/themes';
+import { LessonkitInterchangeV1 } from '@lxpack/validators';
+export { LessonkitInterchangeV1, MaterializeLessonkitOptions, MaterializeLessonkitResult, lessonkitInterchangeSchema, materializeLessonkitProject, parseLessonkitInterchange } from '@lxpack/validators';
 import { ExportTarget, ValidateCourseResult, BuildCourseResult } from '@lxpack/api';
 export { ExportTarget } from '@lxpack/api';
+export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
+export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.cjs';
 
 type SpaLayout = "single-spa" | "per-lesson-spa";
 type LessonDescriptor = {
@@ -38,25 +42,7 @@ type LessonkitCourseDescriptor = {
     /** LXPack SPA lesson id for `single-spa` (default: first lesson id or `main`). */
     spaLessonId?: string;
 };
-type LessonkitInterchangeV1 = {
-    format: "lessonkit";
-    version: "1";
-    course: {
-        id: CourseId;
-        title: string;
-    };
-    lessons: Array<{
-        id: LessonId;
-        title: string;
-        type: "spa";
-        path: string;
-    }>;
-    tracking?: {
-        completion?: {
-            threshold?: number;
-        };
-    };
-};
+
 type MappedLessonkitIds = {
     courseId: CourseId;
     lessonIds: LessonId[];
@@ -76,6 +62,18 @@ type DescriptorValidationResult = {
 };
 declare function validateDescriptor(input: LessonkitCourseDescriptor): DescriptorValidationResult;
 
+type ProjectPathsInput = {
+    spaDistDir?: string;
+    lxpackOutDir?: string;
+    outputBaseDir?: string;
+};
+/** Validate lessonkit.json paths.* entries stay under projectRoot. */
+declare function validateProjectPaths(projectRoot: string, paths: ProjectPathsInput): DescriptorValidationIssue[];
+/**
+ * Resolve a package --out override under projectRoot and ensure it stays inside the project.
+ */
+declare function resolveSafePackageOutputOverride(projectRoot: string, override: string): string;
+
 /**
  * Stable 1:1 mapping from LessonKit ids to LXPack manifest ids.
  * LessonKit slug rules already match LXPack `activityIdSchema` (letter-first, alphanumeric + _ -).
@@ -129,12 +127,17 @@ type WriteLxpackProjectOptions = {
      * For `per-lesson-spa`: map lesson id → absolute path to that lesson's built SPA folder.
      */
     lessonSpaDirs?: Record<string, string>;
+    /** When set, relative `spaDistDir` is resolved under this directory instead of `process.cwd()`. */
+    projectRoot?: string;
 };
 type WriteLxpackProjectResult = {
     outDir: string;
     courseYamlPath: string;
     lessonkitJsonPath: string;
 };
+/**
+ * Materialize an LXPack project tree from a LessonKit descriptor (delegates to LXPack 0.6+).
+ */
 declare function writeLxpackProject(options: WriteLxpackProjectOptions): Promise<WriteLxpackProjectResult>;
 
 type ValidateLessonkitProjectOptions = {
@@ -181,4 +184,4 @@ declare function validateLessonkitProject(options: ValidateLessonkitProjectOptio
 declare function buildLessonkitProject(options: BuildLessonkitProjectOptions): Promise<BuildCourseResult>;
 declare function packageLessonkitCourse(options: PackageLessonkitCourseOptions): Promise<PackageLessonkitCourseResult>;
 
-export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type DescriptorValidationIssue, type DescriptorValidationResult, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitInterchangeV1, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type MappedLessonkitIds, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type SpaLayout, type SpaLessonEntry, type ValidateLessonkitProjectOptions, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, descriptorToInterchange, extractAssessments, mapLessonkitIds, packageLessonkitCourse, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateLessonkitProject, writeLxpackProject };
+export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type DescriptorValidationIssue, type DescriptorValidationResult, type LessonDescriptor, type LessonkitCourseDescriptor, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type MappedLessonkitIds, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type ProjectPathsInput, type SpaLayout, type SpaLessonEntry, type ValidateLessonkitProjectOptions, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, descriptorToInterchange, extractAssessments, mapLessonkitIds, packageLessonkitCourse, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateLessonkitProject, validateProjectPaths, writeLxpackProject };

package/dist/index.d.ts

@@ -1,7 +1,11 @@
 import { CheckId, CourseId, LessonId } from '@lessonkit/core';
 import { ThemePresetName, LessonkitThemeV1 } from '@lessonkit/themes';
+import { LessonkitInterchangeV1 } from '@lxpack/validators';
+export { LessonkitInterchangeV1, MaterializeLessonkitOptions, MaterializeLessonkitResult, lessonkitInterchangeSchema, materializeLessonkitProject, parseLessonkitInterchange } from '@lxpack/validators';
 import { ExportTarget, ValidateCourseResult, BuildCourseResult } from '@lxpack/api';
 export { ExportTarget } from '@lxpack/api';
+export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
+export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.js';
 
 type SpaLayout = "single-spa" | "per-lesson-spa";
 type LessonDescriptor = {
@@ -38,25 +42,7 @@ type LessonkitCourseDescriptor = {
     /** LXPack SPA lesson id for `single-spa` (default: first lesson id or `main`). */
     spaLessonId?: string;
 };
-type LessonkitInterchangeV1 = {
-    format: "lessonkit";
-    version: "1";
-    course: {
-        id: CourseId;
-        title: string;
-    };
-    lessons: Array<{
-        id: LessonId;
-        title: string;
-        type: "spa";
-        path: string;
-    }>;
-    tracking?: {
-        completion?: {
-            threshold?: number;
-        };
-    };
-};
+
 type MappedLessonkitIds = {
     courseId: CourseId;
     lessonIds: LessonId[];
@@ -76,6 +62,18 @@ type DescriptorValidationResult = {
 };
 declare function validateDescriptor(input: LessonkitCourseDescriptor): DescriptorValidationResult;
 
+type ProjectPathsInput = {
+    spaDistDir?: string;
+    lxpackOutDir?: string;
+    outputBaseDir?: string;
+};
+/** Validate lessonkit.json paths.* entries stay under projectRoot. */
+declare function validateProjectPaths(projectRoot: string, paths: ProjectPathsInput): DescriptorValidationIssue[];
+/**
+ * Resolve a package --out override under projectRoot and ensure it stays inside the project.
+ */
+declare function resolveSafePackageOutputOverride(projectRoot: string, override: string): string;
+
 /**
  * Stable 1:1 mapping from LessonKit ids to LXPack manifest ids.
  * LessonKit slug rules already match LXPack `activityIdSchema` (letter-first, alphanumeric + _ -).
@@ -129,12 +127,17 @@ type WriteLxpackProjectOptions = {
      * For `per-lesson-spa`: map lesson id → absolute path to that lesson's built SPA folder.
      */
     lessonSpaDirs?: Record<string, string>;
+    /** When set, relative `spaDistDir` is resolved under this directory instead of `process.cwd()`. */
+    projectRoot?: string;
 };
 type WriteLxpackProjectResult = {
     outDir: string;
     courseYamlPath: string;
     lessonkitJsonPath: string;
 };
+/**
+ * Materialize an LXPack project tree from a LessonKit descriptor (delegates to LXPack 0.6+).
+ */
 declare function writeLxpackProject(options: WriteLxpackProjectOptions): Promise<WriteLxpackProjectResult>;
 
 type ValidateLessonkitProjectOptions = {
@@ -181,4 +184,4 @@ declare function validateLessonkitProject(options: ValidateLessonkitProjectOptio
 declare function buildLessonkitProject(options: BuildLessonkitProjectOptions): Promise<BuildCourseResult>;
 declare function packageLessonkitCourse(options: PackageLessonkitCourseOptions): Promise<PackageLessonkitCourseResult>;
 
-export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type DescriptorValidationIssue, type DescriptorValidationResult, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitInterchangeV1, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type MappedLessonkitIds, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type SpaLayout, type SpaLessonEntry, type ValidateLessonkitProjectOptions, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, descriptorToInterchange, extractAssessments, mapLessonkitIds, packageLessonkitCourse, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateLessonkitProject, writeLxpackProject };
+export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type DescriptorValidationIssue, type DescriptorValidationResult, type LessonDescriptor, type LessonkitCourseDescriptor, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type MappedLessonkitIds, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type ProjectPathsInput, type SpaLayout, type SpaLessonEntry, type ValidateLessonkitProjectOptions, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, descriptorToInterchange, extractAssessments, mapLessonkitIds, packageLessonkitCourse, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateLessonkitProject, validateProjectPaths, writeLxpackProject };