@pubflow/react 0.1.0

package/dist/types/storage/BrowserStorageAdapter.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Browser Storage Adapter for React
+ *
+ * Provides a storage adapter for React applications using localStorage
+ */
+import { StorageAdapter } from '@pubflow/core';
+/**
+ * Options for the browser storage adapter
+ */
+export interface BrowserStorageOptions {
+    /**
+     * Prefix for storage keys
+     */
+    prefix?: string;
+    /**
+     * Whether to use sessionStorage instead of localStorage
+     */
+    useSessionStorage?: boolean;
+    /**
+     * Whether to use cookies as fallback when localStorage/sessionStorage is not available
+     */
+    useCookieFallback?: boolean;
+    /**
+     * Cookie options when using cookie fallback
+     */
+    cookieOptions?: {
+        /**
+         * Cookie expiration in days
+         */
+        maxAge?: number;
+        /**
+         * Cookie path
+         */
+        path?: string;
+        /**
+         * Whether the cookie should be secure
+         */
+        secure?: boolean;
+        /**
+         * Whether the cookie should be HTTP only
+         */
+        httpOnly?: boolean;
+        /**
+         * SameSite attribute for the cookie
+         */
+        sameSite?: 'strict' | 'lax' | 'none';
+    };
+}
+/**
+ * Browser storage adapter for React
+ * Uses localStorage or sessionStorage with cookie fallback
+ */
+export declare class BrowserStorageAdapter implements StorageAdapter {
+    private prefix;
+    private useSessionStorage;
+    private useCookieFallback;
+    private cookieOptions;
+    /**
+     * Create a new browser storage adapter
+     *
+     * @param options Storage options
+     */
+    constructor(options?: BrowserStorageOptions);
+    /**
+     * Get a value from storage
+     *
+     * @param key Storage key
+     * @returns Stored value or null
+     */
+    getItem(key: string): Promise<string | null>;
+    /**
+     * Save a value to storage
+     *
+     * @param key Storage key
+     * @param value Value to store
+     */
+    setItem(key: string, value: string): Promise<void>;
+    /**
+     * Remove a value from storage
+     *
+     * @param key Storage key
+     */
+    removeItem(key: string): Promise<void>;
+    /**
+     * Clear all values with the current prefix
+     */
+    clear(): Promise<void>;
+    /**
+     * Get a cookie value
+     *
+     * @param key Cookie key
+     * @returns Cookie value or null
+     */
+    private getCookie;
+    /**
+     * Set a cookie value
+     *
+     * @param key Cookie key
+     * @param value Cookie value
+     */
+    private setCookie;
+    /**
+     * Remove a cookie
+     *
+     * @param key Cookie key
+     */
+    private removeCookie;
+    /**
+     * Clear all cookies with the current prefix
+     */
+    private clearCookies;
+}

package/dist/types/test/setup.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Test Setup for Pubflow React Package
+ */
+import '@testing-library/jest-dom';

package/dist/types/utils/auth-utils.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Authentication Utilities for React
+ *
+ * Provides utilities for authentication in React applications
+ */
+/**
+ * Options for the useRequireAuth hook
+ */
+export interface UseRequireAuthOptions {
+    /**
+     * User types allowed to access the route
+     */
+    allowedTypes?: string | string[];
+    /**
+     * Redirect function
+     */
+    redirectFn?: (path: string) => void;
+    /**
+     * Redirect path when not authenticated
+     */
+    redirectTo?: string;
+    /**
+     * Pubflow instance ID
+     */
+    instanceId?: string;
+}
+/**
+ * Hook for requiring authentication
+ *
+ * @param options Authentication options
+ * @returns Authentication result
+ */
+export declare function useRequireAuth(options?: UseRequireAuthOptions): {
+    user: import("@pubflow/core").User | null;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+};

package/dist/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Utility exports for React adapter
+ */
+export * from './auth-utils';
+export * from './persistent-cache';

package/dist/types/utils/persistent-cache.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Persistent Cache Utility for React
+ *
+ * Provides a way to persist SWR cache between page refreshes and browser sessions
+ */
+import { Cache } from 'swr';
+/**
+ * Options for persistent cache
+ */
+export interface PersistentCacheOptions {
+    /**
+     * Prefix for storage keys
+     */
+    prefix?: string;
+    /**
+     * Time to live in milliseconds
+     * Default: 24 hours
+     */
+    ttl?: number;
+    /**
+     * Maximum size of a cache item in bytes
+     * Default: 2MB
+     */
+    maxItemSize?: number;
+    /**
+     * Whether to compress cache data to save space
+     * Default: false
+     */
+    compress?: boolean;
+    /**
+     * Custom serialization function
+     * Default: JSON.stringify
+     */
+    serialize?: (data: any) => string;
+    /**
+     * Custom deserialization function
+     * Default: JSON.parse
+     */
+    deserialize?: (text: string) => any;
+    /**
+     * Whether to log cache operations
+     * Default: false
+     */
+    debug?: boolean;
+    /**
+     * Storage mechanism to use
+     * Default: 'localStorage'
+     */
+    storage?: 'localStorage' | 'sessionStorage';
+}
+/**
+ * Creates a persistent cache provider for SWR
+ *
+ * @param options Cache options
+ * @returns SWR cache provider
+ */
+export declare function createPersistentCache(options?: PersistentCacheOptions): () => Cache;

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@pubflow/react",
+  "version": "0.1.0",
+  "description": "React adapter for Pubflow framework with support for TanStack Router and SWR",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest --coverage",
+    "test:watch": "vitest --watch",
+    "lint": "eslint src --ext .ts,.tsx",
+    "clean": "rimraf dist"
+  },
+  "keywords": [
+    "pubflow",
+    "react",
+    "remix",
+    "react-framework",
+    "swr",
+    "api",
+    "bridge",
+    "authentication"
+  ],
+  "author": "Pubflow, Inc.",
+  "license": "AGPL-3.0-or-later",
+  "dependencies": {
+    "@pubflow/core": "^0.2.0",
+    "@hookform/resolvers": "^3.3.2",
+    "react-hook-form": "^7.48.2",
+    "swr": "^2.2.4"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "optionalDependencies": {},
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@testing-library/jest-dom": "^6.1.0",
+    "@testing-library/react": "^14.0.0",
+    "@testing-library/user-event": "^14.5.0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@vitejs/plugin-react": "^4.1.0",
+    "@vitest/ui": "^1.0.0",
+    "eslint": "^8.0.0",
+    "jsdom": "^23.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.0.0",
+    "rollup-plugin-dts": "^5.0.0",
+    "rollup-plugin-peer-deps-external": "^2.0.0",
+    "tslib": "^2.8.1",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  }
+}