v1.0.0

.github/ISSUE_TEMPLATE/config.yml

@@ -3,6 +3,6 @@ contact_links:
   - name: Homebridge Discord Channel for Cloudflared Tunnel
     url: https://discord.gg/8fpZA4S
     about: Please ask and answer questions here.
-  - name: Homebridge-cloudflared-tunnel - Pull Requests
+  - name: homebridge-cloudflared-tunnel - Pull Requests
     url: https://github.com/donavanbecker/homebridge-cloudflared-tunnel/pulls
     about: Please report security vulnerabilities here.

.github/labeler.yml

@@ -1,5 +1,6 @@
 # Add 'branding' to any file changes within 'branding' folder
-branding: branding/*
+branding:
+  - branding/*
 
 # Add 'enhancement' label to any change to index.js file
 enhancement:

.github/workflows/beta-release.yml

@@ -19,7 +19,7 @@ jobs:
   publish:
     needs: lint
 
-    if: ${{ github.repository == 'donavanbecker/homebridge-clouldflared-tunnel' }}
+    if: ${{ github.repository == 'donavanbecker/homebridge-cloudflared-tunnel' }}
 
     uses: donavanbecker/.github/.github/workflows/npm-publish.yml@latest
     with:

.github/workflows/dependabot.yml

@@ -11,7 +11,7 @@ jobs:
     name: Auto-merge dependabot updates
     runs-on: ubuntu-latest
     steps:
-      - uses: mitto98/dependabot-automerge-action@master
+      - uses: mitto98/dependabot-automerge-action@v1.0.2
         with:
           token: ${{ github.token }}
           merge: true

config.schema.json

@@ -16,8 +16,8 @@
       },
       "url": {
         "type": "string",
-        "title": "Name",
-        "default": "URL",
+        "title": "URL",
+        "placeholder": "http://localhost:8581",
         "pattern": "^https?://",
         "required": false
       },
@@ -29,8 +29,8 @@
       },
       "hostname": {
         "type": "string",
-        "title": "Name",
-        "default": "hostname",
+        "title": "hostname",
+        "placeholder": "homebridge.local",
         "required": true
       },
       "protocol": {

package.json

@@ -1,9 +1,13 @@
 {
   "displayName": "Cloudflared Tunnel",
   "name": "homebridge-cloudflared-tunnel",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "The Cloudflared Tunnel plugin allows you to run a Cloudflare-Tunnel for exposing your homebridge instance for remote access.",
-  "author": "donavanbecker",
+  "author": {
+    "name": "donavanbecker",
+    "url": "https://github.com/donavanbecker"
+  },
+  "type": "commonjs",
   "license": "Apache-2.0",
   "icon": "https://raw.githubusercontent.com/donavanbecker/homebridge-cloudflared-tunnel/latest/branding/icon.png",
   "repository": {
@@ -23,6 +27,7 @@
     "update": "ncu -u && npm update && npm install",
     "update dependencies": "npm run check && npm run update",
     "lint": "eslint src/**.ts",
+    "jlint": "eslint homebridge-ui/public/**.mjs",
     "watch": "npm run build && npm link && nodemon",
     "build": "rimraf ./dist && tsc",
     "prepublishOnly": "npm run lint && npm run build",
@@ -48,10 +53,7 @@
   ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^1.0.0",
-    "ctun": "^0.0.10",
-    "undici": "^6.2.0",
-    "rxjs": "^7.8.1",
-    "super-stringify": "^1.0.0"
+    "ctun": "^0.0.10"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",

src/platform.ts

@@ -1,4 +1,4 @@
-import { startTunnel } from "ctun";
+import { startTunnel } from 'ctun';
 import { CloudflaredTunnelPlatformConfig } from './settings';
 import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, Service, Characteristic } from 'homebridge';
 
@@ -77,7 +77,7 @@ export class CloudflaredTunnelPlatform implements DynamicPlatformPlugin {
     if (this.config.url && this.config.hostname) {
       this.debugLog(`URL: ${this.config.url}`);
       this.debugLog(`Hostname: ${this.config.hostname}`);
-      throw new Error(`Cannot have both url and hostname in config. Please remove one.`);
+      throw new Error('Cannot have both url and hostname in config. Please remove one.');
     }
     if (!this.config.logging) {
       this.config.logging = 'standard';
@@ -106,12 +106,7 @@ export class CloudflaredTunnelPlatform implements DynamicPlatformPlugin {
       //Default: {protocol}://{hostname}:{port}
       //The local server URL to tunnel.
 
-      const tunnel = await startTunnel(
-        {
-          url: url,
-          verifyTLS: this.config.verifyTLS,
-        }
-      ); // pass in the port of the server you want to tunnel
+      const tunnel = await startTunnel({ url: url, verifyTLS: this.config.verifyTLS});
       this.infoLog(`Tunnel URL: ${tunnel}`);
     } catch {
       this.errorLog('Failed to Start Tunnel');

src/settings.ts

@@ -11,10 +11,10 @@ export const PLUGIN_NAME = 'homebridge-cloudflared-tunnel';
 
 //Config
 export interface CloudflaredTunnelPlatformConfig extends PlatformConfig {
-  url: string;
-  port: number;
-  hostname: string;
-  protocol: string;
-  verifyTLS: boolean;
+  url?: string;
+  port?: number;
+  hostname?: string;
+  protocol?: string;
+  verifyTLS?: boolean;
   logging?: string;
 }