All files / src/aggregator/content types.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
// SPDX-FileCopyrightText: 2024-2026 Hack23 AB
// SPDX-License-Identifier: Apache-2.0
 
/**
 * @module Aggregator/Content/Types
 * @description Strict type definitions for the content extraction bounded
 * context. Covers lead paragraph extraction, key takeaways synthesis,
 * and section-to-artifact mapping.
 */
 
/**
 * Extracted lead paragraph — the journalistic "nut graf" from the article.
 */
export interface ExtractedLead {
  /** The extracted lead text (plain, no Markdown). */
  readonly text: string;
  /** Run-relative source artifact the lead was extracted from. */
  readonly source: string;
  /** Character length of the extracted lead. */
  readonly length: number;
}
 
/**
 * One synthesised key takeaway bullet ready for rendering.
 */
export interface SynthesisedTakeaway {
  /** Bullet body in Markdown (trimmed; no leading `- `). */
  readonly body: string;
  /** Run-relative path of the source artifact. */
  readonly source: string;
}
 
/**
 * Structured representation of key-takeaways synthesis output.
 *
 * **Note:** The current `buildKeyTakeaways` function returns a plain `string`
 * (the rendered Markdown block). This interface is a forward-looking contract
 * for future structured consumers that need both the raw takeaway items and
 * the rendered output. Use {@link Takeaway} (from `key-takeaways.ts`) for
 * per-item typing when processing the raw bullets.
 */
export interface KeyTakeawaysResult {
  /** Ordered list of synthesised takeaways (3–7 items). */
  readonly takeaways: readonly SynthesisedTakeaway[];
  /** Rendered Markdown block (empty string when below minimum threshold). */
  readonly markdown: string;
}