drakongen 1.0.0

package/examples/ar12.json

@@ -0,0 +1,49 @@
+{
+    "name": "ar12",
+    "params": "",
+    "branches": [
+        {
+            "branchId": 0,
+            "start": "74",
+            "body": [
+                {
+                    "id": "74",
+                    "type": "loop",
+                    "content": "",
+                    "body": [
+                        {
+                            "type": "question",
+                            "id": "4",
+                            "content": {
+                                "operator": "or",
+                                "left": "3",
+                                "right": "5"
+                            },
+                            "yes": [
+                                {
+                                    "type": "break"
+                                }
+                            ],
+                            "no": [
+                                {
+                                    "id": "68",
+                                    "type": "action",
+                                    "content": "4"
+                                },
+                                {
+                                    "id": "arrow-stub-74",
+                                    "type": "loopend",
+                                    "start": "74"
+                                }
+                            ]
+                        }
+                    ]
+                },
+                {
+                    "id": "2",
+                    "type": "end"
+                }
+            ]
+        }
+    ]
+}

package/examples/ar12.txt

@@ -0,0 +1,10 @@
+Procedure "ar12"
+
+Algorithm:
+Loop forever
+    If 3 or 5
+        break
+    Else
+        4
+
+End of procedure

package/examples/getToken.drakon

@@ -0,0 +1,76 @@
+{
+    "items": {
+        "1": {
+            "type": "end"
+        },
+        "2": {
+            "type": "branch",
+            "branchId": 0,
+            "one": "3"
+        },
+        "3": {
+            "type": "action",
+            "content": "<p>Find an existing connection in context.connections by URL</p>",
+            "one": "4"
+        },
+        "4": {
+            "type": "question",
+            "content": "<p>Connection found?</p>",
+            "one": "13",
+            "two": "6",
+            "flag1": 1
+        },
+        "5": {
+            "type": "action",
+            "content": "<p>Try to get an access token using the connection in non-interactive mode.</p>",
+            "one": "8"
+        },
+        "6": {
+            "type": "action",
+            "content": "<p>Create a new MSAL connection object.</p><p>Use the following information to initialize the object:</p><ul><li>context.config.redirectUri is the redirect URI</li><li>context.config.authority is the authority</li><li>context.config.clientId is the client id</li></ul>",
+            "one": "7"
+        },
+        "7": {
+            "type": "action",
+            "content": "<p>Put the connection in context.connections using the URL as the key.</p>",
+            "one": "5"
+        },
+        "8": {
+            "type": "question",
+            "content": "<p>Got exception?</p>",
+            "one": "12",
+            "two": "9",
+            "flag1": 0
+        },
+        "9": {
+            "type": "action",
+            "content": "<p>Get a token in interactive mode.</p>",
+            "one": "10"
+        },
+        "10": {
+            "type": "question",
+            "content": "<p>Did the user cancel the logon?</p>",
+            "one": "12",
+            "two": "11",
+            "flag1": 0
+        },
+        "11": {
+            "type": "action",
+            "content": "<p>Return an empty string</p>",
+            "one": "1"
+        },
+        "12": {
+            "type": "action",
+            "content": "<p>Return the access token</p>",
+            "one": "1"
+        },
+        "13": {
+            "type": "comment",
+            "content": "<p>Some comment</p>",
+            "one": "5"
+        }
+    },
+    "params": "<p>Obtains an access token. Connects to the dataverse if necessary.</p><p>Returns a JWT token as a string.</p><p>An empty return value means the user has cancelled the logon.</p><p><br /></p><p>Parameters:</p><ul><li>context: ServerContext</li><li>url: a string with the address of the dataverse instance</li></ul>",
+    "type": "drakon",
+    "id": "getToken.drakon"
+}

package/examples/getToken.json

@@ -0,0 +1,88 @@
+{
+    "name": "getToken",
+    "params": "<p>Obtains an access token. Connects to the dataverse if necessary.</p><p>Returns a JWT token as a string.</p><p>An empty return value means the user has cancelled the logon.</p><p><br /></p><p>Parameters:</p><ul><li>context: ServerContext</li><li>url: a string with the address of the dataverse instance</li></ul>",
+    "branches": [
+        {
+            "branchId": 0,
+            "start": "3",
+            "body": [
+                {
+                    "id": "3",
+                    "type": "action",
+                    "content": "<p>Find an existing connection in context.connections by URL</p>"
+                },
+                {
+                    "type": "question",
+                    "id": "4",
+                    "content": "<p>Connection found?</p>",
+                    "yes": [
+                        {
+                            "id": "13",
+                            "type": "comment",
+                            "content": "<p>Some comment</p>"
+                        }
+                    ],
+                    "no": [
+                        {
+                            "id": "6",
+                            "type": "action",
+                            "content": "<p>Create a new MSAL connection object.</p><p>Use the following information to initialize the object:</p><ul><li>context.config.redirectUri is the redirect URI</li><li>context.config.authority is the authority</li><li>context.config.clientId is the client id</li></ul>"
+                        },
+                        {
+                            "id": "7",
+                            "type": "action",
+                            "content": "<p>Put the connection in context.connections using the URL as the key.</p>"
+                        }
+                    ]
+                },
+                {
+                    "id": "5",
+                    "type": "action",
+                    "content": "<p>Try to get an access token using the connection in non-interactive mode.</p>"
+                },
+                {
+                    "type": "question",
+                    "id": "8",
+                    "content": "<p>Got exception?</p>",
+                    "yes": [
+                        {
+                            "id": "9",
+                            "type": "action",
+                            "content": "<p>Get a token in interactive mode.</p>"
+                        },
+                        {
+                            "type": "question",
+                            "id": "10",
+                            "content": "<p>Did the user cancel the logon?</p>",
+                            "yes": [
+                                {
+                                    "id": "11",
+                                    "type": "action",
+                                    "content": "<p>Return an empty string</p>"
+                                }
+                            ],
+                            "no": [
+                                {
+                                    "id": "12",
+                                    "type": "action",
+                                    "content": "<p>Return the access token</p>"
+                                }
+                            ]
+                        }
+                    ],
+                    "no": [
+                        {
+                            "id": "12",
+                            "type": "action",
+                            "content": "<p>Return the access token</p>"
+                        }
+                    ]
+                },
+                {
+                    "id": "1",
+                    "type": "end"
+                }
+            ]
+        }
+    ]
+}

package/examples/getToken.txt

@@ -0,0 +1,41 @@
+Obtains an access token. Connects to the dataverse if necessary.
+Returns a JWT token as a string.
+An empty return value means the user has cancelled the logon.
+
+Parameters:
+
+- context: ServerContext
+- url: a string with the address of the dataverse instance
+
+
+Procedure "getToken"
+
+Algorithm:
+Find an existing connection in context.connections by URL
+
+If not (Connection found?)
+    Create a new MSAL connection object.
+    Use the following information to initialize the object:
+    
+    - context.config.redirectUri is the redirect URI
+    - context.config.authority is the authority
+    - context.config.clientId is the client id
+    
+
+    Put the connection in context.connections using the URL as the key.
+
+Try to get an access token using the connection in non-interactive mode.
+
+If Got exception?
+    Get a token in interactive mode.
+
+    If Did the user cancel the logon?
+        Return an empty string
+
+    Else
+        Return the access token
+
+Else
+    Return the access token
+
+End of procedure

package/examples/tmp.drakon

@@ -0,0 +1,49 @@
+{
+    "items": {
+        "1": {
+            "type": "end"
+        },
+        "2": {
+            "type": "branch",
+            "branchId": 1,
+            "one": "5",
+            "content": "Branch1"
+        },
+        "3": {
+            "type": "branch",
+            "content": "Exit",
+            "one": "1",
+            "branchId": 3
+        },
+        "4": {
+            "type": "branch",
+            "content": "Branch2",
+            "one": "6",
+            "branchId": 2
+        },
+        "5": {
+            "type": "question",
+            "content": "<p>AAAAAAA</p>",
+            "one": "4",
+            "two": "3",
+            "flag1": 1
+        },
+        "6": {
+            "type": "question",
+            "content": "<p>BBBB</p>",
+            "one": "7",
+            "two": "3",
+            "flag1": 1
+        },
+        "7": {
+            "type": "action",
+            "content": "<p>CCCC</p>",
+            "one": "3"
+        }
+    },
+    "type": "drakon",
+    "style": "{\"maxWidth\":160}",
+    "id": "tmp.drakon",
+    "params": "<p>It's a nice function</p><p><br /></p><p>Parameters:</p><ul><li>hello</li><li>bye</li><li>foo</li></ul>",
+    "description": "<p>line one</p><p>line two</p><p>line three</p>"
+}

package/examples/tmp.json

@@ -0,0 +1,82 @@
+{
+    "name": "tmp",
+    "params": "<p>It's a nice function</p><p><br /></p><p>Parameters:</p><ul><li>hello</li><li>bye</li><li>foo</li></ul>",
+    "branches": [
+        {
+            "name": "Branch1",
+            "branchId": 1,
+            "start": "5",
+            "body": [
+                {
+                    "type": "question",
+                    "id": "5",
+                    "content": "<p>AAAAAAA</p>",
+                    "yes": [
+                        {
+                            "id": "ad-1000",
+                            "type": "address",
+                            "content": "Branch2"
+                        }
+                    ],
+                    "no": [
+                        {
+                            "id": "ad-1001",
+                            "type": "address",
+                            "content": "Exit"
+                        }
+                    ]
+                },
+                {
+                    "id": "2-end",
+                    "type": "end"
+                }
+            ]
+        },
+        {
+            "name": "Branch2",
+            "branchId": 2,
+            "start": "6",
+            "body": [
+                {
+                    "type": "question",
+                    "id": "6",
+                    "content": "<p>BBBB</p>",
+                    "yes": [
+                        {
+                            "id": "7",
+                            "type": "action",
+                            "content": "<p>CCCC</p>"
+                        },
+                        {
+                            "id": "ad-1002",
+                            "type": "address",
+                            "content": "Exit"
+                        }
+                    ],
+                    "no": [
+                        {
+                            "id": "ad-1002",
+                            "type": "address",
+                            "content": "Exit"
+                        }
+                    ]
+                },
+                {
+                    "id": "4-end",
+                    "type": "end"
+                }
+            ]
+        },
+        {
+            "name": "Exit",
+            "branchId": 3,
+            "start": "1",
+            "body": [
+                {
+                    "id": "1",
+                    "type": "end"
+                }
+            ]
+        }
+    ]
+}

package/examples/tmp.txt

@@ -0,0 +1,37 @@
+It's a nice function
+
+Parameters:
+
+- hello
+- bye
+- foo
+
+
+Procedure "tmp"
+
+Algorithm:
+Call subroutine: "Branch1"
+
+Subroutine: "Branch1"
+If AAAAAAA
+    Call subroutine "Branch2"
+Else
+    Call subroutine "Exit"
+End of subroutine
+
+Subroutine: "Branch2"
+If BBBB
+    CCCC
+
+    Call subroutine "Exit"
+Else
+    Call subroutine "Exit"
+End of subroutine
+
+Subroutine: "Exit"
+End of subroutine
+End of procedure
+
+line one
+line two
+line three

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "drakongen",
+  "version": "1.0.0",
+  "description": "Generates pseudocode and AST from drakon flowcharts built with DrakonWidget or DrakonHub.",
+  "main": "src/index.js",
+  "bin": {
+    "drakongen": "./src/main.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stepan-mitkin/drakongen.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Stepan Mitkin",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "node-html-parser": "^6.1.13"
+  }
+}

package/prompts/drakonToPrompt.txt

@@ -0,0 +1,139 @@
+Write a JavaScript module in CommonJs format that impements function drakonToPrompt.
+Export the function.
+
+The function arguments:
+
+- drakonJson: a JSON string that contains a drakon-graph.
+- filename: the full filename where drakonJson was read from.
+
+The function returns a textual representation of the drakon-graph.
+
+Here is the structure of the drakon-graph.
+
+The "items" property contains a map. The keys are node ids. The values are nodes themselves.
+The first node is the one that has its "type" property equal to "branch" with the lowest "branchId".
+
+The function's algorithm:
+
+- Parse the JSON in drakonJson. If there is an error, add the filename to the description.
+- Start with an empty output list of strings.
+- Add a string: Procedure "<name>". The <name> is the base filename without extension.
+- Add an empty string.
+- If the drakon-graph object has "params" property, add a string: Description:
+  Then, convert the HTML value of the "params" property into a string and add that string to the list.
+  Add an empty string.
+- Build the array of work nodes.
+- Add a string: The algorithm of the procedure is expressed as a graph of steps.
+- Add a string: The id of the first step is <the id of the first node in the array of work nodes>
+- Add an empty string.
+- For each work node, print it to the output list.
+- Add a string: End of procedure.
+- Join the list of strings with the end-of-line separator.
+- Return the result string.
+
+How to build the array of work nodes.
+- Preprocess the select nodes
+- Preprocess the insertion nodes
+- Create an empty set of visited nodes.
+- Create an empty array of work nodes.
+- Call the processBranch procedure with this set, the first node, and the output nodes.
+
+How to preprocess the insertion nodes:
+- For each node in the drakon-graph where node.type === "insertion"
+    Set node.type = "action"
+
+How to preprocess the select nodes:
+- For each node in the drakon-graph where node.type === "select"
+    - build the array of cases and save it in the "cases" property of the node.
+
+How to build the array of cases of a "select" node:
+- Create an empty array
+- Call the visitSelect procedure with the this array and the id stored in the node.one property.
+
+visitSelect procedure takes a node id and the output array as arguments.
+Algorithm of visitSelect procedure:
+- if node id is empty, exit
+- get the node by id
+- add an object to the output array: {value:node.content, next:node.one}
+- recursively call visitSelect with node.two
+
+
+The processBranch procedure traverses the drakon-graph this way:
+- processBranch re-uses the set of visited nodes in recursion
+- If node is in the set of visited nodes, exit.
+- Add the node to the visited nodes.
+- Write the node id in "id" property of the node object.
+- If node.type === "branch", go to the next node.
+- If node.type === "end", exit.
+- If node.type === "comment", go to the next node.
+- If node.type === "arrow-loop":
+    - add the node to the array of work nodes
+    - Go to the next node.
+- If node.type === "action":
+    - if node.content does not have a value, go to the next node.
+    - add the node to the array of work nodes
+    - Go to the next node.
+- if node.type === "question"
+    - If node.content does not have a value, throw an error: A Question icon must have content.
+    - add the node to the array of work nodes
+    - Run processBranch with the node specified in node.one
+    - Run processBranch with the node specified in node.two
+- if node.type === "select"
+    - If node.content does not have a value, throw an error: A Select icon must have content.
+    - add the node to the array of work 
+    - for each item in node.items:
+        - Run processBranch with the node specified in item.next
+- The id of the next node is in the property "one".
+
+How to print a node to the output list of string:
+- If node.type === "action":
+    - if node.content does not have a value, go to the next node.
+    - Add a string: Step id: <node.id>
+    - Convert HTML in node.content into a string and add it to the output list.
+    - Add a string: Next step: <node.one>
+    - Add a string: End of step.
+    - Add an empty string.
+- if node.type === "question"
+    - Add a string: Step id: <node.id>
+    - Convert HTML in node.content into a string and add it to the output list.
+    - Add a string: If yes, next step: the id of the "yes" node.
+    - Add a string: If no, next step: the id of the "no" node.
+    - Add a string: End of step.
+    - Add an empty string.    
+- if node.type === "select"
+    - Add a string: Step id: <node.id>
+    - For each item in node.cases
+        - If item.value is not empty,
+            leftValue = Convert HTML in node.content into a string
+            rightValue = Convert HTML in item.content into a string
+            then, add a string: If <leftValue> = <rightValue>, next step: <item.next>
+        - Otherwise, add a string: Else, next step: <item.next>
+        - If item.value is empty and item is not the last element, throw an error: Only last Case icon can be empty.
+    - Add a string: End of step.
+    - Add an empty string.
+- if node.type === "arrow-loop"
+    - Add a string: Step id: <node.id>
+    - Add a string: Next step: <node.one>
+    - Add a string: End of step.
+    - Add an empty string.
+
+
+In a "question" node, the id of the "yes" node is in "one" property if node.flag1 === 1.
+Otherwise it is in the "two" property.
+
+In a "question" node, the id of the "no" node is in "two" property if node.flag1 === 1.
+Otherwise it is in the "one" property.
+
+When throwing an error, add the filename to the description and the node id if available.
+
+Here is how to convert HTML into string.
+- If the input string is falsish, return an empty string.
+- If the input string does not start and end with HTML tags, return it as it is.
+- Take the text content of each <p> tag into a separate line.
+- Take the text content of each unnumbered list item into a separate line, preceded with a hyphen.
+- Take the text content of each unnumbered list item into a separate line, preceded with the item number.
+- Put an empty line before and after the list.
+- Ignore all other tags.
+
+When generating code, avoid too deeply nested expressions.
+Choose an extra variable over compactness. Prefer readability.

package/prompts/index.txt

@@ -0,0 +1,17 @@
+Write JavaScript code for a NodeJs application.
+The application is a command line tool that accepts one required command line parameter - the path to a file.
+
+Here is the algorithm of the application:
+
+- Read the content of the file into a string. The file is in UTF-8 encoding.
+- Call the function drakonToPrompt(content, filename). Send the content and the full path to that function. The function will return a string.
+- Write the string to disc in UTF-8 encoding. The filename is like the path to the file from the command line,
+but replace its extension to .txt
+
+Use await for async operations.
+Import drakonToPrompt function from ./drakonToPrompt
+
+The format of application is CommonJs.
+If there is an uncaught exception, print both the message and the stacktrace.
+
+If the application has completed its task without errors, do not print anything in the console.