@memberstack/dom 2.0.0 → 2.0.2-beta.0

package/lib/methods/index.d.mts

@@ -1,29 +1,109 @@
-import { GetCurrentMemberParams, MemberstackOptions } from './requests/index.mjs';
+import { MemberstackOptions, GetCurrentMemberParams } from './requests/index.mjs';
 import { GetPostsParams, GetThreadsParams, CreatePostParams, UpdatePostParams, PostVoteParams, DeletePostParams, CreateThreadParams, UpdateThreadParams, ThreadVoteParams, DeleteThreadParams, GetSecureContentParams, SignupWithProviderParams, LoginWithProviderParams, LoginMemberEmailPasswordParams, SendMemberLoginPasswordlessEmailParams, LoginMemberPasswordlessParams, GetPlanParams, UpdateMemberJSONParams, AddPlanParams, PurchasePlansWithCheckoutParams, LaunchStripeCustomerPortalParams, RemovePlanParams, UpdateMemberParams, UpdateMemberAuthParams, SetPasswordParams, SignupMemberEmailPasswordParams, JoinTeamParams, GetTeamParams, RemoveMemberFromTeamParams, GenerateInviteTokenParams, UpdateMemberProfileImageParams, SendMemberResetPasswordEmailParams, ResetMemberPasswordParams, GetDataTableParams, GetDataRecordsParams, CreateDataRecordParams, GetDataRecordParams, UpdateDataRecordParams, DeleteDataRecordParams, QueryDataRecordsParams } from '../types/params.mjs';
 import { DeleteMemberPayload, GetPostsPayload, GetThreadsPayload, CreatePostPayload, UpdatePostPayload, CreateThreadPayload, UpdateThreadPayload, GetSecureContentPayload, ConnectProviderPayload, GetAppAndMemberPayload, AppPayload, LoginMemberEmailPasswordPayload, SendMemberLoginPasswordlessEmailPayload, GetPlanPayload, GetPlansPayload, GetRestrictedUrlGroupsPayload, GetCurrentMemberPayload, GetMemberJSONPayload, AddPlanPayload, PurchasePlansWithCheckoutPayload, LaunchStripeCustomerPortalPayload, RemovePlanPayload, UpdateMemberPayload, UpdateMemberAuthPayload, SetPasswordPayload, SignupMemberEmailPasswordPayload, UpdateMemberProfileImagePayload, SendMemberVerificationEmailPayload, SendMemberResetPasswordEmailPayload, ResetMemberPassworPayload, LogoutMemberPayload, GetDataTablesPayload, GetDataTablePayload, GetDataRecordsPayload, CreateDataRecordPayload, GetDataRecordPayload, UpdateDataRecordPayload, DeleteDataRecordPayload, QueryDataRecordsPayload } from '../types/payloads.mjs';
 import { MemberstackTranslations } from '../types/translations.mjs';
 import '../types/utils/payloads.mjs';
 
+/**
+ * Configuration options for initializing the Memberstack SDK.
+ */
 type DOMConfig = {
+    /**
+     * Your Memberstack public API key.
+     * - Sandbox keys start with `pk_sb_` (use for development/testing)
+     * - Live keys start with `pk_` (use for production)
+     * @example "pk_sb_abc123def456"
+     */
     publicKey: string;
+    /**
+     * Optional app ID for multi-app configurations.
+     * Only needed if you have multiple Memberstack apps.
+     */
     appId?: string;
+    /**
+     * Enable cookie-based session storage.
+     * Recommended when you need sessions to persist across subdomains.
+     * @default false
+     */
     useCookies?: boolean;
+    /**
+     * When `useCookies` is true, set cookies on the root domain.
+     * This allows session sharing across subdomains (e.g., app.example.com and www.example.com).
+     * @default false
+     */
     setCookieOnRootDomain?: boolean;
+    /**
+     * Custom API domain for enterprise or self-hosted deployments.
+     * Most users don't need to set this.
+     */
     domain?: string;
+    /**
+     * Enable debug mode for verbose console logging.
+     * Useful during development to see API calls, auth state changes, and errors.
+     * Also exposes `window.__MEMBERSTACK_DEBUG__` for DevTools inspection.
+     * @default false
+     *
+     * @example
+     * ```typescript
+     * const memberstack = MemberstackDOM.init({
+     *   publicKey: 'pk_sb_...',
+     *   debug: true // Enable in development
+     * });
+     * ```
+     */
+    debug?: boolean;
+    /**
+     * @deprecated This option is no longer used. Session duration is controlled server-side.
+     * @internal
+     */
     sessionDurationDays?: number;
 };
 declare const _default: {
     init: (props: DOMConfig) => {
         openModal: (type: "LOGIN" | "SIGNUP" | "FORGOT_PASSWORD" | "RESET_PASSWORD" | "PROFILE", params?: {
-            [key: string]: any;
+            [key: string]: unknown;
             translations?: MemberstackTranslations;
         }) => Promise<unknown>;
         hideModal: () => void;
-        _hideLoader: (element?: any) => void;
-        _showLoader: (element?: any) => void;
-        _showMessage: (msg: any, isError: any) => Promise<void>;
+        preloadModals: () => Promise<void>;
+        _hideLoader: (element?: HTMLElement) => void;
+        _showLoader: (element?: HTMLElement) => void;
+        _showMessage: (msg: string, isError?: boolean) => Promise<void>;
         getMemberCookie: () => any;
-        onAuthChange: (cb: any) => {
+        onAuthChange: (cb: (member: {
+            id: string;
+            verified: boolean;
+            profileImage: string;
+            auth: {
+                email: string;
+                hasPassword: boolean;
+                providers: {
+                    provider: string;
+                }[];
+            };
+            loginRedirect: string;
+            stripeCustomerId: string;
+            createdAt: string;
+            metaData: object;
+            customFields: object;
+            permissions: [] | string[];
+            planConnections: {
+                id: string;
+                active: boolean;
+                status: string;
+                planId: string;
+                type: string;
+                payment: {
+                    amount: number;
+                    currency: string;
+                    status: string;
+                    lastBillingDate: number;
+                    nextBillingDate: number;
+                    cancelAtDate: number;
+                    priceId: string;
+                };
+            }[];
+        }) => void) => {
             unsubscribe: () => boolean;
         };
         _captchaReady: Promise<unknown>;
@@ -35,34 +115,36 @@ declare const _default: {
         postIsTyping(params: {
             channelKey: string;
         }): Promise<void>;
-        getChannelInfo(params?: {
+        getChannelInfo(params: {
             channelKey: string;
         }): Promise<any>;
-        subscribeToChannel(params?: {
+        subscribeToChannel(params: {
             channelKey: string;
             action: "NONE" | "THREADS_ONLY";
         }): Promise<void>;
-        getPosts(params?: GetPostsParams): Promise<GetPostsPayload>;
-        getThreads(params?: GetThreadsParams): Promise<GetThreadsPayload>;
-        createPost(params?: CreatePostParams): Promise<CreatePostPayload>;
-        updatePost(params?: UpdatePostParams): Promise<UpdatePostPayload>;
-        postVote(params?: PostVoteParams): Promise<void>;
-        deletePost(params?: DeletePostParams): Promise<void>;
-        createThread(params?: CreateThreadParams): Promise<CreateThreadPayload>;
-        updateThread(params?: UpdateThreadParams): Promise<UpdateThreadPayload>;
-        threadVote(params?: ThreadVoteParams): Promise<void>;
-        deleteThread(params?: DeleteThreadParams): Promise<void>;
-        getSecureContent(params?: GetSecureContentParams): Promise<GetSecureContentPayload>;
-        signupWithProvider(params?: SignupWithProviderParams): Promise<unknown>;
-        loginWithProvider(params?: LoginWithProviderParams): Promise<unknown>;
-        connectProvider(params?: LoginWithProviderParams): Promise<ConnectProviderPayload>;
+        getPosts(params: GetPostsParams): Promise<GetPostsPayload>;
+        getThreads(params: GetThreadsParams): Promise<GetThreadsPayload>;
+        createPost(params: CreatePostParams): Promise<CreatePostPayload>;
+        updatePost(params: UpdatePostParams): Promise<UpdatePostPayload>;
+        postVote(params: PostVoteParams): Promise<void>;
+        deletePost(params: DeletePostParams): Promise<void>;
+        createThread(params: CreateThreadParams): Promise<CreateThreadPayload>;
+        updateThread(params: UpdateThreadParams): Promise<UpdateThreadPayload>;
+        threadVote(params: ThreadVoteParams): Promise<void>;
+        deleteThread(params: DeleteThreadParams): Promise<void>;
+        getSecureContent(params: GetSecureContentParams): Promise<GetSecureContentPayload>;
+        signupWithProvider(params: SignupWithProviderParams): Promise<unknown>;
+        loginWithProvider(params: LoginWithProviderParams): Promise<unknown>;
+        connectProvider(params: LoginWithProviderParams): Promise<ConnectProviderPayload>;
         disconnectProvider(params: LoginWithProviderParams): Promise<ConnectProviderPayload>;
-        getAppAndMember(params?: any): Promise<GetAppAndMemberPayload>;
+        getAppAndMember(params?: {
+            trackPageView?: boolean;
+        }): Promise<GetAppAndMemberPayload>;
         getApp(): Promise<AppPayload>;
-        loginMemberEmailPassword(params: LoginMemberEmailPasswordParams, options?: any): Promise<LoginMemberEmailPasswordPayload>;
-        sendMemberLoginPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: any): Promise<SendMemberLoginPasswordlessEmailPayload>;
-        sendMemberSignupPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: any): Promise<SendMemberLoginPasswordlessEmailPayload>;
-        loginMemberPasswordless(params: LoginMemberPasswordlessParams, options?: any): Promise<LoginMemberEmailPasswordPayload>;
+        loginMemberEmailPassword(params: LoginMemberEmailPasswordParams, options?: MemberstackOptions): Promise<LoginMemberEmailPasswordPayload>;
+        sendMemberLoginPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: MemberstackOptions): Promise<SendMemberLoginPasswordlessEmailPayload>;
+        sendMemberSignupPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: MemberstackOptions): Promise<SendMemberLoginPasswordlessEmailPayload>;
+        loginMemberPasswordless(params: LoginMemberPasswordlessParams, options?: MemberstackOptions): Promise<LoginMemberEmailPasswordPayload>;
         getPlan(params: GetPlanParams): Promise<GetPlanPayload>;
         getPlans(): Promise<GetPlansPayload>;
         getRestrictedUrlGroups(): Promise<GetRestrictedUrlGroupsPayload>;
@@ -78,8 +160,8 @@ declare const _default: {
         setPassword(params: SetPasswordParams, options?: MemberstackOptions): Promise<SetPasswordPayload>;
         signupMemberPasswordless(params: Omit<SignupMemberEmailPasswordParams, "password"> & {
             passwordlessToken: string;
-        }, options?: any): Promise<SignupMemberEmailPasswordPayload>;
-        signupMemberEmailPassword(params: SignupMemberEmailPasswordParams, options?: any): Promise<SignupMemberEmailPasswordPayload>;
+        }, options?: MemberstackOptions): Promise<SignupMemberEmailPasswordPayload>;
+        signupMemberEmailPassword(params: SignupMemberEmailPasswordParams, options?: MemberstackOptions): Promise<SignupMemberEmailPasswordPayload>;
         joinTeam(params: JoinTeamParams, options?: MemberstackOptions): Promise<void>;
         getTeam(params: GetTeamParams, options?: MemberstackOptions): Promise<void>;
         removeMemberFromTeam(params: RemoveMemberFromTeamParams, options?: MemberstackOptions): Promise<void>;

package/lib/methods/index.d.ts

@@ -1,29 +1,109 @@
-import { GetCurrentMemberParams, MemberstackOptions } from './requests/index.js';
+import { MemberstackOptions, GetCurrentMemberParams } from './requests/index.js';
 import { GetPostsParams, GetThreadsParams, CreatePostParams, UpdatePostParams, PostVoteParams, DeletePostParams, CreateThreadParams, UpdateThreadParams, ThreadVoteParams, DeleteThreadParams, GetSecureContentParams, SignupWithProviderParams, LoginWithProviderParams, LoginMemberEmailPasswordParams, SendMemberLoginPasswordlessEmailParams, LoginMemberPasswordlessParams, GetPlanParams, UpdateMemberJSONParams, AddPlanParams, PurchasePlansWithCheckoutParams, LaunchStripeCustomerPortalParams, RemovePlanParams, UpdateMemberParams, UpdateMemberAuthParams, SetPasswordParams, SignupMemberEmailPasswordParams, JoinTeamParams, GetTeamParams, RemoveMemberFromTeamParams, GenerateInviteTokenParams, UpdateMemberProfileImageParams, SendMemberResetPasswordEmailParams, ResetMemberPasswordParams, GetDataTableParams, GetDataRecordsParams, CreateDataRecordParams, GetDataRecordParams, UpdateDataRecordParams, DeleteDataRecordParams, QueryDataRecordsParams } from '../types/params.js';
 import { DeleteMemberPayload, GetPostsPayload, GetThreadsPayload, CreatePostPayload, UpdatePostPayload, CreateThreadPayload, UpdateThreadPayload, GetSecureContentPayload, ConnectProviderPayload, GetAppAndMemberPayload, AppPayload, LoginMemberEmailPasswordPayload, SendMemberLoginPasswordlessEmailPayload, GetPlanPayload, GetPlansPayload, GetRestrictedUrlGroupsPayload, GetCurrentMemberPayload, GetMemberJSONPayload, AddPlanPayload, PurchasePlansWithCheckoutPayload, LaunchStripeCustomerPortalPayload, RemovePlanPayload, UpdateMemberPayload, UpdateMemberAuthPayload, SetPasswordPayload, SignupMemberEmailPasswordPayload, UpdateMemberProfileImagePayload, SendMemberVerificationEmailPayload, SendMemberResetPasswordEmailPayload, ResetMemberPassworPayload, LogoutMemberPayload, GetDataTablesPayload, GetDataTablePayload, GetDataRecordsPayload, CreateDataRecordPayload, GetDataRecordPayload, UpdateDataRecordPayload, DeleteDataRecordPayload, QueryDataRecordsPayload } from '../types/payloads.js';
 import { MemberstackTranslations } from '../types/translations.js';
 import '../types/utils/payloads.js';
 
+/**
+ * Configuration options for initializing the Memberstack SDK.
+ */
 type DOMConfig = {
+    /**
+     * Your Memberstack public API key.
+     * - Sandbox keys start with `pk_sb_` (use for development/testing)
+     * - Live keys start with `pk_` (use for production)
+     * @example "pk_sb_abc123def456"
+     */
     publicKey: string;
+    /**
+     * Optional app ID for multi-app configurations.
+     * Only needed if you have multiple Memberstack apps.
+     */
     appId?: string;
+    /**
+     * Enable cookie-based session storage.
+     * Recommended when you need sessions to persist across subdomains.
+     * @default false
+     */
     useCookies?: boolean;
+    /**
+     * When `useCookies` is true, set cookies on the root domain.
+     * This allows session sharing across subdomains (e.g., app.example.com and www.example.com).
+     * @default false
+     */
     setCookieOnRootDomain?: boolean;
+    /**
+     * Custom API domain for enterprise or self-hosted deployments.
+     * Most users don't need to set this.
+     */
     domain?: string;
+    /**
+     * Enable debug mode for verbose console logging.
+     * Useful during development to see API calls, auth state changes, and errors.
+     * Also exposes `window.__MEMBERSTACK_DEBUG__` for DevTools inspection.
+     * @default false
+     *
+     * @example
+     * ```typescript
+     * const memberstack = MemberstackDOM.init({
+     *   publicKey: 'pk_sb_...',
+     *   debug: true // Enable in development
+     * });
+     * ```
+     */
+    debug?: boolean;
+    /**
+     * @deprecated This option is no longer used. Session duration is controlled server-side.
+     * @internal
+     */
     sessionDurationDays?: number;
 };
 declare const _default: {
     init: (props: DOMConfig) => {
         openModal: (type: "LOGIN" | "SIGNUP" | "FORGOT_PASSWORD" | "RESET_PASSWORD" | "PROFILE", params?: {
-            [key: string]: any;
+            [key: string]: unknown;
             translations?: MemberstackTranslations;
         }) => Promise<unknown>;
         hideModal: () => void;
-        _hideLoader: (element?: any) => void;
-        _showLoader: (element?: any) => void;
-        _showMessage: (msg: any, isError: any) => Promise<void>;
+        preloadModals: () => Promise<void>;
+        _hideLoader: (element?: HTMLElement) => void;
+        _showLoader: (element?: HTMLElement) => void;
+        _showMessage: (msg: string, isError?: boolean) => Promise<void>;
         getMemberCookie: () => any;
-        onAuthChange: (cb: any) => {
+        onAuthChange: (cb: (member: {
+            id: string;
+            verified: boolean;
+            profileImage: string;
+            auth: {
+                email: string;
+                hasPassword: boolean;
+                providers: {
+                    provider: string;
+                }[];
+            };
+            loginRedirect: string;
+            stripeCustomerId: string;
+            createdAt: string;
+            metaData: object;
+            customFields: object;
+            permissions: [] | string[];
+            planConnections: {
+                id: string;
+                active: boolean;
+                status: string;
+                planId: string;
+                type: string;
+                payment: {
+                    amount: number;
+                    currency: string;
+                    status: string;
+                    lastBillingDate: number;
+                    nextBillingDate: number;
+                    cancelAtDate: number;
+                    priceId: string;
+                };
+            }[];
+        }) => void) => {
             unsubscribe: () => boolean;
         };
         _captchaReady: Promise<unknown>;
@@ -35,34 +115,36 @@ declare const _default: {
         postIsTyping(params: {
             channelKey: string;
         }): Promise<void>;
-        getChannelInfo(params?: {
+        getChannelInfo(params: {
             channelKey: string;
         }): Promise<any>;
-        subscribeToChannel(params?: {
+        subscribeToChannel(params: {
             channelKey: string;
             action: "NONE" | "THREADS_ONLY";
         }): Promise<void>;
-        getPosts(params?: GetPostsParams): Promise<GetPostsPayload>;
-        getThreads(params?: GetThreadsParams): Promise<GetThreadsPayload>;
-        createPost(params?: CreatePostParams): Promise<CreatePostPayload>;
-        updatePost(params?: UpdatePostParams): Promise<UpdatePostPayload>;
-        postVote(params?: PostVoteParams): Promise<void>;
-        deletePost(params?: DeletePostParams): Promise<void>;
-        createThread(params?: CreateThreadParams): Promise<CreateThreadPayload>;
-        updateThread(params?: UpdateThreadParams): Promise<UpdateThreadPayload>;
-        threadVote(params?: ThreadVoteParams): Promise<void>;
-        deleteThread(params?: DeleteThreadParams): Promise<void>;
-        getSecureContent(params?: GetSecureContentParams): Promise<GetSecureContentPayload>;
-        signupWithProvider(params?: SignupWithProviderParams): Promise<unknown>;
-        loginWithProvider(params?: LoginWithProviderParams): Promise<unknown>;
-        connectProvider(params?: LoginWithProviderParams): Promise<ConnectProviderPayload>;
+        getPosts(params: GetPostsParams): Promise<GetPostsPayload>;
+        getThreads(params: GetThreadsParams): Promise<GetThreadsPayload>;
+        createPost(params: CreatePostParams): Promise<CreatePostPayload>;
+        updatePost(params: UpdatePostParams): Promise<UpdatePostPayload>;
+        postVote(params: PostVoteParams): Promise<void>;
+        deletePost(params: DeletePostParams): Promise<void>;
+        createThread(params: CreateThreadParams): Promise<CreateThreadPayload>;
+        updateThread(params: UpdateThreadParams): Promise<UpdateThreadPayload>;
+        threadVote(params: ThreadVoteParams): Promise<void>;
+        deleteThread(params: DeleteThreadParams): Promise<void>;
+        getSecureContent(params: GetSecureContentParams): Promise<GetSecureContentPayload>;
+        signupWithProvider(params: SignupWithProviderParams): Promise<unknown>;
+        loginWithProvider(params: LoginWithProviderParams): Promise<unknown>;
+        connectProvider(params: LoginWithProviderParams): Promise<ConnectProviderPayload>;
         disconnectProvider(params: LoginWithProviderParams): Promise<ConnectProviderPayload>;
-        getAppAndMember(params?: any): Promise<GetAppAndMemberPayload>;
+        getAppAndMember(params?: {
+            trackPageView?: boolean;
+        }): Promise<GetAppAndMemberPayload>;
         getApp(): Promise<AppPayload>;
-        loginMemberEmailPassword(params: LoginMemberEmailPasswordParams, options?: any): Promise<LoginMemberEmailPasswordPayload>;
-        sendMemberLoginPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: any): Promise<SendMemberLoginPasswordlessEmailPayload>;
-        sendMemberSignupPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: any): Promise<SendMemberLoginPasswordlessEmailPayload>;
-        loginMemberPasswordless(params: LoginMemberPasswordlessParams, options?: any): Promise<LoginMemberEmailPasswordPayload>;
+        loginMemberEmailPassword(params: LoginMemberEmailPasswordParams, options?: MemberstackOptions): Promise<LoginMemberEmailPasswordPayload>;
+        sendMemberLoginPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: MemberstackOptions): Promise<SendMemberLoginPasswordlessEmailPayload>;
+        sendMemberSignupPasswordlessEmail(params: SendMemberLoginPasswordlessEmailParams, options?: MemberstackOptions): Promise<SendMemberLoginPasswordlessEmailPayload>;
+        loginMemberPasswordless(params: LoginMemberPasswordlessParams, options?: MemberstackOptions): Promise<LoginMemberEmailPasswordPayload>;
         getPlan(params: GetPlanParams): Promise<GetPlanPayload>;
         getPlans(): Promise<GetPlansPayload>;
         getRestrictedUrlGroups(): Promise<GetRestrictedUrlGroupsPayload>;
@@ -78,8 +160,8 @@ declare const _default: {
         setPassword(params: SetPasswordParams, options?: MemberstackOptions): Promise<SetPasswordPayload>;
         signupMemberPasswordless(params: Omit<SignupMemberEmailPasswordParams, "password"> & {
             passwordlessToken: string;
-        }, options?: any): Promise<SignupMemberEmailPasswordPayload>;
-        signupMemberEmailPassword(params: SignupMemberEmailPasswordParams, options?: any): Promise<SignupMemberEmailPasswordPayload>;
+        }, options?: MemberstackOptions): Promise<SignupMemberEmailPasswordPayload>;
+        signupMemberEmailPassword(params: SignupMemberEmailPasswordParams, options?: MemberstackOptions): Promise<SignupMemberEmailPasswordPayload>;
         joinTeam(params: JoinTeamParams, options?: MemberstackOptions): Promise<void>;
         getTeam(params: GetTeamParams, options?: MemberstackOptions): Promise<void>;
         removeMemberFromTeam(params: RemoveMemberFromTeamParams, options?: MemberstackOptions): Promise<void>;