node-opcua-modeler 2.64.1 → 2.66.0

package/dist/dump_state_machine_to_graphviz.js

@@ -1,120 +1,120 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dumpStateMachineToGraphViz = exports.dumpStateMachineToPlantUML = void 0;
-function dumpStateMachineToPlantUML(stateMachineType) {
-    const lines = [];
-    function w(str) {
-        lines.push(str);
-    }
-    function s(state) {
-        return state ? state.nodeId.value.toString() : "";
-    }
-    function n(state) {
-        return state ? state.browseName.name.toString() : "";
-    }
-    //w("@startuml "); // + stateMachineType.browseName.toString() + ".png");
-    // initial state if any
-    if (stateMachineType.initialState) {
-        w(" [*] --> " + s(stateMachineType.initialState));
-        w(" " + s(stateMachineType.initialState) + ":" + n(stateMachineType.initialState));
-    }
-    else {
-        w("[*] --> [*]");
-    }
-    function t(transition) {
-        let name = n(transition);
-        name = name.replace(":", "");
-        name = name.replace("To", "\\nTo\\n");
-        name = name.replace("Transition", "\\nTransition");
-        return name;
-    }
-    stateMachineType.states && stateMachineType.states.forEach((state) => w(" " + s(state) + ": " + n(state)));
-    stateMachineType.transitions && stateMachineType.transitions.forEach((transition) => w("  " + s(transition.fromStateNode) + " --> " + s(transition.toStateNode) + " : " + t(transition)));
-    //   w("@enduml");
-    return lines.join("\n");
-}
-exports.dumpStateMachineToPlantUML = dumpStateMachineToPlantUML;
-/*
- @startuml
-
- 2930: Unshelved
-
- 2932: TimedShelved
-
- 2933: OneShotShelved
-
- 2930 --> 2932 :   "2935\nUnshelvedToTimedShelved"
-
- 2930 --> 2933 :   "2936\nUnshelvedToOneShotShelved"
-
- 2932 --> 2930 :   "2940\nTimedShelvedToUnshelved"
-
- 2932 --> 2933 :   "2942\nTimedShelvedToOneShotShelved"
-
- 2933 --> 2930 :   "2943\nOneShotShelvedToUnshelved"
-
- 2933 --> 2932 :   "2945\nOneShotShelvedToTimedShelved"
-
- @enduml
-
- */
-/*
- digraph finite_state_machine {
- rankdir=LR;
- size="8,5"
- node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
- node [shape = circle];
- LR_0 -> LR_2 [ label = "SS(B)" ];
- LR_0 -> LR_1 [ label = "SS(S)" ];
- LR_1 -> LR_3 [ label = "S($end)" ];
- LR_2 -> LR_6 [ label = "SS(b)" ];
- LR_2 -> LR_5 [ label = "SS(a)" ];
- LR_2 -> LR_4 [ label = "S(A)" ];
- LR_5 -> LR_7 [ label = "S(b)" ];
- LR_5 -> LR_5 [ label = "S(a)" ];
- LR_6 -> LR_6 [ label = "S(b)" ];
- LR_6 -> LR_5 [ label = "S(a)" ];
- LR_7 -> LR_8 [ label = "S(b)" ];
- LR_7 -> LR_5 [ label = "S(a)" ];
- LR_8 -> LR_6 [ label = "S(b)" ];
- LR_8 -> LR_5 [ label = "S(a)" ];
- }
- */
-function dumpStateMachineToGraphViz(
-/*StateMachineProxy*/
-stateMachineType) {
-    const lines = [];
-    function w(str) {
-        lines.push(str);
-    }
-    function s(state) {
-        return state.nodeId.value.toString();
-    }
-    function n(state) {
-        return state.browseName.name.toString();
-    }
-    function s_full(state) {
-        return s(state) + ' [ label = "' + n(state) + '" ]';
-    }
-    w("digraph finite_state_machine {");
-    // initial state if any
-    if (stateMachineType.initialState) {
-        w("node [ shape = doublecircle];");
-        w("  _" + s_full(stateMachineType.initialState) + " ;");
-    }
-    w("node [ shape = circle];");
-    stateMachineType.states.forEach((state) => w("   _" + s_full(state)));
-    stateMachineType.transitions.forEach((transition) => w("  _" +
-        s(transition.fromStateNode) +
-        " -> _" +
-        s(transition.toStateNode) +
-        " [ " +
-        //   " labeltooltip = \"" + i(transition) + "\" " +
-        ', label = "' +
-        n(transition) +
-        '" ];'));
-    w("}");
-    return lines.join("\n");
-}
-exports.dumpStateMachineToGraphViz = dumpStateMachineToGraphViz;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dumpStateMachineToGraphViz = exports.dumpStateMachineToPlantUML = void 0;
+function dumpStateMachineToPlantUML(stateMachineType) {
+    const lines = [];
+    function w(str) {
+        lines.push(str);
+    }
+    function s(state) {
+        return state ? state.nodeId.value.toString() : "";
+    }
+    function n(state) {
+        return state ? state.browseName.name.toString() : "";
+    }
+    //w("@startuml "); // + stateMachineType.browseName.toString() + ".png");
+    // initial state if any
+    if (stateMachineType.initialState) {
+        w(" [*] --> " + s(stateMachineType.initialState));
+        w(" " + s(stateMachineType.initialState) + ":" + n(stateMachineType.initialState));
+    }
+    else {
+        w("[*] --> [*]");
+    }
+    function t(transition) {
+        let name = n(transition);
+        name = name.replace(":", "");
+        name = name.replace("To", "\\nTo\\n");
+        name = name.replace("Transition", "\\nTransition");
+        return name;
+    }
+    stateMachineType.states && stateMachineType.states.forEach((state) => w(" " + s(state) + ": " + n(state)));
+    stateMachineType.transitions && stateMachineType.transitions.forEach((transition) => w("  " + s(transition.fromStateNode) + " --> " + s(transition.toStateNode) + " : " + t(transition)));
+    //   w("@enduml");
+    return lines.join("\n");
+}
+exports.dumpStateMachineToPlantUML = dumpStateMachineToPlantUML;
+/*
+ @startuml
+
+ 2930: Unshelved
+
+ 2932: TimedShelved
+
+ 2933: OneShotShelved
+
+ 2930 --> 2932 :   "2935\nUnshelvedToTimedShelved"
+
+ 2930 --> 2933 :   "2936\nUnshelvedToOneShotShelved"
+
+ 2932 --> 2930 :   "2940\nTimedShelvedToUnshelved"
+
+ 2932 --> 2933 :   "2942\nTimedShelvedToOneShotShelved"
+
+ 2933 --> 2930 :   "2943\nOneShotShelvedToUnshelved"
+
+ 2933 --> 2932 :   "2945\nOneShotShelvedToTimedShelved"
+
+ @enduml
+
+ */
+/*
+ digraph finite_state_machine {
+ rankdir=LR;
+ size="8,5"
+ node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
+ node [shape = circle];
+ LR_0 -> LR_2 [ label = "SS(B)" ];
+ LR_0 -> LR_1 [ label = "SS(S)" ];
+ LR_1 -> LR_3 [ label = "S($end)" ];
+ LR_2 -> LR_6 [ label = "SS(b)" ];
+ LR_2 -> LR_5 [ label = "SS(a)" ];
+ LR_2 -> LR_4 [ label = "S(A)" ];
+ LR_5 -> LR_7 [ label = "S(b)" ];
+ LR_5 -> LR_5 [ label = "S(a)" ];
+ LR_6 -> LR_6 [ label = "S(b)" ];
+ LR_6 -> LR_5 [ label = "S(a)" ];
+ LR_7 -> LR_8 [ label = "S(b)" ];
+ LR_7 -> LR_5 [ label = "S(a)" ];
+ LR_8 -> LR_6 [ label = "S(b)" ];
+ LR_8 -> LR_5 [ label = "S(a)" ];
+ }
+ */
+function dumpStateMachineToGraphViz(
+/*StateMachineProxy*/
+stateMachineType) {
+    const lines = [];
+    function w(str) {
+        lines.push(str);
+    }
+    function s(state) {
+        return state.nodeId.value.toString();
+    }
+    function n(state) {
+        return state.browseName.name.toString();
+    }
+    function s_full(state) {
+        return s(state) + ' [ label = "' + n(state) + '" ]';
+    }
+    w("digraph finite_state_machine {");
+    // initial state if any
+    if (stateMachineType.initialState) {
+        w("node [ shape = doublecircle];");
+        w("  _" + s_full(stateMachineType.initialState) + " ;");
+    }
+    w("node [ shape = circle];");
+    stateMachineType.states.forEach((state) => w("   _" + s_full(state)));
+    stateMachineType.transitions.forEach((transition) => w("  _" +
+        s(transition.fromStateNode) +
+        " -> _" +
+        s(transition.toStateNode) +
+        " [ " +
+        //   " labeltooltip = \"" + i(transition) + "\" " +
+        ', label = "' +
+        n(transition) +
+        '" ];'));
+    w("}");
+    return lines.join("\n");
+}
+exports.dumpStateMachineToGraphViz = dumpStateMachineToGraphViz;
 //# sourceMappingURL=dump_state_machine_to_graphviz.js.map

package/dist/generate_markdown_doc.d.ts

@@ -1,6 +1,41 @@
-import { Namespace } from "node-opcua-address-space";
-export interface IWriter {
-    writeLine(...args: any[]): void;
-}
-export declare function buildDocumentationToString(namespace: Namespace): Promise<string>;
-export declare function buildDocumentation(namespace: Namespace, writer: IWriter): Promise<void>;
+import { BaseNode, INamespace, UADataType, UAObjectType, UAReferenceType, UAVariableType } from "node-opcua-address-space";
+export interface IWriter {
+    writeLine(_str: string): void;
+}
+export declare class Writer implements IWriter {
+    private readonly stream;
+    constructor();
+    writeLine(str: string): void;
+    toString(): string;
+}
+export interface BuildDocumentationOptions {
+    node?: BaseNode;
+    dumpGraphics?: (writer: IWriter, type: UAObjectType | UAVariableType) => void;
+}
+export declare function buildDocumentationToString(namespace: INamespace, options?: BuildDocumentationOptions): Promise<string>;
+export declare function extractTypes(namespace: INamespace, options?: BuildDocumentationOptions): {
+    dataTypes: UADataType[];
+    variableTypes: UAVariableType[];
+    objectTypes: UAObjectType[];
+    referenceTypes: UAReferenceType[];
+    dataTypeNode?: undefined;
+} | {
+    dataTypes: UADataType[];
+    variableTypes: never[];
+    objectTypes: never[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+} | {
+    dataTypes: never[];
+    variableTypes: never[];
+    objectTypes: UAObjectType[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+} | {
+    dataTypes: never[];
+    variableTypes: UAVariableType[];
+    objectTypes: never[];
+    dataTypeNode: never[];
+    referenceTypes: never[];
+};
+export declare function buildDocumentation(namespace: INamespace, writer: IWriter, options?: BuildDocumentationOptions): Promise<void>;