@zubyjs/share 1.0.58

package/README.md

@@ -0,0 +1,77 @@
+# @zubyjs/share
+
+The plugin for Zuby.js that allows you to share your local development/prod
+server with anyone in the world using the Cloudflare [Quick Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/do-more-with-tunnels/trycloudflare/) service.
+This is useful when you want to show your work to someone else,
+or quickly test it on a different device.
+
+By using this plugin,
+you agree to the Cloudflare's [Terms of Service](https://www.cloudflare.com/terms/),
+[Privacy Policy](https://www.cloudflare.com/privacypolicy/),
+and [Tunnel License](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/license/).
+
+## Installation
+
+First, install the `@zubyjs/share` package using your favorite package manager.
+If you aren't sure, you can use npm:
+
+```sh
+npm install @zubyjs/share
+```
+
+Then add the `@zubyjs/share` plugin to your `zuby.config.mjs` file under the `plugins` option:
+
+```diff lang="js" title="zuby.config.mjs"
+  import { defineConfig } from 'zuby';
+  import preact from '@zubyjs/preact';
++ import share from '@zubyjs/share';
+
+  export default defineConfig({
+    outDir: '.zuby',
+    jsx: preact(),
++   plugins: [
++       share()
++   ]
+    ^^^^^^^^
+  });
+```
+
+And that's it!
+Now you can run `npx zuby dev` or `npx zuby preview` to start sharing your local server.
+The plugin will expose your local dev/prod server to the internet over a tunnel
+and provide you a unique link that you can share with anyone.
+Once you stop the server, the tunnel will be closed.
+
+Example output:
+
+```diff lang="json"
+Zuby.js  v1.0.58  started in 379ms
+
+┃ Mode     development
+┃ Local    http://127.0.0.1:3000/
+┃ Network  use --host and --port to expose
+
+┃ Share  https://accidents-head-random.trycloudflare.com
+```
+
+NOTE: Always make sure that all zuby packages are in sync in your `package.json` file:
+
+```diff lang="json"
+  {
+    "name": "my-zuby-app",
+    "version": "1.0.0",
+    "dependencies": {
+      "zuby": "latest",
+      "@zubyjs/share": "latest"
+    }
+  }
+```
+
+## Contributing
+
+This package is part of Zuby.js workspace and maintained by the team behind the [Zuby package](https://www.npmjs.com/package/zuby).
+Please refer to it for more details how to contribute.
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,12 @@
+import { ZubyInternalConfig, ZubyPlugin } from 'zuby/types.js';
+/**
+ * Zuby.js plugin that allows you to easily
+ * share your local server with anyone over the internet
+ * using Cloudflare Quick Tunnels.
+ * @returns ZubyPlugin
+ */
+declare const _default: () => ZubyPlugin;
+export default _default;
+export declare function createTunnel({ config }: {
+    config: ZubyInternalConfig;
+}): Promise<void>;

package/index.js

@@ -0,0 +1,33 @@
+import { startTunnel } from './tunnel.js';
+import chalk from 'chalk';
+/**
+ * Zuby.js plugin that allows you to easily
+ * share your local server with anyone over the internet
+ * using Cloudflare Quick Tunnels.
+ * @returns ZubyPlugin
+ */
+export default () => ({
+    name: 'zuby-share-plugin',
+    description: 'Share your local development server with anyone over the internet',
+    hooks: {
+        'zuby:dev:start': createTunnel,
+        'zuby:preview:start': createTunnel,
+    },
+});
+export async function createTunnel({ config }) {
+    const { server, customLogger: logger } = config;
+    const hostname = server?.host;
+    const port = server?.port;
+    if (!hostname || !port)
+        return;
+    const tunnel = await startTunnel({
+        hostname,
+        port,
+        verifyTLS: false,
+    });
+    if (!tunnel) {
+        return logger.error('  ┃ Share: Failed to start the tunnel');
+    }
+    const tunnelUrl = await tunnel.getURL();
+    logger?.info(`  ┃ Share  ${chalk.gray(tunnelUrl)}\r\n`);
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@zubyjs/share",
+  "version": "1.0.58",
+  "description": "Zuby.js share plugin",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "release": "cd ./dist && npm publish --access public && cd ..",
+    "bump-version": "npm version patch",
+    "build": "rm -rf dist/ stage/ && mkdir dist && tsc && cp -rf package.json README.md stage/share/src/* dist/ && rm -rf stage/",
+    "push-build": "npm run build && cd dist && yalc push --force && cd ..",
+    "test": "exit 0"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "peerDependencies": {
+    "zuby": "^1.0.0"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "untun": "0.1.3"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/futrou/zuby.js/-/issues",
+    "email": "zuby@futrou.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/futrou/zuby.js.git"
+  },
+  "homepage": "https://zubyjs.com",
+  "keywords": [
+    "zuby-plugin",
+    "zuby",
+    "share",
+    "tunnel",
+    "cloudflare"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/tunnel.d.ts

@@ -0,0 +1,11 @@
+export interface TunnelOptions {
+    port?: number | string;
+    hostname?: string;
+    protocol?: 'http' | 'https';
+    verifyTLS?: boolean;
+}
+export interface Tunnel {
+    getURL: () => Promise<string>;
+    close: () => Promise<void>;
+}
+export declare function startTunnel(opts: TunnelOptions): Promise<undefined | Tunnel>;

package/tunnel.js

@@ -0,0 +1,28 @@
+import { existsSync } from 'node:fs';
+import { createRequire } from 'module';
+import { resolve } from 'node:path';
+import { normalizePath } from 'zuby/utils/pathUtils.js';
+export async function startTunnel(opts) {
+    const require = createRequire(import.meta.url);
+    const untunDistPath = normalizePath(require.resolve('untun'));
+    const cloudflaredPath = normalizePath(resolve(untunDistPath, '..', 'chunks', 'index.mjs'));
+    const { installCloudflared, startCloudflaredTunnel, cloudflaredBinPath } = await import(`file:///${cloudflaredPath}`);
+    const url = `${opts.protocol || 'http'}://${opts.hostname ?? 'localhost'}:${opts.port ?? 3000}`;
+    if (!existsSync(cloudflaredBinPath)) {
+        await installCloudflared();
+    }
+    const args = [['--url', url], opts.verifyTLS ? undefined : ['--no-tls-verify', '']].filter(Boolean);
+    const tunnel = await startCloudflaredTunnel(Object.fromEntries(args));
+    const cleanup = async () => {
+        await tunnel.stop();
+    };
+    for (const signal of ['SIGINT', 'SIGUSR1', 'SIGUSR2']) {
+        process.once(signal, cleanup);
+    }
+    return {
+        getURL: async () => await tunnel.url,
+        close: async () => {
+            await cleanup();
+        },
+    };
+}