@magemetrics/core 0.5.4 → 0.6.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Client } from 'openapi-fetch';
 import { DefaultChatTransport } from 'ai';
+import { GoTrueClient } from '@supabase/auth-js';
 import { GoTrueClientOptions } from '@supabase/auth-js';
 import { HttpChatTransportInitOptions } from 'ai';
 import type { InferUITool } from 'ai';
@@ -63,6 +64,54 @@ declare interface AsyncStorage_2 {
     removeItem(key: string): Promise<void>;
 }
 
+/**
+ * Authentication provider interface for MageMetrics client.
+ * Providers handle token management and header generation.
+ */
+export declare interface AuthProvider {
+    /**
+     * Initialize the auth provider and perform any necessary setup.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Get authentication headers to include in API requests.
+     */
+    getHeaders(): Promise<Record<string, string>>;
+    /**
+     * Get the current authentication state.
+     */
+    getState(): AuthState;
+    /**
+     * Update the external JWT (if applicable).
+     */
+    updateExternalJwt(jwt: string): Promise<void>;
+    /**
+     * Logout and clear any stored tokens.
+     */
+    logout(): Promise<void>;
+    /**
+     * Get the Supabase client (if available).
+     * Used for backward compatibility with existing code.
+     */
+    getSupabaseClient(): GoTrueClient | null;
+    /**
+     * Add an event listener for auth events.
+     * @param type the type of the event
+     * @param listener the listener to add
+     * @param options options for the event listener
+     * @param options.signal an AbortSignal to remove the listener when aborted
+     */
+    addEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>, options?: {
+        signal?: AbortSignal;
+    }): void;
+    /**
+     * Remove an event listener.
+     * @param type the type of the event
+     * @param listener the listener to remove
+     */
+    removeEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>): void;
+}
+
 /**
  * Authentication states
  */
@@ -275,6 +324,97 @@ declare type CustomDataParts = {
     };
 };
 
+/**
+ * Direct authentication provider that uses a Supabase JWT directly
+ * without going through the token exchange flow.
+ *
+ * This provider:
+ * - Does NOT create shadow users
+ * - Does NOT call the exchange endpoint
+ * - Simply returns the JWT in headers for backend validation
+ * - Preserves the original user's roles and permissions
+ *
+ * Use this for internal admin tools where you already have a valid
+ * Supabase JWT and want to bypass the external auth flow.
+ * @example
+ * ```typescript
+ * const authProvider = new DirectAuthProvider(internalUserJwt);
+ * const client = new MageMetricsClient(config, authProvider);
+ * ```
+ */
+export declare class DirectAuthProvider implements AuthProvider {
+    private state;
+    private jwt;
+    private events;
+    constructor(jwt: string);
+    initialize(): Promise<void>;
+    getHeaders(): Promise<Record<string, string>>;
+    getState(): AuthState;
+    updateExternalJwt(jwt: string): Promise<void>;
+    logout(): Promise<void>;
+    getSupabaseClient(): GoTrueClient | null;
+    addEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>, options?: {
+        signal?: AbortSignal;
+    }): void;
+    removeEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>): void;
+    private setState;
+}
+
+/**
+ * External authentication provider that handles the full token exchange flow.
+ *
+ * This provider:
+ * - Calls the exchange endpoint to create shadow users
+ * - Manages Supabase sessions
+ * - Handles token refresh
+ * - Supports auto-refresh and session management
+ *
+ * This is the default provider used for external customer integrations.
+ */
+export declare class ExternalAuthProvider implements AuthProvider {
+    private config;
+    private state;
+    private supabaseClient;
+    private noAuthApiClient;
+    private authApiResponse;
+    private processedJwt;
+    private userId;
+    private events;
+    constructor(config: ExternalAuthProviderConfig);
+    initialize(): Promise<void>;
+    getHeaders(): Promise<Record<string, string>>;
+    getState(): AuthState;
+    updateExternalJwt(jwt: string): Promise<void>;
+    logout(): Promise<void>;
+    getSupabaseClient(): GoTrueClient | null;
+    addEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>, options?: {
+        signal?: AbortSignal;
+    }): void;
+    removeEventListener<T extends MageMetricsEvent>(type: T["type"], listener: MageMetricsEventListener<T>): void;
+    startAutoRefresh(): Promise<void> | undefined;
+    stopAutoRefresh(): Promise<void> | undefined;
+    private getApiInformation;
+    private initializeSupabaseClient;
+    private handleAuthentication;
+    private exchangeExternalToken;
+    private setState;
+    private encodeCheckKey;
+    private saveCheckKey;
+    private compareCheckKey;
+    private clearCheckKey;
+    private clearStorage;
+}
+
+export declare interface ExternalAuthProviderConfig {
+    apiUrl: string;
+    apiKey: string;
+    externalJwt?: string;
+    additionalHeaders?: Record<string, string>;
+    storage: AsyncStorage_2;
+    applicationName?: string;
+    authOptions?: Pick<GoTrueClientOptions, "fetch">;
+}
+
 declare type ExtractInsightResponse = z.infer<typeof ExtractInsightResponseSchema>;
 
 declare const ExtractInsightResponseSchema: z.ZodUnion<[z.ZodObject<{
@@ -305,6 +445,8 @@ export declare type GenerateInsightParam = {
 
 export declare const getPublicApiClient: (apiUrl: string, apiKey: string) => Client<NoAuthPaths>;
 
+declare const HEADER_SP_TOKEN: "sp-access-token";
+
 declare const inputSchema: z.ZodObject<{
     userRequest: z.ZodString;
     isNewAnalysisGoal: z.ZodBoolean;
@@ -365,18 +507,10 @@ declare type MageMetricsChatTransportOptions = Omit<HttpChatTransportInitOptions
  */
 export declare class MageMetricsClient {
     private config;
-    private authState;
-    private supabaseClient;
+    private authProvider;
     private internalApiClient;
-    private noAuthApiClient;
-    private authApiResponse;
     private authPromise;
-    private processedJwt;
-    private userId;
-    private storageAdapter;
-    private events;
-    private authOptions;
-    constructor(config: MageMetricsClientConfig, auth?: Pick<GoTrueClientOptions, "fetch">);
+    constructor(config: MageMetricsClientConfig, authProviderOrAuthOptions?: AuthProvider | Pick<GoTrueClientOptions, "fetch">);
     toJSON(): {
         config: string;
     };
@@ -404,7 +538,6 @@ export declare class MageMetricsClient {
     updateExternalJwt(jwt: string): Promise<void>;
     get state(): AuthState;
     getHeaders(): Promise<Record<string, string>>;
-    private clearStorage;
     logout(): Promise<void>;
     auth: {
         startAutoRefresh: () => Promise<void> | undefined;
@@ -480,6 +613,16 @@ export declare class MageMetricsClient {
                         null_count: number | null;
                         unique_count: number | null;
                         unique_percentage: number | null;
+                        min_value?: number | null;
+                        max_value?: number | null;
+                        avg_value?: number | null;
+                        median_value?: number | null;
+                        std_value?: number | null;
+                        min_date?: string | null;
+                        max_date?: string | null;
+                        min_length?: number | null;
+                        max_length?: number | null;
+                        avg_length?: number | null;
                     } & {
                         [key: string]: unknown;
                     };
@@ -577,27 +720,8 @@ export declare class MageMetricsClient {
             }[]>;
         }>;
     };
-    /**
-     * Perform the complete authentication flow
-     */
-    private performAuthFlow;
-    private getApiInformation;
-    private initializeSupabaseClient;
     client(): InternalApiClient;
-    /**
-     * Handle the authentication logic (check session or exchange token)
-     */
-    private handleAuthentication;
-    /**
-     * Exchange external JWT for Supabase tokens
-     */
-    private exchangeExternalToken;
     private createSupabaseHeaderMiddleware;
-    private setState;
-    private encodeCheckKey;
-    saveCheckKey(externalJwt: string, apiKey: string): Promise<void>;
-    compareCheckKey(externalJwt: string, apiKey: string): Promise<boolean>;
-    clearCheckKey(): Promise<void>;
 }
 
 /**
@@ -1149,6 +1273,16 @@ declare interface operations {
                                     null_count: number | null;
                                     unique_count: number | null;
                                     unique_percentage: number | null;
+                                    min_value?: number | null;
+                                    max_value?: number | null;
+                                    avg_value?: number | null;
+                                    median_value?: number | null;
+                                    std_value?: number | null;
+                                    min_date?: string | null;
+                                    max_date?: string | null;
+                                    min_length?: number | null;
+                                    max_length?: number | null;
+                                    avg_length?: number | null;
                                 } & {
                                     [key: string]: unknown;
                                 };
@@ -1799,6 +1933,16 @@ declare interface operations {
                                     null_count: number | null;
                                     unique_count: number | null;
                                     unique_percentage: number | null;
+                                    min_value?: number | null;
+                                    max_value?: number | null;
+                                    avg_value?: number | null;
+                                    median_value?: number | null;
+                                    std_value?: number | null;
+                                    min_date?: string | null;
+                                    max_date?: string | null;
+                                    min_length?: number | null;
+                                    max_length?: number | null;
+                                    avg_length?: number | null;
                                 } & {
                                     [key: string]: unknown;
                                 };
@@ -4447,9 +4591,9 @@ declare type TableFilters = Record<string, string | number>;
  */
 export declare const TOKEN_STORAGE_KEY = "mm-ai-sp-token";
 
-declare type ToRemove = Simplify<{
-    header: "sp-access-token";
-}>;
+declare type ToRemove = {
+    header: typeof HEADER_SP_TOKEN;
+};
 
 declare type UiTool = InferUITool<Tool<z.infer<typeof inputSchema>, z.infer<typeof redactedOutputSchema>>>;