@wulperstudio/editor-render 0.0.1-beta → 0.0.4-beta

package/dist/index.d.ts

@@ -0,0 +1,390 @@
+/// <reference types="react" />
+import * as react from 'react';
+import react__default, { ReactNode } from 'react';
+import * as _emotion_styled from '@emotion/styled';
+import * as _mui_system from '@mui/system';
+import * as _mui_material from '@mui/material';
+import { CheckboxProps } from '@mui/material';
+import { DOMNode } from 'html-react-parser';
+
+declare type BlockItemType = 'paragraph' | 'header' | 'delimiter' | 'list' | 'image' | 'table' | 'embed' | 'rawTool' | 'quote' | 'code' | 'checklist' | 'linkTool';
+
+declare type Tune = any;
+interface DataTable {
+    content: string[][];
+}
+interface DataParagraph {
+    text: string;
+}
+interface DataHeader {
+    text: string;
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+}
+interface DataQuote {
+    text: string;
+    caption: string;
+    alignment: 'center' | 'left';
+}
+interface DataChecklistItem {
+    text: string;
+    checked: boolean;
+}
+interface DataCheckList {
+    items: DataChecklistItem[];
+}
+interface DataCodeLang {
+    code: string;
+}
+interface DataRawTool {
+    html: string;
+}
+interface DataMetaLink {
+    title: string;
+    site_name: string;
+    description: string;
+    image: {
+        url: string;
+    };
+}
+interface DataLinkTool {
+    link: string;
+    meta: DataMetaLink;
+}
+interface DataEmbed {
+    service: string;
+    source: string;
+    embed: string;
+    width: number;
+    height: number;
+    caption: string;
+}
+interface DataImage {
+    url: string;
+    caption: string;
+    withBorder: boolean;
+    stretched: boolean;
+    withBackground: boolean;
+}
+interface DataList {
+    style: 'ordered' | 'unordered';
+    items: string[];
+}
+interface DataDelimiter {
+}
+interface BaseBlockModel {
+    id: string;
+    type: BlockItemType;
+    tunes?: Tune;
+}
+interface BlockTableModel extends BaseBlockModel {
+    data: DataTable;
+}
+interface BlockParagraphModel extends BaseBlockModel {
+    data: DataParagraph;
+}
+interface BlockHeaderModel extends BaseBlockModel {
+    data: DataHeader;
+}
+interface BlockQuoteModel extends BaseBlockModel {
+    data: DataQuote;
+}
+interface BlockCheckListModel extends BaseBlockModel {
+    data: DataCheckList;
+}
+interface BlockCodeModel extends BaseBlockModel {
+    data: DataCodeLang;
+}
+interface BlockRawToolModel extends BaseBlockModel {
+    data: DataRawTool;
+}
+interface BlockLinkToolModel extends BaseBlockModel {
+    data: DataLinkTool;
+}
+interface BlockEmbedModel extends BaseBlockModel {
+    data: DataEmbed;
+}
+interface BlockImageModel extends BaseBlockModel {
+    data: DataImage;
+}
+interface BlockListModel extends BaseBlockModel {
+    data: DataList;
+}
+interface BlockDelimiterModel extends BaseBlockModel {
+    data: DataDelimiter;
+}
+interface EditorDataModel {
+    time: number;
+    blocks: (BlockTableModel | BlockParagraphModel | BlockHeaderModel | BlockQuoteModel | BlockCheckListModel | BlockCodeModel | BlockRawToolModel | BlockLinkToolModel | BlockEmbedModel | BlockImageModel | BlockListModel | BlockDelimiterModel)[];
+    version: string;
+}
+
+interface RootContainerProps$1 {
+    stretched?: boolean;
+}
+declare const RootContainer: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme> & RootContainerProps$1, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type RootContainerProps = react__default.ComponentPropsWithRef<typeof RootContainer>;
+interface ContainerModel extends RootContainerProps {
+    stretched?: boolean;
+}
+declare const Container: (props: ContainerModel) => JSX.Element;
+
+declare const RootParagraph: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, {}>;
+
+declare type ParagraphRootProps = react__default.ComponentPropsWithRef<typeof RootParagraph>;
+interface ParagraphProps extends ParagraphRootProps {
+}
+declare const Paragraph: (props: ParagraphProps) => JSX.Element;
+
+declare const RootHeader: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, {}>;
+
+declare type HeaderRootProps = react__default.ComponentPropsWithRef<typeof RootHeader>;
+interface HeaderModel extends HeaderRootProps {
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+}
+declare const Header: ({ level, ...props }: HeaderModel) => JSX.Element;
+
+declare const RootList: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type ListRootProps = react__default.ComponentPropsWithRef<typeof RootList>;
+interface ListProps extends ListRootProps {
+}
+declare const List: ({ ...props }: ListProps) => JSX.Element;
+
+declare const RootListItem$1: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type RootItemProps$1 = react__default.ComponentPropsWithRef<typeof RootListItem$1>;
+interface ItemModel$1 extends RootItemProps$1 {
+}
+declare const ListItem: (props: ItemModel$1) => JSX.Element;
+
+declare const RootInlineCode: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, {}>;
+
+declare type InlineCodeRootProps = react__default.ComponentPropsWithRef<typeof RootInlineCode>;
+interface CodeProps$1 extends InlineCodeRootProps {
+}
+declare const InlineCode: (props: CodeProps$1) => JSX.Element;
+
+declare const RootBold: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, {}>;
+
+declare type BoldRootProps = react__default.ComponentPropsWithRef<typeof RootBold>;
+interface BoldProps extends BoldRootProps {
+}
+declare const Bold: (props: BoldProps) => JSX.Element;
+
+declare const RootItalic: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, {}>;
+
+declare type ItalicRootProps = react__default.ComponentPropsWithRef<typeof RootItalic>;
+interface ItalicProps extends ItalicRootProps {
+}
+declare const Italic: (props: ItalicProps) => JSX.Element;
+
+declare const RootMarker: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLElement>, HTMLElement>, {}>;
+
+declare type MarkerRootProps = react__default.ComponentPropsWithRef<typeof RootMarker>;
+interface MarkerProps extends MarkerRootProps {
+}
+declare const Marker: (props: MarkerProps) => JSX.Element;
+
+declare const RootAnchor: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, {}>;
+
+declare type AnchorRootProps = react__default.ComponentPropsWithRef<typeof RootAnchor>;
+interface AnchorProps extends AnchorRootProps {
+}
+declare const Anchor: (props: AnchorProps) => JSX.Element;
+
+declare const RootDelimiter: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type DelimiterRootProps = react__default.ComponentPropsWithRef<typeof RootDelimiter>;
+interface DelimiterProps extends Omit<DelimiterRootProps, 'children'> {
+}
+declare const Delimiter: (props: DelimiterProps) => JSX.Element;
+
+interface RootProps {
+    withBorder?: boolean;
+    stretched?: boolean;
+    withBackground?: boolean;
+}
+declare const RootImage: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme> & RootProps, react.DetailedHTMLProps<react.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, {}>;
+
+declare type ImageRootProps = react__default.ComponentPropsWithRef<typeof RootImage>;
+interface ImageProps extends ImageRootProps {
+    caption?: string;
+    withBorder?: boolean;
+    stretched?: boolean;
+    withBackground?: boolean;
+}
+declare const Image: ({ caption, withBorder, withBackground, stretched, ...props }: ImageProps) => JSX.Element;
+
+declare const RootTable: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type TableRootProps = react__default.ComponentPropsWithRef<typeof RootTable>;
+interface TableProps extends TableRootProps {
+}
+declare const Table: (props: TableProps) => JSX.Element;
+
+declare const RootTableRow: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type TableRowRootProps = react__default.ComponentPropsWithRef<typeof RootTableRow>;
+interface TableRowProps extends TableRowRootProps {
+}
+declare const TableRow: (props: TableRowProps) => JSX.Element;
+
+declare const RootTableCell: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type TableCellRootProps = react__default.ComponentPropsWithRef<typeof RootTableCell>;
+interface TableCellProps extends TableCellRootProps {
+}
+declare const TableCell: (props: TableCellProps) => JSX.Element;
+
+declare const RootEmbed: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, {}>;
+
+declare type EmbedRootProps = react__default.ComponentPropsWithRef<typeof RootEmbed>;
+interface EmbedProps extends EmbedRootProps {
+}
+declare const Embed: (props: EmbedProps) => JSX.Element;
+
+declare const RootRaw: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type RawRootProps = react__default.ComponentPropsWithRef<typeof RootRaw>;
+interface RawProps extends RawRootProps {
+}
+declare const Raw: (props: RawProps) => JSX.Element;
+
+declare const RootQuote: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.BlockquoteHTMLAttributes<HTMLQuoteElement>, HTMLQuoteElement>, {}>;
+
+declare type QuoteRootProps = react__default.ComponentPropsWithRef<typeof RootQuote>;
+interface QuoteProps extends QuoteRootProps {
+}
+declare const Quote: (props: QuoteProps) => JSX.Element;
+
+declare const RootCode: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type CodeRootProps = react__default.ComponentPropsWithRef<typeof RootCode>;
+interface CodeProps extends CodeRootProps {
+}
+declare const Code: (props: CodeProps) => JSX.Element;
+
+declare const RootLink: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, {}>;
+
+declare type LinkRootProps = react__default.ComponentPropsWithRef<typeof RootLink>;
+interface LinkProps extends Omit<LinkRootProps, 'children'> {
+    image?: string;
+    title?: string;
+    description?: string;
+    siteName?: string;
+}
+declare const Link: ({ id, image, title, description, siteName, ...props }: LinkProps) => JSX.Element;
+
+declare const RootCheckList: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type CheckListRootProps = react__default.ComponentPropsWithRef<typeof RootCheckList>;
+interface CheckListProps extends CheckListRootProps {
+}
+declare const CheckList: (props: CheckListProps) => JSX.Element;
+
+declare const RootListItem: _emotion_styled.StyledComponent<_mui_system.MUIStyledCommonProps<_mui_material.Theme>, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare type RootItemProps = react__default.ComponentPropsWithRef<typeof RootListItem>;
+interface ItemModel extends RootItemProps {
+}
+declare const CheckListItem: (props: ItemModel) => JSX.Element;
+
+declare const CheckBox: ({ checked, ...props }: CheckboxProps) => JSX.Element;
+
+declare type RecursiveNodeType = false | void | object | JSX.Element | null | undefined;
+declare const RecursiveNode: (domNode: DOMNode, idx: string) => RecursiveNodeType;
+
+interface ParagraphNodeModel {
+    type: 'paragraph';
+    data: DataParagraph;
+    id: string;
+}
+declare const ParagraphNode: ({ type, data, id, }: ParagraphNodeModel) => react__default.ReactNode;
+
+interface HeaderNodeModel {
+    type: 'header';
+    data: DataHeader;
+    id: string;
+}
+declare const HeaderNode: ({ type, data, id, }: HeaderNodeModel) => react__default.ReactNode;
+
+interface ListNodeModel {
+    type: 'list';
+    data: DataList;
+    id: string;
+    tunes?: any;
+}
+declare const ListNode: ({ type, data, id, tunes, }: ListNodeModel) => react__default.ReactNode;
+
+interface ImageNodeModel {
+    type: 'image';
+    data: DataImage;
+    id: string;
+}
+declare const ImageNode: ({ type, data, id, }: ImageNodeModel) => react__default.ReactNode;
+
+interface TableNodeModel {
+    type: 'table';
+    data: DataTable;
+    id: string;
+}
+declare const TableNode: ({ type, data, id, }: TableNodeModel) => react__default.ReactNode;
+
+interface DelimiterNodeModel {
+    type: 'delimiter';
+    data: DataDelimiter;
+    id: string;
+}
+declare const DelimiterNode: ({ type, id, }: DelimiterNodeModel) => react__default.ReactNode;
+
+interface EmbedNodeModel {
+    type: 'embed';
+    data: DataEmbed;
+    id: string;
+}
+declare const EmbedNode: ({ type, data, id, }: EmbedNodeModel) => react__default.ReactNode;
+
+interface RawNodeModel {
+    type: 'rawTool';
+    data: DataRawTool;
+    id: string;
+}
+declare const RawNode: ({ type, data, id }: RawNodeModel) => react__default.ReactNode;
+
+interface QuoteNodeModel {
+    type: 'quote';
+    data: DataQuote;
+    id: string;
+}
+declare const QuoteNode: ({ type, data, id, }: QuoteNodeModel) => react__default.ReactNode;
+
+interface CodeNodeModel {
+    type: 'code';
+    data: DataCodeLang;
+    id: string;
+}
+declare const CodeNode: ({ type, data, id }: CodeNodeModel) => react__default.ReactNode;
+
+interface LinkNodeModel {
+    type: 'linkTool';
+    data: DataLinkTool;
+    id: string;
+}
+declare const LinkNode: ({ type, data, id, }: LinkNodeModel) => react__default.ReactNode;
+
+interface CheckListNodeModel {
+    type: 'checklist';
+    data: DataCheckList;
+    id: string;
+    tunes?: any;
+}
+declare const CheckListNode: ({ type, data, id, tunes, }: CheckListNodeModel) => react__default.ReactNode;
+
+declare const PurifyHtml: (html: string) => string;
+declare const ForkIdWithType: (id: string, type: string) => string;
+declare const getFlexBasis: (columns: number, gap: number) => string;
+
+declare const getBaseNodesFromEditor: (value: EditorDataModel) => ReactNode[];
+
+export { BlockCheckListModel, BlockCodeModel, BlockDelimiterModel, BlockEmbedModel, BlockHeaderModel, BlockImageModel, BlockItemType, BlockLinkToolModel, BlockListModel, BlockParagraphModel, BlockQuoteModel, BlockRawToolModel, BlockTableModel, CheckListNode, CheckListNodeModel, CodeNode, CodeNodeModel, DataCheckList, DataChecklistItem, DataCodeLang, DataDelimiter, DataEmbed, DataHeader, DataImage, DataLinkTool, DataList, DataMetaLink, DataParagraph, DataQuote, DataRawTool, DataTable, DelimiterNode, DelimiterNodeModel, Anchor as EditorAnchor, Bold as EditorBold, CheckBox as EditorCheckBox, CheckList as EditorCheckList, CheckListItem as EditorCheckListItem, Code as EditorCode, Container as EditorContainer, EditorDataModel, Delimiter as EditorDelimiter, Embed as EditorEmbed, Header as EditorHeader, Image as EditorImage, InlineCode as EditorInlineCode, Italic as EditorItalic, Link as EditorLink, List as EditorList, ListItem as EditorListItem, Marker as EditorMarker, Paragraph as EditorParagraph, Quote as EditorQuote, Raw as EditorRaw, Table as EditorTable, TableCell as EditorTableCell, TableRow as EditorTableRow, EmbedNode, EmbedNodeModel, ForkIdWithType, HeaderNode, HeaderNodeModel, ImageNode, ImageNodeModel, LinkNode, LinkNodeModel, ListNode, ListNodeModel, ParagraphNode, ParagraphNodeModel, PurifyHtml, QuoteNode, QuoteNodeModel, RawNode, RawNodeModel, RecursiveNode, TableNode, TableNodeModel, Tune, getBaseNodesFromEditor, getFlexBasis };

package/dist/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@wulperstudio/editor-render",
+  "version": "0.0.4-beta",
+  "author": "@wulperstudio",
+  "repository": "https://github.com/WulperStudio/editor-render.git",
+  "license": "MIT",
+  "scripts": {
+    "build": "rollup -c && cp package.json dist && cp README.md dist",
+    "test:lint": "eslint '*/**/*.{ts,tsx}' || eslint src\\**\\*.{ts,tsx} "
+  },
+  "peerDependencies": {
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "@types/react": "^17.0.0 || ^18.0.0",
+    "@types/react-dom": "^17.0.0 || ^18.0.0"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.9.0",
+    "@emotion/styled": "^11.8.1",
+    "@iconify/react": "^3.2.2",
+    "@mui/material": "^5.8.2",
+    "html-react-parser": "^1.4.14",
+    "isomorphic-dompurify": "^0.19.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-typescript": "^8.3.2",
+    "@types/rollup-plugin-auto-external": "^2.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-react": "^7.26.1",
+    "rollup": "^2.75.5",
+    "rollup-plugin-auto-external": "^2.0.0",
+    "rollup-plugin-dts": "^4.2.2",
+    "typescript": "^4.7.2"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts"
+}

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@wulperstudio/editor-render",
-  "version": "0.0.1-beta",
+  "version": "0.0.4-beta",
   "author": "@wulperstudio",
   "repository": "https://github.com/WulperStudio/editor-render.git",
   "license": "MIT",
   "scripts": {
-    "build": "rollup -c && cp package.json dist",
-    "clean:windows": "rmdir -r dist -Force",
-    "clean:linux": "rm -rf dist/*",
+    "build": "rollup -c && cp package.json dist && cp README.md dist",
     "test:lint": "eslint '*/**/*.{ts,tsx}' || eslint src\\**\\*.{ts,tsx} "
   },
   "peerDependencies": {