unplugin-cloudflare-tunnel 0.0.0-alpha-1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2025-PRESENT Kevin Deng (https://github.com/sxzz)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/api.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/api.js

@@ -0,0 +1 @@
+export {  };

package/dist/astro.d.ts

@@ -0,0 +1,25 @@
+//#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;
+//#endregion
+export { astro as default, astro as "module.exports" };

package/dist/astro.js

@@ -0,0 +1,27 @@
+//#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;
+
+//#endregion
+export { astro_default as default, astro as "module.exports" };

package/dist/esbuild.d.ts

@@ -0,0 +1,18 @@
+import { r as CloudflareTunnel } from "./index-BjNI6nQt.js";
+
+//#region src/esbuild.d.ts
+
+/**
+ * Esbuild plugin
+ *
+ * @example
+ * ```ts
+ * import { build } from 'esbuild'
+ * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/esbuild'
+ *
+ * build({ plugins: [Starter()] })
+```
+ */
+declare const esbuild: typeof CloudflareTunnel.esbuild;
+//#endregion
+export { esbuild as default, esbuild as "module.exports" };

package/dist/esbuild.js

@@ -0,0 +1,19 @@
+import { t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+//#region src/esbuild.ts
+/**
+* Esbuild plugin
+*
+* @example
+* ```ts
+* import { build } from 'esbuild'
+* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/esbuild'
+* 
+* build({ plugins: [Starter()] })
+```
+*/
+const esbuild = CloudflareTunnel.esbuild;
+var esbuild_default = esbuild;
+
+//#endregion
+export { esbuild_default as default, esbuild as "module.exports" };

package/dist/farm.d.ts

@@ -0,0 +1,20 @@
+import { r as CloudflareTunnel } from "./index-BjNI6nQt.js";
+
+//#region src/farm.d.ts
+
+/**
+ * Farm plugin
+ *
+ * @example
+ * ```ts
+ * // farm.config.js
+ * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/farm'
+ *
+ * export default {
+ *   plugins: [CloudflareTunnel()],
+ * }
+ * ```
+ */
+declare const farm: typeof CloudflareTunnel.farm;
+//#endregion
+export { farm as default, farm as "module.exports" };

package/dist/farm.js

@@ -0,0 +1,21 @@
+import { t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+//#region src/farm.ts
+/**
+* Farm plugin
+*
+* @example
+* ```ts
+* // farm.config.js
+* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/farm'
+*
+* export default {
+*   plugins: [CloudflareTunnel()],
+* }
+* ```
+*/
+const farm = CloudflareTunnel.farm;
+var farm_default = farm;
+
+//#endregion
+export { farm_default as default, farm as "module.exports" };

package/dist/index-BjNI6nQt.d.ts

@@ -0,0 +1,157 @@
+import { z } from "zod";
+import { UnpluginInstance } from "unplugin";
+
+//#region src/index.d.ts
+
+declare const CloudflareApiResponseSchema: z.ZodType<{
+  success: boolean;
+  errors?: Array<{
+    code: number;
+    message: string;
+  }>;
+  messages?: Array<string>;
+  result: unknown;
+}>;
+declare const AccountSchema: z.ZodType<{
+  id: string;
+  name: string;
+}>;
+declare const ZoneSchema: z.ZodType<{
+  id: string;
+  name: string;
+}>;
+declare const TunnelSchema: z.ZodType<{
+  id: string;
+  name: string;
+  account_tag: string;
+  created_at: string;
+  connections?: Array<unknown>;
+}>;
+declare const DNSRecordSchema: z.ZodType<{
+  id: string;
+  type: string;
+  name: string;
+  content: string;
+  proxied: boolean;
+  comment?: string | null;
+}>;
+type CloudflareApiResponse<T = unknown> = z.infer<typeof CloudflareApiResponseSchema> & {
+  result: T;
+};
+type Account = z.infer<typeof AccountSchema>;
+type Zone = z.infer<typeof ZoneSchema>;
+type Tunnel = z.infer<typeof TunnelSchema>;
+type DNSRecord = z.infer<typeof DNSRecordSchema>;
+/**
+ * Base configuration options shared between named and quick tunnel modes
+ */
+interface BaseTunnelOptions {
+  /**
+   * Local port your dev server listens on
+   * If not specified, will automatically use the bundler's configured port
+   * @default undefined (auto-detect from bundler config)
+   */
+  port?: number;
+  /**
+   * Path to write cloudflared logs to a file
+   * Useful for debugging tunnel issues
+   */
+  logFile?: string;
+  /**
+   * Log level for cloudflared process
+   * @default undefined (uses cloudflared default)
+   */
+  logLevel?: 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+  /**
+   * Enable additional verbose logging for easier debugging.
+   * When true, the plugin will output extra information prefixed with
+   * `[cloudflare-tunnel:debug]`.
+   * @default false
+   */
+  debug?: boolean;
+  /**
+   * Enable or disable the tunnel plugin. When set to `false` the plugin is
+   * completely disabled — cloudflared will NOT be downloaded or started.
+   * @default true
+   */
+  enabled?: boolean;
+}
+/**
+ * Configuration options for named tunnel mode (requires hostname and API token)
+ */
+interface NamedTunnelOptions extends BaseTunnelOptions {
+  /**
+   * Public hostname for the tunnel (e.g., "dev.example.com")
+   * Must be a domain in your Cloudflare account
+   */
+  hostname: string;
+  /**
+   * Cloudflare API token with required permissions:
+   * - Zone:Zone:Read
+   * - Zone:DNS:Edit
+   * - Account:Cloudflare Tunnel:Edit
+   *
+   * Fallback priority:
+   * 1. Provided apiToken option
+   * 2. CLOUDFLARE_API_KEY environment variable
+   */
+  apiToken?: string;
+  /**
+   * Cloudflare account ID
+   * If omitted, uses the first account associated with the API token
+   */
+  accountId?: string;
+  /**
+   * Cloudflare zone ID
+   * If omitted, automatically resolved from the hostname
+   */
+  zoneId?: string;
+  /**
+   * Name for the tunnel in your Cloudflare dashboard
+   * Must contain only letters, numbers, and hyphens. Cannot start or end with a hyphen.
+   * @default "dev-tunnel"
+   */
+  tunnelName?: string;
+  /**
+   * Wildcard DNS domain to ensure exists (e.g., "*.example.com").
+   * When provided the plugin will ensure both A and AAAA records exist.
+   */
+  dns?: string;
+  /**
+   * Wildcard SSL domain to ensure exists (e.g., "*.example.com").
+   * When provided the plugin will request/ensure a wildcard edge certificate.
+   * If omitted the plugin will attempt to detect an existing wildcard certificate
+   * or Total TLS; otherwise it will request a regular certificate for the provided hostname.
+   */
+  ssl?: string;
+  /**
+   * Cleanup configuration for managing orphaned resources
+   */
+  cleanup?: {
+    /**
+     * Whether to automatically clean up orphaned DNS records on startup
+     * @default true
+     */
+    autoCleanup?: boolean;
+    /**
+     * Array of tunnel names to preserve during cleanup (in addition to current tunnel)
+     * @default []
+     */
+    preserveTunnels?: Array<string>;
+  };
+}
+/**
+ * Configuration options for quick tunnel mode (no hostname required, generates random URL)
+ */
+interface QuickTunnelOptions extends BaseTunnelOptions {}
+/**
+ * Configuration options for the Cloudflare Tunnel plugin
+ *
+ * Two modes are supported:
+ * - Named tunnel mode: Provide `hostname` for a persistent tunnel with custom domain
+ * - Quick tunnel mode: Omit `hostname` for a temporary tunnel with random trycloudflare.com URL
+ */
+type CloudflareTunnelOptions = NamedTunnelOptions | QuickTunnelOptions;
+declare const CloudflareTunnel: UnpluginInstance<CloudflareTunnelOptions | undefined, false>;
+//#endregion
+export { DNSRecord as a, CloudflareTunnelOptions as i, CloudflareApiResponse as n, Tunnel as o, CloudflareTunnel as r, Zone as s, Account as t };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { a as DNSRecord, i as CloudflareTunnelOptions, n as CloudflareApiResponse, o as Tunnel, r as CloudflareTunnel, s as Zone, t as Account } from "./index-BjNI6nQt.js";
+export { Account, CloudflareApiResponse, CloudflareTunnel, CloudflareTunnel as default, CloudflareTunnelOptions, DNSRecord, Tunnel, Zone };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { n as src_default, t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+export { CloudflareTunnel, src_default as default };

package/dist/rolldown.d.ts

@@ -0,0 +1,20 @@
+import { r as CloudflareTunnel } from "./index-BjNI6nQt.js";
+
+//#region src/rolldown.d.ts
+
+/**
+ * Rolldown plugin
+ *
+ * @example
+ * ```ts
+ * // rolldown.config.js
+ * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rolldown'
+ *
+ * export default {
+ *   plugins: [CloudflareTunnel()],
+ * }
+ * ```
+ */
+declare const rolldown: typeof CloudflareTunnel.rolldown;
+//#endregion
+export { rolldown as default, rolldown as "module.exports" };

package/dist/rolldown.js

@@ -0,0 +1,21 @@
+import { t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+//#region src/rolldown.ts
+/**
+* Rolldown plugin
+*
+* @example
+* ```ts
+* // rolldown.config.js
+* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rolldown'
+*
+* export default {
+*   plugins: [CloudflareTunnel()],
+* }
+* ```
+*/
+const rolldown = CloudflareTunnel.rolldown;
+var rolldown_default = rolldown;
+
+//#endregion
+export { rolldown_default as default, rolldown as "module.exports" };

package/dist/rollup.d.ts

@@ -0,0 +1,20 @@
+import { r as CloudflareTunnel } from "./index-BjNI6nQt.js";
+
+//#region src/rollup.d.ts
+
+/**
+ * Rollup plugin
+ *
+ * @example
+ * ```ts
+ * // rollup.config.js
+ * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rollup'
+ *
+ * export default {
+ *   plugins: [CloudflareTunnel()],
+ * }
+ * ```
+ */
+declare const rollup: typeof CloudflareTunnel.rollup;
+//#endregion
+export { rollup as default, rollup as "module.exports" };

package/dist/rollup.js

@@ -0,0 +1,21 @@
+import { t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+//#region src/rollup.ts
+/**
+* Rollup plugin
+*
+* @example
+* ```ts
+* // rollup.config.js
+* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rollup'
+*
+* export default {
+*   plugins: [CloudflareTunnel()],
+* }
+* ```
+*/
+const rollup = CloudflareTunnel.rollup;
+var rollup_default = rollup;
+
+//#endregion
+export { rollup_default as default, rollup as "module.exports" };

package/dist/rspack.d.ts

@@ -0,0 +1,20 @@
+import { r as CloudflareTunnel } from "./index-BjNI6nQt.js";
+
+//#region src/rspack.d.ts
+
+/**
+ * Rspack plugin
+ *
+ * @example
+ * ```js
+ * // rspack.config.js
+ * import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rspack'
+ *
+ * export default {
+ *   plugins: [CloudflareTunnel()],
+ * }
+ * ```
+ */
+declare const rspack: typeof CloudflareTunnel.rspack;
+//#endregion
+export { rspack as default, rspack as "module.exports" };

package/dist/rspack.js

@@ -0,0 +1,21 @@
+import { t as CloudflareTunnel } from "./src-BC4MyCER.js";
+
+//#region src/rspack.ts
+/**
+* Rspack plugin
+*
+* @example
+* ```js
+* // rspack.config.js
+* import CloudflareTunnel from 'unplugin-cloudflare-tunnel/rspack'
+*
+* export default {
+*   plugins: [CloudflareTunnel()],
+* }
+* ```
+*/
+const rspack = CloudflareTunnel.rspack;
+var rspack_default = rspack;
+
+//#endregion
+export { rspack_default as default, rspack as "module.exports" };