@nikala-ui/docs 0.12.0

package/dist/vendor/hooks-src/create-websocket.ts

@@ -0,0 +1,179 @@
+import { createSignal, createEffect, onCleanup, type Accessor } from "solid-js";
+
+export type WebSocketReadyState = "CONNECTING" | "OPEN" | "CLOSING" | "CLOSED";
+
+export interface CreateWebSocketOptions {
+  /** Subprotocol or list of subprotocols. */
+  protocols?: string | string[];
+  /** Whether to automatically reconnect upon disconnect. Defaults to true. */
+  autoReconnect?: boolean;
+  /** Reconnection delay in milliseconds. Defaults to 3000ms. */
+  reconnectInterval?: number;
+  /** Maximum reconnection attempts. Defaults to 5. */
+  maxReconnectAttempts?: number;
+  /** Whether to open connection immediately upon initialization. Defaults to true. */
+  immediate?: boolean;
+  /** Callback fired when WebSocket connection opens. */
+  onConnected?: (ws: WebSocket) => void;
+  /** Callback fired when WebSocket connection closes. */
+  onDisconnected?: (event: CloseEvent) => void;
+  /** Callback fired when WebSocket receives a message. */
+  onMessage?: (event: MessageEvent) => void;
+  /** Callback fired when WebSocket encounters an error. */
+  onError?: (event: Event) => void;
+}
+
+export interface CreateWebSocketReturn<T = unknown> {
+  /** Signal accessor containing latest received message data (parsed if JSON). */
+  data: Accessor<T | null>;
+  /** Signal accessor containing current WebSocket ready state. */
+  readyState: Accessor<WebSocketReadyState>;
+  /** Signal accessor containing last raw MessageEvent. */
+  lastMessage: Accessor<MessageEvent | null>;
+  /** Send string data or object payload (auto JSON stringified). */
+  send: (data: string | object | ArrayBufferLike | Blob) => boolean;
+  /** Open or reconnect WebSocket connection. */
+  open: () => void;
+  /** Close active WebSocket connection. */
+  close: (code?: number, reason?: string) => void;
+  /** Signal accessor indicating whether WebSocket is supported in browser environment. */
+  isSupported: Accessor<boolean>;
+}
+
+/**
+ * SolidJS reactive primitive for WebSocket client connections, auto-reconnection, and message passing.
+ */
+export function createWebSocket<T = unknown>(
+  url: string | Accessor<string>,
+  options: CreateWebSocketOptions = {}
+): CreateWebSocketReturn<T> {
+  const [data, setData] = createSignal<T | null>(null);
+  const [lastMessage, setLastMessage] = createSignal<MessageEvent | null>(null);
+  const [readyState, setReadyState] = createSignal<WebSocketReadyState>("CLOSED");
+
+  const getUrl = (): string => (typeof url === "function" ? url() : url);
+
+  const isSupported = (): boolean =>
+    typeof window !== "undefined" && "WebSocket" in window;
+
+  let ws: WebSocket | null = null;
+  let reconnectCount = 0;
+  let reconnectTimer: ReturnType<typeof setTimeout> | null = null;
+
+  const mapReadyState = (state: number): WebSocketReadyState => {
+    switch (state) {
+      case WebSocket.CONNECTING:
+        return "CONNECTING";
+      case WebSocket.OPEN:
+        return "OPEN";
+      case WebSocket.CLOSING:
+        return "CLOSING";
+      case WebSocket.CLOSED:
+      default:
+        return "CLOSED";
+    }
+  };
+
+  const close = (code?: number, reason?: string): void => {
+    if (reconnectTimer) {
+      clearTimeout(reconnectTimer);
+      reconnectTimer = null;
+    }
+    if (ws) {
+      const socket = ws;
+      ws = null;
+      socket.close(code, reason);
+      setReadyState("CLOSED");
+    }
+  };
+
+  const send = (payload: string | object | ArrayBufferLike | Blob): boolean => {
+    if (!ws || ws.readyState !== WebSocket.OPEN) return false;
+
+    try {
+      if (typeof payload === "object" && !(payload instanceof ArrayBuffer) && !(payload instanceof Blob)) {
+        ws.send(JSON.stringify(payload));
+      } else {
+        ws.send(payload as any);
+      }
+      return true;
+    } catch {
+      return false;
+    }
+  };
+
+  const open = (): void => {
+    if (!isSupported()) return;
+
+    if (ws) {
+      ws.close();
+      ws = null;
+    }
+
+    setReadyState("CONNECTING");
+
+    try {
+      const targetUrl = getUrl();
+      const socket = new WebSocket(targetUrl, options.protocols);
+      ws = socket;
+
+      socket.onopen = () => {
+        reconnectCount = 0;
+        setReadyState("OPEN");
+        options.onConnected?.(socket);
+      };
+
+      socket.onmessage = (event: MessageEvent) => {
+        setLastMessage(() => event);
+        try {
+          const parsed = JSON.parse(event.data);
+          setData(() => parsed);
+        } catch {
+          setData(() => event.data as unknown as T);
+        }
+        options.onMessage?.(event);
+      };
+
+      socket.onerror = (event: Event) => {
+        options.onError?.(event);
+      };
+
+      socket.onclose = (event: CloseEvent) => {
+        setReadyState("CLOSED");
+        ws = null;
+        options.onDisconnected?.(event);
+
+        if (
+          (options.autoReconnect ?? false) &&
+          reconnectCount < (options.maxReconnectAttempts ?? 5)
+        ) {
+          reconnectCount++;
+          reconnectTimer = setTimeout(open, options.reconnectInterval ?? 3000);
+        }
+      };
+    } catch {
+      setReadyState("CLOSED");
+      ws = null;
+    }
+  };
+
+  createEffect(() => {
+    if (options.immediate ?? true) {
+      open();
+    }
+
+    onCleanup(() => {
+      close();
+    });
+  });
+
+  return {
+    data,
+    readyState,
+    lastMessage,
+    send,
+    open,
+    close,
+    isSupported,
+  };
+}

package/dist/vendor/hooks-src/create-window-size.ts

@@ -0,0 +1,41 @@
+import { createSignal, onMount, onCleanup, type Accessor } from "solid-js";
+
+export interface CreateWindowSizeReturn {
+  /** Accessor for current window inner width in pixels */
+  width: Accessor<number>;
+  /** Accessor for current window inner height in pixels */
+  height: Accessor<number>;
+}
+
+/**
+ * SolidJS reactive primitive for tracking window viewport dimensions (width and height).
+ */
+export function createWindowSize(): CreateWindowSizeReturn {
+  const [width, setWidth] = createSignal<number>(
+    typeof window !== "undefined" ? window.innerWidth : 0
+  );
+  const [height, setHeight] = createSignal<number>(
+    typeof window !== "undefined" ? window.innerHeight : 0
+  );
+
+  onMount(() => {
+    if (typeof window === "undefined") return;
+
+    const handleResize = () => {
+      setWidth(window.innerWidth);
+      setHeight(window.innerHeight);
+    };
+
+    handleResize();
+
+    window.addEventListener("resize", handleResize);
+    onCleanup(() => {
+      window.removeEventListener("resize", handleResize);
+    });
+  });
+
+  return {
+    width,
+    height,
+  };
+}

package/dist/vendor/hooks-src/index.ts

@@ -0,0 +1,48 @@
+export * from "./create-controllable-signal";
+export * from "./create-click-outside";
+export * from "./create-clipboard";
+export * from "./create-keybindings";
+export * from "./create-lock-scroll";
+export * from "./create-disclosure";
+export * from "./create-media-query";
+export * from "./create-debounce";
+export * from "./create-intersection-observer";
+export * from "./create-timer";
+export * from "./create-resize-observer";
+export * from "./create-window-size";
+export * from "./create-scroll-position";
+export * from "./create-focus-trap";
+export * from "./create-mouse-position";
+export * from "./create-long-press";
+export * from "./create-hover";
+export * from "./create-storage";
+export * from "./create-previous";
+export * from "./create-network-status";
+export * from "./create-color-mode";
+export * from "./create-form";
+export * from "./create-input-mask";
+export * from "./create-idle";
+export * from "./create-active-element";
+export * from "./create-infinite-scroll";
+export * from "./create-fullscreen";
+export * from "./create-audio-video";
+export * from "./create-orientation";
+export * from "./create-undo-redo";
+export * from "./create-fetch";
+export * from "./create-geolocation";
+export * from "./create-permission";
+export * from "./create-battery";
+export * from "./create-web-notification";
+export * from "./create-websocket";
+export * from "./create-document-title";
+export * from "./create-favicon";
+export * from "./create-event-source";
+export * from "./create-scroll-into-view";
+export * from "./create-drop-zone";
+export * from "./create-pagination";
+export * from "./create-chat-scroll";
+export * from "./create-tauri-window";
+export * from "./create-global-shortcut";
+export * from "./create-app-updater";
+export * from "./create-document-tabs";
+export * from "./create-tiptap-editor";

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@nikala-ui/docs",
+  "version": "0.12.0",
+  "description": "Zero-config, fast, and elegant documentation engine for SolidJS, built on Nikala UI and Tailwind CSS v4",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "@nikala-ui/docs": "./dist/cli/index.js",
+    "nikala-docs": "./dist/cli/index.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin/index.d.ts",
+      "import": "./dist/plugin/index.js"
+    },
+    "./theme": {
+      "types": "./dist/themes/default/index.d.ts",
+      "import": "./dist/themes/default/index.js"
+    },
+    "./themes": {
+      "types": "./dist/themes/index.d.ts",
+      "import": "./dist/themes/index.js"
+    },
+    "./themes/*": {
+      "types": "./dist/themes/*/index.d.ts",
+      "import": "./dist/themes/*/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nikala-ui/ui.git",
+    "directory": "packages/docs"
+  },
+  "scripts": {
+    "build": "bun scripts/build.ts",
+    "dev": "tsc -p tsconfig.build.json --watch"
+  },
+  "dependencies": {
+    "@nikala-ui/cli": "workspace:*",
+    "@kobalte/core": "^0.13.12",
+    "@mdx-js/mdx": "^3.1.0",
+    "@mdx-js/rollup": "^3.1.0",
+    "@tailwindcss/vite": "^4.0.7",
+    "chokidar": "^4.0.3",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "commander": "^15.0.0",
+    "corvu": "^0.7.2",
+    "fs-extra": "^11.3.6",
+    "gray-matter": "^4.0.3",
+    "lucide-solid": "^1.28.0",
+    "picocolors": "^1.1.1",
+    "rehype-autolink-headings": "^7.1.0",
+    "rehype-slug": "^6.0.0",
+    "remark-gfm": "^4.0.0",
+    "shiki": "^4.4.3",
+    "tailwind-merge": "^3.6.0",
+    "vite": "^6.2.0",
+    "vite-plugin-solid": "^2.11.14"
+  },
+  "peerDependencies": {
+    "solid-js": ">=1.9.0",
+    "tailwindcss": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^26.1.1",
+    "solid-js": "^1.9.14",
+    "tailwindcss": "^4.0.7",
+    "typescript": "^5.7.2"
+  }
+}