@rstreamlabs/react 1.3.0 → 1.5.0

package/dist/hooks/index.d.ts

@@ -0,0 +1,80 @@
+import { WatchConfig } from '@rstreamlabs/rstream';
+
+/**
+ * Configuration for the UseRstream hook.
+ */
+interface UseRstreamOptions extends Partial<WatchConfig> {
+    /**
+     * Timeout (in milliseconds) to wait before attempting to reconnect
+     * after the SSE connection is closed.
+     *
+     * @default 1000
+     */
+    reconnectTimeout?: number;
+    /**
+     * Timeout (in milliseconds) to wait before showing an error message
+     * when the connection is not yet established.
+     *
+     * @default 5000
+     */
+    errorTimeout?: number;
+}
+/**
+ * A React hook to subscribe to rstream resources.
+ *
+ * This hook fetches the list of clients and tunnels from the rstream API.
+ * It handles automatic reconnection and displays a warning if the connection
+ * is not established within the timeout.
+ *
+ * @param options - The configuration options for the hook.
+ * @returns An object with the current error (if any), and arrays of tunnels and clients.
+ */
+declare function useRstream(options?: UseRstreamOptions): {
+    error: {
+        message: string;
+        type: "warning" | "danger";
+    } | null;
+    tunnels: {
+        status: "online" | "offline";
+        client_id: string;
+        user_id: string;
+        id: string;
+        type?: "bytestream" | "datagram" | undefined;
+        name?: string | undefined;
+        creation_date?: Date | undefined;
+        publish?: boolean | undefined;
+        protocol?: "tls" | "dtls" | "quic" | "http" | undefined;
+        labels?: Record<string, string | undefined> | undefined;
+        geo_ip?: string[] | undefined;
+        trusted_ips?: string[] | undefined;
+        host?: string | undefined;
+        tls_mode?: "passthrough" | "terminated" | undefined;
+        tls_alpns?: string[] | undefined;
+        tls_min_version?: string | undefined;
+        tls_ciphers?: string[] | undefined;
+        mtls?: boolean | undefined;
+        mtls_ca_cert_pem?: string | undefined;
+        http_version?: "http/1.1" | "h2c" | "h3" | undefined;
+        http_use_tls?: boolean | undefined;
+        token_auth?: boolean | undefined;
+        sso?: boolean | undefined;
+        sso_providers?: string[] | undefined;
+        email_whitelist?: string[] | undefined;
+        email_blacklist?: string[] | undefined;
+        challenge?: boolean | undefined;
+    }[];
+    clients: {
+        status: "online" | "offline";
+        user_id: string;
+        id: string;
+        labels?: Record<string, string | undefined> | undefined;
+        details?: {
+            agent?: string | undefined;
+            os?: string | undefined;
+            version?: string | undefined;
+            protocol_version?: string | undefined;
+        } | undefined;
+    }[];
+};
+
+export { type UseRstreamOptions, useRstream };

package/dist/hooks/index.js

@@ -0,0 +1,168 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/hooks/index.ts
+var hooks_exports = {};
+__export(hooks_exports, {
+  useRstream: () => useRstream
+});
+module.exports = __toCommonJS(hooks_exports);
+
+// src/hooks/use-rstream.ts
+var import_rstream = require("@rstreamlabs/rstream");
+var React = __toESM(require("react"));
+function hasAuth(options) {
+  return !!options && !!options.auth;
+}
+function useRstream(options) {
+  const [state, setState] = React.useState("disconnected");
+  const [error, setError] = React.useState(null);
+  const { reconnectTimeout = 1e3, errorTimeout = 5e3 } = options || {};
+  const [clients, setClients] = React.useState([]);
+  const [tunnels, setTunnels] = React.useState([]);
+  React.useEffect(() => {
+    if (!hasAuth(options)) return;
+    let active = true;
+    let watch = null;
+    let timeout = null;
+    const schedule = () => {
+      if (!active) return;
+      if (timeout) return;
+      setState("connecting");
+      timeout = setTimeout(() => {
+        if (!active) return;
+        timeout = null;
+        run();
+      }, reconnectTimeout);
+    };
+    const run = async () => {
+      if (!hasAuth(options)) return;
+      setState("connecting");
+      watch = new import_rstream.Watch(options, {
+        onEvent: (event) => {
+          if (!active) return;
+          if (event.type.startsWith("client")) {
+            setClients((previous) => {
+              if (event.type === "client.created") {
+                return [...previous, event.object];
+              } else if (event.type === "client.updated") {
+                return previous.map((client) => {
+                  if (client.id === event.object.id) {
+                    return event.object;
+                  }
+                  return client;
+                });
+              } else if (event.type === "client.deleted") {
+                return previous.filter(
+                  (client) => client.id !== event.object.id
+                );
+              }
+              return previous;
+            });
+          } else if (event.type.startsWith("tunnel")) {
+            setTunnels((previous) => {
+              if (event.type === "tunnel.created") {
+                return [...previous, event.object];
+              } else if (event.type === "tunnel.updated") {
+                return previous.map((tunnel) => {
+                  if (tunnel.id === event.object.id) {
+                    return event.object;
+                  }
+                  return tunnel;
+                });
+              } else if (event.type === "tunnel.deleted") {
+                return previous.filter(
+                  (tunnel) => tunnel.id !== event.object.id
+                );
+              }
+              return previous;
+            });
+          }
+        },
+        onConnect: () => {
+          if (!active) return;
+          setState("connected");
+        },
+        onClose: () => {
+          if (!active) return;
+          watch = null;
+          schedule();
+        }
+      });
+      try {
+        await watch.connect();
+      } catch {
+        schedule();
+      }
+    };
+    run();
+    return () => {
+      active = false;
+      if (watch) {
+        watch.disconnect();
+        watch = null;
+      }
+      if (timeout) {
+        clearTimeout(timeout);
+        timeout = null;
+      }
+    };
+  }, [options, reconnectTimeout]);
+  React.useEffect(() => {
+    if (options?.auth) {
+      if (error && error.type === "danger") return;
+      if (state !== "connected") {
+        const timeout = setTimeout(() => {
+          setError({
+            message: "Failed to fetch rstream ressources. Retrying...",
+            type: "warning"
+          });
+        }, errorTimeout);
+        return () => {
+          clearTimeout(timeout);
+        };
+      } else if (state === "connected") {
+        setError(null);
+      }
+    } else {
+      setError(null);
+    }
+  }, [options, state, error, errorTimeout]);
+  React.useEffect(() => {
+    if (options?.auth === void 0 || state !== "connected") {
+      setClients([]);
+      setTunnels([]);
+    }
+  }, [options, state]);
+  return { error, tunnels, clients };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useRstream
+});

package/dist/hooks/index.mjs

@@ -0,0 +1,7 @@
+import "../chunk-2JFL7TS5.mjs";
+import {
+  useRstream
+} from "../chunk-2WDUPTYY.mjs";
+export {
+  useRstream
+};

package/dist/index.d.mts

@@ -1,103 +1,8 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ITerminalOptions, Terminal } from '@xterm/xterm';
-import { WebTTYClientConfig, WebTTYExecutionConfig, WebTTYEvents } from '@rstreamlabs/webtty';
-import { RstreamAuth } from '@rstreamlabs/rstream';
-
-interface WebTTYTerminalProps extends WebTTYClientConfig, WebTTYExecutionConfig, WebTTYEvents {
-    /**
-     * xterm.js TerminalOptions override
-     */
-    terminalOptions?: ITerminalOptions;
-    /**
-     * Called once the xterm Terminal is created (before connect).
-     * Can be used to add your own add-ons or manipulate the Terminal instance.
-     */
-    onTerminalCreated?: (terminal: Terminal) => void;
-}
-/**
- * A React component that binds a WebTTY session to an xterm.js instance.
- */
-declare function WebTTYTerminal(props: WebTTYTerminalProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Configuration for the UseRstream hook.
- */
-interface UseRstreamOptions {
-    /**
-     * Short-term authentication token provider.
-     */
-    auth?: RstreamAuth;
-    /**
-     * Timeout (in milliseconds) to wait before attempting to reconnect
-     * after the SSE connection is closed.
-     *
-     * @default 1000
-     */
-    reconnectTimeout?: number;
-    /**
-     * Timeout (in milliseconds) to wait before showing an error message
-     * when the connection is not yet established.
-     *
-     * @default 5000
-     */
-    errorTimeout?: number;
-}
-/**
- * A React hook to subscribe to rstream resources.
- *
- * This hook fetches the list of clients and tunnels from the rstream API.
- * It handles automatic reconnection and displays a warning if the connection
- * is not established within the timeout.
- *
- * @param options - The configuration options for the hook.
- * @returns An object with the current error (if any), and arrays of tunnels and clients.
- */
-declare function useRstream(options?: UseRstreamOptions): {
-    error: {
-        message: string;
-        type: "warning" | "danger";
-    } | null;
-    tunnels: {
-        type?: "bytestream" | "datagram" | undefined;
-        status?: "online" | "offline" | undefined;
-        client_id?: string | undefined;
-        user_id?: string | undefined;
-        id?: string | undefined;
-        name?: string | undefined;
-        creation_date?: Date | undefined;
-        publish?: boolean | undefined;
-        protocol?: "tls" | "dtls" | "quic" | "http" | undefined;
-        labels?: Record<string, string | undefined> | undefined;
-        geo_ip?: string[] | undefined;
-        trusted_ips?: string[] | undefined;
-        host?: string | undefined;
-        tls_mode?: "passthrough" | "terminated" | undefined;
-        tls_alpns?: string[] | undefined;
-        tls_min_version?: string | undefined;
-        tls_ciphers?: string[] | undefined;
-        mtls?: boolean | undefined;
-        mtls_ca_cert_pem?: string | undefined;
-        http_version?: "http/1.1" | "h2c" | "h3" | undefined;
-        http_use_tls?: boolean | undefined;
-        token_auth?: boolean | undefined;
-        sso?: boolean | undefined;
-        sso_providers?: string[] | undefined;
-        email_whitelist?: string[] | undefined;
-        email_blacklist?: string[] | undefined;
-        challenge?: boolean | undefined;
-    }[];
-    clients: {
-        status: "online" | "offline";
-        user_id: string;
-        id: string;
-        labels?: Record<string, string | undefined> | undefined;
-        details?: {
-            agent?: string | undefined;
-            os?: string | undefined;
-            version?: string | undefined;
-            protocol_version?: string | undefined;
-        } | undefined;
-    }[];
-};
-
-export { type UseRstreamOptions, WebTTYTerminal, type WebTTYTerminalProps, useRstream };
+export { WebTTYTerminal, WebTTYTerminalProps } from './components/index.mjs';
+export { UseRstreamOptions, useRstream } from './hooks/index.mjs';
+export { RstreamProvider, useRstreamContext } from './providers/index.mjs';
+import 'react/jsx-runtime';
+import '@xterm/xterm';
+import '@rstreamlabs/webtty';
+import '@rstreamlabs/rstream';
+import 'react';

package/dist/index.d.ts

@@ -1,103 +1,8 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ITerminalOptions, Terminal } from '@xterm/xterm';
-import { WebTTYClientConfig, WebTTYExecutionConfig, WebTTYEvents } from '@rstreamlabs/webtty';
-import { RstreamAuth } from '@rstreamlabs/rstream';
-
-interface WebTTYTerminalProps extends WebTTYClientConfig, WebTTYExecutionConfig, WebTTYEvents {
-    /**
-     * xterm.js TerminalOptions override
-     */
-    terminalOptions?: ITerminalOptions;
-    /**
-     * Called once the xterm Terminal is created (before connect).
-     * Can be used to add your own add-ons or manipulate the Terminal instance.
-     */
-    onTerminalCreated?: (terminal: Terminal) => void;
-}
-/**
- * A React component that binds a WebTTY session to an xterm.js instance.
- */
-declare function WebTTYTerminal(props: WebTTYTerminalProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Configuration for the UseRstream hook.
- */
-interface UseRstreamOptions {
-    /**
-     * Short-term authentication token provider.
-     */
-    auth?: RstreamAuth;
-    /**
-     * Timeout (in milliseconds) to wait before attempting to reconnect
-     * after the SSE connection is closed.
-     *
-     * @default 1000
-     */
-    reconnectTimeout?: number;
-    /**
-     * Timeout (in milliseconds) to wait before showing an error message
-     * when the connection is not yet established.
-     *
-     * @default 5000
-     */
-    errorTimeout?: number;
-}
-/**
- * A React hook to subscribe to rstream resources.
- *
- * This hook fetches the list of clients and tunnels from the rstream API.
- * It handles automatic reconnection and displays a warning if the connection
- * is not established within the timeout.
- *
- * @param options - The configuration options for the hook.
- * @returns An object with the current error (if any), and arrays of tunnels and clients.
- */
-declare function useRstream(options?: UseRstreamOptions): {
-    error: {
-        message: string;
-        type: "warning" | "danger";
-    } | null;
-    tunnels: {
-        type?: "bytestream" | "datagram" | undefined;
-        status?: "online" | "offline" | undefined;
-        client_id?: string | undefined;
-        user_id?: string | undefined;
-        id?: string | undefined;
-        name?: string | undefined;
-        creation_date?: Date | undefined;
-        publish?: boolean | undefined;
-        protocol?: "tls" | "dtls" | "quic" | "http" | undefined;
-        labels?: Record<string, string | undefined> | undefined;
-        geo_ip?: string[] | undefined;
-        trusted_ips?: string[] | undefined;
-        host?: string | undefined;
-        tls_mode?: "passthrough" | "terminated" | undefined;
-        tls_alpns?: string[] | undefined;
-        tls_min_version?: string | undefined;
-        tls_ciphers?: string[] | undefined;
-        mtls?: boolean | undefined;
-        mtls_ca_cert_pem?: string | undefined;
-        http_version?: "http/1.1" | "h2c" | "h3" | undefined;
-        http_use_tls?: boolean | undefined;
-        token_auth?: boolean | undefined;
-        sso?: boolean | undefined;
-        sso_providers?: string[] | undefined;
-        email_whitelist?: string[] | undefined;
-        email_blacklist?: string[] | undefined;
-        challenge?: boolean | undefined;
-    }[];
-    clients: {
-        status: "online" | "offline";
-        user_id: string;
-        id: string;
-        labels?: Record<string, string | undefined> | undefined;
-        details?: {
-            agent?: string | undefined;
-            os?: string | undefined;
-            version?: string | undefined;
-            protocol_version?: string | undefined;
-        } | undefined;
-    }[];
-};
-
-export { type UseRstreamOptions, WebTTYTerminal, type WebTTYTerminalProps, useRstream };
+export { WebTTYTerminal, WebTTYTerminalProps } from './components/index.js';
+export { UseRstreamOptions, useRstream } from './hooks/index.js';
+export { RstreamProvider, useRstreamContext } from './providers/index.js';
+import 'react/jsx-runtime';
+import '@xterm/xterm';
+import '@rstreamlabs/webtty';
+import '@rstreamlabs/rstream';
+import 'react';