@heripo/research-radar 1.0.0

package/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright (c) 2025-present kimhongyeon
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NOTICE

@@ -0,0 +1,60 @@
+Heripo Research Radar
+Copyright (c) 2025-present kimhongyeon
+
+This project is licensed under the Apache License 2.0.
+See LICENSE file for full license text.
+
+This project is built on top of @llm-newsletter-kit/core and serves as both
+a production service and a reference implementation for the LLM Newsletter Kit.
+
+===============================================================================
+
+ATTRIBUTION REQUIREMENT
+
+If you fork this project to build your own newsletter service or create
+derivative works based on this code, you must include the following
+attribution notice:
+
+  "Powered by LLM Newsletter Kit"
+
+This notice should be included in at least one of the following locations:
+- In your newsletter's HTML template footer
+- In your service's documentation or website
+- In your application's user interface (e.g., footer, about page)
+
+For compliance with Section 4(d) of the Apache License 2.0, this attribution
+notice must be retained in derivative works.
+
+===============================================================================
+
+TRADEMARK NOTICE
+
+The following names, marks, and logos are trademarks of kimhongyeon:
+- "heripo" and "헤리포"
+- "Research Radar" and "리서치 레이더"
+- The heripo logo and associated visual designs
+- Domain name: heripo.com
+
+While the source code is freely available under the Apache 2.0 license,
+use of these trademarks requires explicit permission from the trademark owner.
+
+If you fork or modify this project for your own use, please:
+1. Replace all instances of "heripo" with your own brand name
+2. Replace the logo images with your own
+3. Update the domain references to your own
+4. Update branding in templates and configuration files
+
+Example implementations are welcome to use this code, but should establish
+their own brand identity.
+
+For permission to use the "heripo" trademark, contact the project maintainer
+via GitHub: https://github.com/kimhongyeon/heripo-research-radar/issues
+
+===============================================================================
+
+DEPENDENCIES
+
+This software depends on @llm-newsletter-kit/core, which is also licensed
+under the Apache License 2.0.
+
+For third-party dependencies, see package.json.

package/README.md

@@ -0,0 +1,216 @@
+# Heripo Research Radar
+
+English | [한국어](./README-ko.md)
+
+[![CI](https://github.com/kimhongyeon/heripo-research-radar/actions/workflows/ci.yml/badge.svg)](https://github.com/kimhongyeon/heripo-research-radar/actions/workflows/ci.yml)
+[
+![npm version](https://img.shields.io/npm/v/%40heripo%2Fresearch-radar?logo=npm&color=cb0000)
+](https://www.npmjs.com/package/@heripo/research-radar)
+![license](https://img.shields.io/github/license/kimhongyeon/heripo-research-radar)
+![node](https://img.shields.io/badge/node-%3E%3D22-brightgreen)
+
+[Code of Conduct](./CODE_OF_CONDUCT.md) • [Security Policy](./SECURITY.md) • [Contributing](./CONTRIBUTING.md)
+
+## What is this?
+
+An AI-powered newsletter service for Korean cultural heritage. Built on [`@llm-newsletter-kit/core`](https://github.com/kimhongyeon/llm-newsletter-kit-core), it's both a production service ([live at heripo.com](https://heripo.com/research-radar/subscribe)) and a reference implementation showing how to build automated newsletters with LLMs.
+
+**Production metrics**:
+- **Cost**: $0.2-1 USD per issue
+- **Operation**: Fully autonomous 24/7 (no human intervention)
+- **Engagement**: 15% CTR
+
+**Technical highlights**:
+- Type-safe TypeScript with strict interfaces
+- Provider pattern for swapping components (Crawling/Analysis/Content/Email)
+- 62 crawling targets across heritage agencies, museums, academic societies
+- LLM-driven analysis (GPT-5 models)
+- Built-in retries, chain options, preview emails
+
+**Links**: [Live service](https://heripo.com/research-radar/subscribe) • [Newsletter example](https://heripo.com/research-radar-newsletter-example.html) • [Core engine](https://github.com/kimhongyeon/llm-newsletter-kit-core)
+
+## Background
+
+Created by archaeologist-turned-engineer Hongyeon Kim to answer: "Why must research rely on labor-intensive manual work?"
+
+A personal script evolved into a production service after completing research on [Archaeological Informatization Using LLMs](https://poc.heripo.com). This repository open-sources the running service so developers can build domain-specific newsletters without starting from scratch.
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE) and [NOTICE](./NOTICE) for details.
+
+## Citation & Attribution
+
+If you fork this project to build your own newsletter service or use this code in your research, please include the following attribution:
+
+```
+Powered by LLM Newsletter Kit
+```
+
+We recommend adding this notice to your newsletter template footer or service documentation. This attribution helps support the project and its continued development.
+
+### BibTeX Citation
+
+For academic publications:
+
+```bibtex
+@software{llm_newsletter_kit,
+  author = {Kim, Hongyeon},
+  title = {LLM Newsletter Kit: AI-Powered Newsletter Automation Framework},
+  year = {2025},
+  url = {https://github.com/kimhongyeon/heripo-research-radar},
+  note = {Apache License 2.0}
+}
+```
+
+## Installation
+
+```bash
+npm install @heripo/research-radar @llm-newsletter-kit/core
+```
+
+**Requirements**: Node.js >= 22, OpenAI API key
+
+**Note**: `@llm-newsletter-kit/core` is a peer dependency and must be installed separately.
+
+## Quick Start
+
+```typescript
+import { generateNewsletter } from '@heripo/research-radar';
+
+const newsletterId = await generateNewsletter({
+  openAIApiKey: process.env.OPENAI_API_KEY,
+
+  // Implement these repository interfaces (see src/types/dependencies.ts)
+  taskRepository: {
+    createTask: async () => db.tasks.create({ status: 'running' }),
+    completeTask: async (id) => db.tasks.update(id, { status: 'completed' }),
+  },
+
+  articleRepository: {
+    findByUrls: async (urls) => db.articles.findByUrls(urls),
+    saveCrawledArticles: async (articles, ctx) => db.articles.save(articles, ctx),
+    findUnscoredArticles: async () => db.articles.findUnscored(),
+    updateAnalysis: async (article) => db.articles.updateAnalysis(article),
+    findCandidatesForNewsletter: async () => db.articles.findCandidates(),
+  },
+
+  tagRepository: {
+    findAllTags: async () => db.tags.findAll(),
+  },
+
+  newsletterRepository: {
+    getNextIssueOrder: async () => db.newsletters.getNextOrder(),
+    saveNewsletter: async (data) => db.newsletters.save(data),
+  },
+
+  // Optional: Custom logger and preview
+  logger: console,
+  previewNewsletter: {
+    fetchNewsletterForPreview: async () => db.newsletters.latest(),
+    emailService: resendEmailService,
+    emailMessage: { from: 'news@example.com', to: 'preview@example.com' },
+  },
+});
+```
+
+**Repository interfaces** are defined in `src/types/dependencies.ts`. Each method signature includes JSDoc with expected input/output types.
+
+## Architecture
+
+**Pipeline**: Crawling → Analysis → Content Generation → Save
+
+1. **Crawling**: Fetch articles from target websites
+2. **Analysis**: LLM tags and scores articles
+3. **Generation**: Create newsletter from top-scoring articles
+4. **Save**: Store and optionally send preview email
+
+Uses the **Provider-Service pattern** from `@llm-newsletter-kit/core`. See [core docs](https://github.com/kimhongyeon/llm-newsletter-kit-core#architecture--flow) for flow diagrams.
+
+## Components
+
+**Config** (`src/config/`): Brand, language, LLM settings
+
+**Targets** (`src/config/crawling-targets.ts`): 62 sources (News 49, Business 4, Employment 9)
+
+**Parsers** (`src/parsers/`): Custom extractors per organization
+
+**Template** (`src/templates/newsletter-html.ts`): Responsive email with light/dark mode
+
+## Development commands
+
+```bash
+# build
+npm run build              # clean dist/ and build with Rollup (CJS + ESM + types)
+
+# type-check & lint
+npm run lint               # lint source files
+npm run lint:fix           # lint with autofix
+npm run typecheck          # TypeScript type-check
+
+# formatting
+npm run format             # Prettier formatting
+```
+
+## 🤝 Contributing
+
+You can use this project in two ways:
+
+1. Contribute directly to Heripo Research Radar: bug fixes, improvements, new crawl targets
+2. Build your own newsletter: fork this repo and adapt it to your domain
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution workflow, dev setup, and PR guidelines.
+
+## Forking for Your Domain
+
+To build your own newsletter, update these files:
+
+**1. Template** (`src/templates/newsletter-html.ts`):
+- Logo URLs, brand colors (#D2691E, #E59866), contact info
+- Platform intro and footer text
+- Unsubscribe link format (currently Resend's `{{{RESEND_UNSUBSCRIBE_URL}}}`)
+
+**2. Config** (`src/config/index.ts`):
+```typescript
+brandName: 'Your Newsletter Name'
+subscribeUrl: 'https://yourdomain.com/subscribe'
+```
+
+**3. Crawling targets** (`src/config/crawling-targets.ts`):
+- Replace Korean heritage sites with your domain sources
+- Implement parsers in `src/parsers/`
+
+**4. Switch LLM provider** (optional):
+
+To use Anthropic/Gemini/Ollama instead of OpenAI:
+- `src/newsletter-generator.ts`: Change `createOpenAI()` to your provider
+- `src/providers/analysis.provider.ts`: Update model names (currently `gpt-5-mini`, `gpt-5.1`)
+- `src/providers/content-generate.provider.ts`: Update model name
+
+Any [Vercel AI SDK provider](https://sdk.vercel.ai/providers) works.
+
+**Search keywords**: `heripo`, `kimhongyeon`, `#D2691E`, `openai`, `gpt-5`
+
+## Why Code-Based?
+
+Code-based automation delivers **superior output quality** through advanced AI techniques:
+
+**No-code platforms**: Generic content, limited to built-in features
+**This kit**: Self-reflection, chain-of-thought, multi-step verification workflows
+
+**Key advantages**:
+- **Quality**: Sophisticated prompting strategies, custom validation pipelines
+- **Cost control**: Different models per step, token limits, retry logic
+- **Flexibility**: Swap any component (Crawling/Analysis/Content/Email) via Provider interfaces
+- **Operations**: Built-in retries, preview emails, integrates with CI/CD
+- **No lock-in**: OSS, self-hostable, any LLM provider
+
+**Design philosophy**:
+- Logic in code (orchestration, deduplication)
+- Reasoning in AI (analysis, scoring, content generation)
+- Connections in architecture (swappable Providers)
+
+## Related Projects
+
+- [`@llm-newsletter-kit/core`](https://github.com/kimhongyeon/llm-newsletter-kit-core) — Domain-agnostic newsletter engine
+- [Archaeological Informatization Using LLMs](https://poc.heripo.com) — Academic research (Korean)