state-machine-cat 12.0.5 → 12.0.7

package/types/state-machine-cat.d.mts

@@ -1,142 +1,142 @@
 export type StateType =
-  | "regular"
-  | "initial"
-  | "final"
-  | "parallel"
-  | "choice"
-  | "fork"
-  | "forkjoin"
-  | "history"
-  | "deephistory"
-  | "join"
-  | "junction"
-  | "terminate";
+	| "regular"
+	| "initial"
+	| "final"
+	| "parallel"
+	| "choice"
+	| "fork"
+	| "forkjoin"
+	| "history"
+	| "deephistory"
+	| "join"
+	| "junction"
+	| "terminate";
 
 export type TransitionType = "external" | "internal";
 
 export type ActionTypeType = "activity" | "entry" | "exit";
 
 export interface IActionType {
-  body: string;
-  type: ActionTypeType;
+	body: string;
+	type: ActionTypeType;
 }
 
 export interface IState {
-  /**
-   * The name and identifier of the state. Unique within the root state machine.
-   */
-  name: string;
-  /**
-   * What kind of state (or pseudo state) this state is. E.g. 'regular'
-   * for normal states or 'initial', 'final', 'choice' etc for pseudo states
-   */
-  type: StateType;
-  /**
-   * The display label of the state. If it's not present, most renderers
-   * will use the states' name in stead
-   */
-  label?: string;
-  /**
-   * A series of actions and their types. The type describe when the action
-   * takes place (on entry, exit, or otherwise ('activity'))
-   */
-  actions?: IActionType[];
-  /**
-   * State machine nested within the state.
-   */
-  // eslint-disable-next-line no-use-before-define
-  statemachine?: IStateMachine;
-  /**
-   * If true the state is considered to be active and rendered as such.
-   */
-  active?: boolean;
-  /**
-   * Color to use for rendering the state. Accepts all css color names
-   * (\"blue\") and hex notation - with (\"#0000FF77\") or without
-   * (\"#0000FF\") transparency.
-   */
-  color?: string;
-  /**
-   * Class name to give the state in dot and svg output.
-   */
-  class?: string;
-  /**
-   * Comments related to this state. Some renderers will use the note
-   * attribute to render a note (i.e. as a post-it) attached to the
-   * state.
-   */
-  note?: string[];
-  /**
-   * convenience, derived attribute - set to true if there's a state
-   * machine inside the state; false in all other cases. For internal
-   * use - @deprecated
-   */
-  isComposite?: boolean;
-  /**
-   * The default parser derives the `type` from the `name` with inband
-   * signaling. The user can override that behavior by explicitly setting
-   * the `type`. This attribute is there to express that (and make sure
-   * that on next parses & processing it doesn't get accidentily
-   * re-derived from the name again)
-   */
-  typeExplicitlySet?: boolean;
+	/**
+	 * The name and identifier of the state. Unique within the root state machine.
+	 */
+	name: string;
+	/**
+	 * What kind of state (or pseudo state) this state is. E.g. 'regular'
+	 * for normal states or 'initial', 'final', 'choice' etc for pseudo states
+	 */
+	type: StateType;
+	/**
+	 * The display label of the state. If it's not present, most renderers
+	 * will use the states' name in stead
+	 */
+	label?: string;
+	/**
+	 * A series of actions and their types. The type describe when the action
+	 * takes place (on entry, exit, or otherwise ('activity'))
+	 */
+	actions?: IActionType[];
+	/**
+	 * State machine nested within the state.
+	 */
+	// eslint-disable-next-line no-use-before-define
+	statemachine?: IStateMachine;
+	/**
+	 * If true the state is considered to be active and rendered as such.
+	 */
+	active?: boolean;
+	/**
+	 * Color to use for rendering the state. Accepts all css color names
+	 * (\"blue\") and hex notation - with (\"#0000FF77\") or without
+	 * (\"#0000FF\") transparency.
+	 */
+	color?: string;
+	/**
+	 * Class name to give the state in dot and svg output.
+	 */
+	class?: string;
+	/**
+	 * Comments related to this state. Some renderers will use the note
+	 * attribute to render a note (i.e. as a post-it) attached to the
+	 * state.
+	 */
+	note?: string[];
+	/**
+	 * convenience, derived attribute - set to true if there's a state
+	 * machine inside the state; false in all other cases. For internal
+	 * use - @deprecated
+	 */
+	isComposite?: boolean;
+	/**
+	 * The default parser derives the `type` from the `name` with inband
+	 * signaling. The user can override that behavior by explicitly setting
+	 * the `type`. This attribute is there to express that (and make sure
+	 * that on next parses & processing it doesn't get accidentily
+	 * re-derived from the name again)
+	 */
+	typeExplicitlySet?: boolean;
 }
 
 export interface ITransition {
-  /**
-   * The name of the IState the transition is from
-   */
-  from: string;
-  /**
-   * The name of the IState the transition is to
-   */
-  to: string;
-  /**
-   * A display label to represent this transition. Parsers can parse this
-   * label into events conditions and actions.
-   */
-  label?: string;
-  /**
-   * Event triggering the transition
-   */
-  event?: string;
-  /**
-   * Condition for the transition to occur.
-   */
-  cond?: string;
-  /**
-   * Action to execute when the transition occurs.
-   */
-  action?: string;
-  /**
-   * Comments related to this transition. Some renderers will use the note
-   * attribute to render a note attached to the transition.
-   */
-  note?: string[];
-  /**
-   * Color to use for rendering the transition. Accepts all css color
-   * names (\"blue\") and hex notation - with (\"#0000FF77\") or without
-   * (\"#0000FF\") transparency.
-   */
-  color?: string;
-  /**
-   * The line width to use for rendering the transition
-   */
-  width?: number;
-  /**
-   * Class name to give the transition in dot and svg output.
-   */
-  class?: string;
-  /**
-   * Whether the transition is "external" (the default) or "internal".
-   * See https://www.w3.org/TR/scxml/#transition for details.
-   */
-  type?: TransitionType;
+	/**
+	 * The name of the IState the transition is from
+	 */
+	from: string;
+	/**
+	 * The name of the IState the transition is to
+	 */
+	to: string;
+	/**
+	 * A display label to represent this transition. Parsers can parse this
+	 * label into events conditions and actions.
+	 */
+	label?: string;
+	/**
+	 * Event triggering the transition
+	 */
+	event?: string;
+	/**
+	 * Condition for the transition to occur.
+	 */
+	cond?: string;
+	/**
+	 * Action to execute when the transition occurs.
+	 */
+	action?: string;
+	/**
+	 * Comments related to this transition. Some renderers will use the note
+	 * attribute to render a note attached to the transition.
+	 */
+	note?: string[];
+	/**
+	 * Color to use for rendering the transition. Accepts all css color
+	 * names (\"blue\") and hex notation - with (\"#0000FF77\") or without
+	 * (\"#0000FF\") transparency.
+	 */
+	color?: string;
+	/**
+	 * The line width to use for rendering the transition
+	 */
+	width?: number;
+	/**
+	 * Class name to give the transition in dot and svg output.
+	 */
+	class?: string;
+	/**
+	 * Whether the transition is "external" (the default) or "internal".
+	 * See https://www.w3.org/TR/scxml/#transition for details.
+	 */
+	type?: TransitionType;
 }
 
 export interface IStateMachine {
-  states: IState[];
-  transitions?: ITransition[];
+	states: IState[];
+	transitions?: ITransition[];
 }
 
 /**
@@ -149,24 +149,24 @@ export interface IStateMachine {
 export const version: string;
 
 export interface IAllowedValue {
-  default: string;
-  values: {
-    name: string;
-  }[];
+	default: string;
+	values: {
+		name: string;
+	}[];
 }
 
 export interface IAllowedBooleanValue {
-  default: boolean;
-  values: {
-    name: boolean;
-  }[];
+	default: boolean;
+	values: {
+		name: boolean;
+	}[];
 }
 export interface IAllowedValues {
-  inputType: IAllowedValue;
-  outputType: IAllowedValue;
-  engine: IAllowedValue;
-  direction: IAllowedValue;
-  desugar: IAllowedBooleanValue;
+	inputType: IAllowedValue;
+	outputType: IAllowedValue;
+	engine: IAllowedValue;
+	direction: IAllowedValue;
+	desugar: IAllowedBooleanValue;
 }
 
 /**
@@ -183,98 +183,98 @@ export function getAllowedValues(): IAllowedValues;
 export type InputType = "smcat" | "json" | "scxml";
 
 export type OutputType =
-  | "ast"
-  | "dot"
-  | "eps"
-  | "json"
-  | "oldeps"
-  | "oldps"
-  | "oldps2"
-  | "oldsvg"
-  | "pdf"
-  | "png"
-  | "ps"
-  | "ps2"
-  | "scjson"
-  | "scxml"
-  | "smcat"
-  | "svg";
+	| "ast"
+	| "dot"
+	| "eps"
+	| "json"
+	| "oldeps"
+	| "oldps"
+	| "oldps2"
+	| "oldsvg"
+	| "pdf"
+	| "png"
+	| "ps"
+	| "ps2"
+	| "scjson"
+	| "scxml"
+	| "smcat"
+	| "svg";
 
 export type EngineType = "dot" | "circo" | "fdp" | "neato" | "osage" | "twopi";
 
 export type DirectionType =
-  | "top-down"
-  | "bottom-top"
-  | "left-right"
-  | "right-left";
+	| "top-down"
+	| "bottom-top"
+	| "left-right"
+	| "right-left";
 
 export type dotAttributesType = {
-  name: string;
-  value: string;
+	name: string;
+	value: string;
 }[];
 
 export interface IBaseRenderOptions {
-  /**
-   * How to interpret the input (defaults to 'smcat')
-   */
-  inputType?: InputType;
-  /**
-   * What renderer to use (defaults to 'svg')
-   */
-  outputType?: OutputType;
-  /**
-   * For the 'dot' renderer: what engine to use (defaults to 'dot')
-   */
-  engine?: EngineType;
-  /**
-   * For the 'dot' renderer: in what direction to plot the states
-   * (defaults to 'top-down')
-   */
-  direction?: DirectionType;
-  /**
-   * If true state machine cat will replace 'sugar' pseudo states
-   * (choice, forks and junctions) with their equivalent meaning
-   * (defaults to false).
-   *
-   * For details: https://github.com/sverweij/state-machine-cat/blob/main/docs/desugar.md
-   */
-  desugar?: boolean;
+	/**
+	 * How to interpret the input (defaults to 'smcat')
+	 */
+	inputType?: InputType;
+	/**
+	 * What renderer to use (defaults to 'svg')
+	 */
+	outputType?: OutputType;
+	/**
+	 * For the 'dot' renderer: what engine to use (defaults to 'dot')
+	 */
+	engine?: EngineType;
+	/**
+	 * For the 'dot' renderer: in what direction to plot the states
+	 * (defaults to 'top-down')
+	 */
+	direction?: DirectionType;
+	/**
+	 * If true state machine cat will replace 'sugar' pseudo states
+	 * (choice, forks and junctions) with their equivalent meaning
+	 * (defaults to false).
+	 *
+	 * For details: https://github.com/sverweij/state-machine-cat/blob/main/docs/desugar.md
+	 */
+	desugar?: boolean;
 }
 
 export interface IRenderOptions extends IBaseRenderOptions {
-  /**
-   * For the 'dot' renderer: Graph attributes to the engine
-   */
-  dotGraphAttrs?: dotAttributesType;
-  /**
-   * For the 'dot' renderer: Node attributes to the engine
-   */
-  dotNodeAttrs?: dotAttributesType;
-  /**
-   * For the 'dot' renderer: Edge attributes to the engine
-   */
-  dotEdgeAttrs?: dotAttributesType;
-  /**
-   * On nodejs don't display the warning that GraphViz 'dot'
-   * can't be found and we're falling back to wasm
-   */
-  noDotNativeWarning?: boolean;
+	/**
+	 * For the 'dot' renderer: Graph attributes to the engine
+	 */
+	dotGraphAttrs?: dotAttributesType;
+	/**
+	 * For the 'dot' renderer: Node attributes to the engine
+	 */
+	dotNodeAttrs?: dotAttributesType;
+	/**
+	 * For the 'dot' renderer: Edge attributes to the engine
+	 */
+	dotEdgeAttrs?: dotAttributesType;
+	/**
+	 * On nodejs don't display the warning that GraphViz 'dot'
+	 * can't be found and we're falling back to wasm
+	 */
+	noDotNativeWarning?: boolean;
 }
 
 export type StringRenderFunctionType = (
-  pStateMachine: IStateMachine,
-  pOptions?: IRenderOptions,
+	pStateMachine: IStateMachine,
+	pOptions?: IRenderOptions,
 ) => string;
 
 export type WhateverRenderFunctionType = (
-  pStateMachine: IStateMachine,
-  pOptions?: IRenderOptions,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+	pStateMachine: IStateMachine,
+	pOptions?: IRenderOptions,
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 ) => any;
 
 export type RenderFunctionType =
-  | StringRenderFunctionType
-  | WhateverRenderFunctionType;
+	| StringRenderFunctionType
+	| WhateverRenderFunctionType;
 
 /**
  * Translates the input script to an output script.
@@ -291,6 +291,6 @@ export type RenderFunctionType =
  *
  */
 export function render(
-  pScript: IStateMachine | string,
-  pOptions: IRenderOptions,
+	pScript: IStateMachine | string,
+	pOptions: IRenderOptions,
 ): string;