@stxt-lang/core 0.9.1 → 0.10.0

package/out/all.d.ts

@@ -5,6 +5,12 @@ export { Parser } from "./core/Parser";
 export { ParseResult } from "./core/ParseResult";
 export { Line } from "./core/Line";
 export { Constants } from "./core/Constants";
+/**
+ * Version of the STXT specifications (STXT-SPEC, STXT-TREE-SPEC, STXT-SCHEMA-SPEC,
+ * STXT-TEMPLATE-SPEC, STXT-DISCOVERY-SPEC) this library implements, distinct from the version of
+ * the package. Same value as `Constants.SPEC_VERSION`.
+ */
+export declare const SPEC_VERSION: string;
 export { parseLine } from "./core/LineParser";
 export { StringUtils } from "./core/StringUtils";
 export { ParseException } from "./exceptions/ParseException";

package/out/all.js

@@ -3,7 +3,7 @@
 // Anything that should be consumable by third parties (e.g. the VSCode extension)
 // has to be re-exported from here.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiscoveryError = exports.DiscoveryResult = exports.DiscoveryResolver = exports.transformTemplateNodeToSchema = exports.toCanonicalJson = exports.toCanonicalTree = exports.IndentStyle = exports.NodeWriter = exports.ConditionalValidator = exports.UnifiedSchemaProvider = exports.transformNodeToSchema = exports.ChildDefinition = exports.NodeDefinition = exports.SchemaValidator = exports.Schema = exports.ValidationException = exports.ParseException = exports.StringUtils = exports.parseLine = exports.Constants = exports.Line = exports.ParseResult = exports.Parser = exports.TextNode = exports.InlineNode = exports.Node = void 0;
+exports.DiscoveryError = exports.DiscoveryResult = exports.DiscoveryResolver = exports.transformTemplateNodeToSchema = exports.toCanonicalJson = exports.toCanonicalTree = exports.IndentStyle = exports.NodeWriter = exports.ConditionalValidator = exports.UnifiedSchemaProvider = exports.transformNodeToSchema = exports.ChildDefinition = exports.NodeDefinition = exports.SchemaValidator = exports.Schema = exports.ValidationException = exports.ParseException = exports.StringUtils = exports.parseLine = exports.SPEC_VERSION = exports.Constants = exports.Line = exports.ParseResult = exports.Parser = exports.TextNode = exports.InlineNode = exports.Node = void 0;
 var Node_1 = require("./core/Node");
 Object.defineProperty(exports, "Node", { enumerable: true, get: function () { return Node_1.Node; } });
 var InlineNode_1 = require("./core/InlineNode");
@@ -18,6 +18,13 @@ var Line_1 = require("./core/Line");
 Object.defineProperty(exports, "Line", { enumerable: true, get: function () { return Line_1.Line; } });
 var Constants_1 = require("./core/Constants");
 Object.defineProperty(exports, "Constants", { enumerable: true, get: function () { return Constants_1.Constants; } });
+const Constants_2 = require("./core/Constants");
+/**
+ * Version of the STXT specifications (STXT-SPEC, STXT-TREE-SPEC, STXT-SCHEMA-SPEC,
+ * STXT-TEMPLATE-SPEC, STXT-DISCOVERY-SPEC) this library implements, distinct from the version of
+ * the package. Same value as `Constants.SPEC_VERSION`.
+ */
+exports.SPEC_VERSION = Constants_2.Constants.SPEC_VERSION;
 var LineParser_1 = require("./core/LineParser");
 Object.defineProperty(exports, "parseLine", { enumerable: true, get: function () { return LineParser_1.parseLine; } });
 var StringUtils_1 = require("./core/StringUtils");

package/out/core/Constants.d.ts

@@ -1,5 +1,12 @@
 /** Characters and sizes fixed by STXT-SPEC that the parser and the writer share. */
 export declare class Constants {
+    /**
+     * Version of the STXT specifications (STXT-SPEC, STXT-TREE-SPEC, STXT-SCHEMA-SPEC,
+     * STXT-TEMPLATE-SPEC, STXT-DISCOVERY-SPEC) this library implements. It is distinct from the
+     * version of the package: the package may be released many times against the same
+     * specification version.
+     */
+    static readonly SPEC_VERSION: string;
     /** Character that opens a comment line. */
     static readonly COMMENT_CHAR: string;
     /** Number of spaces that make up one indentation level. */

package/out/core/Constants.js

@@ -5,6 +5,13 @@ exports.Constants = void 0;
 class Constants {
 }
 exports.Constants = Constants;
+/**
+ * Version of the STXT specifications (STXT-SPEC, STXT-TREE-SPEC, STXT-SCHEMA-SPEC,
+ * STXT-TEMPLATE-SPEC, STXT-DISCOVERY-SPEC) this library implements. It is distinct from the
+ * version of the package: the package may be released many times against the same
+ * specification version.
+ */
+Constants.SPEC_VERSION = "1.0";
 /** Character that opens a comment line. */
 Constants.COMMENT_CHAR = "#";
 /** Number of spaces that make up one indentation level. */

package/out/exceptions/ParseException.d.ts

@@ -15,6 +15,12 @@ export declare class ParseException extends Error {
      * @param message descriptive message.
      */
     constructor(line: number, code: string, message: string);
-    /** @returns a readable representation of the error, with its line and its code. */
+    /**
+     * The string form carries the frame that `message` deliberately leaves out: `message` is only
+     * the description, and the code and the line are separate fields that whoever formats output
+     * composes. Same framing in every port since 0.10.0.
+     *
+     * @returns `[CODE] line N: message`.
+     */
     toString(): string;
 }

package/out/exceptions/ParseException.js

@@ -20,9 +20,15 @@ class ParseException extends Error {
         this.code = code;
         Object.setPrototypeOf(this, ParseException.prototype);
     }
-    /** @returns a readable representation of the error, with its line and its code. */
+    /**
+     * The string form carries the frame that `message` deliberately leaves out: `message` is only
+     * the description, and the code and the line are separate fields that whoever formats output
+     * composes. Same framing in every port since 0.10.0.
+     *
+     * @returns `[CODE] line N: message`.
+     */
     toString() {
-        return `${this.name} [line=${this.line}, code=${this.code}]: ${this.message}`;
+        return `[${this.code}] line ${this.line}: ${this.message}`;
     }
 }
 exports.ParseException = ParseException;

package/out/exceptions/RuntimeException.d.ts

@@ -15,6 +15,11 @@ export declare class RuntimeException extends Error {
     constructor(code: string, message: string);
     /** @returns the error code in UPPERCASE. */
     getCode(): string;
-    /** @returns a readable representation of the error, with its code. */
+    /**
+     * The string form carries the frame that `message` deliberately leaves out; same framing in
+     * every port since 0.10.0.
+     *
+     * @returns `[CODE] message`.
+     */
     toString(): string;
 }

package/out/exceptions/RuntimeException.js

@@ -23,10 +23,14 @@ class RuntimeException extends Error {
     getCode() {
         return this.code;
     }
-    /** @returns a readable representation of the error, with its code. */
+    /**
+     * The string form carries the frame that `message` deliberately leaves out; same framing in
+     * every port since 0.10.0.
+     *
+     * @returns `[CODE] message`.
+     */
     toString() {
-        const message = this.message;
-        return `${this.name}[${this.code}]${message ? `: ${message}` : ""}`;
+        return `[${this.code}] ${this.message}`;
     }
 }
 exports.RuntimeException = RuntimeException;

package/out/schema/SchemaParser.js

@@ -100,6 +100,11 @@ function createFrom(node, namespace) {
         const valuesNode = valuesNodes[0];
         const values = inline(valuesNode).getChildrenByName("value");
         for (const v of values) {
+            // An empty Value: is a schema error (STXT-SCHEMA-SPEC 7.2, condition 14 of section 13):
+            // an enumeration whose only valid value is the empty string makes no sense
+            if (v.getText().length === 0) {
+                throw new ValidationException_1.ValidationException(v.getLine(), "VALUE_EMPTY", "Value of ENUM cannot be empty");
+            }
             result.addValue(v.getText(), v.getLine());
         }
         // For the final ENUM check

package/out/schema/type/BASE64.d.ts

@@ -1,3 +1,12 @@
 import { Type } from "../Type";
+/**
+ * STXT-SCHEMA-SPEC 9.5: standard Base64 (not URL-safe), padding optional, no leftover bits,
+ * never empty. The check is a regular expression plus the leftover-bits rule, never the
+ * platform decoder, which silently ignores characters outside the alphabet.
+ *
+ * @param value value already stripped of blanks.
+ * @returns whether it is valid Base64.
+ */
+export declare function isValidBase64(value: string): boolean;
 /** `BASE64` type: checks that the content is valid Base64. */
 export declare const BASE64: Type;

package/out/schema/type/BASE64.js

@@ -1,29 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BASE64 = void 0;
+exports.isValidBase64 = isValidBase64;
 const ValidationException_1 = require("../../exceptions/ValidationException");
 const binaryValue_1 = require("./binaryValue");
+/** Standard alphabet of RFC 4648 section 4, used to check the leftover bits of the last character. */
+const ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+/**
+ * Shape of a Base64 value (STXT-SCHEMA-SPEC 9.5): groups of four characters of the standard
+ * alphabet, with an optional final group of two or three characters whose `=` padding may be
+ * omitted. The empty string matches here and is rejected separately.
+ */
+const SHAPE = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}(?:==)?|[A-Za-z0-9+/]{3}=?)?$/;
+/**
+ * STXT-SCHEMA-SPEC 9.5: standard Base64 (not URL-safe), padding optional, no leftover bits,
+ * never empty. The check is a regular expression plus the leftover-bits rule, never the
+ * platform decoder, which silently ignores characters outside the alphabet.
+ *
+ * @param value value already stripped of blanks.
+ * @returns whether it is valid Base64.
+ */
+function isValidBase64(value) {
+    if (value.length === 0 || !SHAPE.test(value)) {
+        return false;
+    }
+    const data = value.replace(/=+$/, "");
+    const rest = data.length % 4;
+    if (rest === 0) {
+        return true;
+    }
+    // The last character encodes 6 bits; with 2 characters 4 of them are leftover, with 3, 2 of them.
+    const last = ALPHABET.indexOf(data.charAt(data.length - 1));
+    const mask = rest === 2 ? 0x0f : 0x03;
+    return (last & mask) === 0;
+}
 /** `BASE64` type: checks that the content is valid Base64. */
 exports.BASE64 = {
     getName() {
         return "BASE64";
     },
     validate(ndef, n) {
-        const raw = (0, binaryValue_1.binaryValue)(n);
-        try {
-            // Try to decode it
-            const buf = Buffer.from(raw, "base64");
-            // Re-encode to check consistency
-            // (this keeps partially valid strings out)
-            const reencoded = buf.toString("base64");
-            // Normalize the padding before comparing
-            const normalizedInput = raw.replace(/=+$/, "");
-            const normalizedReencoded = reencoded.replace(/=+$/, "");
-            if (normalizedInput !== normalizedReencoded) {
-                throw new ValidationException_1.ValidationException(n.getLine(), "INVALID_VALUE", `Node '${n.getName()}' Invalid Base64`);
-            }
-        }
-        catch {
+        if (!isValidBase64((0, binaryValue_1.binaryValue)(n))) {
             throw new ValidationException_1.ValidationException(n.getLine(), "INVALID_VALUE", `Node '${n.getName()}' Invalid Base64`);
         }
     },

package/out/schema/type/binaryValue.d.ts

@@ -1,11 +1,13 @@
 import { Node } from "../../core/Node";
 /**
  * STXT-SCHEMA-SPEC 9.5: effective value for the INLINE/BLOCK binary types
- * (HEXADECIMAL, BINARY, BASE64). In BLOCK form, validation applies to the
- * concatenation of the lines of the block, ignoring line breaks, empty lines
- * and the leading and trailing spaces or tabs of each line.
+ * (HEXADECIMAL, BINARY, BASE64). Every blank (U+0020 space, U+0009 tab) is
+ * removed wherever it is, in both forms; in BLOCK form the lines are
+ * concatenated first, which also drops line breaks and empty lines. So
+ * `DE AD BE EF`, `1010 1010` and Base64 wrapped at 76 columns validate. No
+ * other character is removed: `DE:AD` or `DE-AD` stay invalid.
  *
  * @param node node whose value is wanted.
- * @returns the inline value, or the lines of the block already concatenated.
+ * @returns the value with no blanks, ready for the grammar of the type.
  */
 export declare function binaryValue(node: Node): string;

package/out/schema/type/binaryValue.js

@@ -4,17 +4,17 @@ 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
- * concatenation of the lines of the block, ignoring line breaks, empty lines
- * and the leading and trailing spaces or tabs of each line.
+ * (HEXADECIMAL, BINARY, BASE64). Every blank (U+0020 space, U+0009 tab) is
+ * removed wherever it is, in both forms; in BLOCK form the lines are
+ * concatenated first, which also drops line breaks and empty lines. So
+ * `DE AD BE EF`, `1010 1010` and Base64 wrapped at 76 columns validate. No
+ * other character is removed: `DE:AD` or `DE-AD` stay invalid.
  *
  * @param node node whose value is wanted.
- * @returns the inline value, or the lines of the block already concatenated.
+ * @returns the value with no blanks, ready for the grammar of the type.
  */
 function binaryValue(node) {
-    if (!(node instanceof TextNode_1.TextNode)) {
-        return node.getText();
-    }
-    return node.getTextLines().map((line) => line.trim()).join("");
+    const raw = node instanceof TextNode_1.TextNode ? node.getTextLines().join("") : node.getText();
+    return raw.replace(/[ \t]/g, "");
 }
 //# sourceMappingURL=binaryValue.js.map

package/out/template/ChildLineParser.js

@@ -77,6 +77,12 @@ class ChildLineParser {
             const list = [];
             for (let part of parts) {
                 part = part.trim();
+                // An empty item ("[a, , b]", "[a, b,]") is an error, as an empty Value: is in a
+                // schema (STXT-TEMPLATE-SPEC 14.14). Only the whole list may be empty ("[]"),
+                // which the template parser reports as VALUES_REQUIRED.
+                if (part.length === 0 && parts.length > 1) {
+                    throw new ValidationException_1.ValidationException(lineNumber, "VALUE_EMPTY", `Empty ENUM value in ${valuesStr}`);
+                }
                 if (part.length === 0) {
                     continue;
                 }

package/package.json

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