@lessonkit/lxpack 1.4.0 → 1.5.0

package/dist/index.d.cts

@@ -6,7 +6,7 @@ export { ExportTarget } from '@lxpack/api';
 import { LessonkitInterchangeV1 } from '@lxpack/validators';
 export { LessonkitInterchangeV1, MaterializeLessonkitOptions, MaterializeLessonkitResult, lessonkitInterchangeSchema, materializeLessonkitProject, parseLessonkitInterchange } from '@lxpack/validators';
 export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
-export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.cjs';
+export { t as telemetryEventToLessonkit } from './telemetry-0fIWoomS.cjs';
 
 type SpaLayout = "single-spa" | "per-lesson-spa";
 type LessonDescriptor = {
@@ -171,6 +171,8 @@ type LxpackInjectedAssessment = {
         }>;
     }>;
 };
+/** Escape text embedded into LMS shell / SCORM interchange payloads. */
+declare function escapeShellText(text: string): string;
 declare function assessmentDescriptorToLxpack(assessment: AssessmentDescriptor): LxpackInjectedAssessment | null;
 declare function extractAssessments(descriptor: LessonkitCourseDescriptor): LxpackInjectedAssessment[];
 
@@ -187,8 +189,8 @@ 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;
+    /** Project root used to resolve relative SPA paths and confine output directories. */
+    projectRoot: string;
 };
 type WriteLxpackProjectResult = {
     outDir: string;
@@ -200,7 +202,13 @@ type WriteLxpackProjectResult = {
  */
 declare function writeLxpackProject(options: WriteLxpackProjectOptions): Promise<WriteLxpackProjectResult>;
 
-declare function promoteStagingToOutDir(stagingDir: string, outDir: string): Promise<void>;
+type PromoteStagingOptions = {
+    /** Relative path under `outDir` where LMS artifacts live (default `.lxpack/out`). */
+    outputBaseDir?: string;
+    /** When set, re-validates `outDir` is under the project root immediately before promote. */
+    projectRoot?: string;
+};
+declare function promoteStagingToOutDir(stagingDir: string, outDir: string, options?: PromoteStagingOptions): Promise<void>;
 
 type BuildStagingPackageOptions = WriteLxpackProjectOptions & {
     descriptor: LessonkitCourseDescriptor;
@@ -250,6 +258,8 @@ type PackageLessonkitCourseOptions = WriteLxpackProjectOptions & {
     output?: string;
     dir?: boolean;
     outputBaseDir?: string;
+    /** Treat React parity warnings as packaging errors. */
+    strictParity?: boolean;
 };
 type PackageLessonkitCourseResult = {
     ok: true;
@@ -275,6 +285,10 @@ type PackageLessonkitCourseResult = {
 declare function validateLessonkitProject(options: ValidateLessonkitProjectOptions): Promise<ValidateCourseResult>;
 declare function buildLessonkitProject(options: BuildLessonkitProjectOptions): Promise<BuildCourseResult>;
 
+/**
+ * Package a built SPA into SCORM, xAPI, cmi5, or standalone LMS artifacts.
+ * Prefer `lessonkit package --target …` in course projects; call directly for custom pipelines.
+ */
 declare function packageLessonkitCourse(options: PackageLessonkitCourseOptions): Promise<PackageLessonkitCourseResult>;
 
 type PackageValidationIssue = {
@@ -319,7 +333,11 @@ type ParseManifestResult = {
     ok: false;
     issues: ManifestParseIssue[];
 };
+/**
+ * Parse and validate a project-root `lessonkit.json` manifest (`schemaVersion: 1`).
+ * Pass `projectRoot` for path containment checks equivalent to the CLI.
+ */
 declare function parseLessonkitManifest(raw: unknown, label?: string, projectRoot?: string): ParseManifestResult;
 declare function loadLessonkitManifestFromFile(readJson: () => Promise<unknown>, label?: string, projectRoot?: string): Promise<ParseManifestResult>;
 
-export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type BuildStagingPackageOptions, type BuildStagingPackageResult, type DescriptorValidationIssue, type DescriptorValidationResult, type FillInBlanksAssessmentDescriptor, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitExportTarget, type LessonkitManifest, type LessonkitManifestPaths, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type ManifestParseIssue, type MappedLessonkitIds, type McqAssessmentDescriptor, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type PackageValidationIssue, type ParseManifestResult, type ProjectPathsInput, type ReactParityIssue, type SpaLayout, type SpaLessonEntry, type TrueFalseAssessmentDescriptor, type ValidateLessonkitProjectOptions, type ValidatePackageInputsResult, type ValidationIssue, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, buildStagingPackage, descriptorToInterchange, ensureOutDirParent, extractAssessments, loadLessonkitManifestFromFile, mapLessonkitIds, packageLessonkitCourse, parseLessonkitManifest, promoteStagingToOutDir, remapArtifactPaths, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateDescriptorForTarget, validateLessonkitProject, validatePackageInputs, validateProjectPaths, validateReactManifestParity, writeLxpackProject };
+export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type BuildStagingPackageOptions, type BuildStagingPackageResult, type DescriptorValidationIssue, type DescriptorValidationResult, type FillInBlanksAssessmentDescriptor, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitExportTarget, type LessonkitManifest, type LessonkitManifestPaths, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type ManifestParseIssue, type MappedLessonkitIds, type McqAssessmentDescriptor, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type PackageValidationIssue, type ParseManifestResult, type ProjectPathsInput, type ReactParityIssue, type SpaLayout, type SpaLessonEntry, type TrueFalseAssessmentDescriptor, type ValidateLessonkitProjectOptions, type ValidatePackageInputsResult, type ValidationIssue, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, buildStagingPackage, descriptorToInterchange, ensureOutDirParent, escapeShellText, extractAssessments, loadLessonkitManifestFromFile, mapLessonkitIds, packageLessonkitCourse, parseLessonkitManifest, promoteStagingToOutDir, remapArtifactPaths, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateDescriptorForTarget, validateLessonkitProject, validatePackageInputs, validateProjectPaths, validateReactManifestParity, writeLxpackProject };

package/dist/index.d.ts

@@ -6,7 +6,7 @@ export { ExportTarget } from '@lxpack/api';
 import { LessonkitInterchangeV1 } from '@lxpack/validators';
 export { LessonkitInterchangeV1, MaterializeLessonkitOptions, MaterializeLessonkitResult, lessonkitInterchangeSchema, materializeLessonkitProject, parseLessonkitInterchange } from '@lxpack/validators';
 export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
-export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.js';
+export { t as telemetryEventToLessonkit } from './telemetry-0fIWoomS.js';
 
 type SpaLayout = "single-spa" | "per-lesson-spa";
 type LessonDescriptor = {
@@ -171,6 +171,8 @@ type LxpackInjectedAssessment = {
         }>;
     }>;
 };
+/** Escape text embedded into LMS shell / SCORM interchange payloads. */
+declare function escapeShellText(text: string): string;
 declare function assessmentDescriptorToLxpack(assessment: AssessmentDescriptor): LxpackInjectedAssessment | null;
 declare function extractAssessments(descriptor: LessonkitCourseDescriptor): LxpackInjectedAssessment[];
 
@@ -187,8 +189,8 @@ 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;
+    /** Project root used to resolve relative SPA paths and confine output directories. */
+    projectRoot: string;
 };
 type WriteLxpackProjectResult = {
     outDir: string;
@@ -200,7 +202,13 @@ type WriteLxpackProjectResult = {
  */
 declare function writeLxpackProject(options: WriteLxpackProjectOptions): Promise<WriteLxpackProjectResult>;
 
-declare function promoteStagingToOutDir(stagingDir: string, outDir: string): Promise<void>;
+type PromoteStagingOptions = {
+    /** Relative path under `outDir` where LMS artifacts live (default `.lxpack/out`). */
+    outputBaseDir?: string;
+    /** When set, re-validates `outDir` is under the project root immediately before promote. */
+    projectRoot?: string;
+};
+declare function promoteStagingToOutDir(stagingDir: string, outDir: string, options?: PromoteStagingOptions): Promise<void>;
 
 type BuildStagingPackageOptions = WriteLxpackProjectOptions & {
     descriptor: LessonkitCourseDescriptor;
@@ -250,6 +258,8 @@ type PackageLessonkitCourseOptions = WriteLxpackProjectOptions & {
     output?: string;
     dir?: boolean;
     outputBaseDir?: string;
+    /** Treat React parity warnings as packaging errors. */
+    strictParity?: boolean;
 };
 type PackageLessonkitCourseResult = {
     ok: true;
@@ -275,6 +285,10 @@ type PackageLessonkitCourseResult = {
 declare function validateLessonkitProject(options: ValidateLessonkitProjectOptions): Promise<ValidateCourseResult>;
 declare function buildLessonkitProject(options: BuildLessonkitProjectOptions): Promise<BuildCourseResult>;
 
+/**
+ * Package a built SPA into SCORM, xAPI, cmi5, or standalone LMS artifacts.
+ * Prefer `lessonkit package --target …` in course projects; call directly for custom pipelines.
+ */
 declare function packageLessonkitCourse(options: PackageLessonkitCourseOptions): Promise<PackageLessonkitCourseResult>;
 
 type PackageValidationIssue = {
@@ -319,7 +333,11 @@ type ParseManifestResult = {
     ok: false;
     issues: ManifestParseIssue[];
 };
+/**
+ * Parse and validate a project-root `lessonkit.json` manifest (`schemaVersion: 1`).
+ * Pass `projectRoot` for path containment checks equivalent to the CLI.
+ */
 declare function parseLessonkitManifest(raw: unknown, label?: string, projectRoot?: string): ParseManifestResult;
 declare function loadLessonkitManifestFromFile(readJson: () => Promise<unknown>, label?: string, projectRoot?: string): Promise<ParseManifestResult>;
 
-export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type BuildStagingPackageOptions, type BuildStagingPackageResult, type DescriptorValidationIssue, type DescriptorValidationResult, type FillInBlanksAssessmentDescriptor, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitExportTarget, type LessonkitManifest, type LessonkitManifestPaths, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type ManifestParseIssue, type MappedLessonkitIds, type McqAssessmentDescriptor, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type PackageValidationIssue, type ParseManifestResult, type ProjectPathsInput, type ReactParityIssue, type SpaLayout, type SpaLessonEntry, type TrueFalseAssessmentDescriptor, type ValidateLessonkitProjectOptions, type ValidatePackageInputsResult, type ValidationIssue, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, buildStagingPackage, descriptorToInterchange, ensureOutDirParent, extractAssessments, loadLessonkitManifestFromFile, mapLessonkitIds, packageLessonkitCourse, parseLessonkitManifest, promoteStagingToOutDir, remapArtifactPaths, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateDescriptorForTarget, validateLessonkitProject, validatePackageInputs, validateProjectPaths, validateReactManifestParity, writeLxpackProject };
+export { type AssessmentDescriptor, type BuildLessonkitProjectOptions, type BuildStagingPackageOptions, type BuildStagingPackageResult, type DescriptorValidationIssue, type DescriptorValidationResult, type FillInBlanksAssessmentDescriptor, type LessonDescriptor, type LessonkitCourseDescriptor, type LessonkitExportTarget, type LessonkitManifest, type LessonkitManifestPaths, type LxpackInjectedAssessment, type LxpackRuntimeTheme, type ManifestParseIssue, type MappedLessonkitIds, type McqAssessmentDescriptor, type PackageLessonkitCourseOptions, type PackageLessonkitCourseResult, type PackageValidationIssue, type ParseManifestResult, type ProjectPathsInput, type ReactParityIssue, type SpaLayout, type SpaLessonEntry, type TrueFalseAssessmentDescriptor, type ValidateLessonkitProjectOptions, type ValidatePackageInputsResult, type ValidationIssue, type WriteLxpackProjectOptions, type WriteLxpackProjectResult, assessmentDescriptorToLxpack, buildLessonkitProject, buildStagingPackage, descriptorToInterchange, ensureOutDirParent, escapeShellText, extractAssessments, loadLessonkitManifestFromFile, mapLessonkitIds, packageLessonkitCourse, parseLessonkitManifest, promoteStagingToOutDir, remapArtifactPaths, resolveSafePackageOutputOverride, resolveSpaLessons, themeToLxpackRuntime, validateDescriptor, validateDescriptorForTarget, validateLessonkitProject, validatePackageInputs, validateProjectPaths, validateReactManifestParity, writeLxpackProject };