All files / scripts/deep-inspection index.ts

88.88% Statements 8/9
75% Branches 3/4
100% Functions 2/2
100% Lines 8/8

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84                                                                                                      1x           1x                 1x 1x   1x 1x   1x   1x                  
/**
 * @module deep-inspection
 * @description DeepInspectionPipeline — thin programmatic entrypoint wrapper
 * around `generateDeepInspection()`.
 *
 * The underlying generator performs collection, analysis, synthesis, and
 * rendering internally. This class intentionally does not re-implement those
 * phases; it only delegates execution and returns enriched run metadata.
 *
 * @example
 * ```typescript
 * const pipeline = new DeepInspectionPipeline();
 * const result = await pipeline.run();
 * ```
 *
 * @author Hack23 AB
 * @license Apache-2.0
 */
 
import { generateDeepInspection } from '../generate-news-enhanced/generators.js';
import { analysisDepth, focusTopic } from '../generate-news-enhanced/config.js';
import type { GenerationResult } from '../types/article.js';
 
/**
 * Result produced by a pipeline run.
 * Extends GenerationResult with optional depth and topic metadata.
 */
export interface DeepInspectionResult extends GenerationResult {
  /** Effective analysis depth used. */
  depth: 1 | 2 | 3 | 4;
  /** Focus topic if provided. */
  topic?: string;
}
 
/**
 * DeepInspectionPipeline delegates execution to
 * `generateDeepInspection()` in generators.ts, which
 * reads targeting parameters and `analysisDepth` from CLI config. When used
 * programmatically via this class, those CLI values are already set at module
 * load time — so `run()` simply invokes the generator and enriches the result.
 *
 * All targeting (document IDs, URLs) and analysis depth are controlled via CLI
 * arguments parsed by `config.ts` at module load time. This class provides a
 * clean programmatic entrypoint without duplicating CLI parameter handling.
 */
export class DeepInspectionPipeline {
  /**
   * Phase labels for logging purposes.
   * @internal
   */
  private phaseLabel(depth: 1 | 2 | 3 | 4): string {
    const labels: Record<1 | 2 | 3 | 4, string> = {
      1: 'Surface analysis — events & actors',
      2: 'Predictive + historical context',
      3: 'Full report with executive summary & methodology',
      4: 'Full multi-iteration intelligence report',
    };
    return labels[depth];
  }
 
  /**
   * Run deep-inspection generation via the underlying generator wrapper.
   *
   * @returns DeepInspectionResult with success status, file count, and slug
   */
  async run(): Promise<DeepInspectionResult> {
    const depth = analysisDepth;
    const topic = focusTopic || undefined;
 
    console.log(`🔬 DeepInspectionPipeline starting — depth ${depth}: ${this.phaseLabel(depth)}`);
    Iif (topic) console.log(`   Topic: ${topic}`);
 
    const result = await generateDeepInspection();
 
    return {
      ...result,
      depth,
      topic,
    };
  }
}
 
export default DeepInspectionPipeline;