Merge pull request mientjan#35 from doomsower/ts

Add typescript definitions

Author: mientjan

package.json

@@ -3,6 +3,7 @@
   "version": "3.1.0",
   "description": "Markdown renderer for react-native, with CommonMark spec support + adds syntax extensions & sugar (URL autolinking, typographer).",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {},
   "repository": {
     "type": "git",
@@ -23,6 +24,8 @@
   },
   "homepage": "https://github.com/mientjan/react-native-markdown-renderer#readme",
   "dependencies": {
+    "@types/markdown-it": "^0.0.4",
+    "@types/react-native": ">=0.50.0",
     "markdown-it": "^8.4.0",
     "prop-types": "^15.5.10",
     "react-native-fit-image": "^1.5.2"

src/index.d.ts

@@ -0,0 +1,84 @@
+// tslint:disable:max-classes-per-file
+import { MarkdownIt, Token } from 'markdown-it';
+import { ComponentType, ReactNode } from 'react';
+import { StyleSheet, View } from 'react-native';
+
+export function getUniqueID(): string;
+export function openUrl(url: string): void;
+
+export function hasParents(parents: any[], type: string): boolean;
+
+export type RenderFunction = (
+  node: any,
+  children: ReactNode[],
+  parent: ReactNode,
+  styles: any,
+) => ReactNode;
+
+export interface RenderRules {
+  [name: string]: RenderFunction;
+}
+
+export const renderRules: RenderRules;
+
+export interface MarkdownParser {
+  parse: (value: string, options: any) => Token[];
+}
+
+export interface ASTNode {
+  type: string;
+  sourceType: string; // original source token name
+  key: string;
+  content: string;
+  tokenIndex: number;
+  index: number;
+  attributes: Record<string, any>;
+  children: ASTNode[];
+}
+
+export class AstRenderer {
+  constructor(renderRules: RenderRules, style?: any);
+  getRenderFunction(type: string): RenderFunction;
+  renderNode(node: any, parentNodes: ReadonlyArray<any>): ReactNode;
+  render(nodes: ReadonlyArray<any>): View;
+}
+
+export function parser(
+  source: string,
+  renderer: (node: ASTNode) => View,
+  parser: MarkdownParser,
+): any;
+
+export function stringToTokens(
+  source: string,
+  markdownIt: MarkdownParser,
+): Token[];
+
+export function tokensToAST(tokens: ReadonlyArray<Token>): ASTNode[];
+
+interface PluginContainerResult<A> extends Array<any> {
+  0: A;
+}
+
+export class PluginContainer<A> {
+  constructor(plugin: A, ...options: any[]);
+  toArray(): PluginContainerResult<A>;
+}
+
+export function blockPlugin(md: any, name: string, options: object): any;
+
+export const styles: any;
+
+export interface MarkdownProps {
+  rules?: RenderRules;
+  style?: StyleSheet.NamedStyles<any>;
+  renderer?: AstRenderer;
+  markdownit?: MarkdownIt;
+  plugins?: Array<PluginContainer<any>>;
+}
+
+type MarkdownStatic = React.ComponentType<MarkdownProps>;
+export const Markdown: MarkdownStatic;
+export type Markdown = MarkdownStatic;
+
+export default Markdown;