scjson 0.3.0 → 0.3.1

package/dist/converters.d.ts

@@ -1,17 +1,7 @@
-/**
- * Convert an SCXML string to scjson.
- *
- * @param {string} xmlStr - XML input.
- * @param {boolean} [omitEmpty=true] - Remove empty values when true.
- * @returns {{result: string, valid: boolean, errors: object[]|null}} Conversion outcome.
- *
- * Removes the XML namespace attribute and injects default values
- * expected by the schema.
- */
-export function xmlToJson(xmlStr: string, omitEmpty?: boolean): {
+export function xmlToJson(xmlStr: any, omitEmpty?: boolean): {
     result: string;
-    valid: boolean;
-    errors: object[] | null;
+    valid: any;
+    errors: any;
 };
 /**
  * Convert a scjson string to SCXML.
@@ -120,6 +110,18 @@ export function fixSendContent(value: object | any[]): void;
  * @param {object|Array} value - Parsed object to adjust in place.
  */
 export function fixDonedataContent(value: object | any[]): void;
+export function fixOtherAttributes(value: any): void;
+/**
+ * Decode HTML entities in string values.
+ *
+ * Fast XML parser leaves character references intact. This helper matches the
+ * Python implementation by converting entities like ``
`` to their literal
+ * characters.
+ *
+ * @param {object|Array|string} value - Parsed value to normalise.
+ * @returns {object|Array|string} Normalised value.
+ */
+export function decodeEntities(value: object | any[] | string): object | any[] | string;
 /**
  * Convert a canonical content object back into XML element format.
  *
@@ -162,6 +164,16 @@ export function splitTokenAttrs(value: object | any[], parent: any): void;
  * @param {object|Array} value - Parsed object to adjust in place.
  */
 export function fixEmptyElse(value: object | any[]): void;
+/**
+ * Normalise empty ``onentry`` and ``onexit`` elements.
+ *
+ * The XML parser represents empty tags as an empty string. The Python
+ * reference output preserves these elements as empty objects so they
+ * survive subsequent cleaning steps. This helper mirrors that behaviour.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+export function fixEmptyOnentry(value: object | any[]): void;
 /**
  * Remove transition elements directly under the <scxml> root.
  *
@@ -189,3 +201,30 @@ export function stripQnameNs(value: object | any[]): void;
  * @param {object|Array} value - Parsed object to adjust in place.
  */
 export function reorderScxml(value: object | any[]): void;
+/**
+ * Convert an SCXML string to scjson.
+ *
+ * @param {string} xmlStr - XML input.
+ * @param {boolean} [omitEmpty=true] - Remove empty values when true.
+ * @returns {{result: string, valid: boolean, errors: object[]|null}} Conversion outcome.
+ *
+ * Removes the XML namespace attribute and injects default values
+ * expected by the schema.
+ */
+/**
+ * Recursively strip default attributes from nested data nodes.
+ *
+ * Any object with a ``qname`` property other than ``scxml`` may have
+ * ``version`` or ``datamodel_attribute`` inserted during validation.
+ * This helper removes those keys so that nested structures match the
+ * canonical Python output.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+export function stripNestedDataAttrs(value: object | any[]): void;
+/**
+ * Recursively remove ``xmlns`` attributes from nested objects.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+export function stripXmlns(value: object | any[]): void;

package/dist/converters.js

@@ -59,7 +59,6 @@ const STRUCTURAL_FIELDS = new Set([
  * Recursively convert an XML Element to SCJSON-compliant JS object.
  */
 function convert(element) {
-    var _a;
     const result = {
         tag: element.tagName,
         ...Object.fromEntries(Array.from(element.attributes).map(attr => [attr.name, attr.value]))
@@ -85,16 +84,16 @@ function convert(element) {
         }
     }
     // Handle text content if present
-    const text = (_a = element.textContent) === null || _a === void 0 ? void 0 : _a.trim();
-    if (text && element.children.length === 0) {
-        result.content = [text];
+    const rawText = element.textContent;
+    if (rawText && element.children.length === 0 && rawText.trim() !== '') {
+        result.content = [rawText];
     }
     return result;
 }
 /**
  * Keys that should never be pruned even when empty.
  */
-const ALWAYS_KEEP = new Set(['else_value', 'else', 'final']);
+const ALWAYS_KEEP = new Set(['else_value', 'else', 'final', 'onentry']);
 /**
  * Remove transition elements directly under the <scxml> root.
  *
@@ -145,7 +144,12 @@ function collapseWhitespace(value) {
     if (value && typeof value === 'object') {
         for (const [k, v] of Object.entries(value)) {
             if ((k.endsWith('_attribute') || COLLAPSE_ATTRS.has(k)) && typeof v === 'string') {
-                value[k] = v.replace(/[\n\r\t]/g, ' ');
+                if (v.startsWith('\n')) {
+                    value[k] = '\n' + v.slice(1).replace(/[\n\r\t]/g, ' ');
+                }
+                else {
+                    value[k] = v.replace(/[\n\r\t]/g, ' ');
+                }
             }
             else {
                 value[k] = collapseWhitespace(v);
@@ -175,7 +179,7 @@ function splitTokenAttrs(value, parent) {
                 continue;
             }
             if (k === 'transition') {
-                if (parent !== 'history') {
+                if (parent !== 'history' && parent !== 'initial') {
                     const arr = Array.isArray(v) ? v : [v];
                     arr.forEach(tr => {
                         if (typeof tr.target === 'string')
@@ -311,7 +315,7 @@ function ensureArrays(obj, parent) {
             continue;
         }
         if (k === 'transition' && v && typeof v === 'object') {
-            if (parent !== 'history') {
+            if (parent !== 'history' && parent !== 'initial') {
                 const arr = Array.isArray(v) ? v : [v];
                 arr.forEach(tr => {
                     if (tr.target !== undefined && !Array.isArray(tr.target))
@@ -355,6 +359,66 @@ function fixEmptyElse(value) {
         }
     }
 }
+/**
+ * Normalise empty ``onentry`` and ``onexit`` elements.
+ *
+ * The XML parser represents empty tags as an empty string. The Python
+ * reference output preserves these elements as empty objects so they
+ * survive subsequent cleaning steps. This helper mirrors that behaviour.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+function fixEmptyOnentry(value) {
+    if (Array.isArray(value)) {
+        value.forEach(fixEmptyOnentry);
+        return;
+    }
+    if (value && typeof value === 'object') {
+        for (const [k, v] of Object.entries(value)) {
+            if ((k === 'onentry' || k === 'onexit') &&
+                Array.isArray(v) &&
+                v.length === 1 &&
+                typeof v[0] === 'string' &&
+                v[0].trim() === '') {
+                value[k] = [{}];
+                continue;
+            }
+            fixEmptyOnentry(v);
+        }
+    }
+}
+/**
+ * Decode HTML entities in string values.
+ *
+ * Fast XML parser leaves character references intact. This helper matches the
+ * Python implementation by converting entities like ``&#xA;`` to their literal
+ * characters.
+ *
+ * @param {object|Array|string} value - Parsed value to normalise.
+ * @returns {object|Array|string} Normalised value.
+ */
+function decodeEntities(value) {
+    if (Array.isArray(value)) {
+        return value.map(decodeEntities);
+    }
+    if (value && typeof value === 'object') {
+        for (const [k, v] of Object.entries(value)) {
+            value[k] = decodeEntities(v);
+        }
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value
+            .replace(/&#x([0-9a-fA-F]+);/g, (_, h) => String.fromCharCode(parseInt(h, 16)))
+            .replace(/&#([0-9]+);/g, (_, d) => String.fromCharCode(parseInt(d, 10)))
+            .replace(/&quot;/g, '"')
+            .replace(/&apos;/g, "'")
+            .replace(/&amp;/g, '&')
+            .replace(/&lt;/g, '<')
+            .replace(/&gt;/g, '>');
+    }
+    return value;
+}
 /**
  * Normalise script elements after parsing.
  *
@@ -470,6 +534,52 @@ function fixAssignDefaults(value) {
         }
     }
 }
+/**
+ * Hoist unexpected attributes into ``other_attributes``.
+ *
+ * Handles the ``id`` attribute on ``assign`` elements and the
+ * misspelled ``intial`` attribute on ``state`` elements so that
+ * generated scjson matches the reference Python output.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+// Avoid infinite recursion on cyclic structures
+const VISITED_FLAG = Symbol('fixOtherAttributesVisited');
+function fixOtherAttributes(value) {
+    if (Array.isArray(value)) {
+        value.forEach(fixOtherAttributes);
+        return;
+    }
+    if (value && typeof value === 'object') {
+        if (value[VISITED_FLAG]) {
+            return;
+        }
+        value[VISITED_FLAG] = true;
+        if (Object.prototype.hasOwnProperty.call(value, 'assign')) {
+            const arr = Array.isArray(value.assign) ? value.assign : [value.assign];
+            arr.forEach(a => {
+                if (a.id !== undefined) {
+                    a.other_attributes = a.other_attributes || {};
+                    a.other_attributes.id = a.id;
+                    delete a.id;
+                }
+                fixOtherAttributes(a);
+            });
+            value.assign = arr;
+        }
+        if (value.intial !== undefined) {
+            value.other_attributes = value.other_attributes || {};
+            value.other_attributes.intial = value.intial;
+            delete value.intial;
+        }
+        for (const [k, v] of Object.entries(value)) {
+            if (v === value || k === 'other_attributes')
+                continue;
+            fixOtherAttributes(v);
+        }
+        delete value[VISITED_FLAG];
+    }
+}
 /**
  * Apply default values for send elements.
  *
@@ -521,6 +631,14 @@ function fixSendContent(value) {
         return;
     }
     if (value && typeof value === 'object') {
+        if (Object.prototype.hasOwnProperty.call(value, 'qname')) {
+            if (Object.prototype.hasOwnProperty.call(value, 'version')) {
+                delete value.version;
+            }
+            if (Object.prototype.hasOwnProperty.call(value, 'datamodel_attribute')) {
+                delete value.datamodel_attribute;
+            }
+        }
         if (Object.prototype.hasOwnProperty.call(value, 'send')) {
             const arr = Array.isArray(value.send) ? value.send : [value.send];
             arr.forEach(s => {
@@ -528,8 +646,10 @@ function fixSendContent(value) {
                     const cArr = Array.isArray(s.content) ? s.content : [s.content];
                     const mapped = cArr.map(c => {
                         if (typeof c !== 'object') {
-                            const sVal = String(c).trim();
-                            return sVal ? { content: [{ content: [sVal] }] } : null;
+                            const raw = String(c);
+                            if (raw.trim() === '')
+                                return null;
+                            return { content: [{ content: [raw] }] };
                         }
                         if (c && typeof c === 'object') {
                             if (typeof c.content === 'string' || typeof c.content === 'number' || typeof c.content === 'boolean') {
@@ -537,8 +657,8 @@ function fixSendContent(value) {
                             }
                             if (Array.isArray(c.content)) {
                                 c.content = c.content
-                                    .map(i => (typeof i === 'string' ? i.trim() : i))
-                                    .filter(i => i !== '' && i !== null && i !== undefined);
+                                    .map(i => (typeof i === 'string' ? String(i) : i))
+                                    .filter(i => !(typeof i === 'string' && i.trim() === '') && i !== null && i !== undefined);
                                 if (c.content.length === 0)
                                     delete c.content;
                             }
@@ -550,6 +670,10 @@ function fixSendContent(value) {
                             else {
                                 fixSendContent(c);
                             }
+                            if (c.qname && c.version !== undefined)
+                                delete c.version;
+                            if (c.qname && c.datamodel_attribute !== undefined)
+                                delete c.datamodel_attribute;
                             return c;
                         }
                         return null;
@@ -587,8 +711,10 @@ function fixDonedataContent(value) {
                     const cArr = Array.isArray(d.content) ? d.content : [d.content];
                     const mapped = cArr.map(c => {
                         if (typeof c !== 'object') {
-                            const s = String(c).trim();
-                            return s ? { content: [s] } : null;
+                            const raw = String(c);
+                            if (raw.trim() === '')
+                                return null;
+                            return { content: [raw] };
                         }
                         if (c && typeof c === 'object') {
                             if (typeof c.content === 'string' ||
@@ -604,6 +730,10 @@ function fixDonedataContent(value) {
                             else {
                                 fixDonedataContent(c);
                             }
+                            if (c.qname && c.version !== undefined)
+                                delete c.version;
+                            if (c.qname && c.datamodel_attribute !== undefined)
+                                delete c.datamodel_attribute;
                             return c;
                         }
                         return null;
@@ -776,6 +906,27 @@ function stripQnameNs(value) {
         }
     }
 }
+/**
+ * Recursively remove ``xmlns`` attributes from nested objects.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+function stripXmlns(value) {
+    if (Array.isArray(value)) {
+        value.forEach(stripXmlns);
+        return;
+    }
+    if (value && typeof value === 'object') {
+        for (const k of Object.keys(value)) {
+            if (k === '@_xmlns' || k.startsWith('xmlns')) {
+                delete value[k];
+            }
+            else {
+                stripXmlns(value[k]);
+            }
+        }
+    }
+}
 /**
  * Collapse nested ``content`` wrappers created during parsing.
  *
@@ -800,7 +951,8 @@ function flattenContent(value) {
             Array.isArray(value.content[0].content) &&
             value.content[0].content.length === 1 &&
             value.content[0].content[0] &&
-            typeof value.content[0].content[0] === 'object') {
+            typeof value.content[0].content[0] === 'object' &&
+            !Object.prototype.hasOwnProperty.call(value.content[0].content[0], 'qname')) {
             value.content = [value.content[0].content[0]];
         }
         for (const v of Object.values(value)) {
@@ -822,7 +974,10 @@ function flattenContent(value) {
 function removeEmpty(value, key) {
     if (Array.isArray(value)) {
         const arr = value.map(v => removeEmpty(v, key)).filter(v => v !== undefined);
-        return arr.length > 0 ? arr : undefined;
+        if (arr.length > 0 || ALWAYS_KEEP.has(key)) {
+            return arr;
+        }
+        return undefined;
     }
     if (value && typeof value === 'object') {
         const obj = {};
@@ -844,7 +999,7 @@ function removeEmpty(value, key) {
             const base = key.startsWith('@_') ? key.slice(2) : key;
             if (base.endsWith('_attribute') ||
                 base.endsWith('_value') ||
-                ['expr', 'cond', 'event', 'target', 'id', 'name', 'label', 'text'].includes(key) ||
+                ['expr', 'cond', 'event', 'target', 'id', 'name', 'label', 'text'].includes(base) ||
                 key === '@_xmlns') {
                 return '';
             }
@@ -865,6 +1020,32 @@ const validate = ajv.compile(schema);
  * Removes the XML namespace attribute and injects default values
  * expected by the schema.
  */
+/**
+ * Recursively strip default attributes from nested data nodes.
+ *
+ * Any object with a ``qname`` property other than ``scxml`` may have
+ * ``version`` or ``datamodel_attribute`` inserted during validation.
+ * This helper removes those keys so that nested structures match the
+ * canonical Python output.
+ *
+ * @param {object|Array} value - Parsed object to adjust in place.
+ */
+function stripNestedDataAttrs(value) {
+    if (Array.isArray(value)) {
+        value.forEach(stripNestedDataAttrs);
+        return;
+    }
+    if (value && typeof value === 'object') {
+        if (Object.prototype.hasOwnProperty.call(value, 'qname') &&
+            value.qname !== 'scxml') {
+            delete value.version;
+            delete value.datamodel_attribute;
+        }
+        for (const v of Object.values(value)) {
+            stripNestedDataAttrs(v);
+        }
+    }
+}
 function xmlToJson(xmlStr, omitEmpty = true) {
     const parser = new XMLParser({
         ignoreAttributes: false,
@@ -876,17 +1057,21 @@ function xmlToJson(xmlStr, omitEmpty = true) {
         obj = obj.scxml;
     }
     obj = normaliseKeys(obj);
+    obj = decodeEntities(obj);
     fixNestedScxml(obj);
     fixEmptyElse(obj);
     obj = collapseWhitespace(obj);
     splitTokenAttrs(obj);
     ensureArrays(obj);
+    fixOtherAttributes(obj);
     fixScripts(obj);
     fixAssignDefaults(obj);
     fixSendDefaults(obj);
     fixSendContent(obj);
     fixDonedataContent(obj);
     fixDataContent(obj);
+    fixEmptyOnentry(obj);
+    fixSendContent(obj);
     flattenContent(obj);
     stripRootTransitions(obj);
     obj = collapseWhitespace(obj);
@@ -927,12 +1112,16 @@ function xmlToJson(xmlStr, omitEmpty = true) {
     }
     stripQnameNs(obj);
     reorderScxml(obj);
+    stripNestedDataAttrs(obj);
+    stripXmlns(obj);
     const valid = validate(obj);
     const errors = valid ? null : validate.errors;
     if (omitEmpty) {
         obj = removeEmpty(obj) || {};
         fixDataContent(obj);
         stripQnameNs(obj);
+        stripNestedDataAttrs(obj);
+        stripXmlns(obj);
     }
     let out = JSON.stringify(obj, null, 2);
     out = out.replace(/"version": 1(?=[,\n])/g, '"version": 1.0');
@@ -961,6 +1150,15 @@ function jsonToXml(jsonStr) {
     obj = removeEmpty(obj) || {};
     const valid = validate(obj);
     const errors = valid ? null : validate.errors;
+    // Remove defaults injected by validation that would misidentify
+    // arbitrary XML content blocks as nested SCXML documents. Ajv
+    // populates ``version`` and ``datamodel_attribute`` for objects
+    // matching the ``Scxml`` schema. When the original JSON only
+    // contains a ``qname`` field these defaults lead to erroneous
+    // ``<scxml>`` wrappers being generated on output. Stripping the
+    // fields prior to conversion preserves parity with the Python
+    // implementation.
+    stripNestedDataAttrs(obj);
     function restoreKeys(value) {
         if (Array.isArray(value)) {
             return value.map(restoreKeys);
@@ -1000,6 +1198,14 @@ function jsonToXml(jsonStr) {
                 else if (k === 'else_value') {
                     nk = 'else';
                 }
+                if (nk === 'other_attributes') {
+                    if (v && typeof v === 'object') {
+                        for (const [ak, av] of Object.entries(v)) {
+                            out[`@_${ak}`] = av;
+                        }
+                    }
+                    continue;
+                }
                 for (const [attr, prop] of Object.entries(ATTRIBUTE_MAP)) {
                     if (prop === nk) {
                         nk = `@_${attr}`;
@@ -1024,6 +1230,34 @@ function jsonToXml(jsonStr) {
                 }
                 else if (nk === 'content') {
                     if (Array.isArray(v)) {
+                        if (v.every(item => item && typeof item === 'object' && Object.prototype.hasOwnProperty.call(item, 'qname'))) {
+                            v.forEach(item => {
+                                const r = restoreDataNode(item);
+                                const [ck, cv] = Object.entries(r)[0];
+                                if (out[ck]) {
+                                    if (Array.isArray(out[ck])) {
+                                        out[ck].push(cv);
+                                    }
+                                    else {
+                                        out[ck] = [out[ck], cv];
+                                    }
+                                }
+                                else {
+                                    out[ck] = cv;
+                                }
+                            });
+                            continue;
+                        }
+                        if (value.location !== undefined &&
+                            v.length === 1 &&
+                            v[0] &&
+                            typeof v[0] === 'object' &&
+                            (v[0].state || v[0].parallel || v[0].final || v[0].datamodel ||
+                                v[0].datamodel_attribute !== undefined)) {
+                            const cv = restoreKeys(v[0]);
+                            out.scxml = cv;
+                            continue;
+                        }
                         out[nk] = v.map(item => {
                             if (item &&
                                 typeof item === 'object' &&
@@ -1123,11 +1357,16 @@ module.exports = {
     fixSendDefaults,
     fixSendContent,
     fixDonedataContent,
+    fixOtherAttributes,
+    decodeEntities,
     restoreDataNode,
     flattenContent,
     splitTokenAttrs,
     fixEmptyElse,
+    fixEmptyOnentry,
     stripRootTransitions,
     stripQnameNs,
     reorderScxml,
+    stripNestedDataAttrs,
+    stripXmlns,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scjson",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A JSON-based serialization of SCXML (State Chart XML).",
   "author": "Softoboros Technology Inc. <ira@softoboros.com>",
   "license": "BSD-1-Clause",