fix: updated to robuster typing and added all-in-one example also added typedoc to create documentation

Author: A.P.A. Slaa

.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]  # or 'master', depending on your default branch
+  workflow_dispatch:    # allows manual trigger
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build documentation
+        run: npm run docs:build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -139,3 +139,6 @@ dist
 # Vite logs files
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+
+# Autogenerated Documentation
+docs

examples/all-in-one.ts

@@ -0,0 +1,32 @@
+import {OPAClient} from "../src"; //<< !!! Don't use this if your using the package from npm
+// import {OPAClient} from "@sourceregistry/node-opa";
+
+const client = new OPAClient();
+
+const regoPolicy = `
+package opa.examples
+
+import input.example.flag
+
+allow_request if flag == true
+`
+
+async function main() {
+
+    const policy = await client.policy.create("opa/examples/allow_request", regoPolicy, true, true)
+    console.log(policy);
+
+
+    const result = await client.data.post("opa/examples/allow_request", {
+        "input": {
+            "example": {
+                "flag": true
+            }
+        }
+    })
+
+    console.log('result', result);
+
+}
+
+main().catch(console.error);