@betterportal/tunnels 1.0.24 → 1.0.26

package/lib/schemas/service-tunnels-client.json

@@ -0,0 +1,320 @@
+{
+  "pluginName": "service-tunnels-client",
+  "events": {
+    "ws.toOrigin": {
+      "type": "fire-and-forget",
+      "category": "onEvents",
+      "description": "Relay a public websocket frame to the connected tunnel client",
+      "inputSchema": {
+        "anyvaliVersion": "1.0",
+        "schemaVersion": "1.1",
+        "root": {
+          "kind": "object",
+          "properties": {
+            "publicServerId": {
+              "kind": "string"
+            },
+            "publicSocketId": {
+              "kind": "string"
+            },
+            "hostname": {
+              "kind": "string"
+            },
+            "path": {
+              "kind": "string"
+            },
+            "frameType": {
+              "kind": "string"
+            },
+            "event": {
+              "kind": "optional",
+              "inner": {
+                "kind": "string"
+              }
+            },
+            "body": {
+              "kind": "optional",
+              "inner": {
+                "kind": "string"
+              }
+            }
+          },
+          "required": [
+            "publicServerId",
+            "publicSocketId",
+            "hostname",
+            "path",
+            "frameType"
+          ],
+          "unknownKeys": "strip"
+        },
+        "definitions": {},
+        "extensions": {
+          "bsb": {
+            "description": "Public websocket frame to origin"
+          }
+        }
+      },
+      "outputSchema": null
+    },
+    "proxy.metrics": {
+      "type": "fire-and-forget",
+      "category": "onEvents",
+      "description": "Send final proxy request timings to the connected tunnel client",
+      "inputSchema": {
+        "anyvaliVersion": "1.0",
+        "schemaVersion": "1.1",
+        "root": {
+          "kind": "object",
+          "properties": {
+            "hostname": {
+              "kind": "string"
+            },
+            "requestId": {
+              "kind": "string"
+            },
+            "totalMs": {
+              "kind": "number"
+            },
+            "clientApiRoundtripMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            },
+            "cliOverheadMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            },
+            "originMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            },
+            "internalServerMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            }
+          },
+          "required": [
+            "hostname",
+            "requestId",
+            "totalMs"
+          ],
+          "unknownKeys": "strip"
+        },
+        "definitions": {},
+        "extensions": {
+          "bsb": {
+            "description": "Proxy request metrics"
+          }
+        }
+      },
+      "outputSchema": null
+    },
+    "proxy.request": {
+      "type": "returnable",
+      "category": "onReturnableEvents",
+      "description": "Proxy an HTTP request through a connected tunnel client",
+      "defaultTimeout": 60,
+      "inputSchema": {
+        "anyvaliVersion": "1.0",
+        "schemaVersion": "1.1",
+        "root": {
+          "kind": "object",
+          "properties": {
+            "hostname": {
+              "kind": "string"
+            },
+            "method": {
+              "kind": "string"
+            },
+            "path": {
+              "kind": "string"
+            },
+            "headers": {
+              "kind": "record",
+              "valueSchema": {
+                "kind": "string"
+              }
+            },
+            "body": {
+              "kind": "optional",
+              "inner": {
+                "kind": "string"
+              }
+            },
+            "webStartedAt": {
+              "kind": "number"
+            }
+          },
+          "required": [
+            "hostname",
+            "method",
+            "path",
+            "headers",
+            "webStartedAt"
+          ],
+          "unknownKeys": "strip"
+        },
+        "definitions": {},
+        "extensions": {
+          "bsb": {
+            "description": "Proxy request"
+          }
+        }
+      },
+      "outputSchema": {
+        "anyvaliVersion": "1.0",
+        "schemaVersion": "1.1",
+        "root": {
+          "kind": "object",
+          "properties": {
+            "requestId": {
+              "kind": "string"
+            },
+            "ownerServerId": {
+              "kind": "string"
+            },
+            "status": {
+              "kind": "number"
+            },
+            "headers": {
+              "kind": "record",
+              "valueSchema": {
+                "kind": "string"
+              }
+            },
+            "body": {
+              "kind": "string"
+            },
+            "webStartedAt": {
+              "kind": "number"
+            },
+            "clientApiRoundtripMs": {
+              "kind": "number"
+            },
+            "cliOverheadMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            },
+            "originMs": {
+              "kind": "optional",
+              "inner": {
+                "kind": "number"
+              }
+            }
+          },
+          "required": [
+            "requestId",
+            "ownerServerId",
+            "status",
+            "headers",
+            "body",
+            "webStartedAt",
+            "clientApiRoundtripMs"
+          ],
+          "unknownKeys": "strip"
+        },
+        "definitions": {},
+        "extensions": {
+          "bsb": {
+            "description": "Proxy response"
+          }
+        }
+      }
+    }
+  },
+  "version": "1.0.26",
+  "configSchema": {
+    "anyvaliVersion": "1.0",
+    "schemaVersion": "1.1",
+    "root": {
+      "kind": "object",
+      "properties": {
+        "database": {
+          "kind": "object",
+          "properties": {
+            "connectionString": {
+              "kind": "string",
+              "minLength": 1,
+              "metadata": {
+                "description": "PostgreSQL connection string"
+              }
+            }
+          },
+          "required": [
+            "connectionString"
+          ],
+          "unknownKeys": "strip",
+          "metadata": {
+            "description": "Database configuration"
+          }
+        },
+        "port": {
+          "kind": "number",
+          "default": 8081,
+          "metadata": {
+            "description": "Client API listener port"
+          }
+        },
+        "domain": {
+          "kind": "string",
+          "default": "tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Default public tunnel domain"
+          }
+        },
+        "publicUrl": {
+          "kind": "string",
+          "default": "https://tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Public base URL"
+          }
+        },
+        "authAppBaseUrl": {
+          "kind": "string",
+          "default": "https://betterportal.cloud",
+          "metadata": {
+            "description": "BetterPortal app URL used for CLI auth"
+          }
+        },
+        "authVerifyPath": {
+          "kind": "string",
+          "default": "/cli-auth/verify",
+          "metadata": {
+            "description": "BetterPortal CLI auth verify route"
+          }
+        }
+      },
+      "required": [
+        "database",
+        "port",
+        "domain",
+        "publicUrl",
+        "authAppBaseUrl",
+        "authVerifyPath"
+      ],
+      "unknownKeys": "strip",
+      "metadata": {
+        "description": "service-tunnels-client config"
+      }
+    },
+    "definitions": {},
+    "extensions": {}
+  },
+  "pluginType": "service",
+  "dependencies": [
+    {
+      "id": "betterportal/service-tunnels-proxy.js",
+      "version": "1.0.26"
+    }
+  ]
+}

package/lib/schemas/service-tunnels-client.plugin.json

@@ -0,0 +1,97 @@
+{
+  "id": "service-tunnels-client",
+  "name": "service-tunnels-client",
+  "version": "1.0.26",
+  "description": "Client websocket/API service",
+  "category": "service",
+  "tags": [
+    "service",
+    "websocket",
+    "tunnel"
+  ],
+  "documentation": [],
+  "dependencies": [
+    {
+      "id": "betterportal/service-tunnels-proxy.js",
+      "version": "1.0.26"
+    }
+  ],
+  "license": "(AGPL-3.0-only OR Commercial)",
+  "configSchema": {
+    "anyvaliVersion": "1.0",
+    "schemaVersion": "1.1",
+    "root": {
+      "kind": "object",
+      "properties": {
+        "database": {
+          "kind": "object",
+          "properties": {
+            "connectionString": {
+              "kind": "string",
+              "minLength": 1,
+              "metadata": {
+                "description": "PostgreSQL connection string"
+              }
+            }
+          },
+          "required": [
+            "connectionString"
+          ],
+          "unknownKeys": "strip",
+          "metadata": {
+            "description": "Database configuration"
+          }
+        },
+        "port": {
+          "kind": "number",
+          "default": 8081,
+          "metadata": {
+            "description": "Client API listener port"
+          }
+        },
+        "domain": {
+          "kind": "string",
+          "default": "tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Default public tunnel domain"
+          }
+        },
+        "publicUrl": {
+          "kind": "string",
+          "default": "https://tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Public base URL"
+          }
+        },
+        "authAppBaseUrl": {
+          "kind": "string",
+          "default": "https://betterportal.cloud",
+          "metadata": {
+            "description": "BetterPortal app URL used for CLI auth"
+          }
+        },
+        "authVerifyPath": {
+          "kind": "string",
+          "default": "/cli-auth/verify",
+          "metadata": {
+            "description": "BetterPortal CLI auth verify route"
+          }
+        }
+      },
+      "required": [
+        "database",
+        "port",
+        "domain",
+        "publicUrl",
+        "authAppBaseUrl",
+        "authVerifyPath"
+      ],
+      "unknownKeys": "strip",
+      "metadata": {
+        "description": "service-tunnels-client config"
+      }
+    },
+    "definitions": {},
+    "extensions": {}
+  }
+}

package/lib/schemas/service-tunnels-proxy.json

@@ -0,0 +1,160 @@
+{
+  "pluginName": "service-tunnels-proxy",
+  "events": {
+    "ws.fromOrigin": {
+      "type": "fire-and-forget",
+      "category": "onEvents",
+      "description": "Relay an origin websocket frame to the public websocket",
+      "inputSchema": {
+        "anyvaliVersion": "1.0",
+        "schemaVersion": "1.1",
+        "root": {
+          "kind": "object",
+          "properties": {
+            "publicSocketId": {
+              "kind": "string"
+            },
+            "frameType": {
+              "kind": "string"
+            },
+            "event": {
+              "kind": "optional",
+              "inner": {
+                "kind": "string"
+              }
+            },
+            "body": {
+              "kind": "optional",
+              "inner": {
+                "kind": "string"
+              }
+            }
+          },
+          "required": [
+            "publicSocketId",
+            "frameType"
+          ],
+          "unknownKeys": "strip"
+        },
+        "definitions": {},
+        "extensions": {
+          "bsb": {
+            "description": "Origin websocket frame to public client"
+          }
+        }
+      },
+      "outputSchema": null
+    }
+  },
+  "version": "1.0.26",
+  "configSchema": {
+    "anyvaliVersion": "1.0",
+    "schemaVersion": "1.1",
+    "root": {
+      "kind": "object",
+      "properties": {
+        "database": {
+          "kind": "object",
+          "properties": {
+            "connectionString": {
+              "kind": "string",
+              "minLength": 1,
+              "metadata": {
+                "description": "PostgreSQL connection string"
+              }
+            }
+          },
+          "required": [
+            "connectionString"
+          ],
+          "unknownKeys": "strip",
+          "metadata": {
+            "description": "Database configuration"
+          }
+        },
+        "port": {
+          "kind": "number",
+          "default": 8080,
+          "metadata": {
+            "description": "Public web listener port"
+          }
+        },
+        "domain": {
+          "kind": "string",
+          "default": "tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Tunnel root domain"
+          }
+        },
+        "verificationHost": {
+          "kind": "string",
+          "default": "verify.tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Verification host"
+          }
+        },
+        "cookieSecret": {
+          "kind": "string",
+          "default": "dev-cookie-secret",
+          "metadata": {
+            "description": "Signed verification cookie secret"
+          }
+        },
+        "turnstileSiteKey": {
+          "kind": "optional",
+          "inner": {
+            "kind": "string"
+          },
+          "metadata": {
+            "description": "Cloudflare Turnstile site key"
+          }
+        },
+        "turnstileSecretKey": {
+          "kind": "optional",
+          "inner": {
+            "kind": "string"
+          },
+          "metadata": {
+            "description": "Cloudflare Turnstile secret key"
+          }
+        },
+        "maxHeaderBytes": {
+          "kind": "number",
+          "default": 32768,
+          "metadata": {
+            "description": "Maximum accepted request header bytes"
+          }
+        },
+        "maxBodyBytes": {
+          "kind": "number",
+          "default": 2097152,
+          "metadata": {
+            "description": "Maximum accepted request body bytes"
+          }
+        }
+      },
+      "required": [
+        "database",
+        "port",
+        "domain",
+        "verificationHost",
+        "cookieSecret",
+        "maxHeaderBytes",
+        "maxBodyBytes"
+      ],
+      "unknownKeys": "strip",
+      "metadata": {
+        "description": "service-tunnels-proxy config"
+      }
+    },
+    "definitions": {},
+    "extensions": {}
+  },
+  "pluginType": "service",
+  "dependencies": [
+    {
+      "id": "betterportal/service-tunnels-client.js",
+      "version": "1.0.26"
+    }
+  ]
+}

package/lib/schemas/service-tunnels-proxy.plugin.json

@@ -0,0 +1,123 @@
+{
+  "id": "service-tunnels-proxy",
+  "name": "service-tunnels-proxy",
+  "version": "1.0.26",
+  "description": "Front-facing H3 tunnel service",
+  "category": "service",
+  "tags": [
+    "service",
+    "h3",
+    "tunnel"
+  ],
+  "documentation": [],
+  "dependencies": [
+    {
+      "id": "betterportal/service-tunnels-client.js",
+      "version": "1.0.26"
+    }
+  ],
+  "license": "(AGPL-3.0-only OR Commercial)",
+  "configSchema": {
+    "anyvaliVersion": "1.0",
+    "schemaVersion": "1.1",
+    "root": {
+      "kind": "object",
+      "properties": {
+        "database": {
+          "kind": "object",
+          "properties": {
+            "connectionString": {
+              "kind": "string",
+              "minLength": 1,
+              "metadata": {
+                "description": "PostgreSQL connection string"
+              }
+            }
+          },
+          "required": [
+            "connectionString"
+          ],
+          "unknownKeys": "strip",
+          "metadata": {
+            "description": "Database configuration"
+          }
+        },
+        "port": {
+          "kind": "number",
+          "default": 8080,
+          "metadata": {
+            "description": "Public web listener port"
+          }
+        },
+        "domain": {
+          "kind": "string",
+          "default": "tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Tunnel root domain"
+          }
+        },
+        "verificationHost": {
+          "kind": "string",
+          "default": "verify.tunnels.betterportal.dev",
+          "metadata": {
+            "description": "Verification host"
+          }
+        },
+        "cookieSecret": {
+          "kind": "string",
+          "default": "dev-cookie-secret",
+          "metadata": {
+            "description": "Signed verification cookie secret"
+          }
+        },
+        "turnstileSiteKey": {
+          "kind": "optional",
+          "inner": {
+            "kind": "string"
+          },
+          "metadata": {
+            "description": "Cloudflare Turnstile site key"
+          }
+        },
+        "turnstileSecretKey": {
+          "kind": "optional",
+          "inner": {
+            "kind": "string"
+          },
+          "metadata": {
+            "description": "Cloudflare Turnstile secret key"
+          }
+        },
+        "maxHeaderBytes": {
+          "kind": "number",
+          "default": 32768,
+          "metadata": {
+            "description": "Maximum accepted request header bytes"
+          }
+        },
+        "maxBodyBytes": {
+          "kind": "number",
+          "default": 2097152,
+          "metadata": {
+            "description": "Maximum accepted request body bytes"
+          }
+        }
+      },
+      "required": [
+        "database",
+        "port",
+        "domain",
+        "verificationHost",
+        "cookieSecret",
+        "maxHeaderBytes",
+        "maxBodyBytes"
+      ],
+      "unknownKeys": "strip",
+      "metadata": {
+        "description": "service-tunnels-proxy config"
+      }
+    },
+    "definitions": {},
+    "extensions": {}
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@betterportal/tunnels",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "type": "module",
   "license": "(AGPL-3.0-only OR Commercial)",
   "repository": {