@podlite/markdown 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+# @podlite/markdown
+
+## 0.0.1
+- initial release

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Alexandr Zahatski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,15 @@
+# =Markdown block
+
+## Contributing
+
+This is an open source program. Feel free to fork and contribute.
+
+In order to keep the match between this documentation and the last release, please contribute and pull requests on the dedicated develop branch.
+
+## AUTHOR
+
+Copyright (c) 2022 Alexandr Zahatski
+
+## License
+
+Released under a MIT License.

package/index.js

@@ -0,0 +1,2 @@
+'use strict'
+module.exports = require('./lib')

package/jest.config.js

@@ -0,0 +1,2 @@
+
+module.exports = require('../../jest.config')

package/jest.tsconfig.json

@@ -0,0 +1 @@
+{"extends": "../../jest.tsconfig.json"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+import { Plugins } from '@podlite/schema';
+import { Plugin } from '@podlite/schema';
+export declare const plugin: Plugin;
+export declare const PluginRegister: Plugins;
+export default plugin;

package/lib/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginRegister = exports.plugin = void 0;
+const tools_1 = require("./tools");
+const handlers_1 = require("pod6/built/helpers/handlers");
+exports.plugin = ({
+    toAst: (_, processor) => (node, ctx) => {
+        if (typeof node !== "string" && 'type' in node && 'content' in node && node.type === 'block') {
+            const content = node.content[0];
+            if (content && typeof content !== "string" && 'location' in node && 'value' in content) {
+                const lineOffset = node.location.start.line;
+                return { ...node, content: (0, tools_1.md2ast)(content, { lineOffset }) };
+            }
+            return node;
+        }
+    },
+    toJSX: (helper) => {
+        return handlers_1.content;
+    }
+});
+exports.PluginRegister = {
+    Markdown: exports.plugin
+};
+exports.default = exports.plugin;

package/lib/tools.d.ts

@@ -0,0 +1,6 @@
+import { AstTree } from '@podlite/schema';
+declare type Md2astArgs = {
+    lineOffset?: number;
+};
+export declare const md2ast: (src: string, { lineOffset }?: Md2astArgs) => AstTree;
+export {};

package/lib/tools.js

@@ -0,0 +1,157 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.md2ast = void 0;
+const unified_1 = require("unified");
+const remark_parse_1 = __importDefault(require("remark-parse"));
+const remark_gfm_1 = __importDefault(require("remark-gfm"));
+const exportAny_1 = __importDefault(require("pod6/built/exportAny"));
+const schema_1 = require("@podlite/schema");
+const schema_2 = require("@podlite/schema");
+const schema_3 = require("@podlite/schema");
+const schema_4 = require("@podlite/schema");
+const schema_5 = require("@podlite/schema");
+const md2ast = (src, { lineOffset } = { lineOffset: 0 }) => {
+    // first convert mardown to ast 
+    const md_tree = (0, unified_1.unified)().use(remark_parse_1.default).use(remark_gfm_1.default).parse(src);
+    // first pass : collect linkRefs
+    let definitionMap = {};
+    const applyLineOffset = ((offset) => (location) => {
+        const { start, end } = location;
+        return {
+            "start": {
+                ...start,
+                "line": start.line + offset,
+            },
+            "end": {
+                ...end,
+                "line": end.line + offset,
+            }
+        };
+    })(lineOffset);
+    (0, exportAny_1.default)({ processor: 1 })
+        .use({ '*:*': (writer, processor) => (node, ctx, interator) => {
+            if (node.children)
+                interator(node.children, { ...ctx });
+        } })
+        .use({ ':definition': (writer, processor) => (node, ctx, interator) => {
+            definitionMap[node.identifier] = node;
+        } }).run(md_tree);
+    // second stage - make Universal AST nodes
+    const uast = [];
+    const res = (0, exportAny_1.default)({ processor: 1 })
+        .use({ '*:*': (writer, processor) => (node, ctx, interator) => {
+            console.warn('[Podlite:md2ast]- unhandled MD node');
+            console.warn(JSON.stringify(node, null, 2));
+            if (node.children)
+                interator(node.children, { ...ctx });
+        } })
+        .use({
+        ':root': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_2.mkRootBlock)({}, interator(children, ctx));
+        },
+        ':heading': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ type: 'block', level: node.depth, name: 'head', location: applyLineOffset(position) }, interator(children, ctx));
+        },
+        ':text': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return node.value;
+            // return mkNode({type:"text", value: node.value})
+        },
+        ':list': (writer, processor) => (node, ctx, interator) => {
+            const savedListLevel = ctx['listLevel'] || 0;
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ type: 'list', level: savedListLevel + 1, list: node.ordered ? 'ordered' : 'itemized' }, interator(children, { ...ctx, listLevel: savedListLevel + 1, ordered: node.ordered }));
+        },
+        ':listItem': (writer, processor) => (node, ctx, interator) => {
+            const savedListLevel = ctx['listLevel'] || 0;
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ name: 'item', type: 'block', level: ctx['listLevel'], location: applyLineOffset(position) }, interator(children, { ...ctx, listLevel: savedListLevel, ordered: node.ordered }));
+        },
+        ':paragraph': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ type: 'para', location: applyLineOffset(position), text: 'text', margin: "", }, interator(children, { ...ctx }));
+        },
+        ':linkReference': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            const definition = definitionMap[attr.identifier];
+            const meta = (definition === null || definition === void 0 ? void 0 : definition.url) || '';
+            return (0, schema_1.mkFomattingCodeL)({ meta }, interator(children, { ...ctx }));
+        },
+        ':definition': (writer, processor) => (node, ctx, interator) => {
+            return null;
+        },
+        ':inlineCode': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkFomattingCode)({ name: "C" }, [node.value]);
+        },
+        ':strong': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkFomattingCode)({ name: "B" }, interator(children, { ...ctx }));
+        },
+        ':emphasis': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkFomattingCode)({ name: "I" }, interator(children, { ...ctx }));
+        },
+        ':link': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkFomattingCodeL)({ meta: node.url }, interator(children, { ...ctx }));
+        },
+        ':html': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ type: 'block', name: 'Html', location: applyLineOffset(position) }, [(0, schema_1.mkVerbatim)(node.value)]);
+        },
+        ':code': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, lang, meta, ...attr } = node;
+            if (lang === 'mermaid' || lang === 'diagram') {
+                return (0, schema_1.mkBlock)({ type: 'block', name: 'Diagram', config: [], location: applyLineOffset(position) }, [(0, schema_1.mkVerbatim)(node.value)]);
+            }
+            let config = [];
+            if (lang) {
+                config.push({ name: 'lang', value: lang, type: "string" });
+            }
+            if (meta) {
+                config.push({ name: 'meta', value: meta, type: "string" });
+            } //  filled as is from markdown
+            return (0, schema_1.mkBlock)({ type: 'block', name: 'code', config, location: applyLineOffset(position) }, [(0, schema_1.mkVerbatim)(node.value)]);
+        },
+        ':image': (writer, processor) => (node, ctx, interator) => {
+            const { title, alt, url, position, ...attr } = node;
+            let config = [];
+            return (0, schema_1.mkBlock)({ type: 'block', name: 'Image', config, location: applyLineOffset(position) }, [(0, schema_3.mkImage)(url, alt), (0, schema_4.mkCaption)([title])]);
+        },
+        ':thematicBreak': (writer, processor) => (node, ctx, interator) => {
+            return null; // TODO: add support for "thematic break"
+        },
+        ':blockquote': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ name: 'nested', location: applyLineOffset(position) }, interator(children, { ...ctx }));
+        },
+        //table section
+        ':table': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ name: 'table', location: applyLineOffset(position) }, interator(children, { ...ctx }));
+        },
+        ':tableRow': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ name: 'table_row', location: applyLineOffset(position) }, interator(children, { ...ctx }));
+        },
+        ':tableCell': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_1.mkBlock)({ name: 'table_cell', location: applyLineOffset(position) }, interator(children, { ...ctx }));
+        },
+        ':delete': (writer, processor) => (node, ctx, interator) => {
+            const { children, position, ...attr } = node;
+            return (0, schema_5.mkFomattingCodeDelete)(interator(children, { ...ctx }));
+        },
+        ':break': (writer, processor) => (node, ctx, interator) => {
+            return null;
+        },
+    }).run(md_tree);
+    return res.interator;
+};
+exports.md2ast = md2ast;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@podlite/markdown",
+  "version": "0.0.1",
+  "description": "=Markdown - markdown text block",
+  "main": "index.js",
+  "types": "./lib/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist lib tsconfig.tsbuildinfo",
+    "build": "tsc",
+    "test": "yarn g:jest  --passWithNoTests"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "index.js",
+    "types": "./lib/index.d.ts"
+  },
+  "peerDependencies": {
+    "react": "^16.0.0 || ^17.0.0",
+    "react-dom": "^16.0.0 || ^17.0.0",
+    "remark-gfm": "*",
+    "remark-parse": "*",
+    "unified": "*"
+  },
+  "dependencies": {
+    "@podlite/schema": "0.0.10",
+    "pod6": "^0.0.48",
+    "react": "^16.0.0 || ^17.0.0",
+    "react-dom": "^16.0.0 || ^17.0.0",
+    "react-is": "^17.0.2",
+    "remark-gfm": "^3.0.1",
+    "remark-parse": "^10.0.1",
+    "unified": "^10.1.2"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,28 @@
+import { Plugins } from '@podlite/schema';
+import {Plugin} from '@podlite/schema'
+import { md2ast } from './tools';
+import { content as nodeContent } from 'pod6/built/helpers/handlers'
+  
+export const plugin:Plugin =({
+    toAst: (_, processor) => (node, ctx) => {
+        if (typeof node !== "string" && 'type' in node && 'content' in node && node.type === 'block') {
+            const content = node.content[0]
+            if (content && typeof content !== "string" && 'location' in node && 'value' in content) {
+                const lineOffset = node.location.start.line
+                return { ...node, content: md2ast(content, {lineOffset})  }
+            }
+            return node
+        }
+
+     },
+     toJSX: (helper) => {
+        return nodeContent
+     }
+
+    })
+export const PluginRegister:Plugins = {
+    Markdown: plugin
+}
+export default plugin
+
+

package/src/tools.ts

@@ -0,0 +1,147 @@
+import  {unified}  from 'unified'
+import markdown  from 'remark-parse'
+import remarkGfm from 'remark-gfm'
+import toAny  from 'pod6/built/exportAny'
+import { AstTree, BlockImage, mkBlock, mkFomattingCode, mkFomattingCodeL, mkVerbatim, Location } from '@podlite/schema'
+import { mkRootBlock } from '@podlite/schema'
+import { mkImage } from '@podlite/schema'
+import { mkCaption } from '@podlite/schema'
+import { mkFomattingCodeDelete } from '@podlite/schema'
+
+type Md2astArgs = { lineOffset?: number};
+export const  md2ast = ( src:string, {lineOffset }:Md2astArgs = {lineOffset:0} ) :AstTree => {
+    // first convert mardown to ast 
+    const md_tree = unified().use(markdown).use(remarkGfm).parse(src)
+    // first pass : collect linkRefs
+    let definitionMap = {}
+    const applyLineOffset = ((offset:number)=>(location:Location):Location=>{
+        const { start, end } = location
+        return {
+            "start": {
+                ...start,
+              "line": start.line + offset,
+            },
+            "end": {
+              ...end,
+              "line": end.line + offset,
+            }
+    }
+   })(lineOffset);
+    toAny({processor:1})
+    .use({'*:*':( writer, processor )=>( node, ctx, interator )=>{
+        if (node.children) interator(node.children, { ...ctx})
+    }})
+    .use({':definition' : ( writer, processor )=>( node, ctx, interator )=>{
+        definitionMap[node.identifier] = node
+    }}).run(md_tree)
+
+    // second stage - make Universal AST nodes
+    const uast = []
+    const  res = toAny({processor:1})
+    .use({'*:*':( writer, processor )=>( node, ctx, interator )=>{
+        console.warn('[Podlite:md2ast]- unhandled MD node')
+        console.warn(JSON.stringify(node,null,2))
+        if (node.children) interator(node.children, { ...ctx})
+    }})
+    .use({
+        ':root' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node 
+            return mkRootBlock({}, interator(children, ctx))
+        },
+        ':heading' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({type:'block', level:node.depth,name:'head', location:applyLineOffset(position)},  interator(children, ctx));
+        },
+        ':text' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return node.value
+            // return mkNode({type:"text", value: node.value})
+        },
+        ':list' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const savedListLevel = ctx['listLevel'] || 0
+            const { children, position, ...attr} = node
+            return mkBlock( { type:'list', level:savedListLevel+1, list: node.ordered ? 'ordered' : 'itemized' }, interator(children, { ...ctx, listLevel : savedListLevel + 1, ordered: node.ordered}))
+        },
+        ':listItem' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const savedListLevel = ctx['listLevel'] || 0
+            const { children, position, ...attr} = node
+            return mkBlock({name: 'item', type:'block', level:ctx['listLevel'], location:applyLineOffset(position)}, interator(children, { ...ctx, listLevel : savedListLevel , ordered: node.ordered}))
+        },
+        ':paragraph' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({type:'para', location:applyLineOffset(position), text: 'text', margin:"",}, interator(children, { ...ctx}))
+        },
+        ':linkReference' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            const definition = definitionMap[attr.identifier]
+            const meta = definition?.url || ''
+            return mkFomattingCodeL({ meta}, interator(children, { ...ctx}))
+        },
+        ':definition' : ( writer, processor )=>( node, ctx, interator )=>{
+            return null
+        },
+        ':inlineCode' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkFomattingCode({name:"C"}, [node.value])
+        },
+        ':strong' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkFomattingCode({name:"B"}, interator(children, { ...ctx}))
+        },
+        ':emphasis' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkFomattingCode({name:"I"}, interator(children, { ...ctx}))
+        },
+        ':link': ( writer, processor )=>( node, ctx, interator )=>{ 
+            const { children, position, ...attr} = node
+            return mkFomattingCodeL({ meta:node.url}, interator(children, { ...ctx}))
+        },
+        ':html': ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node 
+            return mkBlock({type:'block', name:'Html', location:applyLineOffset(position)},[mkVerbatim(node.value)]);
+        },
+        ':code' : ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, lang, meta, ...attr} = node
+            if (lang === 'mermaid' || lang === 'diagram') {
+                return mkBlock({type:'block', name:'Diagram', config:[], location:applyLineOffset(position)},[mkVerbatim(node.value)]);
+            }
+            let config = []
+            if (lang) { config.push({ name: 'lang', value:lang, type:"string"})}
+            if (meta) { config.push({ name: 'meta', value:meta, type:"string"})} //  filled as is from markdown
+            return mkBlock({type:'block', name:'code', config, location:applyLineOffset(position)},[mkVerbatim(node.value)]);
+        },
+        ':image':  ( writer, processor )=>( node, ctx, interator ):BlockImage=>{
+            const { title, alt, url, position, ...attr} = node
+            let config = []
+            return mkBlock({type:'block', name:'Image', config, location:applyLineOffset(position)},[mkImage(url,alt),mkCaption([title])]);
+        },
+        ':thematicBreak': ( writer, processor )=>( node, ctx, interator )=>{
+            return null // TODO: add support for "thematic break"
+        },
+        ':blockquote' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({name:'nested', location:applyLineOffset(position)}, interator(children, { ...ctx}))
+        },
+        //table section
+        ':table' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({name:'table', location:applyLineOffset(position)}, interator(children, { ...ctx}))
+        },
+        ':tableRow' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({name:'table_row', location:applyLineOffset(position)}, interator(children, { ...ctx}))
+        },
+        ':tableCell' :  ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkBlock({name:'table_cell', location:applyLineOffset(position)}, interator(children, { ...ctx}))
+        },
+        ':delete': ( writer, processor )=>( node, ctx, interator )=>{
+            const { children, position, ...attr} = node
+            return mkFomattingCodeDelete( interator(children, { ...ctx}))
+        },
+        ':break': ( writer, processor )=>( node, ctx, interator )=>{
+            return null
+        },
+    }).run(md_tree)
+    return res.interator
+}