@novastera-oss/react-native-markdown-display 8.0.1

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Base Markdown component
+ * @author Novastera + contributors
+ */
+import React from 'react';
+import MarkdownIt from 'markdown-it';
+import { Image as MarkdownImage } from 'expo-image';
+import parser from './lib/parser';
+import getUniqueID from './lib/util/getUniqueID';
+import hasParents from './lib/util/hasParents';
+import openUrl from './lib/util/openUrl';
+import tokensToAST from './lib/util/tokensToAST';
+import renderRules from './lib/renderRules';
+import AstRenderer from './lib/AstRenderer';
+import removeTextStyleProps from './lib/util/removeTextStyleProps';
+import { styles } from './lib/styles';
+import { stringToTokens } from './lib/util/stringToTokens';
+import textStyleProps from './lib/data/textStyleProps';
+import type { ASTNode, MarkdownParser, MarkdownProps, RenderFunction, RenderRules } from './types';
+export type { ASTNode, MarkdownParser, MarkdownProps, RenderFunction, RenderRules };
+export { getUniqueID, openUrl, hasParents, renderRules, AstRenderer, parser, stringToTokens, tokensToAST, MarkdownIt, styles, removeTextStyleProps, textStyleProps, MarkdownImage, MarkdownImage as FitImage, };
+declare const Markdown: React.MemoExoticComponent<({ children, renderer, rules, style, mergeStyle, markdownit, onLinkPress, maxTopLevelChildren, topLevelMaxExceededItem, allowedImageHandlers, defaultImageHandler, debugPrintTree, }: React.PropsWithChildren<MarkdownProps>) => React.ReactNode>;
+export default Markdown;

package/dist/types/lib/AstRenderer.d.ts

@@ -0,0 +1,16 @@
+import type { ReactNode } from 'react';
+import type { ASTNode, RenderFunction, RenderImageFunction, RenderLinkFunction, RenderRules } from '../types';
+export default class AstRenderer {
+    private _renderRules;
+    private _style;
+    private _onLinkPress?;
+    private _maxTopLevelChildren?;
+    private _topLevelMaxExceededItem?;
+    private _allowedImageHandlers?;
+    private _defaultImageHandler?;
+    private _debugPrintTree?;
+    constructor(renderRules: RenderRules, style: Record<string, unknown>, onLinkPress?: (url: string) => boolean, maxTopLevelChildren?: number | null, topLevelMaxExceededItem?: ReactNode, allowedImageHandlers?: string[], defaultImageHandler?: string | null, debugPrintTree?: boolean);
+    getRenderFunction: (type: string) => RenderFunction | RenderLinkFunction | RenderImageFunction;
+    renderNode: (node: ASTNode, parentNodes: ASTNode[], isRoot?: boolean) => ReactNode;
+    render: (nodes: ASTNode[]) => ReactNode;
+}

package/dist/types/lib/data/textStyleProps.d.ts

@@ -0,0 +1,2 @@
+declare const textStyleProps: readonly ["textShadowOffset", "color", "fontSize", "fontStyle", "fontWeight", "lineHeight", "textAlign", "textDecorationLine", "textShadowColor", "fontFamily", "textShadowRadius", "includeFontPadding", "textAlignVertical", "fontVariant", "letterSpacing", "textDecorationColor", "textDecorationStyle", "textTransform", "writingDirection"];
+export default textStyleProps;

package/dist/types/lib/parser.d.ts

@@ -0,0 +1,3 @@
+import type { ReactNode } from 'react';
+import type { ASTNode, MarkdownParser } from '../types';
+export default function parser(source: string | ASTNode[], renderer: (nodes: ASTNode[]) => ReactNode, markdownIt: MarkdownParser): ReactNode;

package/dist/types/lib/renderRules.d.ts

@@ -0,0 +1,3 @@
+import type { RenderRules } from '../types';
+declare const renderRules: RenderRules;
+export default renderRules;

package/dist/types/lib/styles.d.ts

@@ -0,0 +1,141 @@
+export declare const styles: {
+    body: {};
+    heading1: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    heading2: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    heading3: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    heading4: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    heading5: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    heading6: {
+        flexDirection: string;
+        fontSize: number;
+    };
+    hr: {
+        backgroundColor: string;
+        height: number;
+    };
+    strong: {
+        fontWeight: string;
+    };
+    em: {
+        fontStyle: string;
+    };
+    s: {
+        textDecorationLine: string;
+    };
+    blockquote: {
+        backgroundColor: string;
+        borderColor: string;
+        borderLeftWidth: number;
+        marginLeft: number;
+        paddingHorizontal: number;
+    };
+    bullet_list: {};
+    ordered_list: {};
+    list_item: {
+        flexDirection: string;
+        justifyContent: string;
+    };
+    bullet_list_icon: {
+        marginLeft: number;
+        marginRight: number;
+    };
+    bullet_list_content: {
+        flex: number;
+    };
+    ordered_list_icon: {
+        marginLeft: number;
+        marginRight: number;
+    };
+    ordered_list_content: {
+        flex: number;
+    };
+    code_inline: {
+        fontFamily?: string | undefined;
+        borderWidth: number;
+        borderColor: string;
+        backgroundColor: string;
+        padding: number;
+        borderRadius: number;
+    };
+    code_block: {
+        fontFamily?: string | undefined;
+        borderWidth: number;
+        borderColor: string;
+        backgroundColor: string;
+        padding: number;
+        borderRadius: number;
+    };
+    fence: {
+        fontFamily?: string | undefined;
+        borderWidth: number;
+        borderColor: string;
+        backgroundColor: string;
+        padding: number;
+        borderRadius: number;
+    };
+    table: {
+        borderWidth: number;
+        borderColor: string;
+        borderRadius: number;
+    };
+    thead: {};
+    tbody: {};
+    th: {
+        flex: number;
+        padding: number;
+    };
+    tr: {
+        borderBottomWidth: number;
+        borderColor: string;
+        flexDirection: string;
+    };
+    td: {
+        flex: number;
+        padding: number;
+    };
+    link: {
+        textDecorationLine: string;
+    };
+    blocklink: {
+        flex: number;
+        borderColor: string;
+        borderBottomWidth: number;
+    };
+    image: {
+        flex: number;
+    };
+    text: {};
+    textgroup: {};
+    paragraph: {
+        marginTop: number;
+        marginBottom: number;
+        flexWrap: string;
+        flexDirection: string;
+        alignItems: string;
+        justifyContent: string;
+        width: string;
+    };
+    hardbreak: {
+        width: string;
+        height: number;
+    };
+    softbreak: {};
+    pre: {};
+    inline: {};
+    span: {};
+};

package/dist/types/lib/util/Token.d.ts

@@ -0,0 +1,8 @@
+import type { MarkdownTokenLike } from '../../types';
+export default class Token implements MarkdownTokenLike {
+    type: string;
+    nesting: number;
+    children: MarkdownTokenLike[] | null;
+    block: boolean;
+    constructor(type: string, nesting?: number, children?: MarkdownTokenLike[] | null, block?: boolean);
+}

package/dist/types/lib/util/cleanupTokens.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export declare function cleanupTokens(tokens: MarkdownTokenLike[]): MarkdownTokenLike[];

package/dist/types/lib/util/convertAdditionalStyles.d.ts

@@ -0,0 +1 @@
+export default function convertAdditionalStyles(style: string): Record<string, string | number>;

package/dist/types/lib/util/flattenInlineTokens.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export default function flattenTokens(tokens: MarkdownTokenLike[]): MarkdownTokenLike[];

package/dist/types/lib/util/getTokenTypeByToken.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export default function getTokenTypeByToken(token: MarkdownTokenLike): string;

package/dist/types/lib/util/getUniqueID.d.ts

@@ -0,0 +1 @@
+export default function getUniqueID(): string;

package/dist/types/lib/util/groupTextTokens.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export default function groupTextTokens(tokens: MarkdownTokenLike[]): MarkdownTokenLike[];

package/dist/types/lib/util/hasParents.d.ts

@@ -0,0 +1,2 @@
+import type { ASTNode } from '../../types';
+export default function hasParents(parents: ASTNode[], type: string): boolean;

package/dist/types/lib/util/omitListItemParagraph.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export default function omitListItemParagraph(tokens: MarkdownTokenLike[]): MarkdownTokenLike[];

package/dist/types/lib/util/openUrl.d.ts

@@ -0,0 +1 @@
+export default function openUrl(url: string, customCallback?: (url: string) => boolean): void;

package/dist/types/lib/util/removeTextStyleProps.d.ts

@@ -0,0 +1 @@
+export default function removeTextStyleProps(style: Record<string, unknown>): Record<string, unknown>;

package/dist/types/lib/util/renderInlineAsText.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownTokenLike } from '../../types';
+export default function renderInlineAsText(tokens: MarkdownTokenLike[]): string;

package/dist/types/lib/util/splitTextNonTextNodes.d.ts

@@ -0,0 +1,7 @@
+import type { ReactElement } from 'react';
+type SplitNodes = {
+    textNodes: ReactElement[];
+    nonTextNodes: ReactElement[];
+};
+export default function splitTextNonTextNodes(children: ReactElement[]): SplitNodes;
+export {};

package/dist/types/lib/util/stringToTokens.d.ts

@@ -0,0 +1,2 @@
+import type { MarkdownParser, MarkdownTokenLike } from '../../types';
+export declare function stringToTokens(source: string, markdownIt: MarkdownParser): MarkdownTokenLike[];

package/dist/types/lib/util/tokensToAST.d.ts

@@ -0,0 +1,2 @@
+import type { ASTNode, MarkdownTokenLike } from '../../types';
+export default function tokensToAST(tokens: MarkdownTokenLike[]): ASTNode[];

package/dist/types/types.d.ts

@@ -0,0 +1,59 @@
+import type { ReactNode } from 'react';
+import type { StyleSheet } from 'react-native';
+export interface MarkdownTokenLike {
+    type: string;
+    nesting: number;
+    children?: MarkdownTokenLike[] | null;
+    block?: boolean;
+    content?: string;
+    attrs?: Array<[string, string]> | null;
+    tag?: string;
+    info?: string;
+    meta?: unknown;
+    markup?: string;
+    attrIndex?: (name: string) => number;
+}
+export interface ASTNode {
+    type: string;
+    sourceType: string;
+    sourceInfo?: string;
+    sourceMeta?: unknown;
+    block?: boolean;
+    key: string;
+    content: string;
+    markup: string;
+    tokenIndex: number;
+    index: number;
+    attributes: Record<string, unknown>;
+    children: ASTNode[];
+}
+export type RenderFunction = (node: ASTNode, children: ReactNode[], parentNodes: ASTNode[], styles: Record<string, unknown>, styleObj?: Record<string, unknown>, ...args: unknown[]) => ReactNode;
+export type RenderLinkFunction = (node: ASTNode, children: ReactNode[], parentNodes: ASTNode[], styles: Record<string, unknown>, onLinkPress?: (url: string) => boolean) => ReactNode;
+export type RenderImageFunction = (node: ASTNode, children: ReactNode[], parentNodes: ASTNode[], styles: Record<string, unknown>, allowedImageHandlers: string[], defaultImageHandler: string | null) => ReactNode;
+export interface RenderRules {
+    [name: string]: RenderFunction | RenderLinkFunction | RenderImageFunction | undefined;
+    link?: RenderLinkFunction;
+    blocklink?: RenderLinkFunction;
+    image?: RenderImageFunction;
+}
+export interface MarkdownParser {
+    parse: (value: string, options: Record<string, unknown>) => MarkdownTokenLike[];
+}
+export interface MarkdownProps {
+    rules?: RenderRules;
+    style?: StyleSheet.NamedStyles<Record<string, unknown>>;
+    renderer?: AstRenderer | ((nodes: ASTNode[]) => ReactNode);
+    markdownit?: MarkdownParser;
+    mergeStyle?: boolean;
+    debugPrintTree?: boolean;
+    onLinkPress?: (url: string) => boolean;
+    maxTopLevelChildren?: number | null;
+    topLevelMaxExceededItem?: ReactNode;
+    allowedImageHandlers?: string[];
+    defaultImageHandler?: string | null;
+}
+export interface AstRenderer {
+    getRenderFunction(type: string): RenderFunction | RenderLinkFunction | RenderImageFunction;
+    renderNode(node: ASTNode, parentNodes: ReadonlyArray<ASTNode>, isRoot?: boolean): ReactNode;
+    render(nodes: ReadonlyArray<ASTNode>): ReactNode;
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@novastera-oss/react-native-markdown-display",
+  "version": "8.0.1",
+  "description": "Markdown renderer for react-native, with CommonMark spec support. Maintained by Novastera.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build": "npm run build:types && npm run build:esm && npm run build:cjs",
+    "lint": "./node_modules/.bin/eslint --fix --cache ./src"
+  },
+  "pre-commit": [
+    "lint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/novastera/react-native-markdown-display.git"
+  },
+  "keywords": [
+    "react",
+    "react-native",
+    "native",
+    "markdown",
+    "commonmark",
+    "markdown-it",
+    "crm",
+    "erp",
+    "novastera"
+  ],
+  "author": "Novastera (originally by Mient-jan Stelling and Tom Pickard + community)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/novastera/react-native-markdown-display/issues"
+  },
+  "homepage": "https://novastera.com",
+  "dependencies": {
+    "markdown-it": "^14.1.0",
+    "expo-image": "^3.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-native": ">=0.79.0"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.0",
+    "@types/react": "^19.0.0",
+    "@babel/core": "^7.9.6",
+    "@babel/runtime": "^7.9.6",
+    "@typescript-eslint/parser": "^8.53.0",
+    "eslint": "^9.0.0",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ]
+}