scjson 0.3.1 → 0.3.3

package/README.md

@@ -1,3 +1,5 @@
+<p align="center"><img src="../scjson.png" alt="scjson logo" width="200"/></p>
+
 # scjson JavaScript Package
 
 This directory contains the JavaScript implementation of **scjson**, a format for representing SCXML state machines in JSON. The package provides a command line interface to convert between `.scxml` and `.scjson` files and to validate documents against the project's schema.
@@ -185,32 +187,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
@@ -330,4 +331,4 @@ docker pull iraa/scjson:latest
 ```
 
 
-All source code in this directory is released under the BSD\u00A01-Clause license. See [LICENSE](./LICENSE) and [LEGAL.md](./LEGAL.md) for details.
+All source code in this directory is released under the BSD 1-Clause license. See [LICENSE](./LICENSE) and [LEGAL.md](./LEGAL.md) for details.

package/dist/scjsonProps.d.ts

@@ -5,6 +5,9 @@
  * 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;
     expr: string | null;
@@ -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

@@ -8,6 +8,7 @@
 */
 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,8 +1,12 @@
 {
   "name": "scjson",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "A JSON-based serialization of SCXML (State Chart XML).",
   "author": "Softoboros Technology Inc. <ira@softoboros.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SoftOboros/scjson"
+  },
   "license": "BSD-1-Clause",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",