@stxt-lang/core 0.6.0 → 0.6.1

package/out/all.d.ts

@@ -17,6 +17,8 @@ export { transformNodeToSchema } from "./schema/SchemaParser";
 export { UnifiedSchemaProvider } from "./runtime/UnifiedSchemaProvider";
 export { ConditionalValidator } from "./runtime/ConditionalValidator";
 export { NodeWriter, IndentStyle } from "./runtime/NodeWriter";
+export { toCanonicalTree, toCanonicalJson } from "./runtime/TreeJson";
+export type { CanonicalDocument, CanonicalNode, CanonicalInlineNode, CanonicalBlockNode } from "./runtime/TreeJson";
 export { transformTemplateNodeToSchema } from "./template/TemplateParser";
 export { DiscoveryResolver, DiscoveryOptions } from "./discovery/DiscoveryResolver";
 export { DiscoveryResult, DiscoveryDefinition, DiscoveryLevel } from "./discovery/DiscoveryResult";

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.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.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.Constants = exports.Line = exports.ParseResult = exports.Parser = exports.Node = void 0;
 var Node_1 = require("./core/Node");
 Object.defineProperty(exports, "Node", { enumerable: true, get: function () { return Node_1.Node; } });
 var Parser_1 = require("./core/Parser");
@@ -39,6 +39,9 @@ Object.defineProperty(exports, "ConditionalValidator", { enumerable: true, get:
 var NodeWriter_1 = require("./runtime/NodeWriter");
 Object.defineProperty(exports, "NodeWriter", { enumerable: true, get: function () { return NodeWriter_1.NodeWriter; } });
 Object.defineProperty(exports, "IndentStyle", { enumerable: true, get: function () { return NodeWriter_1.IndentStyle; } });
+var TreeJson_1 = require("./runtime/TreeJson");
+Object.defineProperty(exports, "toCanonicalTree", { enumerable: true, get: function () { return TreeJson_1.toCanonicalTree; } });
+Object.defineProperty(exports, "toCanonicalJson", { enumerable: true, get: function () { return TreeJson_1.toCanonicalJson; } });
 var TemplateParser_1 = require("./template/TemplateParser");
 Object.defineProperty(exports, "transformTemplateNodeToSchema", { enumerable: true, get: function () { return TemplateParser_1.transformTemplateNodeToSchema; } });
 var DiscoveryResolver_1 = require("./discovery/DiscoveryResolver");

package/out/runtime/TreeJson.d.ts

@@ -0,0 +1,40 @@
+import { Node } from "../core/Node";
+/** Canonical JSON representation of a parsed STXT document (STXT-TREE-SPEC). */
+export type CanonicalDocument = CanonicalNode[];
+/** A node in the canonical JSON representation of an STXT document. */
+export type CanonicalNode = CanonicalInlineNode | CanonicalBlockNode;
+/** Canonical representation of an INLINE (`:`) node. */
+export interface CanonicalInlineNode {
+    name: string;
+    canonicalName: string;
+    namespace: string;
+    form: "inline";
+    value: string;
+    children: CanonicalNode[];
+}
+/** Canonical representation of a BLOCK (`>>`) node. */
+export interface CanonicalBlockNode {
+    name: string;
+    canonicalName: string;
+    namespace: string;
+    form: "block";
+    lines: string[];
+}
+/**
+ * Converts every root node of a parsed document to the logical tree defined by
+ * STXT-TREE-SPEC. The result deliberately excludes source positions, indentation
+ * style, comments and derived values such as a qualified name.
+ *
+ * @param nodes root nodes of an already parsed STXT document.
+ * @returns the canonical document tree, ready to be serialized as JSON.
+ */
+export declare function toCanonicalTree(nodes: ReadonlyArray<Node>): CanonicalDocument;
+/**
+ * Serializes the canonical tree of a parsed document as human-readable JSON.
+ * JSON whitespace is not part of STXT-TREE-SPEC; two-space indentation is this
+ * implementation's deterministic presentation for command-line use.
+ *
+ * @param nodes root nodes of an already parsed STXT document.
+ * @returns the canonical document tree encoded as JSON, without a final line break.
+ */
+export declare function toCanonicalJson(nodes: ReadonlyArray<Node>): string;

package/out/runtime/TreeJson.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCanonicalTree = toCanonicalTree;
+exports.toCanonicalJson = toCanonicalJson;
+/**
+ * Converts every root node of a parsed document to the logical tree defined by
+ * STXT-TREE-SPEC. The result deliberately excludes source positions, indentation
+ * style, comments and derived values such as a qualified name.
+ *
+ * @param nodes root nodes of an already parsed STXT document.
+ * @returns the canonical document tree, ready to be serialized as JSON.
+ */
+function toCanonicalTree(nodes) {
+    return nodes.map(node => toCanonicalNode(node));
+}
+/**
+ * Serializes the canonical tree of a parsed document as human-readable JSON.
+ * JSON whitespace is not part of STXT-TREE-SPEC; two-space indentation is this
+ * implementation's deterministic presentation for command-line use.
+ *
+ * @param nodes root nodes of an already parsed STXT document.
+ * @returns the canonical document tree encoded as JSON, without a final line break.
+ */
+function toCanonicalJson(nodes) {
+    return JSON.stringify(toCanonicalTree(nodes), null, 2);
+}
+function toCanonicalNode(node) {
+    if (node.isTextNode()) {
+        return {
+            name: node.getName(),
+            canonicalName: node.getNormalizedName(),
+            namespace: node.getNamespace(),
+            form: "block",
+            lines: [...node.getTextLines()],
+        };
+    }
+    return {
+        name: node.getName(),
+        canonicalName: node.getNormalizedName(),
+        namespace: node.getNamespace(),
+        form: "inline",
+        value: node.getValue(),
+        children: node.getChildren().map(child => toCanonicalNode(child)),
+    };
+}
+//# sourceMappingURL=TreeJson.js.map

package/out/schema/SchemaProviderMemory.js

@@ -52,9 +52,14 @@ class SchemaProviderMemory {
     addSchema(txt) {
         const parser = new Parser_1.Parser();
         const node = parser.parse(txt)[0];
-        const schema = (0, SchemaParser_1.transformNodeToSchema)(node);
+        // A schema that does not validate against its meta-schema must not be
+        // registered (same policy as UnifiedSchemaProvider/DiscoveryResolver)
         const schemaValidator = new SchemaValidator_1.SchemaValidator(new SchemaProviderMeta_1.SchemaProviderMeta(), true);
-        schemaValidator.validate(node);
+        const errors = schemaValidator.validate(node);
+        if (errors.length > 0) {
+            throw errors[0];
+        }
+        const schema = (0, SchemaParser_1.transformNodeToSchema)(node);
         const key = schema.getNamespace();
         this.schemas.set(key, schema);
     }

package/out/template/TemplateSchemaProviderMemory.d.ts

@@ -18,7 +18,8 @@ export declare class TemplateSchemaProviderMemory extends SchemaProviderMemory {
      *
      * @param template text of the `@stxt.template` document.
      * @throws ValidationException with code `INVALID_SCHEMA` if the document does not hold exactly
-     *         one template, or if the resulting schema has no namespace.
+     *         one template or the resulting schema has no namespace, or the first validation error
+     *         if the template does not validate against the template meta-schema.
      */
     addTemplate(template: string): void;
 }

package/out/template/TemplateSchemaProviderMemory.js

@@ -31,7 +31,8 @@ class TemplateSchemaProviderMemory extends SchemaProviderMemory_1.SchemaProvider
      *
      * @param template text of the `@stxt.template` document.
      * @throws ValidationException with code `INVALID_SCHEMA` if the document does not hold exactly
-     *         one template, or if the resulting schema has no namespace.
+     *         one template or the resulting schema has no namespace, or the first validation error
+     *         if the template does not validate against the template meta-schema.
      */
     addTemplate(template) {
         const parser = new Parser_1.Parser();
@@ -39,9 +40,13 @@ class TemplateSchemaProviderMemory extends SchemaProviderMemory_1.SchemaProvider
         if (nodes.length !== 1) {
             throw new ValidationException_1.ValidationException(0, "INVALID_SCHEMA", `There are ${nodes.length}, and expected is 1`);
         }
-        // Validate the template against the template meta-schema
+        // A template that does not validate against the template meta-schema must not
+        // be registered (same policy as UnifiedSchemaProvider/DiscoveryResolver)
         const schemaValidator = new SchemaValidator_1.SchemaValidator(new MetaTemplateSchemaProvider_1.MetaTemplateSchemaProvider(), true);
-        schemaValidator.validate(nodes[0]);
+        const errors = schemaValidator.validate(nodes[0]);
+        if (errors.length > 0) {
+            throw errors[0];
+        }
         // Build the schema out of the template
         const sch = (0, TemplateParser_1.transformTemplateNodeToSchema)(nodes[0]);
         // Minimum safety check (Java checked the expected namespace here too)

package/package.json

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