@sigx/lynx-markdown 0.4.7 → 0.4.9

package/dist/render/components.d.ts

@@ -12,7 +12,7 @@
  * component only decides *what element to wrap children in*.
  */
 import type { JSXElement } from '@sigx/lynx';
-import type { BlockquoteBlock, CodeBlock, HeadingBlock, HeadingLevel, InlineAutolink, InlineCodeSpan, InlineDel, InlineEm, InlineImage, InlineLink, InlineStrong, ListBlock, ListItem, ParagraphBlock, TableAlign, TableBlock, ThematicBreakBlock } from '../ast.js';
+import type { BlockquoteBlock, CodeBlock, HeadingBlock, HeadingLevel, InlineAutolink, InlineCodeSpan, InlineDel, InlineEm, InlineExtension, InlineImage, InlineLink, InlineStrong, ListBlock, ListItem, ParagraphBlock, TableAlign, TableBlock, ThematicBreakBlock } from '../ast.js';
 /** A renderable child: a JSX element or a raw string (for text/`<br>`). */
 export type MarkdownChild = JSXElement | string;
 export interface RootProps {
@@ -111,6 +111,13 @@ export interface ImageProps {
     onImageTap?: (src: string) => void;
     node: InlineImage;
 }
+export interface ExtensionProps {
+    name: string;
+    attrs: Record<string, string>;
+    /** Rendered `node.children`; `[]` for leaf extensions. */
+    children: MarkdownChild[];
+    node: InlineExtension;
+}
 /**
  * Map of node type → render function. Pass a partial map to `<Markdown
  * components={…}>` to override any subset; unspecified types fall back to the
@@ -136,5 +143,10 @@ export interface MarkdownComponents {
     autolink(props: AutolinkProps): MarkdownChild;
     image(props: ImageProps): MarkdownChild;
     br(): MarkdownChild;
+    /**
+     * Renderers for plugin inline extensions, keyed by extension name. A node
+     * with no matching renderer falls back to its `raw` source as plain text.
+     */
+    extension?: Record<string, (props: ExtensionProps) => MarkdownChild>;
 }
 export declare const defaultComponents: MarkdownComponents;

package/dist/render/engine.js

@@ -141,5 +141,16 @@ function renderInlineNode(node, ctx) {
                 onImageTap: ctx.onImageTap,
                 node,
             });
+        case 'extension': {
+            const renderer = C.extension?.[node.name];
+            if (!renderer)
+                return node.raw; // no renderer registered → literal source
+            return renderer({
+                name: node.name,
+                attrs: node.attrs,
+                children: node.children ? renderInline(node.children, ctx) : [],
+                node,
+            });
+        }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sigx/lynx-markdown",
-  "version": "0.4.7",
-  "description": "SignalX-native streaming markdown renderer for Lynx. Parses markdown in JS (zero deps) and renders to native <view>/<text> primitives, with incremental streaming for AI output. Also ships XMarkdown, the native <x-markdown> wrapper.",
+  "version": "0.4.9",
+  "description": "SignalX-native streaming markdown renderer for Lynx. Parses markdown in JS (zero deps) and renders to native <view>/<text> primitives, with incremental streaming for AI output.",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -19,13 +19,25 @@
     "LICENSE"
   ],
   "peerDependencies": {
-    "@sigx/lynx": "^0.4.7"
+    "@sigx/lynx-keyboard": "^0.4.9",
+    "@sigx/lynx": "^0.4.9",
+    "@sigx/lynx-richtext": "^0.4.9"
+  },
+  "peerDependenciesMeta": {
+    "@sigx/lynx-keyboard": {
+      "optional": true
+    },
+    "@sigx/lynx-richtext": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@typescript/native-preview": "7.0.0-dev.20260521.1",
     "typescript": "^6.0.3",
-    "@sigx/lynx": "^0.4.7",
-    "@sigx/lynx-testing": "^0.4.7"
+    "@sigx/lynx": "^0.4.9",
+    "@sigx/lynx-keyboard": "^0.4.9",
+    "@sigx/lynx-richtext": "^0.4.9",
+    "@sigx/lynx-testing": "^0.4.9"
   },
   "author": "Andreas Ekdahl",
   "license": "MIT",
@@ -48,8 +60,7 @@
     "markdown",
     "native",
     "streaming",
-    "ai",
-    "x-markdown"
+    "ai"
   ],
   "scripts": {
     "build": "node ../../scripts/clean.mjs dist && tsgo",

package/dist/XMarkdown.d.ts

@@ -1,36 +0,0 @@
-import { type Define } from '@sigx/lynx';
-import './jsx-augment.js';
-import type { MarkdownLinkEvent, MarkdownImageTapEvent, MarkdownParseEndEvent } from './jsx-augment.js';
-export type XMarkdownEffect = 'typewriter' | 'none' | (string & {});
-export type XMarkdownProps = Define.Prop<'value', string, false> & Define.Prop<'effect', XMarkdownEffect, false> & Define.Prop<'attachments', ReadonlyArray<unknown>, false> & Define.Prop<'class', string, false> & Define.Prop<'style', string | Record<string, string | number>, false> & Define.Prop<'onLink', (e: MarkdownLinkEvent) => void, false> & Define.Prop<'onImageTap', (e: MarkdownImageTapEvent) => void, false> & Define.Prop<'onParseEnd', (e: MarkdownParseEndEvent) => void, false>;
-/**
- * Render a markdown document using Lynx's native `<x-markdown>` XElement.
- *
- * This is the thin wrapper over the platform's native markdown element. It is
- * fast where available but platform-gated (Harmony 3.7.0+, Android 3.8.0-rc.0+,
- * iOS not yet in a tagged release) and opaque — the engine owns parsing and
- * styling. For a cross-platform, fully-controllable, streaming-aware renderer
- * built on Lynx `<view>`/`<text>` primitives, use {@link Markdown} instead.
- *
- * The markdown source is passed via the `value` prop; it is delivered to the
- * native element as a raw-text child (per the 3.7.0 "raw-text node
- * optimization" path). Event props use signalx's automatic
- * `onLink`→`bindlink` mapping in `nodeOps.parseEventProp`, so handlers wire
- * up without any per-event glue.
- *
- * @example
- * ```tsx
- * <XMarkdown
- *   value={"# Hello\n\nThis is **markdown**."}
- *   effect="typewriter"
- *   onLink={(e) => console.log('tapped', e.detail.url)}
- * />
- * ```
- *
- * @remarks
- * Availability of the `<x-markdown>` element is platform-dependent — see
- * `jsx-augment.ts` for the per-platform schedule. On platforms where the
- * native element is not registered, the engine logs a warning and renders
- * no view; there is no JS-side feature gate.
- */
-export declare const XMarkdown: import("@sigx/runtime-core").ComponentFactory<XMarkdownProps, void, {}>;

package/dist/XMarkdown.js

@@ -1,36 +0,0 @@
-import { jsx as _jsx } from "@sigx/lynx/jsx-runtime";
-import { component } from '@sigx/lynx';
-import './jsx-augment.js';
-/**
- * Render a markdown document using Lynx's native `<x-markdown>` XElement.
- *
- * This is the thin wrapper over the platform's native markdown element. It is
- * fast where available but platform-gated (Harmony 3.7.0+, Android 3.8.0-rc.0+,
- * iOS not yet in a tagged release) and opaque — the engine owns parsing and
- * styling. For a cross-platform, fully-controllable, streaming-aware renderer
- * built on Lynx `<view>`/`<text>` primitives, use {@link Markdown} instead.
- *
- * The markdown source is passed via the `value` prop; it is delivered to the
- * native element as a raw-text child (per the 3.7.0 "raw-text node
- * optimization" path). Event props use signalx's automatic
- * `onLink`→`bindlink` mapping in `nodeOps.parseEventProp`, so handlers wire
- * up without any per-event glue.
- *
- * @example
- * ```tsx
- * <XMarkdown
- *   value={"# Hello\n\nThis is **markdown**."}
- *   effect="typewriter"
- *   onLink={(e) => console.log('tapped', e.detail.url)}
- * />
- * ```
- *
- * @remarks
- * Availability of the `<x-markdown>` element is platform-dependent — see
- * `jsx-augment.ts` for the per-platform schedule. On platforms where the
- * native element is not registered, the engine logs a warning and renders
- * no view; there is no JS-side feature gate.
- */
-export const XMarkdown = component(({ props }) => {
-    return () => (_jsx("x-markdown", { "markdown-effect": props.effect, "text-mark-attachments": props.attachments, class: props.class, style: props.style, bindlink: props.onLink, bindimageTap: props.onImageTap, bindparseEnd: props.onParseEnd, children: props.value ?? '' }));
-});

package/dist/jsx-augment.d.ts

@@ -1,83 +0,0 @@
-/**
- * JSX intrinsic type augmentation for Lynx's `<x-markdown>` XElement.
- *
- * Importing this module registers `'x-markdown'` as a valid JSX intrinsic
- * with its 3.7.0+ attributes and events. Pulled in automatically by
- * `@sigx/lynx-markdown`'s entry point so consumers do not need to import
- * it directly.
- *
- * The native element ships per-platform on different schedules:
- *   - Harmony: available since 3.7.0
- *   - Android: available since 3.8.0-rc.0 (artifact `lynx_xelement_markdown`)
- *   - iOS:     not yet in any tagged release; lands on the main branch
- *               post-3.8.0
- *
- * `<x-markdown>` props in JSX still type-check on every platform. At
- * runtime the SignalX renderer issues a `__CreateElement('x-markdown')`
- * op unconditionally; on platforms where the native element is not
- * registered, the underlying engine handles the unknown tag (today it
- * logs a warning and emits no view). There is no JS-side feature gate
- * in this package — once you upgrade to a Lynx release that ships the
- * element on your target platforms, rendering activates automatically.
- */
-import type { LynxCommonAttributes, LynxEventHandler } from '@sigx/lynx-runtime';
-/** Detail payload of `bindlink` — the engine ships `url` plus optional fields. */
-export interface MarkdownLinkEventDetail {
-    url: string;
-    [k: string]: unknown;
-}
-export interface MarkdownLinkEvent {
-    type: 'link';
-    detail: MarkdownLinkEventDetail;
-}
-/** Detail payload of `bindimageTap`. */
-export interface MarkdownImageTapEventDetail {
-    src: string;
-    [k: string]: unknown;
-}
-export interface MarkdownImageTapEvent {
-    type: 'imageTap';
-    detail: MarkdownImageTapEventDetail;
-}
-/** Detail payload of `bindparseEnd`. */
-export interface MarkdownParseEndEventDetail {
-    [k: string]: unknown;
-}
-export interface MarkdownParseEndEvent {
-    type: 'parseEnd';
-    detail: MarkdownParseEndEventDetail;
-}
-export interface XMarkdownAttributes extends LynxCommonAttributes {
-    /**
-     * Raw markdown source. Lynx parses the first text child of
-     * `<x-markdown>` per the 3.7.0 raw-text-node optimization. Passing a
-     * single string here is the common path; JSX expressions resolving to
-     * a string also work.
-     */
-    children?: any;
-    /**
-     * Render-time effect applied to the parsed markdown output.
-     * Known values: `'typewriter'`, `'none'`. The engine treats unknown
-     * strings as `'none'`.
-     */
-    'markdown-effect'?: string;
-    /**
-     * Inline view attachments referenced by markdown text marks. Shape is
-     * engine-defined; passed through as-is.
-     */
-    'text-mark-attachments'?: ReadonlyArray<unknown>;
-    /** Fires when the user taps an `[anchor](url)` link. */
-    bindlink?: LynxEventHandler<MarkdownLinkEvent>;
-    /** Fires when the user taps an inline image. */
-    bindimageTap?: LynxEventHandler<MarkdownImageTapEvent>;
-    /** Fires once the engine finishes parsing the source. */
-    bindparseEnd?: LynxEventHandler<MarkdownParseEndEvent>;
-}
-declare global {
-    namespace JSX {
-        interface IntrinsicElements {
-            'x-markdown': XMarkdownAttributes;
-        }
-    }
-}
-export {};

package/dist/jsx-augment.js

@@ -1 +0,0 @@
-export {};