lens-content-processor 0.79.0 → 0.80.0

package/dist/flattener/index.d.ts

@@ -1,8 +1,10 @@
-import type { FlattenedModule, Section, Segment, ContentError, Course } from "../index.js";
-import type { ContentTier } from "../validator/tier.js";
+import type { FlattenedModule, Section, Segment, ContentError, LearningOutcomeRef } from "../index.js";
+import type { ContentFiles, TierMap } from "../engine/reader.js";
+import { type ParsedModule } from "../parser/module.js";
 import { type ParsedLearningOutcome } from "../parser/learning-outcome.js";
 import { type ParsedLens } from "../parser/lens.js";
 import { type AuthorLink } from "../parser/author-links.js";
+import { type DeclaredSection, type DroppedContent, type DroppedItem } from "../dropped.js";
 /** One credited source of a lens: the name, and its article's linked authors
  * when author_url sets them. */
 export interface AttributionSource {
@@ -13,6 +15,8 @@ export interface FlattenModuleResult {
     module: FlattenedModule | null;
     modules: FlattenedModule[];
     errors: ContentError[];
+    /** What errors left out of each page, in the order of `modules` (src/dropped.ts). */
+    dropped: DroppedItem[][];
 }
 export type BoundaryMarker = {
     __boundary: true;
@@ -37,17 +41,33 @@ export declare function splitAtBoundaries(items: FlatItem[], parentSlug: string,
 /**
  * Flatten a module by resolving all references to Learning Outcomes, Lenses, and content.
  */
-export declare function flattenModule(modulePath: string, files: Map<string, string>, visitedPaths?: Set<string>, tierMap?: Map<string, ContentTier>): FlattenModuleResult;
-/** An outcome's suggested lens files, as `files` keys (extension resolved). */
-export declare function suggestedLensPaths(lo: ParsedLearningOutcome, files: Map<string, string>): Set<string>;
+export declare function flattenModule(modulePath: string, files: ContentFiles, visitedPaths?: Set<string>, tierMap?: TierMap): FlattenModuleResult;
 /**
- * A course teaches an outcome across units but tests it once, so a lens also
- * carries every outcome that suggests it and is tested in any module of a
- * course the lens's module is in. Runs after flattening, once the course
- * progressions are resolved to module slugs; tags from the lens's own
- * submodule come first, and the ones added here are marked testedElsewhere.
+ * The sections a module declares, for the cross-check in src/dropped.ts:
+ * every lens import, and every outcome import except one whose outcome
+ * declares no test segment (that builds nothing, on purpose). A section's page
+ * is the index of its `# Submodule:` (0 outside any). Paths resolve as
+ * flattenLensSection and flattenLearningOutcomeSection resolve them, so a
+ * section and its record name the same file.
  */
-export declare function tagCourseOutcomes(modules: FlattenedModule[], courses: Course[], lensPathsOf: (loPath: string) => Set<string>): void;
+export declare function declaredSections(parsedModule: ParsedModule, modulePath: string, files: ContentFiles): DeclaredSection[];
+/** An outcome imported by a module, with the lens files it suggests. */
+export interface ImportedOutcome {
+    ref: LearningOutcomeRef;
+    /** Suggested lens files, as `files` keys (extension resolved). */
+    lensPaths: string[];
+}
+/** Tag a lens section with every outcome that suggests its file. An inline
+ * lens's sourcePath is the module file, which no outcome suggests. */
+export declare function tagLensOutcomes(section: Section, outcomes: readonly ImportedOutcome[]): void;
+/** An outcome's suggested lens files, as `files` keys (extension resolved). */
+export declare function suggestedLensPaths(lo: ParsedLearningOutcome, files: ContentFiles): string[];
+export interface ArticlePlanEntry {
+    segments: Segment[];
+    errors: ContentError[];
+    /** What errors left out of the excerpt (src/dropped.ts). */
+    dropped: DroppedContent[];
+}
 interface ExpandPromptImportsResult {
     /** The field value with prompt imports inlined, or null when an import failed. */
     value: string | null;
@@ -70,18 +90,15 @@ interface ExpandPromptImportsResult {
  *   doesn't resolve is an error, and the segment is dropped like a failed
  *   sole import.
  */
-export declare function expandPromptImports(value: string, fieldName: string, lensPath: string, files: Map<string, string>, tierMap?: Map<string, ContentTier>): ExpandPromptImportsResult;
+export declare function expandPromptImports(value: string, fieldName: string, lensPath: string, files: ContentFiles, tierMap?: TierMap): ExpandPromptImportsResult;
 /**
  * Flatten an article file on its own, the way the standalone article page
  * shows it: one anchorless excerpt of the whole body, split around inline
  * imports exactly as a lens excerpt would be. Errors name the article file.
  */
-export declare function flattenStandaloneArticle(articlePath: string, files: Map<string, string>, tierMap?: Map<string, ContentTier>): {
-    segments: Segment[];
-    errors: ContentError[];
-};
+export declare function flattenStandaloneArticle(articlePath: string, files: ContentFiles, tierMap?: TierMap): ArticlePlanEntry;
 /**
  * Flatten a single Lens file into a FlattenedModule.
  */
-export declare function flattenLens(lensPath: string, files: Map<string, string>, tierMap?: Map<string, ContentTier>, preParsedLens?: ParsedLens): FlattenModuleResult;
+export declare function flattenLens(lensPath: string, files: ContentFiles, tierMap?: TierMap, preParsedLens?: ParsedLens): FlattenModuleResult;
 export {};