@heripo/research-radar 1.0.0

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,346 @@
+import { UrlString, ParsedTarget, CrawlingTargetGroup, CrawlingTarget, UnscoredArticle, ArticleForUpdateByAnalysis, ArticleForGenerateContent, Newsletter, AppLogger, EmailService, EmailMessage, DateService as DateService$1, IsoDateString, TaskService as TaskService$1, AnalysisProvider as AnalysisProvider$1, ContentGenerateProvider as ContentGenerateProvider$1, HtmlTemplate, CrawlingProvider as CrawlingProvider$1 } from '@llm-newsletter-kit/core';
+import { OpenAIProvider } from '@ai-sdk/openai';
+
+/**
+ * Repository interface for task management
+ */
+interface TaskRepository {
+    /**
+     * Create and save a new task
+     * @returns Created task ID
+     */
+    createTask(): Promise<number>;
+    /**
+     * Complete a task
+     * @param taskId Task ID to complete
+     */
+    completeTask(taskId: number): Promise<void>;
+}
+/**
+ * Repository interface for article management
+ */
+interface ArticleRepository {
+    /**
+     * Find existing articles by URLs
+     * @param urls URLs to query
+     * @returns Previously saved articles
+     */
+    findByUrls(urls: UrlString[]): Promise<ParsedTarget[]>;
+    /**
+     * Save crawled articles
+     * @param articles Articles to save
+     * @param context Task context information
+     * @returns Number of saved articles
+     */
+    saveCrawledArticles<TaskId>(articles: ParsedTarget[], context: {
+        taskId: TaskId;
+        targetGroup: Omit<CrawlingTargetGroup, 'targets'>;
+        target: CrawlingTarget;
+    }): Promise<number>;
+    /**
+     * Find unscored articles (targets for analysis)
+     * @returns Articles without scores
+     */
+    findUnscoredArticles(): Promise<UnscoredArticle[]>;
+    /**
+     * Update article with analysis results
+     * @param article Article information to update
+     */
+    updateAnalysis(article: ArticleForUpdateByAnalysis): Promise<void>;
+    /**
+     * Find candidate articles for newsletter generation
+     * @returns Candidate articles
+     */
+    findCandidatesForNewsletter(): Promise<ArticleForGenerateContent[]>;
+}
+/**
+ * Repository interface for tag management
+ */
+interface TagRepository {
+    /**
+     * Find all existing tags
+     * @returns Tag name list
+     */
+    findAllTags(): Promise<string[]>;
+}
+/**
+ * Repository interface for newsletter management
+ */
+interface NewsletterRepository {
+    /**
+     * Get the next issue order number
+     * @returns Next issue order
+     */
+    getNextIssueOrder(): Promise<number>;
+    /**
+     * Save newsletter
+     * @param input - Input parameters
+     * @param input.newsletter - Newsletter data
+     * @param input.usedArticles - List of used articles
+     * @returns Saved newsletter ID
+     */
+    saveNewsletter(input: {
+        newsletter: Newsletter;
+        usedArticles: ArticleForGenerateContent[];
+    }): Promise<{
+        id: string | number;
+    }>;
+}
+
+/**
+ * This implementation is currently hardcoded to use OpenAI.
+ * To use a different LLM provider, you need to modify:
+ * - This file: Change `createOpenAI` import and initialization
+ * - src/providers/analysis.provider.ts: Change OpenAIProvider type and model names
+ * - src/providers/content-generate.provider.ts: Change OpenAIProvider type and model name
+ *
+ * For details on switching providers, see README.md section:
+ * "⚠️ Fork하여 나만의 뉴스레터 만들기 > 4. LLM 프로바이더 변경"
+ */
+
+/**
+ * Preview newsletter configuration options
+ */
+interface PreviewNewsletterOptions {
+    /** Function to fetch newsletter for preview */
+    fetchNewsletterForPreview: () => Promise<Newsletter>;
+    /** Email sending service */
+    emailService: EmailService;
+    /** Email message configuration (subject, html, text are auto-generated) */
+    emailMessage: Omit<EmailMessage, 'subject' | 'html' | 'text'>;
+}
+/**
+ * Newsletter generator dependencies interface
+ */
+interface NewsletterGeneratorDependencies {
+    /** OpenAI API key */
+    openAIApiKey: string;
+    /** Task management repository */
+    taskRepository: TaskRepository;
+    /** Article management repository */
+    articleRepository: ArticleRepository;
+    /** Tag management repository */
+    tagRepository: TagRepository;
+    /** Newsletter management repository */
+    newsletterRepository: NewsletterRepository;
+    /** Logger (optional) */
+    logger?: AppLogger;
+    /** Preview email configuration (optional) */
+    previewNewsletter?: PreviewNewsletterOptions;
+}
+/**
+ * Newsletter generation execution function
+ *
+ * @param dependencies - Repository implementations and options
+ * @returns Generated newsletter ID
+ *
+ * @example
+ * ```typescript
+ * const newsletterId = await generateNewsletter({
+ *   openAIApiKey: process.env.OPENAI_API_KEY,
+ *   taskRepository: new PrismaTaskRepository(prisma),
+ *   articleRepository: new PrismaArticleRepository(prisma),
+ *   tagRepository: new PrismaTagRepository(prisma),
+ *   newsletterRepository: new PrismaNewsletterRepository(prisma),
+ * });
+ * ```
+ */
+declare function generateNewsletter(dependencies: NewsletterGeneratorDependencies): Promise<string | number | null>;
+
+/**
+ * Date service implementation
+ * - Provides current date and display date strings
+ */
+declare class DateService implements DateService$1 {
+    /**
+     * Get current date in ISO format (YYYY-MM-DD)
+     * @returns ISO date string (e.g., "2024-10-15")
+     */
+    getCurrentISODateString(): IsoDateString;
+    /**
+     * Get formatted display date string
+     * @returns Korean formatted date (e.g., "2024년 10월 15일")
+     */
+    getDisplayDateString(): string;
+}
+
+/**
+ * Task service implementation
+ * - Manages newsletter generation task lifecycle (start/end)
+ * - Prevents duplicate execution
+ */
+declare class TaskService implements TaskService$1<number> {
+    private readonly taskRepository;
+    private currentTaskId;
+    constructor(taskRepository: TaskRepository);
+    /**
+     * Start a new task
+     * @throws Error if a task is already running
+     * @returns Task ID
+     */
+    start(): Promise<number>;
+    /**
+     * End the current task
+     * @throws Error if no task is running
+     */
+    end(): Promise<void>;
+}
+
+/**
+ * Analysis provider implementation
+ * - LLM-based article analysis
+ * - Tag classification, image analysis, importance scoring
+ */
+declare class AnalysisProvider implements AnalysisProvider$1 {
+    private readonly openai;
+    private readonly articleRepository;
+    private readonly tagRepository;
+    classifyTagOptions: {
+        model: ReturnType<OpenAIProvider>;
+    };
+    analyzeImagesOptions: {
+        model: ReturnType<OpenAIProvider>;
+    };
+    determineScoreOptions: {
+        model: ReturnType<OpenAIProvider>;
+        minimumImportanceScoreRules: Array<{
+            targetUrl: string;
+            minScore: number;
+        }>;
+    };
+    constructor(openai: OpenAIProvider, articleRepository: ArticleRepository, tagRepository: TagRepository);
+    /**
+     * Fetch articles that haven't been scored yet
+     * @returns Unscored articles awaiting analysis
+     */
+    fetchUnscoredArticles(): Promise<UnscoredArticle[]>;
+    /**
+     * Fetch all existing tags for classification
+     * @returns List of tag names
+     */
+    fetchTags(): Promise<string[]>;
+    /**
+     * Update article with analysis results (tags, image analysis, importance score)
+     * @param article - Article with analysis data
+     */
+    update(article: ArticleForUpdateByAnalysis): Promise<void>;
+}
+
+/**
+ * Content generation provider implementation
+ * - LLM-based newsletter content generation
+ * - HTML template provisioning
+ * - Newsletter persistence
+ */
+declare class ContentGenerateProvider implements ContentGenerateProvider$1 {
+    private readonly openai;
+    private readonly articleRepository;
+    private readonly newsletterRepository;
+    private _issueOrder;
+    model: ReturnType<OpenAIProvider>;
+    constructor(openai: OpenAIProvider, articleRepository: ArticleRepository, newsletterRepository: NewsletterRepository);
+    /** LLM temperature setting for content generation */
+    temperature: number;
+    /** Newsletter brand name */
+    newsletterBrandName: string;
+    /** Subscribe page URL */
+    subscribePageUrl: UrlString;
+    /** Publication criteria (minimum article count, priority score threshold) */
+    publicationCriteria: {
+        minimumArticleCountForIssue: number;
+        priorityArticleScoreThreshold: number;
+    };
+    /**
+     * Get current issue order
+     * @throws Error if issue order not initialized
+     */
+    get issueOrder(): number;
+    /**
+     * Initialize issue order before newsletter generation
+     */
+    initializeIssueOrder(): Promise<void>;
+    /**
+     * Fetch candidate articles for newsletter generation
+     * @returns Articles eligible for inclusion in the newsletter
+     */
+    fetchArticleCandidates(): Promise<ArticleForGenerateContent[]>;
+    /** HTML template with markers for title and content injection */
+    htmlTemplate: HtmlTemplate;
+    /**
+     * Save generated newsletter to the repository
+     * @param input - Newsletter data and used articles
+     * @returns Saved newsletter ID
+     */
+    saveNewsletter(input: {
+        newsletter: Newsletter;
+        usedArticles: ArticleForGenerateContent[];
+    }): Promise<{
+        id: string | number;
+    }>;
+}
+
+/**
+ * Crawling provider implementation
+ * - Defines crawling targets
+ * - Saves crawling results
+ * - Fetches existing articles
+ */
+declare class CrawlingProvider implements CrawlingProvider$1 {
+    private readonly articleRepository;
+    /** Maximum number of concurrent crawling operations */
+    maxConcurrency: number;
+    constructor(articleRepository: ArticleRepository);
+    /** Crawling target groups configuration */
+    crawlingTargetGroups: CrawlingTargetGroup[];
+    /**
+     * Fetch existing articles by URLs to avoid duplicate crawling
+     * @param articleUrls - URLs to check
+     * @returns Existing articles
+     */
+    fetchExistingArticlesByUrls(articleUrls: UrlString[]): Promise<ParsedTarget[]>;
+    /**
+     * Save crawled articles to the repository
+     * @param articles - Articles to save
+     * @param context - Task context (task ID, target group, target)
+     * @returns Number of saved articles
+     */
+    saveCrawledArticles<TaskId>(articles: ParsedTarget[], context: {
+        taskId: TaskId;
+        targetGroup: Omit<CrawlingTargetGroup, 'targets'>;
+        target: CrawlingTarget;
+    }): Promise<number>;
+}
+
+declare const crawlingTargetGroups: CrawlingTargetGroup[];
+
+/**
+ * Newsletter content configuration
+ */
+declare const contentOptions: {
+    outputLanguage: string;
+    expertField: string[];
+};
+/**
+ * Newsletter brand configuration
+ */
+declare const newsletterConfig: {
+    brandName: string;
+    subscribePageUrl: string;
+    publicationCriteria: {
+        minimumArticleCountForIssue: number;
+        priorityArticleScoreThreshold: number;
+    };
+};
+/**
+ * LLM configuration
+ */
+declare const llmConfig: {
+    maxRetries: number;
+    chainStopAfterAttempt: number;
+    generation: {
+        temperature: number;
+    };
+};
+
+export { AnalysisProvider, ContentGenerateProvider, CrawlingProvider, DateService, TaskService, contentOptions, crawlingTargetGroups, generateNewsletter, llmConfig, newsletterConfig };
+export type { ArticleRepository, NewsletterGeneratorDependencies, NewsletterRepository, PreviewNewsletterOptions, TagRepository, TaskRepository };