@podlite/schema 0.0.63 → 0.0.64

package/lib/helpers/config.d.ts

@@ -9,5 +9,6 @@ export interface Attr {
     (): {};
     exists(name: string): boolean;
 }
+export declare const codeConfigWithDefaults: (node: any, ctx?: Context) => any;
 export declare const makeAttrs: (node: any, ctx?: Context) => Attr;
 export default makeAttrs;

package/lib/helpers/config.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAttrs = void 0;
+exports.makeAttrs = exports.codeConfigWithDefaults = void 0;
+// A markup code is pre-configured under its name followed by a pair of angles.
+// The declaration comes first, so a value written on the code itself is read
+// last and wins.
+const codeConfigWithDefaults = (node, ctx = {}) => {
+    const declared = ctx.config ? ctx.config[`${node.name}<>`] : undefined;
+    const own = Array.isArray(node.config) ? node.config : [];
+    return Array.isArray(declared) ? [...declared, ...own] : own;
+};
+exports.codeConfigWithDefaults = codeConfigWithDefaults;
 const makeAttrs = (node, ctx = {}) => {
     const config = node.config instanceof Array ? node.config : [];
     // add config's from ctx

package/lib/helpers/configPropagation.d.ts

@@ -1,3 +1,3 @@
 import { PodNode, PodliteDocument } from '../types';
-export declare const propagateConfigDefaults: <T extends PodliteDocument | PodNode>(ast: T) => T;
+export declare const propagateConfigDefaults: <T extends PodliteDocument | PodNode | unknown[]>(ast: T) => T;
 export default propagateConfigDefaults;

package/lib/helpers/configPropagation.js

@@ -43,7 +43,8 @@ const walk = (node, config) => {
         }
     }
     if (anyNode.content !== undefined) {
-        walk(anyNode.content, config);
+        // a block is a lexical scope: what is declared inside it stays inside
+        walk(anyNode.content, anyNode.type === 'block' ? { ...config } : config);
     }
 };
 const propagateConfigDefaults = (ast) => {

package/lib/helpers/link-config.d.ts

@@ -0,0 +1,8 @@
+import { ConfigItem } from '../types';
+export type LinkConfig = {
+    newContext?: boolean;
+    title?: string;
+    lang?: string;
+    download?: boolean | string;
+};
+export declare const readLinkConfig: (config?: ConfigItem[]) => LinkConfig;

package/lib/helpers/link-config.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readLinkConfig = void 0;
+const last = (config, name) => config.filter(item => item.name === name).slice(-1)[0];
+const asText = (item) => item && (item.type === 'string' || item.type === 'number') ? String(item.value) : undefined;
+const readLinkConfig = (config) => {
+    if (!Array.isArray(config) || config.length === 0)
+        return {};
+    const result = {};
+    const openInNew = last(config, 'new');
+    if (openInNew)
+        result.newContext = openInNew.value !== false;
+    const title = asText(last(config, 'title'));
+    if (title !== undefined)
+        result.title = title;
+    const lang = asText(last(config, 'lang'));
+    if (lang !== undefined)
+        result.lang = lang;
+    const download = last(config, 'download');
+    if (download) {
+        const name = asText(download);
+        result.download = name !== undefined ? name : download.value !== false;
+    }
+    return result;
+};
+exports.readLinkConfig = readLinkConfig;
+//# sourceMappingURL=link-config.js.map

package/lib/helpers/makeInterator.js

@@ -19,6 +19,29 @@ function thisFunc(rules) {
             // convert string to lex node with type
             return interator({ type: 'text', value: node }, context);
         }
+        // a block is a lexical scope: a =config or =alias written inside it must not
+        // reach what follows the block. The context object itself is kept, since
+        // rules count cells and mark rows through it
+        if (node.type === 'block' && context) {
+            const outer = { config: context.config, alias: context.alias };
+            const had = { config: context.hasOwnProperty('config'), alias: context.hasOwnProperty('alias') };
+            context.config = { ...outer.config };
+            context.alias = { ...outer.alias };
+            try {
+                return dispatch(node, context);
+            }
+            finally {
+                for (const key of ['config', 'alias']) {
+                    if (had[key])
+                        context[key] = outer[key];
+                    else
+                        delete context[key];
+                }
+            }
+        }
+        return dispatch(node, context);
+    }
+    function dispatch(node, context) {
         // get first rule for this node
         const reversed = rules.slice();
         reversed.reverse();

package/lib/index.d.ts

@@ -11,8 +11,10 @@ export * from './helpers/handlers';
 export { makeInterator } from './ast-inerator';
 export { makeTransformer, isNamedBlock, isSemanticBlock } from './helpers/makeTransformer';
 export { toAny } from './exportAny';
-export { makeAttrs } from './helpers/config';
+export { makeAttrs, codeConfigWithDefaults } from './helpers/config';
 export { parseAttributes } from './helpers/parseAttributes';
+export { readLinkConfig } from './helpers/link-config';
+export type { LinkConfig } from './helpers/link-config';
 export { pluginCleanLocation } from './plugin-clean-location';
 export { toAnyRules } from './helpers/plugins';
 export { podlitePluggable, Podlite, PodliteExport, cleanIds, frozenIds } from './pluggableParser';
@@ -79,7 +81,9 @@ declare function makeTree(): {
 export { makeTree as toTree };
 declare const parse: Function;
 export { parse as parse };
-export { parse as parseFormattingCodes } from './grammarfc';
+export declare const parseFormattingCodes: (text: string, options?: {
+    [key: string]: any;
+}) => any[];
 export { default as toHtml } from './exportHtml';
 export { default as toMarkdown } from './exportMarkdown';
 export { default as Writer } from './writer';

package/lib/index.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = exports.applyImageBase = exports.runSelector = exports.parseSelector = exports.Writer = exports.toMarkdown = exports.toHtml = exports.parseFormattingCodes = exports.parse = exports.frozenIds = exports.cleanIds = exports.podlitePluggable = exports.toAnyRules = exports.pluginCleanLocation = exports.parseAttributes = exports.makeAttrs = exports.toAny = exports.isSemanticBlock = exports.isNamedBlock = exports.makeTransformer = exports.makeInterator = void 0;
+exports.version = exports.applyImageBase = exports.runSelector = exports.parseSelector = exports.Writer = exports.toMarkdown = exports.toHtml = exports.parseFormattingCodes = exports.parse = exports.frozenIds = exports.cleanIds = exports.podlitePluggable = exports.toAnyRules = exports.pluginCleanLocation = exports.readLinkConfig = exports.parseAttributes = exports.codeConfigWithDefaults = exports.makeAttrs = exports.toAny = exports.isSemanticBlock = exports.isNamedBlock = exports.makeTransformer = exports.makeInterator = void 0;
 exports.toAst = toAst;
 exports.getTextContentFromNode = getTextContentFromNode;
 exports.getPodContentFromNode = getPodContentFromNode;
@@ -69,8 +69,11 @@ var exportAny_1 = require("./exportAny");
 Object.defineProperty(exports, "toAny", { enumerable: true, get: function () { return exportAny_1.toAny; } });
 var config_1 = require("./helpers/config");
 Object.defineProperty(exports, "makeAttrs", { enumerable: true, get: function () { return config_1.makeAttrs; } });
+Object.defineProperty(exports, "codeConfigWithDefaults", { enumerable: true, get: function () { return config_1.codeConfigWithDefaults; } });
 var parseAttributes_1 = require("./helpers/parseAttributes");
 Object.defineProperty(exports, "parseAttributes", { enumerable: true, get: function () { return parseAttributes_1.parseAttributes; } });
+var link_config_1 = require("./helpers/link-config");
+Object.defineProperty(exports, "readLinkConfig", { enumerable: true, get: function () { return link_config_1.readLinkConfig; } });
 var plugin_clean_location_1 = require("./plugin-clean-location");
 Object.defineProperty(exports, "pluginCleanLocation", { enumerable: true, get: function () { return plugin_clean_location_1.pluginCleanLocation; } });
 var plugins_1 = require("./helpers/plugins");
@@ -80,6 +83,8 @@ Object.defineProperty(exports, "podlitePluggable", { enumerable: true, get: func
 Object.defineProperty(exports, "cleanIds", { enumerable: true, get: function () { return pluggableParser_1.cleanIds; } });
 Object.defineProperty(exports, "frozenIds", { enumerable: true, get: function () { return pluggableParser_1.frozenIds; } });
 const parser = __importStar(require("./grammar"));
+const grammarfc_1 = require("./grammarfc");
+const parseAttributes_2 = require("./helpers/parseAttributes");
 const plugin_vmargin_1 = __importDefault(require("./plugin-vmargin"));
 const plugin_formatting_codes_1 = __importDefault(require("./plugin-formatting-codes"));
 const plugin_items_1 = __importDefault(require("./plugin-items"));
@@ -88,6 +93,7 @@ const plugin_group_defn_1 = __importDefault(require("./plugin-group-defn"));
 const plugin_group_items_1 = __importDefault(require("./plugin-group-items"));
 const plugin_defn_fill_term_1 = __importDefault(require("./plugin-defn-fill-term"));
 const plugin_set_1 = __importDefault(require("./plugin-set"));
+const configPropagation_1 = require("./helpers/configPropagation");
 const plugin_tables_1 = __importDefault(require("./plugin-tables"));
 const plugin_data_table_1 = __importDefault(require("./plugin-data-table"));
 function toAst() {
@@ -162,6 +168,7 @@ function isValidateError(result, src) {
     }
     return undefined;
 }
+const configDefaults_plug = () => tree => (0, configPropagation_1.propagateConfigDefaults)(tree);
 function makeTree() {
     var plugins = [];
     chain.use = use;
@@ -173,6 +180,9 @@ function makeTree() {
     chain.use(plugin_defn_fill_term_1.default);
     chain.use(plugin_tables_1.default);
     chain.use(plugin_data_table_1.default);
+    // pre-configured attributes must sit on the blocks before markup codes are
+    // parsed, since :allow decides which of them are read at all
+    chain.use(configDefaults_plug);
     chain.use(plugin_formatting_codes_1.default);
     // save order for the next two plugins
     chain.use(plugin_group_items_1.default);
@@ -205,8 +215,8 @@ function makeTree() {
 }
 const parse = makeTree().parse;
 exports.parse = parse;
-var grammarfc_1 = require("./grammarfc");
-Object.defineProperty(exports, "parseFormattingCodes", { enumerable: true, get: function () { return grammarfc_1.parse; } });
+const parseFormattingCodes = (text, options = {}) => (0, grammarfc_1.parse)(text, { parseAttributes: parseAttributes_2.parseAttributes, ...options });
+exports.parseFormattingCodes = parseFormattingCodes;
 var exportHtml_1 = require("./exportHtml");
 Object.defineProperty(exports, "toHtml", { enumerable: true, get: function () { return __importDefault(exportHtml_1).default; } });
 var exportMarkdown_1 = require("./exportMarkdown");

package/lib/plugin-data-table.js

@@ -137,7 +137,11 @@ function processDataTable(node, tree) {
     if (renameMap) {
         rows = applyRename(rows, renameMap, hasHeader);
     }
-    const filledNode = { ...node, name: 'table', content: (0, plugin_tables_1.csvToTableContent)(rows, hasHeader) };
+    const filledNode = {
+        ...node,
+        name: 'table',
+        content: (0, plugin_tables_1.csvToTableContent)(rows, hasHeader, attrs.getAllValues('allow')),
+    };
     return (0, plugin_tables_1.normalizeCellCounts)(filledNode, 'data-table');
 }
 exports.default = () => tree => {

package/lib/plugin-formatting-codes.js

@@ -40,15 +40,16 @@ const fcparser = __importStar(require("./grammarfc"));
 const makeTransformer_1 = __importDefault(require("./helpers/makeTransformer"));
 const makeTransformer_2 = require("./helpers/makeTransformer");
 const config_1 = __importDefault(require("./helpers/config"));
+const parseAttributes_1 = require("./helpers/parseAttributes");
 const middle = () => tree => {
     const transformerBlocks = (0, makeTransformer_1.default)({
         ':para': (n, ctx, visiter) => {
             return (0, makeTransformer_1.default)({
                 ':text': (n, ctx) => {
-                    return fcparser.parse(n.value);
+                    return fcparser.parse(n.value, { parseAttributes: parseAttributes_1.parseAttributes });
                 },
                 ':verbatim': (n, ctx) => {
-                    return fcparser.parse(n.value);
+                    return fcparser.parse(n.value, { parseAttributes: parseAttributes_1.parseAttributes });
                 },
             })(n, { ...ctx });
             return n;
@@ -70,10 +71,13 @@ const middle = () => tree => {
                 return n;
             if (isVerbatimDefault && allowValues.length === 0)
                 return n;
+            // a cell built from data carries its own set; declared empty means no code acts
+            if (name === 'cell' && conf.exists('allow') && allowValues.length === 0)
+                return n;
             const allowed = allowValues.sort();
             const transformer = (0, makeTransformer_1.default)({
-                ':verbatim': (n, ctx) => fcparser.parse(n.value, { allowed }),
-                ':text': (n, ctx) => fcparser.parse(n.value, { allowed }),
+                ':verbatim': (n, ctx) => fcparser.parse(n.value, { allowed, parseAttributes: parseAttributes_1.parseAttributes }),
+                ':text': (n, ctx) => fcparser.parse(n.value, { allowed, parseAttributes: parseAttributes_1.parseAttributes }),
                 ':block': (n, ctx) => transformerBlocks(n, { ...ctx }),
             });
             return { ...n, content: transformer(n.content, { ...ctx }) };

package/lib/plugin-tables.d.ts

@@ -6,7 +6,7 @@ export declare function parseMimeType(raw: any): {
 };
 export declare function findDataBlockByKey(tree: any, key: any): any;
 export declare function extractDataText(dataNode: any): any;
-export declare function csvToTableContent(csvRows: any, hasHeader?: boolean): any;
+export declare function csvToTableContent(csvRows: any, hasHeader?: boolean, allow?: string[]): any;
 export declare function normalizeCellCounts(tableNode: any, source?: string): any;
 declare const _default: () => (tree: any) => any;
 export default _default;

package/lib/plugin-tables.js

@@ -178,13 +178,19 @@ function detectSourceReference(tableNode) {
         return null;
     return { scheme: m[1], target: m[2] };
 }
-function buildCellBlock(text) {
-    return {
+function buildCellBlock(text, allow) {
+    const block = {
         name: 'cell',
         type: 'block',
         margin: '',
         content: [{ type: 'text', value: text }],
     };
+    // a value read from data is not markup, so the cell carries the set of codes
+    // that may act inside it, empty unless the block declared :allow
+    if (allow) {
+        block.config = [{ name: 'allow', value: [...allow], type: 'array' }];
+    }
+    return block;
 }
 function buildRowBlock(cells, isHeader) {
     const block = {
@@ -204,9 +210,9 @@ function buildRowBlock(cells, isHeader) {
 // `:header`. Default behaviour leaves all rows unmarked, matching authors
 // who use a structured table with explicit `=begin row :header` or a
 // Markdown GFM table.
-function csvToTableContent(csvRows, hasHeader = false) {
+function csvToTableContent(csvRows, hasHeader = false, allow = []) {
     return csvRows.map((row, i) => {
-        const cells = row.map(v => buildCellBlock(v.trim()));
+        const cells = row.map(v => buildCellBlock(v.trim(), allow));
         return buildRowBlock(cells, hasHeader && i === 0);
     });
 }
@@ -468,7 +474,8 @@ exports.default = () => tree => {
                         return { ...node, content: [] };
                     }
                     const hasHeader = mimeParams.header === 'present';
-                    const filledNode = { ...node, content: csvToTableContent(rows, hasHeader) };
+                    const allow = (0, config_1.default)(node, {}).getAllValues('allow');
+                    const filledNode = { ...node, content: csvToTableContent(rows, hasHeader, allow) };
                     return normalizeCellCounts(filledNode, `table data:${ref.target}`);
                 }
                 // Rule 4: source not tabular → render as code block so content remains visible

package/lib/types.d.ts

@@ -216,12 +216,14 @@ export interface FormattingCodeL {
     type: 'fcode';
     name: 'L';
     meta: string | null;
+    config?: ConfigItem[];
     content: string | Text | [Text];
 }
 export interface FormattingCodeW {
     type: 'fcode';
     name: 'W';
     meta: string | null;
+    config?: ConfigItem[];
     content: string | Text | [Text];
 }
 export interface FormattingCodeI {

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.0.63";
+export declare const version = "0.0.64";

package/lib/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // generated by scripts/inject-version.mjs — do not edit by hand
-exports.version = '0.0.63';
+exports.version = '0.0.64';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podlite/schema",
-  "version": "0.0.63",
+  "version": "0.0.64",
   "description": "AST tools and schema for Podlite markup language — validate, traverse, and transform document trees",
   "main": "./lib/index.js",
   "sideEffects": false,

package/schema/AstTree.json

@@ -2238,6 +2238,12 @@
                         "string"
                     ]
                 },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ConfigItem"
+                    }
+                },
                 "content": {
                     "anyOf": [
                         {
@@ -2283,6 +2289,12 @@
                         "string"
                     ]
                 },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ConfigItem"
+                    }
+                },
                 "content": {
                     "anyOf": [
                         {

package/schema/PodliteDocument.json

@@ -2238,6 +2238,12 @@
                         "string"
                     ]
                 },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ConfigItem"
+                    }
+                },
                 "content": {
                     "anyOf": [
                         {
@@ -2283,6 +2289,12 @@
                         "string"
                     ]
                 },
+                "config": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ConfigItem"
+                    }
+                },
                 "content": {
                     "anyOf": [
                         {