@biglogic/rgs 3.0.1 → 3.2.0

package/examples/big-data-indexeddb/BigDataStore.ts

@@ -1,60 +0,0 @@
-import { gstate } from '../../index'
-import { indexedDBPlugin } from '../../plugins/official/indexeddb.plugin'
-
-/**
- * Big Data Store using IndexedDB
- * RECOMMENDED FOR: Frontend (FE)
- *
- * Demonstrates how to handle massive datasets (GBs) that would exceed
- * the standard 5MB-10MB limit of localStorage.
- */
-
-export interface BigDataState extends Record<string, unknown> {
-  largeCollection: any[]
-  metaInfo: { totalItems: number, lastSync: number }
-}
-
-const initialState: BigDataState = {
-  largeCollection: [],
-  metaInfo: { totalItems: 0, lastSync: Date.now() }
-}
-
-// 1. Define the store
-export const useBigData = gstate<BigDataState>(initialState, {
-  namespace: 'big-data-vault',
-  persist: false // Disable standard persistence to use IndexedDB exclusively
-})
-
-// 2. Add the IndexedDB Plugin
-useBigData._addPlugin(indexedDBPlugin({
-  dbName: 'UserLargeStorage',
-  storeName: 'appStates'
-}))
-
-/**
- * Action to simulate adding a large amount of data.
- */
-export const populateData = (count: number = 1000) => {
-  const data: Array<{ id: string, payload: string, timestamp: number }> = []
-  for (let i = 0; i < count; i++) {
-    data.push({
-      id: `item_${i}`,
-      payload: 'X'.repeat(1024), // 1KB per item
-      timestamp: Date.now()
-    })
-  }
-
-  useBigData.transaction(() => {
-    useBigData.set('largeCollection', data)
-    useBigData.set('metaInfo', { totalItems: count, lastSync: Date.now() })
-  })
-}
-
-/**
- * Clear the database
- */
-export const clearBigData = async () => {
-  // Access plugin methods registered on the store
-  await (useBigData as any).plugins.indexedDB.clear()
-  useBigData.set('largeCollection', [])
-}

package/examples/global-theme/ThemeManager.d.ts

@@ -1,7 +0,0 @@
-export interface ThemeState extends Record<string, unknown> {
-    mode: 'light' | 'dark';
-    accent: string;
-}
-export declare const useTheme: import("../../advanced").IStore<ThemeState> & (<K extends keyof ThemeState>(key: K) => readonly [ThemeState[K] | undefined, (val: ThemeState[K] | ((draft: ThemeState[K]) => ThemeState[K]), options?: unknown) => boolean]);
-export declare const initTheme: () => import("../../advanced").IStore<ThemeState> & (<K extends keyof ThemeState>(key: K) => readonly [ThemeState[K] | undefined, (val: ThemeState[K] | ((draft: ThemeState[K]) => ThemeState[K]), options?: unknown) => boolean]);
-export declare const toggleTheme: () => void;

package/examples/global-theme/ThemeManager.ts

@@ -1,32 +0,0 @@
-import { gstate, getStore } from '../../index'
-
-// Define the shape of our theme state
-export interface ThemeState extends Record<string, unknown> {
-  mode: 'light' | 'dark'
-  accent: string
-}
-
-/**
- * Global Theme Manager
- * RECOMMENDED FOR: Frontend (FE)
- *
- * Demonstrates global state using a dedicated store instance.
- */
-export const useTheme = gstate<ThemeState>({
-  mode: 'light',
-  accent: '#007bff'
-}, {
-  namespace: 'theme-store',
-  persist: true
-})
-
-/**
- * Helper to initialize the theme (useful for SSR or specific init logic)
- */
-export const initTheme = () => useTheme
-
-// Reusable action to toggle theme
-export const toggleTheme = () => {
-  const current = useTheme.get('mode')
-  useTheme.set('mode', current === 'light' ? 'dark' : 'light')
-}

package/examples/hybrid-cloud-sync/HybridStore.d.ts

@@ -1,19 +0,0 @@
-export interface AppState extends Record<string, unknown> {
-    userProfile: {
-        name: string;
-        preferences: any;
-    };
-    projects: Array<{
-        id: string;
-        content: string;
-    }>;
-}
-export declare const useHybridStore: import("../../advanced").IStore<AppState> & (<K extends keyof AppState>(key: K) => readonly [AppState[K] | undefined, (val: AppState[K] | ((draft: AppState[K]) => AppState[K]), options?: unknown) => boolean]);
-export declare const syncNow: () => Promise<void>;
-export declare const getSyncReport: () => {
-    lastSync: string;
-    count: any;
-    errors: any;
-    averageKeysPerSync: number;
-};
-export declare const updateName: (newName: string) => void;

package/examples/hybrid-cloud-sync/HybridStore.ts

@@ -1,78 +0,0 @@
-import { gstate } from '../../index'
-import { indexedDBPlugin } from '../../plugins/official/indexeddb.plugin'
-import { cloudSyncPlugin, createMongoAdapter } from '../../plugins/official/cloud-sync.plugin'
-
-/**
- * Hybrid Cloud Sync Store
- * RECOMMENDED FOR: Frontend (FE) with Cloud Backup
- *
- * Demonstrates a multi-layer storage strategy:
- * 1. Cache: Memory (fast)
- * 2. Persistent Local: IndexedDB (large capacity)
- * 3. remote: MongoDB Cloud (On-demand/Scheduled backup)
- */
-
-export interface AppState extends Record<string, unknown> {
-  userProfile: { name: string; preferences: any }
-  projects: Array<{ id: string; content: string }>
-}
-
-const initialState: AppState = {
-  userProfile: { name: 'Dario', preferences: { theme: 'dark' } },
-  projects: []
-}
-
-// 1. Initialize the store
-export const useHybridStore = gstate<AppState>(initialState, {
-  namespace: 'hybrid-app-vault',
-  persist: false // We use plugins for persistence
-})
-
-// 2. Add IndexedDB for local persistence (up to GBs)
-useHybridStore._addPlugin(indexedDBPlugin({
-  dbName: 'LocalCacheDB'
-}))
-
-// 3. Add Cloud Sync for remote backup
-// Configured to automatically sync every 5 minutes (300000ms)
-useHybridStore._addPlugin(cloudSyncPlugin({
-  adapter: createMongoAdapter('https://api.mongodb.com/v1', 'YOUR_SECRET_API_KEY'),
-  autoSyncInterval: 300000,
-  onSync: (stats) => {
-    console.info(`[CloudSync] Success! Keys: ${stats.totalKeysSynced}, Total Bytes: ${stats.totalBytesSynced}`)
-  }
-}))
-
-/**
- * Manual Trigger for Cloud Sync
- */
-export const syncNow = async () => {
-  const result = await (useHybridStore as any).plugins.cloudSync.sync()
-  if (result.status === 'success') {
-    alert(`Sync completed! ${result.stats.totalKeysSynced} items pushed to cloud.`)
-  } else if (result.status === 'no-change') {
-    console.log('No new changes to sync.')
-  }
-}
-
-/**
- * Get synchronization diagnostics
- */
-export const getSyncReport = () => {
-  const stats = (useHybridStore as any).plugins.cloudSync.getStats()
-  return {
-    lastSync: stats.lastSyncTimestamp ? new Date(stats.lastSyncTimestamp).toLocaleString() : 'Never',
-    count: stats.syncCount,
-    errors: stats.errors,
-    averageKeysPerSync: stats.syncCount > 0 ? stats.totalKeysSynced / stats.syncCount : 0
-  }
-}
-
-/**
- * Action to update profile
- */
-export const updateName = (newName: string) => {
-  useHybridStore.set('userProfile', (draft) => {
-    draft.name = newName
-  })
-}

package/examples/persistent-cart/CartStore.d.ts

@@ -1,13 +0,0 @@
-export interface CartItem {
-    id: string;
-    name: string;
-    price: number;
-    quantity: number;
-}
-export interface CartState extends Record<string, unknown> {
-    items: CartItem[];
-    coupon: string | null;
-}
-export declare const useCart: import("../../advanced").IStore<CartState> & (<K extends keyof CartState>(key: K) => readonly [CartState[K] | undefined, (val: CartState[K] | ((draft: CartState[K]) => CartState[K]), options?: unknown) => boolean]);
-export declare const addToCart: (product: Omit<CartItem, "quantity">) => void;
-export declare const getCartTotal: () => number;

package/examples/persistent-cart/CartStore.ts

@@ -1,41 +0,0 @@
-import { gstate } from '../../index'
-
-export interface CartItem {
-  id: string
-  name: string
-  price: number
-  quantity: number
-}
-
-export interface CartState extends Record<string, unknown> {
-  items: CartItem[]
-  coupon: string | null
-}
-
-/**
- * Persistent Cart Store
- * RECOMMENDED FOR: Frontend (FE)
- */
-export const useCart = gstate<CartState>({
-  items: [],
-  coupon: null
-}, {
-  namespace: 'shopping-cart',
-  persist: true
-})
-
-export const addToCart = (product: Omit<CartItem, 'quantity'>) => {
-  useCart.set('items', (items) => {
-    const existing = items.find(item => item.id === product.id)
-    if (existing) {
-      existing.quantity++
-    } else {
-      items.push({ ...product, quantity: 1 })
-    }
-  })
-}
-
-export const getCartTotal = () => useCart.compute('totalPrice', (get) => {
-  const items = get<CartItem[]>('items') || []
-  return items.reduce((total, item) => total + (item.price * item.quantity), 0)
-})

package/examples/rbac-dashboard/DashboardStore.d.ts

@@ -1,47 +0,0 @@
-export declare const useDashboard: import("../../advanced").IStore<{
-    stats: {
-        visitors: number;
-        revenue: number;
-    };
-    settings: {
-        allowPublicSignup: boolean;
-    };
-    logs: string[];
-}> & (<K extends "stats" | "settings" | "logs">(key: K) => readonly [{
-    stats: {
-        visitors: number;
-        revenue: number;
-    };
-    settings: {
-        allowPublicSignup: boolean;
-    };
-    logs: string[];
-}[K] | undefined, (val: {
-    stats: {
-        visitors: number;
-        revenue: number;
-    };
-    settings: {
-        allowPublicSignup: boolean;
-    };
-    logs: string[];
-}[K] | ((draft: {
-    stats: {
-        visitors: number;
-        revenue: number;
-    };
-    settings: {
-        allowPublicSignup: boolean;
-    };
-    logs: string[];
-}[K]) => {
-    stats: {
-        visitors: number;
-        revenue: number;
-    };
-    settings: {
-        allowPublicSignup: boolean;
-    };
-    logs: string[];
-}[K]), options?: unknown) => boolean]);
-export declare const addLog: (msg: string) => boolean;

package/examples/rbac-dashboard/DashboardStore.ts

@@ -1,46 +0,0 @@
-import { gstate } from '../../index'
-
-/**
- * RBAC Dashboard Store
- * RECOMMENDED FOR: Backend (BE) / Admin Frontend (FE)
- *
- * Demonstrates Role-Based Access Control.
- */
-export const useDashboard = gstate({
-  stats: { visitors: 100, revenue: 5000 },
-  settings: { allowPublicSignup: true },
-  logs: [] as string[]
-}, {
-  userId: 'manager-101',
-  accessRules: [
-    {
-      // Allow 'manager-101' read access to stats
-      pattern: (key, userId) => key === 'stats' && userId === 'manager-101',
-      permissions: ['read']
-    },
-    {
-      // Allow 'manager-101' full access to settings
-      pattern: (key, userId) => key === 'settings' && userId === 'manager-101',
-      permissions: ['read', 'write']
-    },
-    {
-      // ONLY 'admin-user' can access logs
-      pattern: (key, userId) => key === 'logs' && userId === 'admin-user',
-      permissions: ['admin']
-    }
-  ]
-})
-
-/**
- * Attempt to add a log entry.
- * Will fail if the current store userId is not 'admin-user'.
- */
-export const addLog = (msg: string) => {
-  const success = useDashboard.set('logs', (draft: string[]) => {
-    draft.push(msg)
-  })
-  if (!success) {
-    console.warn(`[Security] Access Denied for user ${useDashboard.userId}: Insufficient permissions for 'logs'`)
-  }
-  return success
-}

package/examples/secure-auth/AuthStore.d.ts

@@ -1,14 +0,0 @@
-export interface AuthState extends Record<string, unknown> {
-    user: {
-        id: string;
-        email: string;
-    } | null;
-    token: string | null;
-    isAuthenticated: boolean;
-}
-export declare const useAuth: import("../../advanced").IStore<AuthState> & (<K extends keyof AuthState>(key: K) => readonly [AuthState[K] | undefined, (val: AuthState[K] | ((draft: AuthState[K]) => AuthState[K]), options?: unknown) => boolean]);
-export declare const login: (user: {
-    id: string;
-    email: string;
-}, token: string) => void;
-export declare const logout: () => void;

package/examples/secure-auth/AuthStore.ts

@@ -1,36 +0,0 @@
-import { gstate } from '../../index'
-
-export interface AuthState extends Record<string, unknown> {
-  user: { id: string, email: string } | null
-  token: string | null
-  isAuthenticated: boolean
-}
-
-/**
- * Secure Authentication Store
- * RECOMMENDED FOR: Frontend (FE) / Backend (BE)
- *
- * Demonstrates the 'encoded' option for basic obfuscation in localStorage.
- * Notice: For industrial-grade security, use encryptionKey in config.
- */
-export const useAuth = gstate<AuthState>({
-  user: null,
-  token: null,
-  isAuthenticated: false
-}, {
-  namespace: 'secure-auth',
-  encoded: true, // Base64 encodes data in localStorage
-  persist: true
-})
-
-export const login = (user: { id: string, email: string }, token: string) => {
-  useAuth.transaction(() => {
-    useAuth.set('user', user)
-    useAuth.set('token', token)
-    useAuth.set('isAuthenticated', true)
-  })
-}
-
-export const logout = () => {
-  useAuth.deleteAll() // Clears all state and storage for this namespace
-}

package/examples/security-best-practices/SecurityStore.d.ts

@@ -1,22 +0,0 @@
-export interface VaultState extends Record<string, unknown> {
-    encryptedData: string | null;
-}
-export declare const initSecureVault: () => Promise<IStore<VaultState> & (<K extends keyof VaultState>(key: K) => readonly [VaultState[K] | undefined, (val: VaultState[K] | ((draft: VaultState[K]) => VaultState[K]), options?: unknown) => boolean])>;
-export declare const useProfileStore: IStore<{
-    bio: string;
-    displayName: string;
-}> & (<K extends "bio" | "displayName">(key: K) => readonly [{
-    bio: string;
-    displayName: string;
-}[K] | undefined, (val: {
-    bio: string;
-    displayName: string;
-}[K] | ((draft: {
-    bio: string;
-    displayName: string;
-}[K]) => {
-    bio: string;
-    displayName: string;
-}[K]), options?: unknown) => boolean]);
-import type { IStore } from '../../index';
-export declare const purgeUserData: (store: IStore<Record<string, unknown>>, userId: string) => void;

package/examples/security-best-practices/SecurityStore.ts

@@ -1,75 +0,0 @@
-import { gstate, setAuditLogger, generateEncryptionKey } from '../../index'
-
-/**
- * SECURITY BEST PRACTICES EXAMPLE
- *
- * RECOMMENDED FOR: Frontend (FE) and Backend (BE/Node)
- *
- * DESIGN PRINCIPLE:
- * - NEVER hardcode sensitive data (PII, Credit Cards, Keys) in source code.
- * - Use environment variables or secure user input at runtime.
- */
-
-export interface VaultState extends Record<string, unknown> {
-  encryptedData: string | null
-}
-
-/**
- * 1. AES-256-GCM Encryption (Enterprise Grade)
- * This store demonstrates how to handle sensitive information securely.
- */
-export const initSecureVault = async () => {
-  // At runtime, you would typically fetch the key from a secure vault or env
-  const masterKey = await generateEncryptionKey()
-
-  return gstate<VaultState>({
-    encryptedData: null
-  }, {
-    namespace: 'secure-vault',
-    persist: true,
-    encryptionKey: masterKey, // Real AES-256-GCM encryption
-    encoded: true
-  })
-}
-
-/**
- * 2. Field-Level Sanitization (XSS Defense)
- * RECOMMENDED FOR: Frontend (FE)
- * Automatically strips <script> and other XSS vectors from input values.
- */
-export const useProfileStore = gstate({
-  bio: '',
-  displayName: ''
-}, {
-  validateInput: true // Enables automatic sanitizeValue() on all .set() calls
-})
-
-/**
- * 3. Audit Logging Integration
- * RECOMMENDED FOR: Backend (BE) / Regulatory Compliance
- * Tracks every 'set' or 'delete' operation for accountability.
- */
-const auditBuffer: any[] = []
-setAuditLogger((entry) => {
-  // In a real BE scenario, send this to a logging service (Datadog, Elastic, etc.)
-  auditBuffer.push({
-    ...entry,
-    timestamp: new Date().toISOString()
-  })
-})
-
-import type { IStore } from '../../index'
-
-/**
- * 4. GDPR "Right to be Forgotten"
- * RECOMMENDED FOR: Compliance
- */
-export const purgeUserData = (store: IStore<Record<string, unknown>>, userId: string) => {
-  // Wipe state and storage
-  store.deleteAll()
-
-  // Enterprise: Wipe GDPR consents and audit traces
-  store.deleteUserData(userId)
-
-  console.info(`[Security] Data purge requested for ${userId}`)
-}

package/examples/stress-tests/StressStore.d.ts

@@ -1,41 +0,0 @@
-export declare const useRapidStore: import("../../advanced").IStore<{
-    updates: number;
-    lastBatchTime: number;
-}> & (<K extends "updates" | "lastBatchTime">(key: K) => readonly [{
-    updates: number;
-    lastBatchTime: number;
-}[K] | undefined, (val: {
-    updates: number;
-    lastBatchTime: number;
-}[K] | ((draft: {
-    updates: number;
-    lastBatchTime: number;
-}[K]) => {
-    updates: number;
-    lastBatchTime: number;
-}[K]), options?: unknown) => boolean]);
-export declare const runRapidFire: (iterations?: number) => number;
-export declare const usePayloadStore: import("../../advanced").IStore<{
-    data: any;
-}> & (<K extends "data">(key: K) => readonly [{
-    data: any;
-}[K] | undefined, (val: {
-    data: any;
-}[K] | ((draft: {
-    data: any;
-}[K]) => {
-    data: any;
-}[K]), options?: unknown) => boolean]);
-export declare const generateBigPayload: (keys?: number) => number;
-export declare const useChainStore: import("../../advanced").IStore<{
-    base: number;
-}> & (<K extends "base">(key: K) => readonly [{
-    base: number;
-}[K] | undefined, (val: {
-    base: number;
-}[K] | ((draft: {
-    base: number;
-}[K]) => {
-    base: number;
-}[K]), options?: unknown) => boolean]);
-export declare const setupChain: () => void;

package/examples/stress-tests/StressStore.ts

@@ -1,61 +0,0 @@
-import { gstate } from '../../index'
-
-/**
- * Rapid Fire Stress Test
- * Tests RGS ability to handle massive bursts of updates.
- */
-export const useRapidStore = gstate({
-  updates: 0,
-  lastBatchTime: 0
-})
-
-export const runRapidFire = (iterations: number = 1000) => {
-  const start = performance.now()
-  for (let i = 0; i < iterations; i++) {
-    useRapidStore.set('updates', i + 1)
-  }
-  const end = performance.now()
-  useRapidStore.set('lastBatchTime', end - start)
-  return end - start
-}
-
-/**
- * Big Payload Stress Test
- * Tests memory handling and cloning performance with large objects.
- */
-export const usePayloadStore = gstate({
-  data: {} as any
-})
-
-export const generateBigPayload = (keys: number = 5000) => {
-  const bigObj: Record<string, any> = {}
-  for (let i = 0; i < keys; i++) {
-    bigObj[`key_${i}`] = {
-      id: i,
-      value: Math.random(),
-      meta: { timestamp: Date.now(), tags: ['test', 'stress', 'payload'] }
-    }
-  }
-
-  const start = performance.now()
-  usePayloadStore.set('data', bigObj)
-  const end = performance.now()
-  return end - start
-}
-
-/**
- * Computed Chain Stress Test
- * Tests dependency tracking and recursive updates.
- */
-export const useChainStore = gstate({
-  base: 0
-})
-
-// Create a chain of 5 computed values
-export const setupChain = () => {
-  useChainStore.compute('level1', (get) => (get<number>('base') || 0) + 1)
-  useChainStore.compute('level2', (get) => (get<number>('level1') || 0) + 1)
-  useChainStore.compute('level3', (get) => (get<number>('level2') || 0) + 1)
-  useChainStore.compute('level4', (get) => (get<number>('level3') || 0) + 1)
-  useChainStore.compute('level5', (get) => (get<number>('level4') || 0) + 1)
-}

package/examples/super-easy/EasyStore.d.ts

@@ -1,44 +0,0 @@
-export declare const useEasyStore: import("../../advanced").IStore<{
-    user: {
-        name: string;
-        role: string;
-    };
-    theme: string;
-    notifications: number;
-    tempData: string;
-}> & (<K extends "user" | "theme" | "notifications" | "tempData">(key: K) => readonly [{
-    user: {
-        name: string;
-        role: string;
-    };
-    theme: string;
-    notifications: number;
-    tempData: string;
-}[K] | undefined, (val: {
-    user: {
-        name: string;
-        role: string;
-    };
-    theme: string;
-    notifications: number;
-    tempData: string;
-}[K] | ((draft: {
-    user: {
-        name: string;
-        role: string;
-    };
-    theme: string;
-    notifications: number;
-    tempData: string;
-}[K]) => {
-    user: {
-        name: string;
-        role: string;
-    };
-    theme: string;
-    notifications: number;
-    tempData: string;
-}[K]), options?: unknown) => boolean]);
-export declare const updateSettings: () => void;
-export declare const checkState: () => void;
-export declare const clearTempData: () => boolean;