@podlite/schema 0.0.14 → 0.0.16

package/esm/writer.js

@@ -0,0 +1,85 @@
+/**
+ * Default writer
+ */
+import * as Events from 'events';
+class Writer extends Events.EventEmitter {
+    INDEXTERMS;
+    FOOTNOTES;
+    output;
+    errors;
+    out;
+    ons;
+    // write: (p: any) => void;
+    // getStr: () => { errors: any; toString: () => any; valueOf: () => any; };
+    // errors: any;
+    // out: any;
+    // startWrite: () => void;
+    // ons: any[];
+    // endWrite: () => void;
+    constructor(output) {
+        super();
+        // save X<> entries
+        this.INDEXTERMS = [];
+        // save N<> annotates
+        this.FOOTNOTES = [];
+        this.output = output;
+        this.ons = [];
+        this.emit('ready');
+    }
+    // escape function for output
+    escape(p) {
+        return p;
+    }
+    // write with escape special symbols
+    write(p) {
+        return this.writeRaw(this.escape(p));
+    }
+    // raw write as is
+    writeRaw(str) {
+        if ('function' === typeof this.output) {
+            this.output(str);
+        }
+        else {
+            console.log(str);
+        }
+    }
+    getStr() {
+        return {
+            errors: this.errors,
+            toString: () => this.out,
+            valueOf: () => this.out,
+        };
+    }
+    startWrite(tree) {
+        // setup events
+        ;
+        (this.ons || []).map(a => 
+        //@ts-ignore
+        super.on(...a));
+        this.emit('start', tree);
+        this.addListener('errors', err => {
+            this.errors = this.errors || [];
+            this.errors.push(err);
+        });
+    }
+    on(...params) {
+        // overload 'on' method for reverse setup handlers
+        this.ons = this.ons || [];
+        this.ons.unshift([...params]);
+        return this;
+    }
+    endWrite = () => {
+        this.emit('end');
+    };
+    // nesting methods
+    _add_nesting(n) { }
+    _remove_nesting(n) { }
+    addLevel(n) {
+        this._add_nesting(n);
+    }
+    removeLevel(n) {
+        this._remove_nesting(n);
+    }
+}
+export default Writer;
+//# sourceMappingURL=writer.js.map

package/esm/writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.js","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,MAAM,MAAO,SAAQ,MAAM,CAAC,YAAY;IACtC,UAAU,CAAO;IACjB,SAAS,CAAO;IAChB,MAAM,CAAK;IACX,MAAM,CAAK;IACX,GAAG,CAAK;IACR,GAAG,CAAO;IACV,2BAA2B;IAC3B,2EAA2E;IAC3E,eAAe;IACf,YAAY;IACZ,0BAA0B;IAC1B,cAAc;IACd,wBAAwB;IAExB,YAAY,MAAO;QACjB,KAAK,EAAE,CAAA;QACP,mBAAmB;QACnB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACpB,qBAAqB;QACrB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAA;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpB,CAAC;IACD,6BAA6B;IAC7B,MAAM,CAAC,CAAC;QACN,OAAO,CAAC,CAAA;IACV,CAAC;IACD,oCAAoC;IACpC,KAAK,CAAC,CAAC;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACtC,CAAC;IACD,kBAAkB;IAClB,QAAQ,CAAC,GAAG;QACV,IAAI,UAAU,KAAK,OAAO,IAAI,CAAC,MAAM,EAAE;YACrC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;SACjB;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;SACjB;IACH,CAAC;IACD,MAAM;QACJ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG;YACxB,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG;SACxB,CAAA;IACH,CAAC;IACD,UAAU,CAAC,IAAS;QAClB,eAAe;QACf,CAAC;QAAA,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACxB,YAAY;QACZ,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CACf,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QACxB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;YAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAA;YAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;IACD,EAAE,CAAC,GAAG,MAAM;QACV,kDAAkD;QAClD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,EAAE,CAAA;QACzB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,QAAQ,GAAG,GAAG,EAAE;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClB,CAAC,CAAA;IAED,kBAAkB;IAElB,YAAY,CAAC,CAAS,IAAG,CAAC;IAC1B,eAAe,CAAC,CAAS,IAAG,CAAC;IAE7B,QAAQ,CAAC,CAAS;QAChB,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IAED,WAAW,CAAC,CAAS;QACnB,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}

package/esm/writerHtml.d.ts

@@ -0,0 +1,11 @@
+/**
+ * HTML writer
+ */
+import Writer from './writer';
+declare class WriterHTML extends Writer {
+    constructor(output?: any);
+    escape(string: any): string;
+    _add_nesting(n: any): void;
+    _remove_nesting(n: any): void;
+}
+export default WriterHTML;

package/esm/writerHtml.js

@@ -0,0 +1,29 @@
+/**
+ * HTML writer
+ */
+import Writer from './writer';
+class WriterHTML extends Writer {
+    constructor(output) {
+        super(output);
+    }
+    escape(string) {
+        const HTML_CHARS = {
+            '&': '&',
+            '<': '&lt;',
+            '>': '&gt;',
+            '"': '&quot;',
+            "'": '&#x27;',
+            '/': '&#x2F;',
+            '`': '&#x60;',
+        };
+        return (string + '').replace(/[&<>"'\/`]/g, match => HTML_CHARS[match]);
+    }
+    _add_nesting(n) {
+        this.writeRaw('<blockquote>'.repeat(n));
+    }
+    _remove_nesting(n) {
+        this.writeRaw('</blockquote>'.repeat(n));
+    }
+}
+export default WriterHTML;
+//# sourceMappingURL=writerHtml.js.map

package/esm/writerHtml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writerHtml.js","sourceRoot":"","sources":["../src/writerHtml.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,MAAM,UAAW,SAAQ,MAAM;IAC7B,YAAY,MAAO;QACjB,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IACD,MAAM,CAAC,MAAM;QACX,MAAM,UAAU,GAAG;YACjB,GAAG,EAAE,OAAO;YACZ,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,QAAQ;SACd,CAAA;QACD,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,YAAY,CAAC,CAAC;QACZ,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACzC,CAAC;IACD,eAAe,CAAC,CAAC;QACf,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAC1C,CAAC;CACF;AACD,eAAe,UAAU,CAAA"}

package/lib/grammar.js

@@ -134,7 +134,7 @@ function peg$parse(input, options) {
             type: "boolean"
         };
     }, peg$c88 = function (isFalse, key, value) { return { name: key, ...value }; }, peg$c89 = function (first, rest) { return rest; }, peg$c90 = function (first, cont) { return flattenDeep([...first, ...cont]); }, peg$c91 = /^[^'"]/, peg$c92 = peg$classExpectation(["'", "\""], true, false), peg$c93 = function (text) { return text; }, peg$c94 = /^[0-9]/, peg$c95 = peg$classExpectation([["0", "9"]], false, false), peg$c96 = /^[\-+]/, peg$c97 = peg$classExpectation(["-", "+"], false, false), peg$c98 = "True", peg$c99 = peg$literalExpectation("True", false), peg$c100 = function () { return true; }, peg$c101 = "False", peg$c102 = peg$literalExpectation("False", false), peg$c103 = function () { return false; }, peg$c104 = ".", peg$c105 = peg$literalExpectation(".", false), peg$c106 = /^[eE]/, peg$c107 = peg$classExpectation(["e", "E"], false, false), peg$c108 = /^["]/, peg$c109 = peg$classExpectation(["\""], false, false), peg$c110 = /^[^"]/, peg$c111 = peg$classExpectation(["\""], true, false), peg$c112 = /^[']/, peg$c113 = peg$classExpectation(["'"], false, false), peg$c114 = /^[^']/, peg$c115 = peg$classExpectation(["'"], true, false), peg$c116 = function (numberFloat) { return parseFloat(numberFloat); }, peg$c117 = function (number) { return parseInt(number, 10); }, peg$c118 = function (vmargin, name, config) {
-        return ((name.match(/code|comment|output|input|markdown|toc|data/))
+        return ((name.match(/code|comment|output|input|markdown|picture|toc|data/))
             ||
                 isNamedBlock(name));
     }, peg$c119 = function (vmargin, name, config, margins, ename) { return vmargin.length === margins.length && name === ename; }, peg$c120 = function (vmargin, name, config, margins, line) { return exludeVMargin(vmargin, `${margins}${line}`); }, peg$c121 = function (vmargin, name, config, content, vmargin2, ename) { return name === ename; }, peg$c122 = function (vmargin, name, config, content, vmargin2, ename) {
@@ -261,7 +261,7 @@ function peg$parse(input, options) {
             location: location(),
         };
     }, peg$c150 = function () { return { empty: 1 }; }, peg$c151 = /^[s]/, peg$c152 = peg$classExpectation(["s"], false, false), peg$c153 = function (line) { return { text: text(), type: "ambient1" }; }, peg$c154 = function (vmargin, name) {
-        return ((name.match(/code|comment|output|input|markdown|toc|data/))
+        return ((name.match(/code|comment|output|input|markdown|picture|toc|data/))
             ||
                 isNamedBlock(name));
     }, peg$c155 = function (vmargin, name, content) {
@@ -320,7 +320,7 @@ function peg$parse(input, options) {
             margin: vmargin
         };
     }, peg$c168 = function (vmargin, marker, name, config) {
-        return ((name.match(/code|comment|output|input|markdown|toc|data/))
+        return ((name.match(/code|comment|output|input|markdown|picture|toc|data/))
             ||
                 isNamedBlock(name));
     }, peg$c169 = function (vmargin, marker, name, config, content) {
@@ -6364,6 +6364,7 @@ function peg$parse(input, options) {
             'nested',
             'output',
             'para',
+            'picture',
             'pod',
             'table',
             'toc',

package/lib/plugin-formatting-codes.js

@@ -50,9 +50,10 @@ const middle = () => tree => {
             const isCodeBlock = 'name' in n && n.name === 'code';
             const isDataBlock = 'name' in n && n.name === 'data';
             const isMarkdownBlock = 'name' in n && n.name === 'markdown';
+            const isPictureBlock = 'name' in n && n.name === 'picture';
             const allowValues = conf.getAllValues('allow');
             // for code block not parse content by default
-            if ((isCodeBlock || isDataBlock || isMarkdownBlock) && allowValues.length == 0)
+            if ((isCodeBlock || isDataBlock || isMarkdownBlock || isPictureBlock) && allowValues.length == 0)
                 return n;
             const allowed = allowValues.sort();
             const transformer = (0, makeTransformer_1.default)({

package/lib/types.d.ts

@@ -46,6 +46,7 @@ export interface RulesStrict {
     nested: RuleHandler<BlockNested>;
     output: RuleHandler<BlockOutput>;
     input: RuleHandler<BlockInput>;
+    picture: RuleHandler<BlockPicture>;
     image: RuleHandler<BlockImage>;
     ':image': RuleHandler<Image>;
     'item:block': RuleHandler<BlockItem>;
@@ -67,6 +68,7 @@ export interface RulesStrict {
     ':toc-item': RuleHandler<TocItem>;
     markdown: RuleHandler<BlockMarkdown>;
     Diagram: RuleHandler<BlockDiagram>;
+    Mermaid: RuleHandler<BlockMermaid>;
     Image: RuleHandler<BlockNamed>;
 }
 export interface Rules extends RulesStrict {
@@ -107,6 +109,12 @@ export interface BlockImage extends Omit<Block, 'content'> {
     link?: string;
     content: [Image, BlockCaption];
 }
+export interface BlockPicture extends Omit<Block, 'content'> {
+    name: 'picture';
+    caption?: string;
+    link?: string;
+    content: [Image, BlockCaption];
+}
 export interface BlockCaption extends Omit<Block, 'content' | 'location' | 'margin' | 'config' | 'id'> {
     name: 'caption';
     content: Array<Node>;
@@ -335,8 +343,15 @@ export interface BlockDiagram extends Omit<BlockNamed, 'content'> {
         location: Location;
     };
 }
+export interface BlockMermaid extends Omit<BlockNamed, 'content'> {
+    name: 'Mermaid';
+    content: [Verbatim];
+    custom?: {
+        location: Location;
+    };
+}
 export declare type FormattingCodes = FormattingCodeA | FormattingCodeC | FormattingCodeB | FormattingCodeD | FormattingCodeE | FormattingCodeI | FormattingCodeL | FormattingCodeN | FormattingCodeX | FormattingCodeZ | FormattingCodeV | FormattingCodeS | FormattingCodeAny;
-export declare type PodNode = Ambient | BlockPod | BlockData | BlockCode | BlankLine | BlockNested | BlockMarkdown | BlockOutput | BlockInput | BlockPara | BlockHead | BlockComment | BlockDefn | string | Para | Text | Code | BlockNamed | BlockAny | Verbatim | BlockTable | List | BlockConfig | BlockItem | Alias | BlockToc | BlockImage | Image | RootBlock | Separator | BlockCaption | FormattingCodes | Toc;
+export declare type PodNode = Ambient | BlockPod | BlockData | BlockCode | BlankLine | BlockNested | BlockMarkdown | BlockOutput | BlockInput | BlockPara | BlockHead | BlockComment | BlockDefn | string | Para | Text | Code | BlockNamed | BlockAny | Verbatim | BlockTable | List | BlockConfig | BlockItem | Alias | BlockToc | BlockPicture | BlockImage | Image | RootBlock | Separator | BlockCaption | FormattingCodes | Toc;
 export declare type Node = PodNode;
 export declare type AstTree = Array<PodNode>;
 export declare type PodliteDocument = RootBlock;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podlite/schema",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "AST tools for Podlite markup language",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -8,6 +8,7 @@
   "files": [
     "lib/**/*.js",
     "lib/**/*.d.ts",
+    "esm",
     "schema/*",
     "README.md",
     "CHANGELOG.md"
@@ -19,14 +20,14 @@
   "publishConfig": {
     "access": "public",
     "main": "lib/index.js",
-    "types": "./lib/index.d.ts"
+    "types": "./lib/index.d.ts",
+    "module": "./esm/index.js"
   },
   "scripts": {
-    "clean": "rm -rf lib esm tsconfig.tsbuildinfo",
-    "build": "run-s build:pegjs build:ts build:ast ",
+    "clean": "rm -rf lib esm *.tsbuildinfo",
+    "build": "run-s build:pegjs build_lib build:ast ",
+    "build_lib": "yarn g:build",
     "build:ast": "ts-node scripts/make-ast-scheme.ts",
-    "build:ts": "yarn g:tsc --build $INIT_CWD",
-    "build:esm": "yarn g:tsctest -p tsconfig.esm.json",
     "build:pegjs": "pegjs -o src/grammar.js src/grammar.pegjs && pegjs -o src/grammarfc.js src/grammarfc.pegjs",
     "watch": "npx nodemon -e js,ts --exec 'yarn' build",
     "watch:pegjs": "npx nodemon -e pegjs --exec 'yarn' build:pegjs",
@@ -52,5 +53,6 @@
     "ts-node": "^9.1.1",
     "typescript": "4.5.5",
     "typescript-json-schema": "0.53.0"
-  }
+  },
+  "module": "./esm/index.js"
 }

package/schema/AstTree.json

@@ -111,6 +111,9 @@
                 {
                     "$ref": "#/definitions/BlockImage"
                 },
+                {
+                    "$ref": "#/definitions/BlockPicture"
+                },
                 {
                     "$ref": "#/definitions/BlockCaption"
                 },
@@ -449,6 +452,71 @@
                 "value"
             ]
         },
+        "BlockPicture": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "enum": [
+                        "picture"
+                    ]
+                },
+                "caption": {
+                    "type": "string"
+                },
+                "link": {
+                    "type": "string"
+                },
+                "content": {
+                    "type": "array",
+                    "items": [
+                        {
+                            "$ref": "#/definitions/Image"
+                        },
+                        {
+                            "$ref": "#/definitions/BlockCaption"
+                        }
+                    ],
+                    "minItems": 2,
+                    "maxItems": 2
+                },
+                "type": {
+                    "type": "string",
+                    "enum": [
+                        "block"
+                    ]
+                },
+                "location": {
+                    "$ref": "#/definitions/Location"
+                },
+                "margin": {
+                    "type": "string"
+                },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/BrokenConfigItem"
+                            },
+                            {
+                                "$ref": "#/definitions/ConfigItem"
+                            }
+                        ]
+                    }
+                },
+                "id": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "content",
+                "location",
+                "margin",
+                "name",
+                "type"
+            ]
+        },
         "RootBlock": {
             "type": "object",
             "properties": {
@@ -1168,6 +1236,9 @@
                             {
                                 "$ref": "#/definitions/BlockImage"
                             },
+                            {
+                                "$ref": "#/definitions/BlockPicture"
+                            },
                             {
                                 "$ref": "#/definitions/BlockCaption"
                             },

package/schema/PodliteDocument.json

@@ -111,6 +111,9 @@
                 {
                     "$ref": "#/definitions/BlockImage"
                 },
+                {
+                    "$ref": "#/definitions/BlockPicture"
+                },
                 {
                     "$ref": "#/definitions/BlockCaption"
                 },
@@ -449,6 +452,71 @@
                 "value"
             ]
         },
+        "BlockPicture": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "enum": [
+                        "picture"
+                    ]
+                },
+                "caption": {
+                    "type": "string"
+                },
+                "link": {
+                    "type": "string"
+                },
+                "content": {
+                    "type": "array",
+                    "items": [
+                        {
+                            "$ref": "#/definitions/Image"
+                        },
+                        {
+                            "$ref": "#/definitions/BlockCaption"
+                        }
+                    ],
+                    "minItems": 2,
+                    "maxItems": 2
+                },
+                "type": {
+                    "type": "string",
+                    "enum": [
+                        "block"
+                    ]
+                },
+                "location": {
+                    "$ref": "#/definitions/Location"
+                },
+                "margin": {
+                    "type": "string"
+                },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/BrokenConfigItem"
+                            },
+                            {
+                                "$ref": "#/definitions/ConfigItem"
+                            }
+                        ]
+                    }
+                },
+                "id": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "content",
+                "location",
+                "margin",
+                "name",
+                "type"
+            ]
+        },
         "RootBlock": {
             "type": "object",
             "properties": {
@@ -1168,6 +1236,9 @@
                             {
                                 "$ref": "#/definitions/BlockImage"
                             },
+                            {
+                                "$ref": "#/definitions/BlockPicture"
+                            },
                             {
                                 "$ref": "#/definitions/BlockCaption"
                             },