lens-content-processor 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export interface UrlToValidate {
     file: string;
     line: number;
     label: string;
+    allowUnreachable?: boolean;
 }
 export interface ProcessResult {
     modules: FlattenedModule[];
@@ -15,40 +16,57 @@ export interface FlattenedModule {
     title: string;
     contentId: string | null;
     sections: Section[];
+    sourcePath?: string;
     parentSlug?: string;
     parentTitle?: string;
     error?: string;
     warnings?: string[];
+    addToAiContext?: string[] | null;
+}
+/** Light co-branding for a partnership/demo course (e.g. the Iliad demo). */
+export interface CoursePartner {
+    /** Display name of the partner org, e.g. "Iliad". Used as alt/aria text. */
+    name: string;
+    /** Big lockup logo: bare filename served from /assets/partners/, or an absolute URL/path. */
+    logo: string;
+    /** Optional small/square mark for narrow (mobile) headers; falls back to logo. */
+    logoSmall?: string;
+    /** Optional click-through URL — the logo links here when set. */
+    url?: string;
 }
 export interface Course {
     slug: string;
     title: string;
+    slugAliases?: string[];
+    /** Present only when both partner-name and partner-logo are set in frontmatter. */
+    partner?: CoursePartner;
     progression: ProgressionItem[];
     error?: string;
 }
 export interface Section {
-    type: 'page' | 'lens-video' | 'lens-article' | 'test';
+    type: "lens" | "test";
+    displayType?: "lens-article" | "lens-video" | "lens-mixed";
     meta: SectionMeta;
     segments: Segment[];
+    sourcePath?: string;
     optional?: boolean;
+    hide?: boolean;
     feedback?: boolean;
     contentId: string | null;
     learningOutcomeId: string | null;
     learningOutcomeName: string | null;
-    videoId: string | null;
     wordCount?: number;
     videoDurationSeconds?: number;
     tldr?: string;
+    summaryForTutor?: string;
+    addToAiContext?: string[] | null;
+    addToAiContextLo?: string[] | null;
 }
 export interface SectionMeta {
     title?: string;
-    author?: string;
-    sourceUrl?: string;
-    published?: string;
-    channel?: string;
 }
 export interface ProgressionItem {
-    type: 'module' | 'meeting';
+    type: "module" | "meeting";
     slug?: string;
     path?: string;
     name?: string;
@@ -59,37 +77,46 @@ export interface ContentError {
     line?: number;
     message: string;
     suggestion?: string;
-    severity: 'error' | 'warning';
-    category?: 'production' | 'wip';
+    severity: "error" | "warning";
+    category?: "production" | "wip";
 }
 export interface TextSegment {
-    type: 'text';
+    type: "text";
     content: string;
     optional?: boolean;
 }
 export interface ChatSegment {
-    type: 'chat';
+    type: "chat";
     instructions?: string;
     hidePreviousContentFromUser?: boolean;
     hidePreviousContentFromTutor?: boolean;
     optional?: boolean;
 }
-export interface ArticleExcerptSegment {
-    type: 'article-excerpt';
+export interface ArticleSegment {
+    type: "article";
     content: string;
     collapsed_before?: string;
     collapsed_after?: string;
+    title?: string;
+    author?: string;
+    sourceUrl?: string;
+    published?: string;
+    sourcePath?: string;
     optional?: boolean;
 }
-export interface VideoExcerptSegment {
-    type: 'video-excerpt';
+export interface VideoSegment {
+    type: "video";
     from: number;
     to: number | null;
-    transcript: string;
+    transcript: TranscriptSentence[];
+    title?: string;
+    channel?: string;
+    videoId?: string;
+    isShort?: boolean;
     optional?: boolean;
 }
 export interface QuestionSegment {
-    type: 'question';
+    type: "question";
     content: string;
     assessmentInstructions?: string;
     maxTime?: string;
@@ -99,16 +126,19 @@ export interface QuestionSegment {
     feedback?: boolean;
 }
 export interface RoleplaySegment {
-    type: 'roleplay';
+    type: "roleplay";
     id: string;
     content: string;
     aiInstructions: string;
     openingMessage?: string;
     assessmentInstructions?: string;
+    userCustomizable?: boolean;
     optional?: boolean;
     feedback?: boolean;
 }
-export type Segment = TextSegment | ChatSegment | ArticleExcerptSegment | VideoExcerptSegment | QuestionSegment | RoleplaySegment;
-export type { ContentTier } from './validator/tier.js';
-export { checkTierViolation } from './validator/tier.js';
+export type Segment = TextSegment | ChatSegment | ArticleSegment | VideoSegment | QuestionSegment | RoleplaySegment;
+import { type TranscriptSentence } from "./bundler/video.js";
+export type { TranscriptSentence } from "./bundler/video.js";
+export type { ContentTier } from "./validator/tier.js";
+export { checkTierViolation } from "./validator/tier.js";
 export declare function processContent(files: Map<string, string>): ProcessResult;