Initial lean NIM-Script debug framework.

Author: Auke Bruinsma

.gitignore

@@ -0,0 +1,3 @@
+node_modules/**/*
+out/**/*
+config.json

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "sourceMaps": true,
+            "program": "${workspaceFolder}\\out\\src\\main.js",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "eslint.format.enable": true,
+    "eslint.codeActionsOnSave.mode": "all",
+    "editor.tabSize": 2,
+    "[typescript]": {
+        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+    },
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit",
+        "source.organizeImports": "explicit"
+    },
+}

.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+	"version": "2.0.0",
+    "tasks": [
+        {
+            "type": "typescript",
+            "tsconfig": "tsconfig.json",
+            "option": "watch",
+            "problemMatcher": [
+                "$tsc-watch"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "label": "Transpile 'Service' on code change"
+        }
+    ]
+
+}

README.md

@@ -0,0 +1,27 @@
+# nimScript
+
+nimScript is a node project to test and debug your nim script functions right within Microsoft Visual Code
+
+## Installation
+
+First install [Visual Code](https://code.visualstudio.com/download)
+
+First install the latest 18.x release of [node](https://nodejs.org/en/about/previous-releases#looking-for-latest-release-of-a-version-branch)
+
+Open the project folder in Visual Code and run `npm i`` in a terminal window
+
+```bash
+npm i
+```
+
+## Usage
+
+Start NIM and download the nim references file, place this nim.ts file in the src directory.
+
+Create a config.json (according to the options in the config.sample.json file)
+
+In the script.ts you can write your own script functions, some examples are provided.
+Use the build task to build the output files to be able to debug your code.
+Place calls to your script functions inside main.ts
+Now run the project to execute the function in main.ts which in turn will execute your script functions.
+

config.sample.json

@@ -0,0 +1,10 @@
+{
+    "serviceHost": "http://localhost:51947",
+    "serviceUser": "your NIM user name",
+    "servicePassword": "the password of the above user",
+    "proxy": {
+        "host": "localhost",
+        "port": 8888,
+        "protocol": "http"
+    }
+}

package.json

@@ -0,0 +1,18 @@
+{
+  "name": "nimscript",
+  "version": "1.0",
+  "description": "nim script example project",
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "tsc --build --clean"
+  },
+  "dependencies": {
+    "axios": "^1.6.2"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/node": "^18.19.3",
+    "eslint-config-standard-with-typescript": "^43.0.0",
+    "typescript": "^5.2.2"
+  }
+}

src/main.ts

@@ -0,0 +1,8 @@
+
+async function run (): Promise<void> {
+  // Here you can put call your script functions to test them.
+}
+
+run().catch((error) => {
+  console.error(error)
+})

src/nim.ts

@@ -0,0 +1 @@
+// place the generated nim.ts over this file

src/nimHost.ts

@@ -0,0 +1,16 @@
+import axios, { type AxiosProxyConfig } from 'axios'
+import nimSettings from '../config.json'
+
+export class NimHost {
+  constructor (private readonly _hostPort: string = '', private readonly _baseUrl: string = '', private readonly userName: string, private readonly passWord: string, private readonly proxy?: AxiosProxyConfig) { }
+  public async post<T> (httpRequest: string, body: unknown): Promise<T> {
+    const url = new URL(this._baseUrl + httpRequest, this._hostPort)
+    const urlString = url.toString()
+
+    const proxy = this.proxy
+    const data = await axios.post<T>(urlString, body, { auth: { username: this.userName, password: this.passWord }, proxy })
+    return data.data
+  }
+}
+
+export const nimHost: NimHost = new NimHost(nimSettings.serviceHost, '/api/v1/script', nimSettings.serviceUser, nimSettings.servicePassword, nimSettings.proxy ?? undefined)