@podlite/schema 0.0.67 → 0.0.68

package/lib/helpers/corePlugins.js

@@ -2,14 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.core = void 0;
 const __1 = require("..");
+const ast_helpers_1 = require("../ast-helpers");
+const html_attr_1 = require("./html-attr");
 exports.core = {
     ':image': {
         toHtml: writer => node => {
             if (typeof node !== 'string' && 'type' in node && node.type === 'image') {
                 writer.writeRaw(`<img`);
-                writer.writeRaw(` src="${node.src}"`);
-                if (node.alt) {
-                    writer.writeRaw(` alt="${node.alt}"`);
+                writer.writeRaw(` src="${(0, html_attr_1.quoteAttribute)(String(node.src ?? ''))}"`);
+                // html reads a missing alt as "this image is part of the content" and an
+                // empty one as "decorative", so an alternative text the author never wrote
+                // is left out
+                const alt = (0, ast_helpers_1.writtenValue)(node.alt);
+                if (alt !== undefined) {
+                    writer.writeRaw(` alt="${(0, html_attr_1.quoteAttribute)(alt)}"`);
                 }
                 writer.writeRaw(`/>`);
             }

package/lib/helpers/html-attr.d.ts

@@ -0,0 +1 @@
+export declare const quoteAttribute: (value: string) => string;

package/lib/helpers/html-attr.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quoteAttribute = void 0;
+// The value of an attribute written inside double quotes. The ampersand goes
+// first: escaping it after the quote would rewrite the `"` this produced. A
+// value arrives as document text, so every `&` in it is a literal one the
+// browser must not read as a character reference.
+const quoteAttribute = (value) => value.replace(/&/g, '&').replace(/"/g, '"');
+exports.quoteAttribute = quoteAttribute;
+//# sourceMappingURL=html-attr.js.map

package/lib/index.d.ts

@@ -4,6 +4,7 @@ export { PodliteDocument } from './types';
 export { AstTree } from './types';
 export * from './types';
 export * from './block-names';
+export * from './attribute-names';
 export * from './blocks-helpers';
 export * from './query-helpers';
 export * from './ast-helpers';
@@ -14,10 +15,11 @@ export { toAny } from './exportAny';
 export { makeAttrs, codeConfigWithDefaults } from './helpers/config';
 export { parseAttributes } from './helpers/parseAttributes';
 export { readLinkConfig } from './helpers/link-config';
+export { quoteAttribute } from './helpers/html-attr';
 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';
+export { podlitePluggable, Podlite, PodliteExport, cleanIds, frozenIds, headingId } from './pluggableParser';
 export declare function toAst(): {};
 export type SchemaValidationError = ErrorObject<string, Record<string, any>>;
 export declare function getTextContentFromNode(node: PodNode): string;
@@ -89,6 +91,7 @@ export { default as toMarkdown } from './exportMarkdown';
 export { default as Writer } from './writer';
 export { parseSelector, runSelector, filePathMatches } from './selectors';
 export { markGuarded, isCovered } from './guard';
+export { applyFoldedSections } from './folded-sections';
 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.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.version = exports.applyImageBase = exports.applyFoldedSections = exports.isCovered = exports.markGuarded = exports.filePathMatches = exports.runSelector = exports.parseSelector = exports.Writer = exports.toMarkdown = exports.toHtml = exports.parseFormattingCodes = exports.parse = exports.headingId = exports.frozenIds = exports.cleanIds = exports.podlitePluggable = exports.toAnyRules = exports.pluginCleanLocation = exports.quoteAttribute = 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;
@@ -55,6 +55,7 @@ const jsonShemes = __importStar(require("../schema"));
 const ast_inerator_1 = require("./ast-inerator");
 __exportStar(require("./types"), exports);
 __exportStar(require("./block-names"), exports);
+__exportStar(require("./attribute-names"), exports);
 __exportStar(require("./blocks-helpers"), exports);
 __exportStar(require("./query-helpers"), exports);
 __exportStar(require("./ast-helpers"), exports);
@@ -74,6 +75,8 @@ 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 html_attr_1 = require("./helpers/html-attr");
+Object.defineProperty(exports, "quoteAttribute", { enumerable: true, get: function () { return html_attr_1.quoteAttribute; } });
 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");
@@ -82,6 +85,7 @@ var pluggableParser_1 = require("./pluggableParser");
 Object.defineProperty(exports, "podlitePluggable", { enumerable: true, get: function () { return pluggableParser_1.podlitePluggable; } });
 Object.defineProperty(exports, "cleanIds", { enumerable: true, get: function () { return pluggableParser_1.cleanIds; } });
 Object.defineProperty(exports, "frozenIds", { enumerable: true, get: function () { return pluggableParser_1.frozenIds; } });
+Object.defineProperty(exports, "headingId", { enumerable: true, get: function () { return pluggableParser_1.headingId; } });
 const parser = __importStar(require("./grammar"));
 const grammarfc_1 = require("./grammarfc");
 const parseAttributes_2 = require("./helpers/parseAttributes");
@@ -230,6 +234,8 @@ Object.defineProperty(exports, "filePathMatches", { enumerable: true, get: funct
 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 folded_sections_1 = require("./folded-sections");
+Object.defineProperty(exports, "applyFoldedSections", { enumerable: true, get: function () { return folded_sections_1.applyFoldedSections; } });
 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.d.ts

@@ -1,5 +1,5 @@
 import { Plugins, PodliteDocument, parseOpt } from '.';
-export { cleanIds, frozenIds } from './helpers/ids';
+export { cleanIds, frozenIds, headingId } from './helpers/ids';
 export interface podlitePluggableOpt {
     plugins?: Plugins;
 }

package/lib/pluggableParser.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.podlitePluggable = exports.frozenIds = exports.cleanIds = void 0;
+exports.podlitePluggable = exports.headingId = exports.frozenIds = exports.cleanIds = void 0;
 const _1 = require(".");
 const exportMarkdown_1 = __importDefault(require("./exportMarkdown"));
 const ids_1 = __importDefault(require("./helpers/ids"));
@@ -12,9 +12,11 @@ const configPropagation_1 = require("./helpers/configPropagation");
 const headingNumbering_1 = require("./helpers/headingNumbering");
 const itemNumbering_1 = require("./helpers/itemNumbering");
 const guard_1 = require("./guard");
+const folded_sections_1 = require("./folded-sections");
 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; } });
+Object.defineProperty(exports, "headingId", { enumerable: true, get: function () { return ids_2.headingId; } });
 const podlitePluggable = ({ plugins = {} } = {}) => {
     let instance = function () { };
     let _plugins = [];
@@ -80,6 +82,7 @@ const podlitePluggable = ({ plugins = {} } = {}) => {
                 (0, itemNumbering_1.promoteOrderedLists)(resultAfter.interator);
                 (0, headingNumbering_1.attachHeadingNumberPrefix)(resultAfter.interator);
                 (0, guard_1.markGuarded)(resultAfter.interator);
+                resultAfter.interator = (0, folded_sections_1.applyFoldedSections)(resultAfter.interator);
             }
             return resultAfter;
         }
@@ -88,6 +91,7 @@ const podlitePluggable = ({ plugins = {} } = {}) => {
             (0, itemNumbering_1.promoteOrderedLists)(result.interator);
             (0, headingNumbering_1.attachHeadingNumberPrefix)(result.interator);
             (0, guard_1.markGuarded)(result.interator);
+            result.interator = (0, folded_sections_1.applyFoldedSections)(result.interator);
         }
         return result;
     };

package/lib/types.d.ts

@@ -100,11 +100,16 @@ export interface Image {
     alt?: string;
     link?: string;
 }
+export interface ParaBuilt {
+    type: 'para';
+    content: Array<Node | FormattingCodes>;
+}
 export interface Toc {
     type: 'toc';
     title?: string;
     folded?: boolean;
     foldedLevels?: Record<number, boolean>;
+    location?: Location;
     content: TocList;
 }
 export interface TocList {
@@ -114,8 +119,8 @@ export interface TocList {
 }
 export interface TocItem {
     type: 'toc-item';
-    node: PodNode;
-    content: Array<Node>;
+    node: PodNode | ParaBuilt;
+    content: Array<Node | ParaBuilt>;
 }
 export interface BlockImage extends Omit<Block, 'content'> {
     name: 'image';
@@ -152,7 +157,7 @@ export interface FormattingCodeB {
 export interface FormattingCodeC {
     type: 'fcode';
     name: 'C';
-    content?: Array<FormattingCodes | string>;
+    content?: Array<Node>;
 }
 export interface FormattingCodeE {
     type: 'fcode';
@@ -179,23 +184,23 @@ export interface FormattingCodeF {
 export interface FormattingCodeN {
     type: 'fcode';
     name: 'N';
-    content?: Array<FormattingCodes | string>;
+    content?: Array<Node>;
 }
 export interface FormattingCodeX {
     type: 'fcode';
     name: 'X';
     entry: Array<string> | null;
-    content?: Array<FormattingCodes | string>;
+    content?: Array<Node>;
 }
 export interface FormattingCodeZ {
     type: 'fcode';
     name: 'Z';
-    content?: string;
+    content?: string | Text;
 }
 export interface FormattingCodeV {
     type: 'fcode';
     name: 'V';
-    content?: string;
+    content?: string | Text;
 }
 export interface FormattingCodeS {
     type: 'fcode';
@@ -211,7 +216,7 @@ export interface FormattingCodeD {
     type: 'fcode';
     name: 'D';
     synonyms: Array<string>;
-    content: string;
+    content: Array<Node>;
 }
 export interface FormattingCodeL {
     type: 'fcode';
@@ -225,18 +230,18 @@ export interface FormattingCodeW {
     name: 'W';
     meta: string | null;
     config?: ConfigItem[];
-    content: string | Text | [Text];
+    content: Array<Node>;
 }
 export interface FormattingCodeI {
     type: 'fcode';
     name: 'I';
-    meta: string;
-    content: string | Text;
+    meta?: string;
+    content: Array<Node>;
 }
 export interface FormattingCodeAny {
     type: 'fcode';
     name: string;
-    content?: Array<FormattingCodes | string>;
+    content?: Array<Node>;
 }
 export interface Ambient {
     type: 'ambient';
@@ -260,6 +265,12 @@ export interface Para {
     location: Location;
     content: Array<Node | FormattingCodes>;
 }
+export interface ParaTerm {
+    type: 'para';
+    name: 'term';
+    text: string;
+    content: Array<Node | FormattingCodes>;
+}
 export interface Code {
     type: 'code';
     text: string;
@@ -273,8 +284,8 @@ export interface BlankLine {
 export interface List {
     type: 'list';
     level: string | number;
-    content: Array<BlockItem | BlankLine | List>;
-    list: 'itemized';
+    content: Array<BlockItem | BlockDefn | BlankLine | List>;
+    list: 'itemized' | 'task' | 'variable';
 }
 export interface ConfigItemKV {
     [key: string]: string | number | boolean;
@@ -387,7 +398,7 @@ export interface TableSeparator {
 export type BlockAny = BlockNamed;
 export interface BlockNamed extends Omit<Block, 'content'> {
     name: string;
-    content: [(Verbatim | Para | Code)?] | Array<Image | BlockCaption> | RootBlock;
+    content: Array<Node> | RootBlock;
 }
 export interface BlockDiagram extends Omit<BlockNamed, 'content'> {
     name: 'Diagram';
@@ -408,7 +419,7 @@ export interface BlockFormula extends Omit<BlockNamed, 'content'> {
     content: [Verbatim];
 }
 export type FormattingCodes = FormattingCodeA | FormattingCodeC | FormattingCodeB | FormattingCodeD | FormattingCodeE | FormattingCodeF | FormattingCodeI | FormattingCodeL | FormattingCodeW | FormattingCodeN | FormattingCodeX | FormattingCodeZ | FormattingCodeV | FormattingCodeS | FormattingCodeAny;
-export type PodNode = Ambient | BlockPod | BlockData | BlockFormula | BlockCode | BlankLine | BlockNested | BlockMarkdown | BlockOutput | BlockInput | BlockInclude | 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 type PodNode = Ambient | BlockPod | BlockData | BlockFormula | BlockCode | BlankLine | BlockNested | BlockMarkdown | BlockOutput | BlockInput | BlockInclude | BlockPara | BlockHead | BlockComment | BlockDefn | string | Para | ParaTerm | ParaBuilt | Text | Code | BlockNamed | BlockAny | Verbatim | BlockTable | List | BlockConfig | BlockItem | Alias | BlockToc | BlockPicture | BlockImage | Image | RootBlock | Separator | BlockCaption | FormattingCodes | Toc;
 export type Node = PodNode;
 export type AstTree = Array<PodNode>;
 export type PodliteDocument = RootBlock;

package/lib/version.d.ts

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

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

package/package.json

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