@podlite/schema 0.0.66 → 0.0.67

package/lib/index.d.ts

@@ -87,7 +87,8 @@ export declare const parseFormattingCodes: (text: string, options?: {
 export { default as toHtml } from './exportHtml';
 export { default as toMarkdown } from './exportMarkdown';
 export { default as Writer } from './writer';
-export { parseSelector, runSelector } from './selectors';
+export { parseSelector, runSelector, filePathMatches } from './selectors';
+export { markGuarded, isCovered } from './guard';
 export type { SelectorDoc, ParsedSelector } from './selectors';
 export { applyImageBase } from './image-base';
 export { version } from './version';

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.readLinkConfig = exports.parseAttributes = exports.codeConfigWithDefaults = exports.makeAttrs = exports.toAny = exports.isSemanticBlock = exports.isNamedBlock = exports.makeTransformer = exports.makeInterator = void 0;
+exports.version = exports.applyImageBase = exports.isCovered = exports.markGuarded = exports.filePathMatches = 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;
@@ -226,6 +226,10 @@ Object.defineProperty(exports, "Writer", { enumerable: true, get: function () {
 var selectors_1 = require("./selectors");
 Object.defineProperty(exports, "parseSelector", { enumerable: true, get: function () { return selectors_1.parseSelector; } });
 Object.defineProperty(exports, "runSelector", { enumerable: true, get: function () { return selectors_1.runSelector; } });
+Object.defineProperty(exports, "filePathMatches", { enumerable: true, get: function () { return selectors_1.filePathMatches; } });
+var guard_1 = require("./guard");
+Object.defineProperty(exports, "markGuarded", { enumerable: true, get: function () { return guard_1.markGuarded; } });
+Object.defineProperty(exports, "isCovered", { enumerable: true, get: function () { return guard_1.isCovered; } });
 var image_base_1 = require("./image-base");
 Object.defineProperty(exports, "applyImageBase", { enumerable: true, get: function () { return image_base_1.applyImageBase; } });
 var version_1 = require("./version");

package/lib/pluggableParser.js

@@ -11,6 +11,7 @@ const corePlugins_1 = __importDefault(require("./helpers/corePlugins"));
 const configPropagation_1 = require("./helpers/configPropagation");
 const headingNumbering_1 = require("./helpers/headingNumbering");
 const itemNumbering_1 = require("./helpers/itemNumbering");
+const guard_1 = require("./guard");
 var ids_2 = require("./helpers/ids");
 Object.defineProperty(exports, "cleanIds", { enumerable: true, get: function () { return ids_2.cleanIds; } });
 Object.defineProperty(exports, "frozenIds", { enumerable: true, get: function () { return ids_2.frozenIds; } });
@@ -78,6 +79,7 @@ const podlitePluggable = ({ plugins = {} } = {}) => {
                 (0, configPropagation_1.propagateConfigDefaults)(resultAfter.interator);
                 (0, itemNumbering_1.promoteOrderedLists)(resultAfter.interator);
                 (0, headingNumbering_1.attachHeadingNumberPrefix)(resultAfter.interator);
+                (0, guard_1.markGuarded)(resultAfter.interator);
             }
             return resultAfter;
         }
@@ -85,6 +87,7 @@ const podlitePluggable = ({ plugins = {} } = {}) => {
             (0, configPropagation_1.propagateConfigDefaults)(result.interator);
             (0, itemNumbering_1.promoteOrderedLists)(result.interator);
             (0, headingNumbering_1.attachHeadingNumberPrefix)(result.interator);
+            (0, guard_1.markGuarded)(result.interator);
         }
         return result;
     };

package/lib/plugin-data-table.js

@@ -43,7 +43,8 @@ function resolveColumnIndex(col, headerRow, maxCols) {
     }
     const idx = headerRow.indexOf(col);
     if (idx === -1) {
-        throw new Error(`column name "${col}" not found in header`);
+        const names = headerRow.map(h => `"${h}"`).join(', ');
+        throw new Error(`column name "${col}" not found in header; header has ${names}`);
     }
     return idx;
 }

package/lib/plugin-tables.js

@@ -508,6 +508,9 @@ exports.default = (opt = {}) => tree => {
                     report('table-source-unreadable', `no =data block found for data:${ref.target}, table rendered as empty`, node);
                     return { ...node, content: [] };
                 }
+                // whatever is built out of a covered =data block is covered as well,
+                // otherwise the table is a way to read what the cover hides
+                const carryCover = built => (0, config_1.default)(dataBlock, {}).getFirstValue('masked') ? { ...built, guarded: true } : built;
                 const rawMime = (0, config_1.default)(dataBlock, {}).getFirstValue('mime-type');
                 const { type: mimeType, params: mimeParams } = parseMimeType(rawMime);
                 const isCsv = mimeType === 'text/csv';
@@ -522,11 +525,11 @@ exports.default = (opt = {}) => tree => {
                     const hasHeader = mimeParams.header === 'present';
                     const allow = (0, config_1.default)(node, {}).getAllValues('allow');
                     const filledNode = { ...node, content: csvToTableContent(rows, hasHeader, allow) };
-                    return normalizeCellCounts(filledNode, `table data:${ref.target}`, report);
+                    return carryCover(normalizeCellCounts(filledNode, `table data:${ref.target}`, report));
                 }
                 // Rule 4: source not tabular → render as code block so content remains visible
                 report('table-source-unreadable', `=data :key<${ref.target}> has non-tabular mime-type ${rawMime || '(none)'}, rendered as =code`, node);
-                return buildCodeFromDataBlock(node, dataBlock);
+                return carryCover(buildCodeFromDataBlock(node, dataBlock));
             }
             // structured mode: transform row children (wrap implicit cells), then
             // apply Rule 2 cell count normalization.

package/lib/selectors.d.ts

@@ -31,4 +31,5 @@ export type ParsedSelector = {
     patterns: Pattern[];
 };
 export declare const parseSelector: (selector: string) => ParsedSelector | undefined;
+export declare const filePathMatches: (docFile: string, target: string) => boolean;
 export declare const runSelector: <T extends SelectorDoc>(selector: string, docs: T[]) => T[] | PodNode[];

package/lib/selectors.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runSelector = exports.parseSelector = void 0;
+exports.runSelector = exports.filePathMatches = exports.parseSelector = void 0;
 const index_1 = require("./index");
+const parseAttributes_1 = require("./helpers/parseAttributes");
 // --- predicate parser ---------------------------------------------------
 const isIdentStart = (c) => /[a-zA-Z_]/.test(c);
 const isIdentCont = (c) => /[a-zA-Z0-9_-]/.test(c);
@@ -229,6 +230,39 @@ const parseSelector = (selector) => {
     return undefined;
 };
 exports.parseSelector = parseSelector;
+// The operand is read by the same grammar as a declaration: the delimiters
+// around it decide whether it is a string, a list or a number. Reading it as
+// raw text would put values out of reach that a document can hold — a quoted
+// string among them.
+const readOperand = (raw) => {
+    const [item] = (0, parseAttributes_1.parseAttributes)(`:x<${raw}>`);
+    return item ? { value: item.value, type: item.type } : undefined;
+};
+// The declared value with its kind kept. makeAttrs flattens a list into the
+// surrounding values, which loses the very thing equality compares.
+const declaredValue = (node, name, ctx) => {
+    const anyNode = node;
+    const own = (Array.isArray(anyNode.config) ? anyNode.config : []).find(c => c && c.name === name);
+    if (own)
+        return { value: own.value, type: own.type };
+    const configured = (anyNode.name && ctx.config?.[anyNode.name]) || [];
+    const inherited = configured.find(c => c && c.name === name);
+    return inherited ? { value: inherited.value, type: inherited.type } : undefined;
+};
+const sameScalar = (a, b) => typeof a === typeof b && a === b;
+// A list equals another list when their elements match one by one, in order; a
+// value of one kind never equals a value of another.
+const sameValue = (a, b) => {
+    if (Array.isArray(a.value) || Array.isArray(b.value)) {
+        if (!Array.isArray(a.value) || !Array.isArray(b.value))
+            return false;
+        return a.value.length === b.value.length && a.value.every((item, i) => sameScalar(item, b.value[i]));
+    }
+    return sameScalar(a.value, b.value);
+};
+// Membership runs over the values as declared. A string is one value, even
+// when it holds spaces, so a word taken from its middle is not a member.
+const valuesOf = (typed) => (Array.isArray(typed.value) ? typed.value : [typed.value]);
 const matchCondition = (node, cond, ctx) => {
     const attrs = (0, index_1.makeAttrs)(node, ctx);
     const exists = attrs.exists(cond.attrName);
@@ -244,30 +278,19 @@ const matchCondition = (node, cond, ctx) => {
                 return !exists;
         }
     }
+    const declared = declaredValue(node, cond.attrName, ctx);
+    const operand = readOperand(cond.valueSpec.value);
     if (cond.valueSpec.kind === 'angle') {
-        if (!exists)
+        if (!exists || !declared || !operand)
             return false;
-        const equal = String(attrs.getFirstValue(cond.attrName)) === cond.valueSpec.value;
+        const equal = sameValue(declared, operand);
         return cond.modifier === '!' ? !equal : equal;
     }
     if (cond.valueSpec.kind === 'contains') {
-        if (!exists)
+        if (!exists || !declared || !operand)
             return false;
-        // Author-facing semantics: `:tags<a b c>` is a list of three elements.
-        // Grammar parses unquoted identifier sequences as a single string, so
-        // split string values on whitespace/comma to recover list shape.
-        const tokens = [];
-        for (const v of attrs.getAllValues(cond.attrName)) {
-            if (typeof v === 'string') {
-                for (const t of v.split(/[\s,]+/))
-                    if (t)
-                        tokens.push(t);
-            }
-            else {
-                tokens.push(String(v));
-            }
-        }
-        const present = tokens.includes(cond.valueSpec.value);
+        const values = valuesOf(declared);
+        const present = valuesOf(operand).every(wanted => values.some(held => sameScalar(held, wanted)));
         return cond.modifier === '!' ? !present : present;
     }
     return false;
@@ -388,6 +411,7 @@ const filePathMatches = (docFile, target) => {
     }
     return a === b || a.endsWith('/' + b) || b.endsWith('/' + a);
 };
+exports.filePathMatches = filePathMatches;
 const getDocIDs = (doc) => {
     const ids = [];
     (0, index_1.getFromTree)(doc.node, 'NAME', 'TITLE').forEach(block => {
@@ -421,7 +445,7 @@ const runSelector = (selector, docs) => {
         matchedDocs = docs.filter(doc => getDocIDs(doc).includes(document));
     }
     else if (scheme === 'file' && document) {
-        matchedDocs = docs.filter(doc => filePathMatches(doc.file, document));
+        matchedDocs = docs.filter(doc => (0, exports.filePathMatches)(doc.file, document));
     }
     else if (scheme && scheme !== 'doc' && scheme !== 'file') {
         return [];

package/lib/types.d.ts

@@ -246,10 +246,12 @@ export interface Ambient {
 export interface Verbatim {
     type: 'verbatim';
     value: string;
+    guarded?: boolean;
 }
 export interface Text {
     type: 'text';
     value: string;
+    guarded?: boolean;
 }
 export interface Para {
     type: 'para';
@@ -309,6 +311,7 @@ export interface Block {
     margin: string;
     config?: Array<ConfigItem | BrokenConfigItem>;
     id?: string;
+    guarded?: boolean;
 }
 export interface BlockPod extends Block {
     name: 'pod';

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.0.66";
+export declare const version = "0.0.67";

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.66';
+exports.version = '0.0.67';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podlite/schema",
-  "version": "0.0.66",
+  "version": "0.0.67",
   "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

@@ -244,6 +244,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -394,6 +397,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -446,6 +452,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -465,6 +474,9 @@
                 },
                 "value": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -510,6 +522,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -570,6 +585,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -618,6 +636,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -666,6 +687,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -714,6 +738,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -762,6 +789,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -810,6 +840,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -864,6 +897,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -913,6 +949,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -961,6 +1000,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1159,6 +1201,9 @@
                 },
                 "value": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1275,6 +1320,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1323,6 +1371,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1408,6 +1459,9 @@
                 "type": {
                     "type": "string",
                     "const": "block"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1488,6 +1542,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1674,6 +1731,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1777,6 +1837,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1838,6 +1901,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [
@@ -1899,6 +1965,9 @@
                 },
                 "id": {
                     "type": "string"
+                },
+                "guarded": {
+                    "type": "boolean"
                 }
             },
             "required": [