@archbase/ssr 3.0.0

package/dist/tanstack/ArchbaseTanStackIntegration.d.ts

@@ -0,0 +1,67 @@
+import { default as React, ReactNode } from 'react';
+import { QueryClient } from '@tanstack/react-query';
+interface ArchbaseTanStackProviderProps {
+    children: ReactNode;
+    /** Custom QueryClient instance */
+    queryClient?: QueryClient;
+    /** Server-side dehydrated state */
+    dehydratedState?: any;
+    /** Default stale time for queries */
+    defaultStaleTime?: number;
+    /** Default cache time for queries */
+    defaultCacheTime?: number;
+}
+/**
+ * TanStack Query provider with SSR support for Archbase
+ */
+export declare function ArchbaseTanStackProvider({ children, queryClient: providedQueryClient, dehydratedState, defaultStaleTime, // 5 minutes
+defaultCacheTime, }: ArchbaseTanStackProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to create TanStack queries that work with Archbase DataSources
+ */
+export declare function useArchbaseQuery<TData = unknown, TError = Error>(key: string | readonly unknown[], fetchFn: () => Promise<TData>, options?: {
+    /** Archbase DataSource to sync with */
+    dataSource?: any;
+    /** Auto-update DataSource when query succeeds */
+    syncWithDataSource?: boolean;
+    /** Transform data before setting to DataSource */
+    transformForDataSource?: (data: TData) => any[];
+    /** SSR initial data */
+    ssrData?: TData;
+    /** Enable SSR for this query */
+    ssr?: boolean;
+} & Omit<any, 'queryKey' | 'queryFn'>): {
+    data: any;
+    isLoading: boolean;
+    error: TError | null;
+    isSuccess: boolean;
+    isError: boolean;
+    refetch: () => Promise<{
+        data: Awaited<TData>;
+    }>;
+};
+/**
+ * Utility to serialize QueryClient state for SSR
+ */
+export declare function serializeQueryClientState(queryClient: QueryClient): string;
+/**
+ * Server-side utility to prepare query data
+ */
+export declare function prepareServerQueries(queryClient: QueryClient, queries: Array<{
+    key: string | readonly unknown[];
+    fetchFn: () => Promise<unknown>;
+}>): Promise<void>;
+/**
+ * Higher-order component to provide TanStack Start integration
+ */
+export declare function withArchbaseTanStack<P extends object>(Component: React.ComponentType<P>, options?: {
+    queryClient?: QueryClient;
+    prefetchQueries?: (props: P) => Array<{
+        key: string | readonly unknown[];
+        fetchFn: () => Promise<unknown>;
+    }>;
+}): {
+    (props: P): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export {};

package/dist/utils/ArchbaseSSRUtils.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Utility functions for Server-Side Rendering with Archbase React
+ */
+/**
+ * Check if code is running on server side
+ */
+export declare const isServer: boolean;
+/**
+ * Check if code is running on client side
+ */
+export declare const isClient: boolean;
+/**
+ * Safe check for browser APIs
+ */
+export declare const canUseDOM: () => boolean;
+/**
+ * Safely access localStorage with SSR compatibility
+ */
+export declare const safeLocalStorage: {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+};
+/**
+ * Safely access sessionStorage with SSR compatibility
+ */
+export declare const safeSessionStorage: {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+};
+/**
+ * Serialize data for SSR with circular reference handling
+ */
+export declare function serializeForSSR<T>(data: T): string;
+/**
+ * Deserialize SSR data safely
+ */
+export declare function deserializeFromSSR<T>(serializedData: string): T | null;
+export declare function createSSRId(prefix?: string): string;
+/**
+ * Reset ID counter (useful for testing)
+ */
+export declare function resetSSRIdCounter(): void;
+/**
+ * Safely get window object
+ */
+export declare function getWindow(): Window | undefined;
+/**
+ * Safely get document object
+ */
+export declare function getDocument(): Document | undefined;
+/**
+ * Check if a feature is available in the current environment
+ */
+export declare function hasFeature(feature: string): boolean;
+/**
+ * Wrap a value that might not be available during SSR
+ */
+export declare function withSSRFallback<T>(getValue: () => T, fallback: T): T;
+/**
+ * Execute a function only on the client side
+ */
+export declare function clientOnly<T>(fn: () => T): T | undefined;
+/**
+ * Execute a function only on the server side
+ */
+export declare function serverOnly<T>(fn: () => T): T | undefined;
+/**
+ * Create a value that's different between server and client
+ * Useful for hydration-safe random values
+ */
+export declare function createHydrationSafeValue<T>(serverValue: T, clientValue: () => T): T;
+/**
+ * Media query hook that works with SSR
+ */
+export interface MediaQueryResult {
+    matches: boolean;
+    media: string;
+}
+export declare function getMediaQuery(query: string): MediaQueryResult;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@archbase/ssr",
+  "version": "3.0.0",
+  "description": "Server-Side Rendering utilities for Archbase React components with TanStack Start",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "@mantine/core": "8.3.12",
+    "@mantine/hooks": "8.3.12",
+    "@tanstack/react-query": "^5.0.0",
+    "@tanstack/start": "^1.0.0"
+  },
+  "dependencies": {
+    "serialize-javascript": "^6.0.2",
+    "@archbase/core": "3.0.0",
+    "@archbase/data": "3.0.0"
+  },
+  "devDependencies": {
+    "@types/serialize-javascript": "^5.0.4",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.1",
+    "vite-plugin-dts": "^4.3.0"
+  },
+  "keywords": [
+    "react",
+    "ssr",
+    "server-side-rendering",
+    "tanstack-start",
+    "archbase",
+    "components"
+  ],
+  "author": "Edson Martins",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edsonmartins/archbase-react"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "clean": "rm -rf dist",
+    "type-check": "tsc --noEmit"
+  }
+}