apps-sdk 2.1.2 → 2.1.4

package/types/index.d.ts

@@ -37,6 +37,10 @@ declare module 'apps-sdk' {
         init(): Promise<void>;
         setDebugMode(debugMode: boolean): void;
         setConfigEndpoint(endpoint: string): void;
+        setUserCreateEndpoint(endpoint: string): void;
+        setBaseUrl(baseUrl: string): void;
+        getCredits(webappUrl: string, websiteId: string): Promise<number>;
+        getWebappBasePayload(websiteId: string, additionalData?: any): any;
         initSession(): Promise<void>;
         storeSessionStructure(): Promise<void>;
         checkFirstOpen(): Promise<void>;
@@ -119,8 +123,42 @@ declare module 'apps-sdk' {
         isSpecialEvent(eventKeyword: string): boolean;
     }
 
+    export interface RatingConfigOptions {
+        /** Called when the sentiment prompt ("Are you enjoying the app?") should be shown. */
+        onShowSentimentPrompt: (source: string) => void;
+        /** Called when the feedback form should be shown (user said NO). */
+        onShowFeedbackForm: () => void;
+        /** Called to track analytics events. */
+        onTrackEvent: (eventName: string, properties: Record<string, any>) => void;
+        /** Optional: called after feedback text is submitted. */
+        onSubmitFeedback?: (feedbackText: string) => Promise<void>;
+    }
+
     export class Rating {
-        showRatingDialog(force?: boolean): Promise<void>;
+        /** Register UI callbacks. Call once on app startup after initialize(). */
+        configure(options: RatingConfigOptions): void;
+        /** Load persisted state from storage. Call on app startup. */
+        initialize(): Promise<void>;
+        /** Trigger rating flow after a successful AI interaction. */
+        onAIInteractionSuccess(isUserInitiated?: boolean): Promise<void>;
+        /** Trigger rating flow when credits are running low. */
+        onCreditsRunningLow(currentCredits: number): Promise<void>;
+        /** Trigger rating flow after user downloads or shares a result. */
+        onResultDownloadedOrShared(actionType: 'download' | 'share'): Promise<void>;
+        /** Directly call StoreReview.requestReview(). */
+        triggerNativeRating(): Promise<void>;
+        /** Call this when the user taps YES on the sentiment prompt. */
+        onUserRespondedYes(): Promise<void>;
+        /** Call this when the user taps NO on the sentiment prompt. */
+        onUserRespondedNo(): void;
+        /** Submit written feedback text. */
+        submitFeedback(feedbackText: string): Promise<void>;
+        /** Call when the user dismisses the feedback form without submitting. */
+        onFeedbackCanceled(): void;
+        /** Reset all persisted rating state (for debugging/testing). */
+        reset(): Promise<void>;
+        /** @deprecated Legacy method — use the new flow methods instead. */
+        showRatingDialog(force?: boolean): Promise<{ success: boolean; shown: boolean; [key: string]: any }>;
     }
 
     export class NotificationsPush {
@@ -305,6 +343,269 @@ declare module 'apps-sdk' {
         setUserProperty(name: string, value: string): Promise<void>;
     }
 
+    // ─── Authentication ────────────────────────────────────────────────────────
+
+    export interface AuthApiResult<T = any> {
+        success: boolean;
+        data?: T;
+        error?: string;
+        code?: number;
+        message?: string;
+        raw?: any;
+    }
+
+    export interface AuthLoginPayload {
+        /** Email or username */
+        login?: string;
+        /** Credential (alias for login) */
+        credential?: string;
+        /** Password */
+        password: string;
+        /** Optional website ID (defaults to config value) */
+        websiteid?: string;
+    }
+
+    export interface AuthRegisterPayload {
+        /** Email or username */
+        login?: string;
+        /** Email (alias for login) */
+        email?: string;
+        /** Password */
+        password: string;
+        /** Optional website ID (defaults to config value) */
+        websiteid?: string;
+    }
+
+    export interface AuthRegisterAndLinkPayload {
+        email: string;
+        password: string;
+    }
+
+    export interface AuthLinkUserPayload {
+        /** Web user ID */
+        user_id: string;
+        /** Mobile app user ID */
+        app_user_id: string;
+    }
+
+    export interface AuthCheckLinkPayload {
+        user_id: string;
+        app_user_id: string;
+    }
+
+    export interface AuthCheckSubscriptionPayload {
+        user_id: string;
+        app_user_id: string;
+    }
+
+    export interface AuthValidatePhonePayload {
+        phoneNumber: string;
+        countryCode: string;
+    }
+
+    export interface AuthRequestPasswordResetPayload {
+        credential: string;
+    }
+
+    export interface AuthVerifyResetCodePayload {
+        code: string;
+    }
+
+    export interface AuthResetPasswordPayload {
+        resetToken: string;
+        newPassword: string;
+    }
+
+    export interface AuthResendCodePayload {
+        credential: string;
+    }
+
+    export interface AuthValidateQrCodePayload {
+        qrData: string;
+    }
+
+    export interface AuthLinkWithQrCodePayload {
+        user_id: string;
+    }
+
+    export interface AuthUserData {
+        us_id: string | number;
+        us_login?: string;
+        login?: string;
+        metadata?: Record<string, any> | any[];
+        subscription_data?: AuthSubscriptionData;
+        success?: number;
+    }
+
+    export interface AuthSubscriptionData {
+        subscription_active?: boolean;
+        [key: string]: any;
+    }
+
+    export interface AuthLinkedUserData {
+        success: number;
+        linked: boolean;
+        items?: AuthUserData[];
+    }
+
+    export interface AuthRegisterAndLinkResult {
+        success: boolean;
+        user?: AuthUserData;
+        linked?: boolean;
+        error?: string;
+        code?: number;
+    }
+
+    export interface AuthQrValidationData {
+        valid: boolean;
+        user_id?: string;
+    }
+
+    export interface AuthQrLinkData {
+        linked: boolean;
+        message?: string;
+        subscriptionActive?: boolean;
+    }
+
+    export interface AuthCallApiOptions {
+        retries?: number;
+        timeoutMs?: number;
+        silent?: boolean;
+    }
+
+    export class Authentication {
+        AUTH_API_BASE_URL: string;
+        USER_API_BASE_URL: string;
+        CHATCONNECT_API_BASE_URL: string;
+
+        /** Get website ID from config */
+        getWebsiteId(): string;
+
+        /** Get app user ID from session */
+        getAppUserId(): string;
+
+        /**
+         * Generic API call helper with retry logic.
+         */
+        callApi(url: string, payload: object, opts?: AuthCallApiOptions): Promise<AuthApiResult>;
+
+        /**
+         * Login with credentials.
+         * POST /auth/auth-user
+         */
+        login(payload: AuthLoginPayload): Promise<AuthApiResult<AuthUserData>>;
+
+        /**
+         * Register a new user account.
+         * POST /chatconnect/create-user
+         */
+        register(payload: AuthRegisterPayload): Promise<AuthApiResult<{ user: AuthUserData }>>;
+
+        /**
+         * Complete registration flow: create-user → link-user.
+         */
+        registerAndLinkAccount(payload: AuthRegisterAndLinkPayload): Promise<AuthRegisterAndLinkResult>;
+
+        /**
+         * Link a user account.
+         * POST /user/link
+         */
+        linkUser(payload: AuthLinkUserPayload): Promise<AuthApiResult<AuthLinkedUserData>>;
+
+        /**
+         * Fetch authenticated user profile using stored credentials.
+         */
+        fetchUserProfile(): Promise<AuthApiResult<AuthUserData>>;
+
+        /**
+         * Check if user account is linked (using stored data).
+         */
+        isAccountLinked(): Promise<boolean>;
+
+        /**
+         * Get stored auth user login (email).
+         */
+        getStoredUserLogin(): Promise<string | null>;
+
+        /**
+         * Check if user is linked.
+         * POST /user/check-link
+         */
+        checkLink(payload: AuthCheckLinkPayload): Promise<AuthApiResult>;
+
+        /**
+         * Check user subscription status.
+         * POST /user/check-subs
+         */
+        checkSubscription(payload: AuthCheckSubscriptionPayload): Promise<AuthApiResult>;
+
+        /**
+         * Check if a credential exists (stub for backward compatibility).
+         */
+        checkCredential(payload: { credentialType: string; [key: string]: any }): Promise<AuthApiResult<{ exists: boolean; credentialType: string; requiresPhone: boolean }>>;
+
+        /**
+         * Validate phone number (client-side).
+         */
+        validatePhone(payload: AuthValidatePhonePayload): Promise<AuthApiResult<{ valid: boolean; formattedPhone?: string }>>;
+
+        /**
+         * Request password reset (stub).
+         */
+        requestPasswordReset(payload: AuthRequestPasswordResetPayload): Promise<AuthApiResult<{ sent: boolean; destination: string; expiresIn: number }>>;
+
+        /**
+         * Verify reset code (stub).
+         */
+        verifyResetCode(payload: AuthVerifyResetCodePayload): Promise<AuthApiResult<{ valid: boolean; resetToken: string }>>;
+
+        /**
+         * Reset password (stub).
+         */
+        resetPassword(payload: AuthResetPasswordPayload): Promise<AuthApiResult<{ success: boolean; message: string }>>;
+
+        /**
+         * Resend verification code (stub).
+         */
+        resendCode(payload: AuthResendCodePayload): Promise<AuthApiResult<{ sent: boolean; canResendAt: string }>>;
+
+        /**
+         * Validate QR code data.
+         */
+        validateQrCode(payload: AuthValidateQrCodePayload): Promise<AuthApiResult<AuthQrValidationData>>;
+
+        /**
+         * Link account using QR code.
+         * POST /user/link
+         */
+        linkWithQrCode(payload: AuthLinkWithQrCodePayload): Promise<AuthApiResult<AuthQrLinkData>>;
+
+        /**
+         * Logout current user (clears stored auth data).
+         */
+        logout(): Promise<AuthApiResult<{ success: boolean }>>;
+
+        /**
+         * Check if user is currently authenticated (has stored user ID).
+         */
+        isAuthenticated(): Promise<boolean>;
+
+        /**
+         * Get stored user ID.
+         */
+        getStoredUserId(): Promise<string | null>;
+
+        /**
+         * Get stored user metadata.
+         */
+        getStoredUserMetadata(): Promise<Record<string, any> | null>;
+
+        /**
+         * Get stored subscription data.
+         */
+        getStoredSubscription(): Promise<AuthSubscriptionData | null>;
+    }
+
     export class AppsSDK {
         initializePushNotifications(): Promise<string>;
     }
@@ -323,13 +624,16 @@ declare module 'apps-sdk' {
         mixpanel            : MixPanel;
         tracking            : TrackingTransparency;
         paywallLogic        : PayWallLogic;
+        /** @deprecated Use `notifications` instead */
         notificationsPush   : NotificationsPush;
+        notifications       : NotificationsPush;
         voice               : Voice;
         adapty              : Adapty;
         homeActions         : HomeActions;
         facebook            : Facebook;
         firebase            : Firebase;
         legal               : Legal;
+        authentication      : Authentication;
     }
 
     const Core: AppsSDK;