@nexushub/client 0.2.6 → 0.2.8

package/dist/index.d.cts

@@ -222,23 +222,9 @@ declare class AnalyticsEngine {
     start(): void;
     pageView(): void;
     private setupShareTracking;
-    /**
-     * 1. IDENTIFY: Link anonymous session to a User ID
-     */
     identify(userId: string, traits?: Record<string, any>): Promise<boolean>;
-    /**
-     * 2. GROUP: Link the current user to a Company/Organization (B2B)
-     * Required for the /api/group Rust route.
-     */
     group(groupId: string, traits?: Record<string, any>): Promise<boolean>;
-    /**
-     * 3. ALIAS: Merge two identities (e.g. "Guest_123" -> "User_99")
-     * Required for the /api/alias Rust route.
-     */
     alias(newId: string): Promise<boolean>;
-    /**
-     * 4. RESET: Clear local data and (optionally) request GDPR scrub
-     */
     reset(performGdprScrub?: boolean): void;
     track(eventName: string, properties?: Record<string, any>): void;
     trackPurchase(orderData: {
@@ -265,8 +251,20 @@ declare class NexusClient {
     content: ContentEngine;
     analytics?: AnalyticsEngine;
     constructor(config?: Partial<NexusConfig>);
+    /**
+     * Helper alias for cleaner content fetching.
+     */
     getPage<T = any>(slug: string, options?: any): Promise<T>;
+    /**
+     * Returns a readonly snapshot of the current config.
+     */
     getConfig(): Readonly<NexusConfig>;
+    /**
+     * Updates specific config fields at runtime.
+     * Replaces the previous pattern of `(nexus as any).config.projectId = x`
+     * which bypassed TypeScript and mutated internal state unsafely.
+     */
+    updateConfig(updates: Partial<NexusConfig>): void;
 }
 declare const nexus: NexusClient;
 declare const createNexusClient: (config: Partial<NexusConfig>) => NexusClient;
@@ -275,23 +273,32 @@ interface NexusProviderProps {
     children: React.ReactNode;
     /**
      * Optional project ID override.
-     * If provided, this will override the environment variable NEXT_PUBLIC_NEXUS_ID.
+     * Overrides the NEXT_PUBLIC_NEXUS_ID environment variable.
      */
     projectId?: string;
     /**
-     * Optional configuration to disable analytics tracking (e.g., for GDPR compliance).
+     * Set true to disable analytics (e.g. for GDPR opt-out).
      */
     disableAnalytics?: boolean;
 }
 /**
- * The God-Tier NexusHub Provider.
+ * NexusHub Provider.
+ * Manages the Analytics lifecycle, automates page view tracking on route
+ * changes, and exposes the NexusClient singleton via React Context.
  *
- * 1. Orchestrates the Authentication state.
- * 2. Manages the Analytics lifecycle.
- * 3. Automates Page View tracking on route changes.
- * 4. Provides the NexusClient singleton via Context.
+ * Usage in app/layout.tsx:
+ *
+ *   <NexusProvider projectId="your_id">
+ *     {children}
+ *   </NexusProvider>
+ *
+ * No manual <Suspense> wrapper needed — the provider handles it internally.
  */
 declare const NexusProvider: ({ children, projectId, disableAnalytics, }: NexusProviderProps) => react_jsx_runtime.JSX.Element;
+/**
+ * Access the raw NexusClient instance from any component inside the provider.
+ */
+declare const useNexus: () => NexusClient;
 
 interface SiteUser {
     id: string;
@@ -420,4 +427,4 @@ declare class LocalCacheProxy implements ILocalCache {
 
 declare const VERSION = "0.0.1";
 
-export { AnalyticsEngine, type AuthContextType, type AuthError, AuthProvider, type AuthState, BrowserCache, type CacheEntry, type CacheMetadata, CacheTags, type CollectionQuery, type CollectionResponse, ContentEngine, type ContentResponse, DEFAULT_ANALYTICS_URL, DEFAULT_API_URL, type ErrorResponse, LOCAL_NEST_URL, LOCAL_RUST_URL, LocalCacheProxy as LocalCache, type LoginCredentials, MemoryCache, type MinimalNexusConfig, NexusClient, type NexusConfig, NexusProvider, type RegisterCredentials, type SiteUser, VERSION, createNexusClient, getEnvConfig, getFullConfig, mergeConfigs, nexus, useNexusAuth, validateConfig };
+export { AnalyticsEngine, type AuthContextType, type AuthError, AuthProvider, type AuthState, BrowserCache, type CacheEntry, type CacheMetadata, CacheTags, type CollectionQuery, type CollectionResponse, ContentEngine, type ContentResponse, DEFAULT_ANALYTICS_URL, DEFAULT_API_URL, type ErrorResponse, LOCAL_NEST_URL, LOCAL_RUST_URL, LocalCacheProxy as LocalCache, type LoginCredentials, MemoryCache, type MinimalNexusConfig, NexusClient, type NexusConfig, NexusProvider, type NexusProviderProps, type RegisterCredentials, type SiteUser, VERSION, createNexusClient, getEnvConfig, getFullConfig, mergeConfigs, nexus, useNexus, useNexusAuth, validateConfig };

package/dist/index.d.ts

@@ -222,23 +222,9 @@ declare class AnalyticsEngine {
     start(): void;
     pageView(): void;
     private setupShareTracking;
-    /**
-     * 1. IDENTIFY: Link anonymous session to a User ID
-     */
     identify(userId: string, traits?: Record<string, any>): Promise<boolean>;
-    /**
-     * 2. GROUP: Link the current user to a Company/Organization (B2B)
-     * Required for the /api/group Rust route.
-     */
     group(groupId: string, traits?: Record<string, any>): Promise<boolean>;
-    /**
-     * 3. ALIAS: Merge two identities (e.g. "Guest_123" -> "User_99")
-     * Required for the /api/alias Rust route.
-     */
     alias(newId: string): Promise<boolean>;
-    /**
-     * 4. RESET: Clear local data and (optionally) request GDPR scrub
-     */
     reset(performGdprScrub?: boolean): void;
     track(eventName: string, properties?: Record<string, any>): void;
     trackPurchase(orderData: {
@@ -265,8 +251,20 @@ declare class NexusClient {
     content: ContentEngine;
     analytics?: AnalyticsEngine;
     constructor(config?: Partial<NexusConfig>);
+    /**
+     * Helper alias for cleaner content fetching.
+     */
     getPage<T = any>(slug: string, options?: any): Promise<T>;
+    /**
+     * Returns a readonly snapshot of the current config.
+     */
     getConfig(): Readonly<NexusConfig>;
+    /**
+     * Updates specific config fields at runtime.
+     * Replaces the previous pattern of `(nexus as any).config.projectId = x`
+     * which bypassed TypeScript and mutated internal state unsafely.
+     */
+    updateConfig(updates: Partial<NexusConfig>): void;
 }
 declare const nexus: NexusClient;
 declare const createNexusClient: (config: Partial<NexusConfig>) => NexusClient;
@@ -275,23 +273,32 @@ interface NexusProviderProps {
     children: React.ReactNode;
     /**
      * Optional project ID override.
-     * If provided, this will override the environment variable NEXT_PUBLIC_NEXUS_ID.
+     * Overrides the NEXT_PUBLIC_NEXUS_ID environment variable.
      */
     projectId?: string;
     /**
-     * Optional configuration to disable analytics tracking (e.g., for GDPR compliance).
+     * Set true to disable analytics (e.g. for GDPR opt-out).
      */
     disableAnalytics?: boolean;
 }
 /**
- * The God-Tier NexusHub Provider.
+ * NexusHub Provider.
+ * Manages the Analytics lifecycle, automates page view tracking on route
+ * changes, and exposes the NexusClient singleton via React Context.
  *
- * 1. Orchestrates the Authentication state.
- * 2. Manages the Analytics lifecycle.
- * 3. Automates Page View tracking on route changes.
- * 4. Provides the NexusClient singleton via Context.
+ * Usage in app/layout.tsx:
+ *
+ *   <NexusProvider projectId="your_id">
+ *     {children}
+ *   </NexusProvider>
+ *
+ * No manual <Suspense> wrapper needed — the provider handles it internally.
  */
 declare const NexusProvider: ({ children, projectId, disableAnalytics, }: NexusProviderProps) => react_jsx_runtime.JSX.Element;
+/**
+ * Access the raw NexusClient instance from any component inside the provider.
+ */
+declare const useNexus: () => NexusClient;
 
 interface SiteUser {
     id: string;
@@ -420,4 +427,4 @@ declare class LocalCacheProxy implements ILocalCache {
 
 declare const VERSION = "0.0.1";
 
-export { AnalyticsEngine, type AuthContextType, type AuthError, AuthProvider, type AuthState, BrowserCache, type CacheEntry, type CacheMetadata, CacheTags, type CollectionQuery, type CollectionResponse, ContentEngine, type ContentResponse, DEFAULT_ANALYTICS_URL, DEFAULT_API_URL, type ErrorResponse, LOCAL_NEST_URL, LOCAL_RUST_URL, LocalCacheProxy as LocalCache, type LoginCredentials, MemoryCache, type MinimalNexusConfig, NexusClient, type NexusConfig, NexusProvider, type RegisterCredentials, type SiteUser, VERSION, createNexusClient, getEnvConfig, getFullConfig, mergeConfigs, nexus, useNexusAuth, validateConfig };
+export { AnalyticsEngine, type AuthContextType, type AuthError, AuthProvider, type AuthState, BrowserCache, type CacheEntry, type CacheMetadata, CacheTags, type CollectionQuery, type CollectionResponse, ContentEngine, type ContentResponse, DEFAULT_ANALYTICS_URL, DEFAULT_API_URL, type ErrorResponse, LOCAL_NEST_URL, LOCAL_RUST_URL, LocalCacheProxy as LocalCache, type LoginCredentials, MemoryCache, type MinimalNexusConfig, NexusClient, type NexusConfig, NexusProvider, type NexusProviderProps, type RegisterCredentials, type SiteUser, VERSION, createNexusClient, getEnvConfig, getFullConfig, mergeConfigs, nexus, useNexus, useNexusAuth, validateConfig };