unplugin-cloudflare-tunnel 0.0.2 → 0.0.4

package/.github/README.md

@@ -0,0 +1,141 @@
+# unplugin-cloudflare-tunnel
+
+[![NPM version](https://img.shields.io/npm/v/unplugin-cloudflare-tunnel?color=a1b858&label=)](https://npm.im/unplugin-cloudflare-tunnel)
+[![pkg.pr.new](https://pkg.pr.new/badge/o-az/unplugin-cloudflare-tunnel)](https://pkg.pr.new/~/o-az/unplugin-cloudflare-tunnel)
+
+A plugin that automatically creates and manages Cloudflare tunnels for local development.
+Available for:
+
+- [Vite](https://vite.dev),
+- [Rspack](https://rspack.rs)
+- [Webpack](https://webpack.js.org)
+- [Astro](https://astro.build) <sup>soon</sup>
+- [Farm](https://farmfe.org) <sup>soon</sup>
+- [esbuild](https://esbuild.github.io) <sup>soon</sup>
+- [Rollup](https://rollupjs.org) <sup>soon</sup>
+- [Rolldown](https://rolldown.rs) <sup>soon</sup>
+
+> [!NOTE]
+> This is under active development.
+> If you have any suggestions, I'm all ears, please open an issue.
+
+## Install
+
+unplugin-cloudflare-tunnel
+
+```bash
+npm add unplugin-cloudflare-tunnel
+```
+
+## Usage
+
+<details>
+<summary>Vite</summary><br>
+
+```ts
+// vite.config.ts
+import CloudflareTunnel from 'unplugin-cloudflare-tunnel/vite'
+
+export default defineConfig({
+  plugins: [
+    CloudflareTunnel(),
+  ],
+})
+```
+
+Example in [./example/vite.config.ts](../example/vite.config.ts): `bun --filter example dev:vite`
+
+<br></details>
+
+<details>
+<summary>Rspack</summary><br>
+
+```ts
+// rspack.config.mjs
+import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rspack'
+
+export default {
+  /* ... */
+  plugins: [
+    CloudflareTunnel(),
+  ]
+}
+```
+
+Example in [./example/rspack.config.ts](../example/rspack.config.ts): `bun --filter example dev:rspack`
+
+<br></details>
+
+<details>
+<summary>Webpack</summary><br>
+
+```ts
+// webpack.config.js
+module.exports = {
+  /* ... */
+  plugins: [
+    require('unplugin-cloudflare-tunnel/webpack')({
+      CloudflareTunnel(),
+  ]
+}
+```
+
+Example in [./example/webpack.config.ts](../example/webpack.config.ts): `bun --filter example dev:webpack`
+
+<br></details>
+
+## Virtual Module: Access Tunnel URL
+
+> [!NOTE]
+> This feature is only available in Vite and Vite-based frameworks (i.e., Astro)
+
+The plugin provides a virtual module that allows you to access the tunnel URL in your application code during development. This is useful for:
+
+- Displaying the tunnel URL in your UI
+- Sharing the URL with users
+- Debugging and logging
+- Building features that need the public URL
+
+### Usage
+
+```typescript
+import { getTunnelUrl } from 'virtual:unplugin-cloudflare-tunnel'
+
+// Get the current tunnel URL
+const tunnelUrl = getTunnelUrl()
+console.log('Public tunnel URL:', tunnelUrl)
+
+// Example: Copy tunnel URL to clipboard
+const shareButton = document.getElementById('share')
+shareButton.onclick = () => {
+  navigator.clipboard.writeText(getTunnelUrl())
+  alert('Tunnel URL copied!')
+}
+```
+
+### TypeScript Support
+
+To get TypeScript support for the virtual module, add a reference to the types:
+
+```typescript
+// In your tsconfig.json or a .d.ts file
+/// <reference types="unplugin-cloudflare-tunnel/virtual" />
+```
+
+Or create a `virtual.d.ts` file in your project:
+
+```typescript
+/// <reference types="unplugin-cloudflare-tunnel/virtual" />
+```
+
+### Return Value
+
+- **Quick tunnel mode**: Returns a random URL like `https://abc-123.trycloudflare.com`
+- **Named tunnel mode**: Returns your custom domain URL like `https://dev.example.com`
+- **Plugin disabled**: Returns an empty string `""`
+
+### Notes
+
+- The virtual module is only available during development mode
+- In production builds, the virtual module will not be available
+- The URL is automatically updated if the port changes or tunnel restarts

package/dist/astro.d.mts

@@ -1,25 +1,6 @@
+import { CloudflareTunnelOptions } from "./index.mjs";
+
 //#region src/astro.d.ts
-/**
- * This entry file is for Astro plugin.
- *
- * @module
- */
-/**
- * TODO: figure out how to import the Astro plugin
- */
-/**
- * Astro plugin
- *
- * @example
- * ```ts
- * // astro.config.ts
- * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/astro'
- *
- * export default defineConfig({
- *   plugins: [CloudflareTunnel()],
- * })
- * ```
- */
-declare const astro: never;
+declare const _default: (options: CloudflareTunnelOptions) => any;
 //#endregion
-export { astro as default, astro as "module.exports" };
+export { _default as default };

package/dist/astro.mjs

@@ -1,27 +1,13 @@
+import src_default from "./index.mjs";
+
 //#region src/astro.ts
-/**
-* This entry file is for Astro plugin.
-*
-* @module
-*/
-/**
-* TODO: figure out how to import the Astro plugin
-*/
-/**
-* Astro plugin
-*
-* @example
-* ```ts
-* // astro.config.ts
-* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/astro'
-*
-* export default defineConfig({
-*   plugins: [CloudflareTunnel()],
-* })
-* ```
-*/
-const astro = {};
-var astro_default = astro;
+var astro_default = (options) => ({
+	name: "unplugin-cloudflare-tunnel",
+	hooks: { "astro:config:setup": async (astro) => {
+		astro.config.vite.plugins ||= [];
+		astro.config.vite.plugins.push(src_default.vite(options));
+	} }
+});
 
 //#endregion
-export { astro_default as default, astro as "module.exports" };
+export { astro_default as default };

package/dist/esbuild.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as esbuild0 from "esbuild";
 
 //#region src/esbuild.d.ts
 
+/**
+ * This entry file is for esbuild plugin.
+ *
+ * @module
+ */
 /**
  * Esbuild plugin
  *
@@ -13,6 +19,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * build({ plugins: [Starter()] })
 ```
  */
-declare const esbuild: typeof CloudflareTunnel.esbuild;
+declare const esbuild: (options?: CloudflareTunnelOptions | undefined) => esbuild0.Plugin;
 //#endregion
 export { esbuild as default, esbuild as "module.exports" };

package/dist/farm.d.mts

@@ -1,7 +1,12 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
 
 //#region src/farm.d.ts
 
+/**
+ * This entry file is for Farm plugin.
+ *
+ * @module
+ */
 /**
  * Farm plugin
  *
@@ -15,6 +20,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * }
  * ```
  */
-declare const farm: typeof CloudflareTunnel.farm;
+declare const farm: (options?: CloudflareTunnelOptions | undefined) => JsPlugin;
 //#endregion
 export { farm as default, farm as "module.exports" };

package/dist/rolldown.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as rolldown0 from "rolldown";
 
 //#region src/rolldown.d.ts
 
+/**
+ * This entry file is for Rolldown plugin.
+ *
+ * @module
+ */
 /**
  * Rolldown plugin
  *
@@ -15,6 +21,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * }
  * ```
  */
-declare const rolldown: typeof CloudflareTunnel.rolldown;
+declare const rolldown: (options?: CloudflareTunnelOptions | undefined) => rolldown0.Plugin<any>;
 //#endregion
 export { rolldown as default, rolldown as "module.exports" };

package/dist/rollup.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as rollup0 from "rollup";
 
 //#region src/rollup.d.ts
 
+/**
+ * This entry file is for Rollup plugin.
+ *
+ * @module
+ */
 /**
  * Rollup plugin
  *
@@ -15,6 +21,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * }
  * ```
  */
-declare const rollup: typeof CloudflareTunnel.rollup;
+declare const rollup: (options?: CloudflareTunnelOptions | undefined) => rollup0.Plugin<any>;
 //#endregion
 export { rollup as default, rollup as "module.exports" };

package/dist/rspack.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as unplugin0 from "unplugin";
 
 //#region src/rspack.d.ts
 
+/**
+ * This entry file is for Rspack plugin.
+ *
+ * @module
+ */
 /**
  * Rspack plugin
  *
@@ -15,6 +21,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * }
  * ```
  */
-declare const rspack: typeof CloudflareTunnel.rspack;
+declare const rspack: (options?: CloudflareTunnelOptions | undefined) => unplugin0.RspackPluginInstance;
 //#endregion
 export { rspack as default, rspack as "module.exports" };

package/dist/vite.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as vite0 from "vite";
 
 //#region src/vite.d.ts
 
+/**
+ * This entry file is for Vite plugin.
+ *
+ * @module
+ */
 /**
  * Vite plugin
  *
@@ -15,6 +21,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * })
  * ```
  */
-declare const vite: typeof CloudflareTunnel.vite;
+declare const vite: (options?: CloudflareTunnelOptions | undefined) => vite0.Plugin<any>;
 //#endregion
 export { vite as default, vite as "module.exports" };

package/dist/webpack.d.mts

@@ -1,7 +1,13 @@
-import { CloudflareTunnel } from "./index.mjs";
+import { CloudflareTunnelOptions } from "./index.mjs";
+import * as webpack0 from "webpack";
 
 //#region src/webpack.d.ts
 
+/**
+ * This entry file is for webpack plugin.
+ *
+ * @module
+ */
 /**
  * Webpack plugin
  *
@@ -15,6 +21,6 @@ import { CloudflareTunnel } from "./index.mjs";
  * }
  * ```
  */
-declare const webpack: typeof CloudflareTunnel.webpack;
+declare const webpack: (options?: CloudflareTunnelOptions | undefined) => webpack0.WebpackPluginInstance;
 //#endregion
 export { webpack as default, webpack as "module.exports" };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-cloudflare-tunnel",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A plugin that automatically creates and manages Cloudflare tunnels for local development",
   "type": "module",
   "imports": {
@@ -9,7 +9,9 @@
   },
   "files": [
     "dist",
-    "package.json"
+    "LICENSE",
+    "package.json",
+    "./.github/README.md"
   ],
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
@@ -66,6 +68,7 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "unplugin-unused": "^0.5.6",
+    "unplugin-utils": "^0.3.1",
     "vite": "^7.3.0",
     "vitest": "^4.0.16",
     "webpack-dev-server": "^5.2.2",
@@ -106,12 +109,6 @@
       "optional": true
     }
   },
-  "resolutions": {
-    "zod": "^4.3.3"
-  },
-  "overrides": {
-    "zod": "^4.3.3"
-  },
   "engines": {
     "node": ">=20.0"
   },