scjson 0.3.0 → 0.3.2

package/README.md

@@ -185,32 +185,31 @@ Several generated classes share generic helper fields:
 
 ### Document / Object Types
 Plain typescript types without runtime validation.
-
-- `AssignProps` `AssignArray` – update a datamodel location with an expression or value.
-- `CancelProps` `CancelArray` – cancel a pending `<send>` operation.
-- `ContentProps` `ContentArray` – inline payload used by `<send>` and `<invoke>`.
-- `DataProps` `DataArray` – represents a single datamodel variable.
-- `DatamodelProps` `DatamodelArray` – container for one or more `<data>` elements.
-- `DonedataProps` `DonedataArray`  – payload returned when a `<final>` state is reached.
-- `ElseProps` – fallback branch for `<if>` conditions.
-- `ElseifProps` – conditional branch following an `<if>`.
-- `FinalProps` `FinalArray` – marks a terminal state in the machine.
-- `FinalizeProps` `FinalizeArray` – executed after an `<invoke>` completes.
-- `ForeachProps` `ForeachArray` – iterate over items within executable content.
-- `HistoryProps` `HistoryArray` – pseudostate remembering previous active children.
-- `IfProps` `IfArray` – conditional execution block.
-- `InitialProps` `InitialArray` – starting state within a compound state.
-- `InvokeProps` `InvokeArray` – run an external process or machine.
-- `LogProps` `LogArray` – diagnostic output statement.
-- `OnentryProps` `OnentryArray` – actions performed when entering a state.
-- `OnexitProps` `OnexitArray` – actions performed when leaving a state.
-- `ParallelProps` `ParallelArray` – coordinates concurrent regions.
-- `ParamProps` `ParamArray` – parameter passed to `<invoke>` or `<send>`.
-- `RaiseProps` `RaiseArray` – raise an internal event.
-- `ScriptProps` `ScriptArray` – inline executable script.
-- `ScxmlProps` – root element of an SCJSON document.
-- `SendProps` `SendArray` – dispatch an external event.
-- `StateProps` `StateArray` – basic state node.
+- `AssignProps` `AssignArray`         – update a datamodel location with an expression or value.
+- `CancelProps` `CancelArray`         – cancel a pending `<send>` operation.
+- `ContentProps` `ContentArray`       – inline payload used by `<send>` and `<invoke>`.
+- `DataProps` `DataArray`             – represents a single datamodel variable.
+- `DatamodelProps` `DatamodelArray`   – container for one or more `<data>` elements.
+- `DonedataProps` `DonedataArray`     – payload returned when a `<final>` state is reached.
+- `ElseProps`                         – fallback branch for `<if>` conditions.
+- `ElseifProps`                       – conditional branch following an `<if>`.
+- `FinalProps` `FinalArray`           – marks a terminal state in the machine.
+- `FinalizeProps` `FinalizeArray`     – executed after an `<invoke>` completes.
+- `ForeachProps` `ForeachArray`       – iterate over items within executable content.
+- `HistoryProps` `HistoryArray`       – pseudostate remembering previous active children.
+- `IfProps` `IfArray`                 – conditional execution block.
+- `InitialProps` `InitialArray`       – starting state within a compound state.
+- `InvokeProps` `InvokeArray`         – run an external process or machine.
+- `LogProps` `LogArray`               – diagnostic output statement.
+- `OnentryProps` `OnentryArray`       – actions performed when entering a state.
+- `OnexitProps` `OnexitArray`         – actions performed when leaving a state.
+- `ParallelProps` `ParallelArray`     – coordinates concurrent regions.
+- `ParamProps` `ParamArray`           – parameter passed to `<invoke>` or `<send>`.
+- `RaiseProps` `RaiseArray`           – raise an internal event.
+- `ScriptProps` `ScriptArray`         – inline executable script.
+- `ScxmlProps`                        – root element of an SCJSON document.
+- `SendProps` `SendArray`             – dispatch an external event.
+- `StateProps` `StateArray`           – basic state node.
 - `TransitionProps` `TransitionArray` – edge between states triggered by events.
 
 ### Object Management

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/dist/scjsonProps.d.ts

@@ -1,9 +1,12 @@
 /**
- * Agent Name: ts-props
+ * scjsonProps.ts : Properties runtime file for scjson types
  *
  * Part of the scjson project.
  * Developed by Softoboros Technology Inc.
  * Licensed under the BSD 1-Clause License.
+ */
+/**
+ * update a datamodel location with an expression or value.
 */
 export interface AssignProps {
     location: string;
@@ -13,8 +16,23 @@ export interface AssignProps {
     otherAttributes: Record<string, object>;
     content: Record<string, object>[];
 }
+/** Instantiate a default object of type AssignProps */
 export declare const defaultAssign: () => AssignProps;
+/**
+ * update a datamodel location with an expression or value.
+*/
+/** Type for an array of of AssignProps */
 export type AssignArray = AssignProps[];
+/**
+ * The assign type that allows for precise manipulation of the datamodel
+ *     location.
+ *     Types are:
+ *     replacechildren (default),
+ *     firstchild, lastchild,
+ *     previoussibling, nextsibling,
+ *     replace, delete,
+ *     addattribute
+*/
 export declare const AssignTypeDatatypeProps: {
     readonly Addattribute: "addattribute";
     readonly Delete: "delete";
@@ -25,32 +43,60 @@ export declare const AssignTypeDatatypeProps: {
     readonly Replace: "replace";
     readonly Replacechildren: "replacechildren";
 };
+/** executable version of AssignTypeDatatypeProps */
 export type AssignTypeDatatypeProps = typeof AssignTypeDatatypeProps[keyof typeof AssignTypeDatatypeProps];
+/**
+ *     The binding type in use for the SCXML document.
+*/
 export declare const BindingDatatypeProps: {
     readonly Early: "early";
     readonly Late: "late";
 };
+/** executable version of BindingDatatypeProps */
 export type BindingDatatypeProps = typeof BindingDatatypeProps[keyof typeof BindingDatatypeProps];
+/**
+ * Boolean: true or false only
+*/
 export declare const BooleanDatatypeProps: {
     readonly False: "false";
     readonly True: "true";
 };
+/** executable version of BooleanDatatypeProps */
 export type BooleanDatatypeProps = typeof BooleanDatatypeProps[keyof typeof BooleanDatatypeProps];
+/**
+ * cancel a pending `<send>` operation.
+*/
 export interface CancelProps {
     otherElement: Record<string, object>[];
     sendid: string | null;
     sendidexpr: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type CancelProps */
 export declare const defaultCancel: () => CancelProps;
+/**
+ * cancel a pending `<send>` operation.
+*/
+/** Type for an array of of CancelProps */
 export type CancelArray = CancelProps[];
+/**
+ * inline payload used by `<send>` and `<invoke>`.
+*/
 export interface ContentProps {
     content: ScxmlProps[] | null;
     expr: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ContentProps */
 export declare const defaultContent: () => ContentProps;
+/**
+ * inline payload used by `<send>` and `<invoke>`.
+*/
+/** Type for an array of of ContentProps */
 export type ContentArray = ContentProps[];
+/**
+ * represents a single datamodel variable.
+*/
 export interface DataProps {
     id: string;
     src: string | null;
@@ -58,36 +104,74 @@ export interface DataProps {
     otherAttributes: Record<string, object>;
     content: Record<string, object>[];
 }
+/** Instantiate a default object of type DataProps */
 export declare const defaultData: () => DataProps;
+/**
+ * represents a single datamodel variable.
+*/
+/** Type for an array of of DataProps */
 export type DataArray = DataProps[];
+/**
+ * container for one or more `<data>` elements.
+*/
 export interface DatamodelProps {
     data: DataProps[];
     otherElement: Record<string, object>[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type DatamodelProps */
 export declare const defaultDatamodel: () => DatamodelProps;
+/**
+ * container for one or more `<data>` elements.
+*/
+/** Type for an array of of DatamodelProps */
 export type DatamodelArray = DatamodelProps[];
+/**
+ * payload returned when a `<final>` state is reached.
+*/
 export interface DonedataProps {
     content: ContentProps | null;
     param: ParamProps[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type DonedataProps */
 export declare const defaultDonedata: () => DonedataProps;
+/**
+ * payload returned when a `<final>` state is reached.
+*/
+/** Type for an array of of DonedataProps */
 export type DonedataArray = DonedataProps[];
+/**
+ * fallback branch for `<if>` conditions.
+*/
 export interface ElseProps {
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ElseProps */
 export declare const defaultElse: () => ElseProps;
+/**
+ * conditional branch following an `<if>`.
+*/
 export interface ElseifProps {
     cond: string;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ElseifProps */
 export declare const defaultElseif: () => ElseifProps;
+/**
+ *     Describes the processor execution mode for this document, being either "lax"
+ * or
+ *     "strict".
+*/
 export declare const ExmodeDatatypeProps: {
     readonly Lax: "lax";
     readonly Strict: "strict";
 };
+/** executable version of ExmodeDatatypeProps */
 export type ExmodeDatatypeProps = typeof ExmodeDatatypeProps[keyof typeof ExmodeDatatypeProps];
+/**
+ * marks a terminal state in the machine.
+*/
 export interface FinalProps {
     onentry: OnentryProps[];
     onexit: OnexitProps[];
@@ -96,8 +180,16 @@ export interface FinalProps {
     id: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type FinalProps */
 export declare const defaultFinal: () => FinalProps;
+/**
+ * marks a terminal state in the machine.
+*/
+/** Type for an array of of FinalProps */
 export type FinalArray = FinalProps[];
+/**
+ * executed after an `<invoke>` completes.
+*/
 export interface FinalizeProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -110,8 +202,16 @@ export interface FinalizeProps {
     cancel: CancelProps[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type FinalizeProps */
 export declare const defaultFinalize: () => FinalizeProps;
+/**
+ * executed after an `<invoke>` completes.
+*/
+/** Type for an array of of FinalizeProps */
 export type FinalizeArray = FinalizeProps[];
+/**
+ * iterate over items within executable content.
+*/
 export interface ForeachProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -127,8 +227,16 @@ export interface ForeachProps {
     index: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ForeachProps */
 export declare const defaultForeach: () => ForeachProps;
+/**
+ * iterate over items within executable content.
+*/
+/** Type for an array of of ForeachProps */
 export type ForeachArray = ForeachProps[];
+/**
+ * pseudostate remembering previous active children.
+*/
 export interface HistoryProps {
     otherElement: Record<string, object>[];
     transition: TransitionProps;
@@ -136,13 +244,25 @@ export interface HistoryProps {
     typeValue: HistoryTypeDatatypeProps | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type HistoryProps */
 export declare const defaultHistory: () => HistoryProps;
+/**
+ * pseudostate remembering previous active children.
+*/
+/** Type for an array of of HistoryProps */
 export type HistoryArray = HistoryProps[];
+/**
+ * type of `<history>` state: `shallow` or `deep`.
+*/
 export declare const HistoryTypeDatatypeProps: {
     readonly Deep: "deep";
     readonly Shallow: "shallow";
 };
+/** executable version of HistoryTypeDatatypeProps */
 export type HistoryTypeDatatypeProps = typeof HistoryTypeDatatypeProps[keyof typeof HistoryTypeDatatypeProps];
+/**
+ * conditional execution block.
+*/
 export interface IfProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -158,15 +278,31 @@ export interface IfProps {
     cond: string;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type IfProps */
 export declare const defaultIf: () => IfProps;
+/**
+ * conditional execution block.
+*/
+/** Type for an array of of IfProps */
 export type IfArray = IfProps[];
+/**
+ * starting state within a compound state.
+*/
 export interface InitialProps {
     otherElement: Record<string, object>[];
     transition: TransitionProps;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type InitialProps */
 export declare const defaultInitial: () => InitialProps;
+/**
+ * starting state within a compound state.
+*/
+/** Type for an array of of InitialProps */
 export type InitialArray = InitialProps[];
+/**
+ * run an external process or machine.
+*/
 export interface InvokeProps {
     content: ContentProps[];
     param: ParamProps[];
@@ -182,16 +318,32 @@ export interface InvokeProps {
     autoforward: BooleanDatatypeProps;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type InvokeProps */
 export declare const defaultInvoke: () => InvokeProps;
+/**
+ * run an external process or machine.
+*/
+/** Type for an array of of InvokeProps */
 export type InvokeArray = InvokeProps[];
+/**
+ * diagnostic output statement.
+*/
 export interface LogProps {
     otherElement: Record<string, object>[];
     label: string | null;
     expr: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type LogProps */
 export declare const defaultLog: () => LogProps;
+/**
+ * diagnostic output statement.
+*/
+/** Type for an array of of LogProps */
 export type LogArray = LogProps[];
+/**
+ * actions performed when entering a state.
+*/
 export interface OnentryProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -204,8 +356,16 @@ export interface OnentryProps {
     cancel: CancelProps[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type OnentryProps */
 export declare const defaultOnentry: () => OnentryProps;
+/**
+ * actions performed when entering a state.
+*/
+/** Type for an array of of OnentryProps */
 export type OnentryArray = OnentryProps[];
+/**
+ * actions performed when leaving a state.
+*/
 export interface OnexitProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -218,8 +378,16 @@ export interface OnexitProps {
     cancel: CancelProps[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type OnexitProps */
 export declare const defaultOnexit: () => OnexitProps;
+/**
+ * actions performed when leaving a state.
+*/
+/** Type for an array of of OnexitProps */
 export type OnexitArray = OnexitProps[];
+/**
+ * coordinates concurrent regions.
+*/
 export interface ParallelProps {
     onentry: OnentryProps[];
     onexit: OnexitProps[];
@@ -233,8 +401,16 @@ export interface ParallelProps {
     id: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ParallelProps */
 export declare const defaultParallel: () => ParallelProps;
+/**
+ * coordinates concurrent regions.
+*/
+/** Type for an array of of ParallelProps */
 export type ParallelArray = ParallelProps[];
+/**
+ * parameter passed to `<invoke>` or `<send>`.
+*/
 export interface ParamProps {
     otherElement: Record<string, object>[];
     name: string;
@@ -242,21 +418,45 @@ export interface ParamProps {
     location: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ParamProps */
 export declare const defaultParam: () => ParamProps;
+/**
+ * parameter passed to `<invoke>` or `<send>`.
+*/
+/** Type for an array of of ParamProps */
 export type ParamArray = ParamProps[];
+/**
+ * raise an internal event.
+*/
 export interface RaiseProps {
     event: string;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type RaiseProps */
 export declare const defaultRaise: () => RaiseProps;
+/**
+ * raise an internal event.
+*/
+/** Type for an array of of RaiseProps */
 export type RaiseArray = RaiseProps[];
+/**
+ * inline executable script.
+*/
 export interface ScriptProps {
     src: string | null;
     otherAttributes: Record<string, object>;
     content: Record<string, object>[];
 }
+/** Instantiate a default object of type ScriptProps */
 export declare const defaultScript: () => ScriptProps;
+/**
+ * inline executable script.
+*/
+/** Type for an array of of ScriptProps */
 export type ScriptArray = ScriptProps[];
+/**
+ * root element of an SCJSON document.
+*/
 export interface ScxmlProps {
     state: StateProps[];
     parallel: ParallelProps[];
@@ -272,7 +472,11 @@ export interface ScxmlProps {
     exmode: ExmodeDatatypeProps | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type ScxmlProps */
 export declare const defaultScxml: () => ScxmlProps;
+/**
+ * dispatch an external event.
+*/
 export interface SendProps {
     content: ContentProps[];
     param: ParamProps[];
@@ -290,8 +494,16 @@ export interface SendProps {
     namelist: string | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type SendProps */
 export declare const defaultSend: () => SendProps;
+/**
+ * dispatch an external event.
+*/
+/** Type for an array of of SendProps */
 export type SendArray = SendProps[];
+/**
+ * basic state node.
+*/
 export interface StateProps {
     onentry: OnentryProps[];
     onexit: OnexitProps[];
@@ -308,8 +520,16 @@ export interface StateProps {
     initialAttribute: string[];
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type StateProps */
 export declare const defaultState: () => StateProps;
+/**
+ * basic state node.
+*/
+/** Type for an array of of StateProps */
 export type StateArray = StateProps[];
+/**
+ * edge between states triggered by events.
+*/
 export interface TransitionProps {
     otherElement: Record<string, object>[];
     raiseValue: RaiseProps[];
@@ -326,12 +546,21 @@ export interface TransitionProps {
     typeValue: TransitionTypeDatatypeProps | null;
     otherAttributes: Record<string, object>;
 }
+/** Instantiate a default object of type TransitionProps */
 export declare const defaultTransition: () => TransitionProps;
+/**
+ * edge between states triggered by events.
+*/
+/** Type for an array of of TransitionProps */
 export type TransitionArray = TransitionProps[];
+/**
+ *     The type of the transition i.e. internal or external.
+*/
 export declare const TransitionTypeDatatypeProps: {
     readonly External: "external";
     readonly Internal: "internal";
 };
+/** executable version of TransitionTypeDatatypeProps */
 export type TransitionTypeDatatypeProps = typeof TransitionTypeDatatypeProps[keyof typeof TransitionTypeDatatypeProps];
 export type Kind = "number" | "string" | "record<string, object>" | "number[]" | "string[]" | "record<string, object>[]" | "assign" | "assigntypedatatype" | "bindingdatatype" | "booleandatatype" | "cancel" | "content" | "data" | "datamodel" | "donedata" | "else" | "elseif" | "exmodedatatype" | "final" | "finalize" | "foreach" | "history" | "historytypedatatype" | "if" | "initial" | "invoke" | "log" | "onentry" | "onexit" | "parallel" | "param" | "raise" | "script" | "scxml" | "send" | "state" | "transition" | "transitiontypedatatype" | "assignarray" | "cancelarray" | "contentarray" | "dataarray" | "datamodelarray" | "donedataarray" | "finalarray" | "finalizearray" | "foreacharray" | "historyarray" | "ifarray" | "initialarray" | "invokearray" | "logarray" | "onentryarray" | "onexitarray" | "parallelarray" | "paramarray" | "raisearray" | "scriptarray" | "sendarray" | "statearray" | "transitionarray";
 export type PropsUnion = null | string | number | Record<string, object> | string[] | number[] | Record<string, object>[] | AssignProps | AssignTypeDatatypeProps | BindingDatatypeProps | BooleanDatatypeProps | CancelProps | ContentProps | DataProps | DatamodelProps | DonedataProps | ElseProps | ElseifProps | ExmodeDatatypeProps | FinalProps | FinalizeProps | ForeachProps | HistoryProps | HistoryTypeDatatypeProps | IfProps | InitialProps | InvokeProps | LogProps | OnentryProps | OnexitProps | ParallelProps | ParamProps | RaiseProps | ScriptProps | ScxmlProps | SendProps | StateProps | TransitionProps | TransitionTypeDatatypeProps | AssignArray | CancelArray | ContentArray | DataArray | DatamodelArray | DonedataArray | FinalArray | FinalizeArray | ForeachArray | HistoryArray | IfArray | InitialArray | InvokeArray | LogArray | OnentryArray | OnexitArray | ParallelArray | ParamArray | RaiseArray | ScriptArray | SendArray | StateArray | TransitionArray;

package/dist/scjsonProps.js

@@ -1,13 +1,14 @@
 "use strict";
 /**
- * Agent Name: ts-props
+ * scjsonProps.ts : Properties runtime file for scjson types
  *
  * Part of the scjson project.
  * Developed by Softoboros Technology Inc.
  * Licensed under the BSD 1-Clause License.
-*/
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransitionTypeDatatypeProps = exports.defaultTransition = exports.defaultState = exports.defaultSend = exports.defaultScxml = exports.defaultScript = exports.defaultRaise = exports.defaultParam = exports.defaultParallel = exports.defaultOnexit = exports.defaultOnentry = exports.defaultLog = exports.defaultInvoke = exports.defaultInitial = exports.defaultIf = exports.HistoryTypeDatatypeProps = exports.defaultHistory = exports.defaultForeach = exports.defaultFinalize = exports.defaultFinal = exports.ExmodeDatatypeProps = exports.defaultElseif = exports.defaultElse = exports.defaultDonedata = exports.defaultDatamodel = exports.defaultData = exports.defaultContent = exports.defaultCancel = exports.BooleanDatatypeProps = exports.BindingDatatypeProps = exports.AssignTypeDatatypeProps = exports.defaultAssign = void 0;
+/** Instantiate a default object of type AssignProps */
 const defaultAssign = () => ({
     location: "",
     expr: null,
@@ -17,6 +18,16 @@ const defaultAssign = () => ({
     content: [],
 });
 exports.defaultAssign = defaultAssign;
+/**
+ * The assign type that allows for precise manipulation of the datamodel
+ *     location.
+ *     Types are:
+ *     replacechildren (default),
+ *     firstchild, lastchild,
+ *     previoussibling, nextsibling,
+ *     replace, delete,
+ *     addattribute
+*/
 exports.AssignTypeDatatypeProps = {
     Addattribute: "addattribute",
     Delete: "delete",
@@ -27,14 +38,21 @@ exports.AssignTypeDatatypeProps = {
     Replace: "replace",
     Replacechildren: "replacechildren",
 };
+/**
+ *     The binding type in use for the SCXML document.
+*/
 exports.BindingDatatypeProps = {
     Early: "early",
     Late: "late",
 };
+/**
+ * Boolean: true or false only
+*/
 exports.BooleanDatatypeProps = {
     False: "false",
     True: "true",
 };
+/** Instantiate a default object of type CancelProps */
 const defaultCancel = () => ({
     otherElement: [],
     sendid: null,
@@ -42,12 +60,14 @@ const defaultCancel = () => ({
     otherAttributes: {},
 });
 exports.defaultCancel = defaultCancel;
+/** Instantiate a default object of type ContentProps */
 const defaultContent = () => ({
     content: null,
     expr: null,
     otherAttributes: {},
 });
 exports.defaultContent = defaultContent;
+/** Instantiate a default object of type DataProps */
 const defaultData = () => ({
     id: "",
     src: null,
@@ -56,31 +76,41 @@ const defaultData = () => ({
     content: [],
 });
 exports.defaultData = defaultData;
+/** Instantiate a default object of type DatamodelProps */
 const defaultDatamodel = () => ({
     data: [],
     otherElement: [],
     otherAttributes: {},
 });
 exports.defaultDatamodel = defaultDatamodel;
+/** Instantiate a default object of type DonedataProps */
 const defaultDonedata = () => ({
     content: null,
     param: [],
     otherAttributes: {},
 });
 exports.defaultDonedata = defaultDonedata;
+/** Instantiate a default object of type ElseProps */
 const defaultElse = () => ({
     otherAttributes: {},
 });
 exports.defaultElse = defaultElse;
+/** Instantiate a default object of type ElseifProps */
 const defaultElseif = () => ({
     cond: "",
     otherAttributes: {},
 });
 exports.defaultElseif = defaultElseif;
+/**
+ *     Describes the processor execution mode for this document, being either "lax"
+ * or
+ *     "strict".
+*/
 exports.ExmodeDatatypeProps = {
     Lax: "lax",
     Strict: "strict",
 };
+/** Instantiate a default object of type FinalProps */
 const defaultFinal = () => ({
     onentry: [],
     onexit: [],
@@ -90,6 +120,7 @@ const defaultFinal = () => ({
     otherAttributes: {},
 });
 exports.defaultFinal = defaultFinal;
+/** Instantiate a default object of type FinalizeProps */
 const defaultFinalize = () => ({
     otherElement: [],
     raiseValue: [],
@@ -103,6 +134,7 @@ const defaultFinalize = () => ({
     otherAttributes: {},
 });
 exports.defaultFinalize = defaultFinalize;
+/** Instantiate a default object of type ForeachProps */
 const defaultForeach = () => ({
     otherElement: [],
     raiseValue: [],
@@ -119,6 +151,7 @@ const defaultForeach = () => ({
     otherAttributes: {},
 });
 exports.defaultForeach = defaultForeach;
+/** Instantiate a default object of type HistoryProps */
 const defaultHistory = () => ({
     otherElement: [],
     transition: (0, exports.defaultTransition)(),
@@ -127,10 +160,14 @@ const defaultHistory = () => ({
     otherAttributes: {},
 });
 exports.defaultHistory = defaultHistory;
+/**
+ * type of `<history>` state: `shallow` or `deep`.
+*/
 exports.HistoryTypeDatatypeProps = {
     Deep: "deep",
     Shallow: "shallow",
 };
+/** Instantiate a default object of type IfProps */
 const defaultIf = () => ({
     otherElement: [],
     raiseValue: [],
@@ -147,12 +184,14 @@ const defaultIf = () => ({
     otherAttributes: {},
 });
 exports.defaultIf = defaultIf;
+/** Instantiate a default object of type InitialProps */
 const defaultInitial = () => ({
     otherElement: [],
     transition: (0, exports.defaultTransition)(),
     otherAttributes: {},
 });
 exports.defaultInitial = defaultInitial;
+/** Instantiate a default object of type InvokeProps */
 const defaultInvoke = () => ({
     content: [],
     param: [],
@@ -169,6 +208,7 @@ const defaultInvoke = () => ({
     otherAttributes: {},
 });
 exports.defaultInvoke = defaultInvoke;
+/** Instantiate a default object of type LogProps */
 const defaultLog = () => ({
     otherElement: [],
     label: null,
@@ -176,6 +216,7 @@ const defaultLog = () => ({
     otherAttributes: {},
 });
 exports.defaultLog = defaultLog;
+/** Instantiate a default object of type OnentryProps */
 const defaultOnentry = () => ({
     otherElement: [],
     raiseValue: [],
@@ -189,6 +230,7 @@ const defaultOnentry = () => ({
     otherAttributes: {},
 });
 exports.defaultOnentry = defaultOnentry;
+/** Instantiate a default object of type OnexitProps */
 const defaultOnexit = () => ({
     otherElement: [],
     raiseValue: [],
@@ -202,6 +244,7 @@ const defaultOnexit = () => ({
     otherAttributes: {},
 });
 exports.defaultOnexit = defaultOnexit;
+/** Instantiate a default object of type ParallelProps */
 const defaultParallel = () => ({
     onentry: [],
     onexit: [],
@@ -216,6 +259,7 @@ const defaultParallel = () => ({
     otherAttributes: {},
 });
 exports.defaultParallel = defaultParallel;
+/** Instantiate a default object of type ParamProps */
 const defaultParam = () => ({
     otherElement: [],
     name: "",
@@ -224,17 +268,20 @@ const defaultParam = () => ({
     otherAttributes: {},
 });
 exports.defaultParam = defaultParam;
+/** Instantiate a default object of type RaiseProps */
 const defaultRaise = () => ({
     event: "",
     otherAttributes: {},
 });
 exports.defaultRaise = defaultRaise;
+/** Instantiate a default object of type ScriptProps */
 const defaultScript = () => ({
     src: null,
     otherAttributes: {},
     content: [],
 });
 exports.defaultScript = defaultScript;
+/** Instantiate a default object of type ScxmlProps */
 const defaultScxml = () => ({
     state: [],
     parallel: [],
@@ -251,6 +298,7 @@ const defaultScxml = () => ({
     otherAttributes: {},
 });
 exports.defaultScxml = defaultScxml;
+/** Instantiate a default object of type SendProps */
 const defaultSend = () => ({
     content: [],
     param: [],
@@ -269,6 +317,7 @@ const defaultSend = () => ({
     otherAttributes: {},
 });
 exports.defaultSend = defaultSend;
+/** Instantiate a default object of type StateProps */
 const defaultState = () => ({
     onentry: [],
     onexit: [],
@@ -286,6 +335,7 @@ const defaultState = () => ({
     otherAttributes: {},
 });
 exports.defaultState = defaultState;
+/** Instantiate a default object of type TransitionProps */
 const defaultTransition = () => ({
     otherElement: [],
     raiseValue: [],
@@ -303,6 +353,9 @@ const defaultTransition = () => ({
     otherAttributes: {},
 });
 exports.defaultTransition = defaultTransition;
+/**
+ *     The type of the transition i.e. internal or external.
+*/
 exports.TransitionTypeDatatypeProps = {
     External: "external",
     Internal: "internal",

package/package.json

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