@stxt-lang/core 0.6.3 → 0.7.0

package/out/runtime/NodeWriter.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeWriter = exports.IndentStyle = void 0;
+const InlineNode_1 = require("../core/InlineNode");
+const TextNode_1 = require("../core/TextNode");
 /** Indentation style to use when writing. */
 var IndentStyle;
 (function (IndentStyle) {
@@ -21,7 +23,7 @@ class NodeWriter {
      */
     static toSTXT(node, style = IndentStyle.TABS) {
         const out = [];
-        NodeWriter.writeNode(out, node, 0, style, "");
+        NodeWriter.writeNode(out, node, 0, style);
         return out.join("");
     }
     /**
@@ -37,34 +39,36 @@ class NodeWriter {
             if (i > 0) {
                 out.push("\n");
             }
-            NodeWriter.writeNode(out, docs[i], 0, style, "");
+            NodeWriter.writeNode(out, docs[i], 0, style);
         }
         return out.join("");
     }
-    static writeNode(out, n, depth, style, parentNs) {
+    static writeNode(out, n, depth, style) {
         NodeWriter.indent(out, depth, style);
-        const ns = n.getNamespace();
+        // The namespace is written where the node declares it; inherited ones are implicit,
+        // exactly as in the source (the effective namespace is the same either way)
+        const ns = n.getDeclaredNamespace();
         out.push(n.getName());
-        if (ns.length > 0 && ns !== parentNs) {
+        if (ns.length > 0) {
             out.push(" (", ns, ")");
         }
-        if (n.isTextNode()) {
+        if (n instanceof TextNode_1.TextNode) {
             out.push(" >>\n");
             for (const line of n.getTextLines()) {
                 NodeWriter.indent(out, depth + 1, style);
                 out.push(line, "\n");
             }
         }
-        else {
+        else if (n instanceof InlineNode_1.InlineNode) {
             out.push(":");
             const value = n.getValue();
             if (value.length > 0) {
                 out.push(" ", value);
             }
             out.push("\n");
-        }
-        for (const child of n.getChildren()) {
-            NodeWriter.writeNode(out, child, depth + 1, style, ns);
+            for (const child of n.getChildren()) {
+                NodeWriter.writeNode(out, child, depth + 1, style);
+            }
         }
     }
     static indent(out, depth, style) {

package/out/runtime/TreeJson.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toCanonicalTree = toCanonicalTree;
 exports.toCanonicalJson = toCanonicalJson;
+const TextNode_1 = require("../core/TextNode");
 /**
  * Converts every root node of a parsed document to the logical tree defined by
  * STXT-TREE-SPEC. The result deliberately excludes source positions, indentation
@@ -25,22 +26,23 @@ function toCanonicalJson(nodes) {
     return JSON.stringify(toCanonicalTree(nodes), null, 2);
 }
 function toCanonicalNode(node) {
-    if (node.isTextNode()) {
+    if (node instanceof TextNode_1.TextNode) {
         return {
             name: node.getName(),
-            canonicalName: node.getNormalizedName(),
+            canonicalName: node.getCanonicalName(),
             namespace: node.getNamespace(),
             form: "block",
             lines: [...node.getTextLines()],
         };
     }
+    const inline = node;
     return {
-        name: node.getName(),
-        canonicalName: node.getNormalizedName(),
-        namespace: node.getNamespace(),
+        name: inline.getName(),
+        canonicalName: inline.getCanonicalName(),
+        namespace: inline.getNamespace(),
         form: "inline",
-        value: node.getValue(),
-        children: node.getChildren().map(child => toCanonicalNode(child)),
+        value: inline.getValue(),
+        children: inline.getChildren().map(child => toCanonicalNode(child)),
     };
 }
 //# sourceMappingURL=TreeJson.js.map

package/out/schema/ChildDefinition.d.ts

@@ -19,6 +19,11 @@ export declare class ChildDefinition {
     /** @returns the name of the expected child, as it appears in the schema. */
     getName(): string;
     /** @returns the canonical name of the expected child. */
+    getCanonicalName(): string;
+    /**
+     * @returns the canonical name of the expected child.
+     * @deprecated since 0.7.0, use getCanonicalName().
+     */
     getNormalizedName(): string;
     /** @returns the namespace of the expected child, or the empty string if it has none. */
     getNamespace(): string;

package/out/schema/ChildDefinition.js

@@ -32,6 +32,13 @@ class ChildDefinition {
         return this.name;
     }
     /** @returns the canonical name of the expected child. */
+    getCanonicalName() {
+        return this.normalizedName;
+    }
+    /**
+     * @returns the canonical name of the expected child.
+     * @deprecated since 0.7.0, use getCanonicalName().
+     */
     getNormalizedName() {
         return this.normalizedName;
     }

package/out/schema/NodeDefinition.d.ts

@@ -23,6 +23,11 @@ export declare class NodeDefinition {
     /** @returns the name of the node, as it appears in the schema. */
     getName(): string;
     /** @returns the canonical name of the node. */
+    getCanonicalName(): string;
+    /**
+     * @returns the canonical name of the node.
+     * @deprecated since 0.7.0, use getCanonicalName().
+     */
     getNormalizedName(): string;
     /** @returns the name of the value type of this node (see {@link TypeRegistry}). */
     getType(): string;

package/out/schema/NodeDefinition.js

@@ -33,6 +33,13 @@ class NodeDefinition {
         return this.name;
     }
     /** @returns the canonical name of the node. */
+    getCanonicalName() {
+        return this.normalizedName;
+    }
+    /**
+     * @returns the canonical name of the node.
+     * @deprecated since 0.7.0, use getCanonicalName().
+     */
     getNormalizedName() {
         return this.normalizedName;
     }

package/out/schema/Schema.js

@@ -40,7 +40,7 @@ class Schema {
      * @throws ValidationException with code `NODE_DEF_ALREADY_DEFINED` if there already was a node definition with the same name.
      */
     addNodeDefinition(nodeDefinition) {
-        const qname = nodeDefinition.getNormalizedName();
+        const qname = nodeDefinition.getCanonicalName();
         if (this.nodes.has(qname)) {
             throw new ValidationException_1.ValidationException(0, "NODE_DEF_ALREADY_DEFINED", `Exists a previous node definition with: ${qname}`);
         }

package/out/schema/SchemaParser.js

@@ -4,6 +4,7 @@ exports.transformNodeToSchema = transformNodeToSchema;
 const Schema_1 = require("./Schema");
 const NodeDefinition_1 = require("./NodeDefinition");
 const ChildDefinition_1 = require("./ChildDefinition");
+const InlineNode_1 = require("../core/InlineNode");
 const ValidationException_1 = require("../exceptions/ValidationException");
 const RuntimeException_1 = require("../exceptions/RuntimeException");
 const NameNamespaceParser_1 = require("../core/NameNamespaceParser");
@@ -17,34 +18,30 @@ const TypeRegistry_1 = require("./TypeRegistry");
  */
 function transformNodeToSchema(node) {
     // Node name
-    const nodeName = node.getNormalizedName();
+    const nodeName = node.getCanonicalName();
     const namespaceSchema = node.getNamespace();
     // Get the name and the namespace
     if (nodeName !== "schema" || namespaceSchema !== Schema_1.Schema.SCHEMA_NAMESPACE) {
         throw new ValidationException_1.ValidationException(node.getLine(), "NOT_STXT_SCHEMA", `Expected schema(${Schema_1.Schema.SCHEMA_NAMESPACE}) but got ${nodeName}(${namespaceSchema})`);
     }
+    const root = inline(node);
     // Get the description
-    const descrip = node.getChild("description")?.getText();
-    const schema = new Schema_1.Schema(node.getValue(), node.getLine(), descrip);
+    const descrip = root.getChild("description")?.getText();
+    const schema = new Schema_1.Schema(root.getValue(), root.getLine(), descrip);
     // Used to check that every child is defined
     const allNames = new Set();
     // Get the nodes
-    for (const n of node.getChildrenByName("node")) {
+    for (const n of root.getChildrenByName("node")) {
         const schNode = createFrom(n, schema.getNamespace());
         schema.addNodeDefinition(schNode);
-        allNames.add(schNode.getNormalizedName());
+        allNames.add(schNode.getCanonicalName());
     }
     // Check that every name is defined
     for (const schNode of schema.getNodes().values()) {
         for (const schChild of schNode.getChildren().values()) {
             // Only names of the same namespace are checked
             if (schChild.getNamespace() === schema.getNamespace()) {
-                // Defensive leftover from the Java port: ChildDefinition does expose
-                // getNormalizedName(), so this check can never fail with the current class.
-                const childNorm = schChild.getNormalizedName?.();
-                if (!childNorm) {
-                    throw new RuntimeException_1.RuntimeException("CHILD_DEFINITION_API_MISMATCH", "ChildDefinition.getNormalizedName() is missing in TypeScript version. Add it to ChildDefinition.");
-                }
+                const childNorm = schChild.getCanonicalName();
                 if (!allNames.has(childNorm)) {
                     throw new ValidationException_1.ValidationException(0, "CHILD_NOT_DEFINED", `Child ${childNorm} not defined in ${schema.getNamespace()}`);
                 }
@@ -53,13 +50,21 @@ function transformNodeToSchema(node) {
     }
     return schema;
 }
+/** The schema language is written with inline nodes; anything else is not a schema. */
+function inline(node) {
+    if (node instanceof InlineNode_1.InlineNode) {
+        return node;
+    }
+    throw new ValidationException_1.ValidationException(node.getLine(), "INVALID_SCHEMA", `Node '${node.getName()}' must be inline in a schema`);
+}
 /** Builds the definition of a node from a `Node:` entry of the schema document. */
-function createFrom(n, namespace) {
+function createFrom(node, namespace) {
+    const n = inline(node);
     const name = n.getValue();
     let type = "INLINE";
     const typeNode = n.getChild("type");
     if (typeNode) {
-        type = typeNode.getValue();
+        type = typeNode.getText();
     }
     const description = n.getChild("description")?.getText();
     const result = new NodeDefinition_1.NodeDefinition(name, type, n.getLine(), description);
@@ -69,7 +74,7 @@ function createFrom(n, namespace) {
         if (!TypeRegistry_1.TypeRegistry.admitsChildren(type)) {
             throw new ValidationException_1.ValidationException(children.getLine(), "CHILDREN_NOT_ALLOWED_FOR_TYPE", `Type ${type} does not allow children (node ${name})`);
         }
-        for (const child of children.getChildrenByName("child")) {
+        for (const child of inline(children).getChildrenByName("child")) {
             putChildToSchemaNode(result, child, namespace);
         }
     }
@@ -83,9 +88,9 @@ function createFrom(n, namespace) {
             throw new RuntimeException_1.RuntimeException("INVALID_SIZE_VALUES", `Unexpected number of values: ${valuesNodes.length}`);
         }
         const valuesNode = valuesNodes[0];
-        const values = valuesNode.getChildrenByName("value");
+        const values = inline(valuesNode).getChildrenByName("value");
         for (const v of values) {
-            result.addValue(v.getValue(), v.getLine());
+            result.addValue(v.getText(), v.getLine());
         }
         // For the final ENUM check
         valuesNodes = values;
@@ -97,7 +102,8 @@ function createFrom(n, namespace) {
     return result;
 }
 /** Adds to a node definition the expected child a `Child:` entry declares. */
-function putChildToSchemaNode(schemaNode, child, defNamespace) {
+function putChildToSchemaNode(schemaNode, childNode, defNamespace) {
+    const child = inline(childNode);
     // Get the name and the namespace
     const ns = NameNamespaceParser_1.NameNamespaceParser.parse(child.getValue(), defNamespace, child.getLine(), child.getValue());
     const name = ns.getName();
@@ -117,7 +123,7 @@ function getInteger(node, name) {
     if (!n) {
         return null;
     }
-    const raw = n.getValue();
+    const raw = n.getText();
     const parsed = Number.parseInt(raw, 10);
     if (Number.isNaN(parsed)) {
         throw new ValidationException_1.ValidationException(node.getLine(), "INVALID_INTEGER", `Integer not valid: ${raw}`);

package/out/schema/SchemaValidator.d.ts

@@ -29,6 +29,7 @@ export declare class SchemaValidator implements Validator {
      * @returns the validation errors found, empty if the node is valid.
      */
     validateAgainstSchema(node: Node, schema: Schema): ValidationException[];
+    private static childrenOf;
     private static validateChildrenDeclared;
     private static validateValue;
     private static validateCount;

package/out/schema/SchemaValidator.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaValidator = void 0;
+const InlineNode_1 = require("../core/InlineNode");
 const ValidationException_1 = require("../exceptions/ValidationException");
 const TypeRegistry_1 = require("./TypeRegistry");
 /** {@link Validator} that, for each node, resolves its {@link Schema} through a {@link SchemaProvider} and validates type and cardinality. */
@@ -32,8 +33,8 @@ class SchemaValidator {
         }
         // Validate the node
         errors.push(...this.validateAgainstSchema(node, schema));
-        // Validate the children
-        if (this.recursiveValidation) {
+        // Validate the children (only an inline node has any)
+        if (this.recursiveValidation && node instanceof InlineNode_1.InlineNode) {
             for (const childNode of node.getChildren()) {
                 errors.push(...this.validate(childNode));
             }
@@ -49,9 +50,9 @@ class SchemaValidator {
      */
     validateAgainstSchema(node, schema) {
         const errors = [];
-        const schemaNode = schema.getNodeDefinition(node.getNormalizedName());
+        const schemaNode = schema.getNodeDefinition(node.getCanonicalName());
         if (!schemaNode) {
-            const error = `NOT EXIST NODE ${node.getNormalizedName()} for namespace ${schema.getNamespace()}`;
+            const error = `NOT EXIST NODE ${node.getCanonicalName()} for namespace ${schema.getNamespace()}`;
             errors.push(new ValidationException_1.ValidationException(node.getLine(), "NODE_NOT_EXIST_IN_SCHEMA", error));
             return errors;
         }
@@ -60,11 +61,15 @@ class SchemaValidator {
         errors.push(...SchemaValidator.validateCount(schemaNode, node));
         return errors;
     }
+    // The children of a node for the purposes of the content model: a text node has none
+    static childrenOf(node) {
+        return node instanceof InlineNode_1.InlineNode ? node.getChildren() : [];
+    }
     // Closed content model (STXT-SCHEMA-SPEC, section 6): only the direct children declared
     // in the definition of the parent are allowed; with no Children, nothing is
     static validateChildrenDeclared(nodeDef, node) {
         const errors = [];
-        for (const child of node.getChildren()) {
+        for (const child of SchemaValidator.childrenOf(node)) {
             if (!nodeDef.getChildren().has(child.getQualifiedName())) {
                 errors.push(new ValidationException_1.ValidationException(child.getLine(), "CHILD_NOT_DECLARED", `Child '${child.getQualifiedName()}' not declared in node '${node.getQualifiedName()}'`));
             }
@@ -99,7 +104,7 @@ class SchemaValidator {
         const errors = [];
         const count = new Map();
         const childrenByType = new Map();
-        for (const child of node.getChildren()) {
+        for (const child of SchemaValidator.childrenOf(node)) {
             const childName = child.getQualifiedName();
             count.set(childName, (count.get(childName) ?? 0) + 1);
             if (!childrenByType.has(childName)) {

package/out/schema/type/ENUM.js

@@ -12,7 +12,7 @@ exports.ENUM = {
         if (node.isTextNode()) {
             throw new ValidationException_1.ValidationException(node.getLine(), "NOT_ALLOWED_TEXT", `Not allowed text in node ${node.getQualifiedName()}`);
         }
-        const value = node.getValue();
+        const value = node.getText();
         const allowed = nodeDef.getValues(); // ReadonlySet<string>
         if (!nodeDef.isAllowedValue(value)) {
             throw new ValidationException_1.ValidationException(node.getLine(), "INVALID_VALUE", `The value '${value}' not allowed. Only: ${Array.from(allowed).join(", ")}`);

package/out/schema/type/GROUP.js

@@ -9,7 +9,7 @@ exports.GROUP = {
     },
     validate(nodeDef, node) {
         // NONE value form (STXT-SCHEMA-SPEC 9.2): neither an inline value nor a '>>' block
-        if (node.getValue().length > 0 || node.isTextNode()) {
+        if (node.isTextNode() || node.getText().length > 0) {
             throw new ValidationException_1.ValidationException(node.getLine(), "INVALID_VALUE", `Node '${node.getName()}' has to be empty`);
         }
     },

package/out/schema/type/MARKDOWN.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MARKDOWN = void 0;
+const InlineNode_1 = require("../../core/InlineNode");
 const ValidationException_1 = require("../../exceptions/ValidationException");
 /**
  * `MARKDOWN` type. STXT-SCHEMA-SPEC 9.7: for validation purposes it is equivalent to TEXT
@@ -11,7 +12,7 @@ exports.MARKDOWN = {
         return "MARKDOWN";
     },
     validate(nodeDef, node) {
-        if (node.getChildren().length > 0) {
+        if (node instanceof InlineNode_1.InlineNode && node.getChildren().length > 0) {
             throw new ValidationException_1.ValidationException(node.getLine(), "NOT_ALLOWED_CHILDREN_TEXT", `Not allowed children nodes in node ${node.getQualifiedName()}`);
         }
     },

package/out/schema/type/TEXT.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TEXT = void 0;
+const InlineNode_1 = require("../../core/InlineNode");
 const ValidationException_1 = require("../../exceptions/ValidationException");
 /** `TEXT` type: free text node, with no children allowed. */
 exports.TEXT = {
@@ -8,7 +9,7 @@ exports.TEXT = {
         return "TEXT";
     },
     validate(nodeDef, node) {
-        if (node.getChildren().length > 0) {
+        if (node instanceof InlineNode_1.InlineNode && node.getChildren().length > 0) {
             throw new ValidationException_1.ValidationException(node.getLine(), "NOT_ALLOWED_CHILDREN_TEXT", `Not allowed children nodes in node ${node.getQualifiedName()}`);
         }
     },

package/out/schema/type/URL.js

@@ -12,7 +12,7 @@ exports.URL = {
         if (n.isTextNode()) {
             throw new ValidationException_1.ValidationException(n.getLine(), "NOT_ALLOWED_TEXT", `Not allowed text in node ${n.getQualifiedName()}`);
         }
-        const url = n.getValue();
+        const url = n.getText();
         try {
             const parsed = new globalThis.URL(url);
             const ok = !!parsed.protocol && !!parsed.hostname;

package/out/schema/type/binaryValue.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.binaryValue = binaryValue;
+const TextNode_1 = require("../../core/TextNode");
 /**
  * STXT-SCHEMA-SPEC 9.5: effective value for the INLINE/BLOCK binary types
  * (HEXADECIMAL, BINARY, BASE64). In BLOCK form, validation applies to the
@@ -11,8 +12,8 @@ exports.binaryValue = binaryValue;
  * @returns the inline value, or the lines of the block already concatenated.
  */
 function binaryValue(node) {
-    if (!node.isTextNode()) {
-        return node.getValue();
+    if (!(node instanceof TextNode_1.TextNode)) {
+        return node.getText();
     }
     return node.getTextLines().map((line) => line.trim()).join("");
 }

package/out/template/TemplateParser.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformTemplateNodeToSchema = transformTemplateNodeToSchema;
+const InlineNode_1 = require("../core/InlineNode");
 const Parser_1 = require("../core/Parser");
 const ValidationException_1 = require("../exceptions/ValidationException");
 const ChildDefinition_1 = require("../schema/ChildDefinition");
@@ -20,9 +21,9 @@ const TypeRegistry_1 = require("../schema/TypeRegistry");
  */
 function transformTemplateNodeToSchema(node) {
     // Set the namespace
-    const result = new Schema_1.Schema(node.getValue(), node.getLine(), undefined);
-    // Look for the structure node
-    const structure = node.getChild("structure");
+    const result = new Schema_1.Schema(node.getText(), node.getLine(), undefined);
+    // Look for the structure node (a template is an inline root; a text root has none)
+    const structure = node instanceof InlineNode_1.InlineNode ? node.getChild("structure") : null;
     if (!structure) {
         throw new ValidationException_1.ValidationException(node.getLine(), "TEMPLATE_STRUCTURE_REQUIRED", "Template must define 'Structure >>'");
     }
@@ -74,7 +75,7 @@ function transformTemplateNodeToSchema(node) {
 function addToSchema(schema, node) {
     // A Structure line must use the template grammar's ':' form. The core parser
     // also accepts BLOCK nodes here, so reject them explicitly (STXT-TEMPLATE-SPEC 6.3).
-    if (node.isTextNode()) {
+    if (!(node instanceof InlineNode_1.InlineNode)) {
         throw new ValidationException_1.ValidationException(node.getLine(), "INVALID_CHILD_LINE", "Template Structure lines must use ':'");
     }
     // Get the qualified name
@@ -142,11 +143,11 @@ function addToSchema(schema, node) {
         }
         const reference = type.substring(1).trim();
         // Reference and explicit type on the same line (STXT-TEMPLATE-SPEC 14.13)
-        const explicitType = referenceType(reference, node.getNormalizedName());
+        const explicitType = referenceType(reference, node.getCanonicalName());
         if (explicitType) {
             throw new ValidationException_1.ValidationException(node.getLine(), "REFERENCE_WITH_TYPE_NOT_ALLOWED", `Reference '@${node.getName()}' can not declare a type: ${explicitType}`);
         }
-        if (StringUtils_1.StringUtils.normalize(reference) !== node.getNormalizedName()) {
+        if (StringUtils_1.StringUtils.normalize(reference) !== node.getCanonicalName()) {
             throw new ValidationException_1.ValidationException(node.getLine(), "NODE_REFERENCE_NOT_VALID", `Reference must be '@${node.getName()}', not '${reference}'`);
         }
         // A reference may override the cardinality, but it may redefine neither the ENUM
@@ -168,6 +169,10 @@ function addToSchema(schema, node) {
     }
     // Add the children
     for (const child of childrenNode) {
+        // STXT-TEMPLATE-SPEC 6.3: every Structure line uses ':', so a child is inline too
+        if (!(child instanceof InlineNode_1.InlineNode)) {
+            throw new ValidationException_1.ValidationException(child.getLine(), "INVALID_CHILD_LINE", "Template Structure lines must use ':'");
+        }
         cl = ChildLineParser_1.ChildLineParser.parse(child.getValue(), child.getLine());
         const childName = child.getName();
         let childNamespace = child.getNamespace();
@@ -211,7 +216,7 @@ function addDescriptions(schema, nodes) {
             throw new ValidationException_1.ValidationException(node.getLine(), "EXTERNAL_DESCRIPTION_NOT_ALLOWED", "Not allowed description in external namespaces");
         }
         // No children either
-        if (node.getChildren().length > 0) {
+        if (node instanceof InlineNode_1.InlineNode && node.getChildren().length > 0) {
             throw new ValidationException_1.ValidationException(node.getLine(), "CHILDREN_DESCRIPTION_NOT_ALLOWED", "Not allowed children in description");
         }
         // Look for the node in the schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stxt-lang/core",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "Parser and schema validator for STXT, an indentation-based structured-text format.",
   "main": "out/all.js",
   "types": "out/all.d.ts",