streamdown-angular 0.4.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2023 Vercel, Inc.
+
+   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,23 @@
+ngx-streamdown
+==============
+
+This project is an Angular port of Streamdown.
+
+Original work:
+  Streamdown
+  Copyright 2023 Vercel, Inc.
+  Source: https://github.com/vercel/streamdown
+  Licensed under the Apache License, Version 2.0.
+
+This Angular port ("ngx-streamdown") contains modifications and new code
+derived from and inspired by the original Streamdown source. In accordance
+with Section 4 of the Apache License 2.0, the following changes were made:
+
+  - React components and hooks were re-implemented as Angular standalone
+    components, services and signals.
+  - The React-specific HAST-to-JSX runtime (hast-util-to-jsx-runtime) was
+    replaced by a custom HAST → Angular DOM renderer (lib/hast/*).
+  - The unified markdown pipeline was wrapped in an Angular injectable
+    service (MarkdownService).
+
+The original Apache-2.0 license text is retained in the LICENSE file.

package/README.md

@@ -0,0 +1,246 @@
+<div align="center">
+
+# 🅰️ streamdown-angular
+
+### Stream-safe Markdown rendering for Angular — built for AI chat UIs
+
+Angular port of [**Vercel Streamdown**](https://github.com/vercel/streamdown). Drop‑in `<ngx-streamdown>` component powered by **signals**, **standalone components** and **OnPush**.
+
+[![npm](https://img.shields.io/npm/v/streamdown-angular.svg?color=%23c2185b&label=npm)](https://www.npmjs.com/package/streamdown-angular)
+[![license](https://img.shields.io/npm/l/streamdown-angular.svg?color=blue)](./LICENSE)
+![Angular](https://img.shields.io/badge/Angular-21%2B-dd0031?logo=angular&logoColor=white)
+![types](https://img.shields.io/badge/types-included-3178c6?logo=typescript&logoColor=white)
+
+</div>
+
+---
+
+Render Markdown that **arrives one token at a time**. `streamdown-angular` parses Markdown into a sanitized HAST tree and renders it as **real Angular DOM** (never `innerHTML` of untrusted content). As text streams in, incomplete Markdown — `**bold`, `[half link`, unterminated ```code fences``` — is auto‑completed, and a diffing renderer updates only what changed (no flicker, scroll & selection preserved).
+
+```ts
+<ngx-streamdown [content]="response()" [caret]="true" />
+```
+
+## 📑 Contents
+
+- [Why streamdown-angular](#-why-streamdown-angular)
+- [Install](#-install)
+- [Quick start](#-quick-start)
+- [Streaming from an API](#-streaming-from-an-api)
+- [Inputs](#-inputs)
+- [Optional plugins](#-optional-plugins)
+- [Styling](#-styling)
+- [Internationalization & customization](#-internationalization--customization)
+- [Low‑level API](#-low-level-api)
+- [How it works](#-how-it-works)
+- [License](#-license)
+
+## ✨ Why streamdown-angular
+
+| | Feature |
+|---|---|
+| 🔄 | **Streaming‑first** — Markdown is split into memoized blocks; only the changed block re‑renders. Incomplete Markdown is fixed via [`remend`](https://www.npmjs.com/package/remend). |
+| ⚡ | **Incremental rendering** — HAST diffing keeps unchanged DOM in place; no flicker, scroll/selection/focus preserved, mapped components keep their instance. |
+| 🛡️ | **Safe by default** — `rehype-sanitize` in the pipeline; text via `Renderer2.createText`, never raw `innerHTML`. |
+| 🎨 | **GFM** — tables, strikethrough, task lists, autolinks. |
+| 🌈 | **Code blocks** — [Shiki](https://shiki.style) highlighting (light/dark) + copy & download buttons. *Default on.* |
+| 📊 | **Tables** — copy as Markdown/CSV, download CSV. *Default on.* |
+| 📐 | **Math** — KaTeX `$inline$` and `$$block$$`. *Opt‑in.* |
+| 🧜 | **Diagrams** — Mermaid. *Opt‑in.* |
+| ✍️ | **Streaming caret** + optional **fade‑in** for new tokens. |
+| 🔗 | **Link safety** — external links open via a confirmation modal; always `rel="noopener noreferrer"`. |
+| 🖼️ | **Images** — loading skeleton + error fallback. |
+| 🌐 | **i18n / icons / prefix** — fully overridable via providers. |
+| ↔️ | **RTL/LTR** auto‑detection. |
+
+## 📦 Install
+
+```bash
+npm i streamdown-angular
+```
+
+Heavy features are **optional peer dependencies** — install only what you use:
+
+```bash
+npm i shiki                            # code highlighting (recommended)
+npm i mermaid                          # diagrams
+npm i katex remark-math rehype-katex   # math
+```
+
+> Requires **Angular 21+**.
+
+## 🚀 Quick start
+
+```ts
+import { Component, signal } from '@angular/core';
+import { StreamdownComponent } from 'streamdown-angular';
+
+@Component({
+  selector: 'app-chat',
+  standalone: true,
+  imports: [StreamdownComponent],
+  template: `<ngx-streamdown [content]="markdown()" />`,
+})
+export class ChatComponent {
+  markdown = signal('# Hello 👋\n\nStreaming **markdown** with `code`, tables and math.');
+}
+```
+
+That's it — no module imports, no `NgModule`. Code blocks and tables work out of the box.
+
+## 🔌 Streaming from an API
+
+Just keep growing the `content` signal as chunks arrive. Turn on `caret` while the response is in flight:
+
+```ts
+@Component({
+  selector: 'app-chat',
+  standalone: true,
+  imports: [StreamdownComponent],
+  template: `<ngx-streamdown [content]="answer()" [caret]="streaming()" />`,
+})
+export class ChatComponent {
+  readonly answer = signal('');
+  readonly streaming = signal(false);
+
+  async ask(prompt: string): Promise<void> {
+    this.answer.set('');
+    this.streaming.set(true);
+    for await (const chunk of streamFromApi(prompt)) {
+      this.answer.update((text) => text + chunk);   // diffing renders only the delta
+    }
+    this.streaming.set(false);
+  }
+}
+```
+
+## ⚙️ Inputs
+
+| Input | Type | Default | Description |
+|---|---|:---:|---|
+| `content` | `string` | `''` | Markdown source — grow it as tokens stream in. |
+| `parseIncompleteMarkdown` | `boolean` | `true` | Auto‑complete unterminated Markdown while streaming. |
+| `caret` | `boolean` | `false` | Blinking "typing" caret after the last block. |
+
+## 🧩 Optional plugins
+
+Register once in your app providers:
+
+```ts
+import { ApplicationConfig } from '@angular/core';
+import {
+  provideStreamdownMath,
+  provideStreamdownMermaid,
+  provideStreamdownAnimation,
+} from 'streamdown-angular';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideStreamdownMath(),       // KaTeX:  $E=mc^2$  and  $$\int_0^\infty …$$
+    provideStreamdownMermaid(),    // ```mermaid fenced diagrams
+    provideStreamdownAnimation(),  // fade-in newly streamed elements
+  ],
+};
+```
+
+> **Math needs KaTeX CSS.** Add it to `angular.json` → `styles`:
+> ```jsonc
+> "node_modules/katex/dist/katex.min.css"
+> ```
+
+| Provider | Adds | Extra dependency |
+|---|---|---|
+| `provideStreamdownMath()` | KaTeX math | `katex`, `remark-math`, `rehype-katex` |
+| `provideStreamdownMermaid()` | Mermaid diagrams | `mermaid` |
+| `provideStreamdownAnimation()` | Fade‑in for new DOM (respects `prefers-reduced-motion`) | — |
+| `provideStreamdownLinkSafety()` | Confirmation modal for external links | — |
+
+## 🎨 Styling
+
+**Zero‑config — no Tailwind, no CSS import needed.** All styles are plain CSS, scoped under
+`.ngx-streamdown`, and ship inside the component (`ViewEncapsulation.None`). They apply
+automatically when the component is used and never leak into the rest of your app.
+
+Customize by overriding the scoped CSS in your own stylesheet:
+
+```css
+.ngx-streamdown h1 { font-size: 2.25rem; color: #111; }
+.ngx-streamdown a  { color: rebeccapurple; }
+```
+
+Or add classes per tag / swap whole components from TypeScript:
+
+```ts
+import { ELEMENT_CLASSES, COMPONENT_MAP } from 'streamdown-angular';
+
+ELEMENT_CLASSES['h1'] = 'my-heading';            // extra class on every <h1>
+COMPONENT_MAP.set('pre', MyCodeBlockComponent);  // replace the code-block renderer
+```
+
+## 🌐 Internationalization & customization
+
+```ts
+import {
+  provideStreamdownTranslations,
+  provideStreamdownIcons,
+  provideStreamdownPrefix,
+} from 'streamdown-angular';
+
+providers: [
+  // i18n — every UI string (e.g. Uzbek)
+  provideStreamdownTranslations({
+    copy: 'Nusxa', copied: 'Nusxalandi', download: 'Yuklab olish',
+    linkWarningTitle: 'Tashqi havolani ochasizmi?', open: 'Ochish', cancel: 'Bekor qilish',
+  }),
+  // swap the copy / download / … SVG icons
+  provideStreamdownIcons({ copy: '<svg>…</svg>' }),
+  // namespace CSS hooks
+  provideStreamdownPrefix('myapp'),
+]
+```
+
+## 🔬 Low‑level API
+
+<details>
+<summary>Render Markdown or HAST yourself</summary>
+
+| Export | Purpose |
+|---|---|
+| `MarkdownService.toHast(md, { remend? })` | Markdown → sanitized HAST `Root` |
+| `HastRendererComponent` | Renders a HAST `Root` to Angular DOM (with diffing) |
+| `HastRendererService` | The reconciling HAST → DOM engine (`reconcile`, `renderNodes`, `clear`) |
+| `parseMarkdownIntoBlocks(md)` | Split Markdown into top‑level blocks |
+| `detectDirection(text)` | `'rtl'` / `'ltr'` |
+| `extractTableData` · `toCsv` · `toTsv` · `toMarkdown` | Table export helpers |
+| `STREAMDOWN_PIPELINE` | DI token to add custom remark/rehype plugins to the pipeline |
+
+```ts
+const md = inject(MarkdownService);
+const hast = md.toHast('# Hi');          // → HAST Root
+```
+</details>
+
+## 🛠️ How it works
+
+<details>
+<summary>Data flow (React → Angular mapping)</summary>
+
+```
+content ──▶ parseMarkdownIntoBlocks ──▶ @for(block) [track $index, OnPush]
+        └─▶ MarkdownService.toHast
+              remark-parse → gfm → [plugins] → remark-rehype
+                            → rehype-raw → [plugins] → rehype-sanitize
+        └─▶ HastRendererComponent ──▶ HastRendererService.reconcile
+              ├─ text node    → Renderer2.createText        (patched in place)
+              ├─ generic tag  → Renderer2.createElement     (attrs diffed)
+              └─ pre/table/img→ Angular component           (node input updated)
+```
+
+It mirrors Streamdown's React data flow — `useMemo` chain → `computed`, `memo()` → `OnPush` + `@for track` — and replaces React's `hast-util-to-jsx-runtime` with a native, diffing Angular DOM renderer.
+</details>
+
+## 📄 License
+
+[Apache‑2.0](./LICENSE) — Angular port of Streamdown. Original work © 2023 Vercel, Inc. (see [`NOTICE`](./NOTICE)).
+
+<div align="center"><sub>Built with ❤️ for the Angular community</sub></div>