@memberstack/dom 2.0.0 → 2.0.2-beta.0

package/lib/models-CTRKogoR.d.ts

@@ -0,0 +1,487 @@
+declare namespace Payload {
+    interface PaginatedResponse<T> {
+        hasNext: boolean;
+        endCursor: string | null;
+        totalCount: number;
+        data: T[];
+    }
+    interface Transforms {
+        Pagination: {
+            hasNext: boolean;
+            endCursor: string | null;
+            totalCount: number;
+        };
+        RemovePlan: {
+            member: Transforms["Member"];
+        };
+        SendMemberVerificationEmail: {
+            success: boolean;
+        };
+        ResetMemberPassword: {
+            success: boolean;
+        };
+        GetAppAndMember: {
+            app: Transforms["App"];
+            member: Transforms["Member"] | null;
+        };
+        SecureContent: {
+            content: string;
+            type: "HTML" | "CSS" | "LINK" | "JS" | "JSON" | "TEXT" | "IMAGE" | "FILE";
+        };
+        Post: {
+            id: string;
+            internalOrder: string;
+            createdAt: string;
+            content: string;
+            member: {
+                id: string;
+                customFields: object;
+                profileImage: string;
+            };
+            _count: {
+                Threads: number;
+                likedBy: number;
+                dislikedBy: number;
+            };
+        };
+        DeletedMember: {
+            id: string;
+        };
+        Posts: {
+            posts: Transforms["Post"][];
+            totalCount: number;
+        };
+        Thread: {
+            id: string;
+            internalOrder: string;
+            createdAt: string;
+            content: string;
+            member: {
+                id: string;
+                customFields: object;
+                profileImage: string;
+            };
+            _count: {
+                Threads: number;
+                likedBy: number;
+            };
+        };
+        Threads: {
+            threads: Transforms["Thread"][];
+        };
+        App: {
+            id: string;
+            name: string;
+            mode: "live" | "sandbox";
+            plans: Transforms["Plan"][];
+            contentGroups: Transforms["RestrictedUrlGroup"][];
+            emailVerificationEnabled: boolean;
+            requireEmailVerification: boolean;
+            customField: Transforms["CustomField"][];
+            branding: Transforms["Branding"];
+            authProviders: Transforms["AuthProvider"][];
+        };
+        Branding: {
+            logo: string;
+            colors: {
+                lightMode: {
+                    primaryButton: string;
+                };
+            };
+        };
+        RestrictedUrlGroup: {
+            id: string;
+            name: string;
+            key: string;
+            allowAllMembers: boolean;
+            activeMemberHasAccess?: boolean;
+            redirect: string;
+            urls: {
+                url: string;
+                filter: string;
+            }[];
+            plans: {
+                id: string;
+            }[];
+        };
+        MemberAuth: {
+            tokens: {
+                accessToken: string;
+                expires: number;
+                type: "bearer";
+            };
+            member: Transforms["Member"];
+            redirect: string;
+            contentGroups?: Transforms["RestrictedUrlGroup"][];
+        };
+        MemberJSON: object;
+        AuthProviders: {
+            providers: {
+                provider: string;
+            }[];
+            message?: string;
+        };
+        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: Transforms["MemberPlanConnection"][];
+        };
+        MemberReceipt: {
+            id: string;
+            amount: number;
+            url: string;
+            stripe?: {
+                url: string;
+            };
+            number: string;
+            purchase: string;
+            invoice: string;
+            createdAt: string;
+            currency: string;
+        };
+        MemberInvoices: PaginatedResponse<{
+            id: string;
+            status: string;
+            amount: number;
+            url: string;
+            description: string;
+            number: string;
+            purchase: string;
+        }>;
+        MemberReceipts: PaginatedResponse<{
+            id: string;
+            amount: string;
+            url: string;
+            number: string;
+            planConnection: string;
+            invoice: Transforms["MemberInvoice"];
+        }>;
+        MemberCard: {
+            id: string;
+            brand: string;
+            expMonth: string;
+            expYear: string;
+            last4: string;
+            default: boolean;
+        };
+        MemberInvoice: {
+            id: string;
+            status: string;
+            amount: number;
+            url: string;
+            description: string;
+            number: string;
+            planConnection: string;
+            createdAt: string;
+            currency: string;
+        };
+        Plan: {
+            id: string;
+            name: string;
+            description: string;
+            status: string;
+            redirects: {
+                afterLogin: string;
+                afterLogout: string;
+                afterSignup: string;
+            };
+            prices?: Transforms["Price"][] | [];
+        };
+        Price: {
+            id: string;
+            amount: string;
+            interval: {
+                type: string;
+                count: number;
+            };
+            name: string;
+            type: string;
+            status: string;
+            currency: string;
+        };
+        Permission: {
+            id: string;
+            name: string;
+            description: string;
+        };
+        PermissionGroup: {
+            id: string;
+            name: string;
+            permissions: Transforms["Permission"][];
+        };
+        CustomField: {
+            order: number;
+            key: string;
+            label: string;
+            hidden: boolean;
+        };
+        MemberPlanConnection: {
+            id: string;
+            active: boolean;
+            status: string;
+            planId: string;
+            type: string;
+            payment: {
+                amount: number;
+                currency: string;
+                status: string;
+                lastBillingDate: number | null;
+                nextBillingDate: number | null;
+                cancelAtDate: number | null;
+                priceId: string;
+            } | null;
+        };
+        Purchase: {
+            plan: string;
+            payment: {
+                requiresPayment: boolean;
+                requiresAuthentication: boolean;
+            };
+        };
+        AddPlan: {
+            redirect: string;
+            member: Transforms["Member"];
+        };
+        PurchaseWithCheckout: {
+            url: string;
+        };
+        LaunchStripeCustomerPortal: {
+            url: string;
+        };
+        OpenStripeCustomerPortal: {
+            url: string;
+        };
+        AuthenticationClientSecret: string;
+        AuthProvider: {
+            clientId: string;
+            provider: string;
+            providerType: string;
+            icon: string;
+        };
+        TotalCheckoutAmount: {
+            total: number;
+            subTotal: number;
+            currency: string;
+            setupFee?: {
+                enabled: boolean;
+                amount: number;
+                name: string;
+            };
+            freeTrial?: {
+                days: number;
+                enabled: boolean;
+            };
+            tax?: {
+                name: string;
+                percent: number;
+                description: string;
+            }[];
+        };
+    }
+}
+
+/**
+ * @fileoverview Convenience type exports for Memberstack SDK.
+ * These types provide direct access to core data models without needing
+ * to navigate the Payload.Transforms namespace.
+ *
+ * @example
+ * ```typescript
+ * import type { Member, Plan, PlanConnection } from '@memberstack/dom';
+ *
+ * function displayMember(member: Member) {
+ *   console.log(member.auth.email);
+ * }
+ * ```
+ */
+
+/**
+ * A Memberstack member (authenticated user).
+ *
+ * @example
+ * ```typescript
+ * const { data: member } = await memberstack.getCurrentMember();
+ * if (member) {
+ *   console.log('Email:', member.auth.email);
+ *   console.log('Verified:', member.verified);
+ *   console.log('Plans:', member.planConnections.map(p => p.planId));
+ * }
+ * ```
+ */
+type Member = Payload.Transforms["Member"];
+/**
+ * A membership plan in your Memberstack app.
+ *
+ * @example
+ * ```typescript
+ * const { data: plans } = await memberstack.getPlans();
+ * plans.forEach((plan: Plan) => {
+ *   console.log(`${plan.name}: ${plan.prices?.[0]?.amount}`);
+ * });
+ * ```
+ */
+type Plan = Payload.Transforms["Plan"];
+/**
+ * A price option for a plan (monthly, yearly, etc.).
+ *
+ * @example
+ * ```typescript
+ * const plan = plans[0];
+ * plan.prices?.forEach((price: Price) => {
+ *   console.log(`${price.name}: ${price.amount} ${price.currency}/${price.interval.type}`);
+ * });
+ * ```
+ */
+type Price = Payload.Transforms["Price"];
+/**
+ * A member's connection to a plan (subscription or one-time purchase).
+ *
+ * @example
+ * ```typescript
+ * const activePlans = member.planConnections.filter(
+ *   (conn: PlanConnection) => conn.active
+ * );
+ * ```
+ */
+type PlanConnection = Payload.Transforms["MemberPlanConnection"];
+/**
+ * A content group that restricts access to URLs.
+ *
+ * @example
+ * ```typescript
+ * const { data: groups } = await memberstack.getRestrictedUrlGroups();
+ * const accessibleGroups = groups.filter(
+ *   (g: ContentGroup) => g.activeMemberHasAccess
+ * );
+ * ```
+ */
+type ContentGroup = Payload.Transforms["RestrictedUrlGroup"];
+/**
+ * App configuration and settings.
+ *
+ * @example
+ * ```typescript
+ * const { data: app } = await memberstack.getApp();
+ * console.log('App:', app.name);
+ * console.log('Mode:', app.mode); // 'live' or 'sandbox'
+ * ```
+ */
+type App = Payload.Transforms["App"];
+/**
+ * Authentication provider configuration (Google, Facebook, etc.).
+ */
+type AuthProvider = Payload.Transforms["AuthProvider"];
+/**
+ * Authentication response with tokens and member data.
+ */
+type MemberAuth = Payload.Transforms["MemberAuth"];
+/**
+ * Auth tokens returned after login/signup.
+ */
+type AuthTokens = MemberAuth["tokens"];
+/**
+ * A saved payment card for a member.
+ *
+ * @example
+ * ```typescript
+ * const { data: cards } = await memberstack.getMemberCards();
+ * const defaultCard = cards.find((card: MemberCard) => card.default);
+ * ```
+ */
+type MemberCard = Payload.Transforms["MemberCard"];
+/**
+ * An invoice for a member's subscription.
+ */
+type MemberInvoice = Payload.Transforms["MemberInvoice"];
+/**
+ * A payment receipt.
+ */
+type MemberReceipt = Payload.Transforms["MemberReceipt"];
+/**
+ * Checkout total calculation including taxes and fees.
+ */
+type CheckoutTotal = Payload.Transforms["TotalCheckoutAmount"];
+/**
+ * Gated content returned by getSecureContent().
+ */
+type SecureContent = Payload.Transforms["SecureContent"];
+/**
+ * A custom field defined in your Memberstack app.
+ */
+type CustomField = Payload.Transforms["CustomField"];
+/**
+ * App branding configuration.
+ */
+type Branding = Payload.Transforms["Branding"];
+/**
+ * A community post.
+ */
+type Post = Payload.Transforms["Post"];
+/**
+ * A thread/reply on a post.
+ */
+type Thread = Payload.Transforms["Thread"];
+/**
+ * Extract the data type from a Memberstack SDK response.
+ *
+ * @example
+ * ```typescript
+ * import type { ExtractData, GetCurrentMemberPayload } from '@memberstack/dom';
+ *
+ * // Get the member type from the response
+ * type MemberData = ExtractData<GetCurrentMemberPayload>;
+ * // MemberData = Member | null
+ * ```
+ */
+type ExtractData<T> = T extends {
+    data: infer D;
+} ? D : never;
+/**
+ * Generic paginated response shape.
+ *
+ * @example
+ * ```typescript
+ * type InvoicesPage = PaginatedData<MemberInvoice>;
+ * // { data: MemberInvoice[], hasNext: boolean, endCursor: string | null, totalCount: number }
+ * ```
+ */
+type PaginatedData<T> = {
+    data: T[];
+    hasNext: boolean;
+    endCursor: string | null;
+    totalCount: number;
+};
+/**
+ * Common member fields for display purposes.
+ *
+ * @example
+ * ```typescript
+ * function getMemberDisplayInfo(member: Member): MemberDisplayInfo {
+ *   return {
+ *     id: member.id,
+ *     email: member.auth.email,
+ *     profileImage: member.profileImage,
+ *     verified: member.verified,
+ *   };
+ * }
+ * ```
+ */
+type MemberDisplayInfo = Pick<Member, 'id' | 'profileImage' | 'verified'> & {
+    email: string;
+};
+
+export { type App as A, type Branding as B, type ContentGroup as C, type ExtractData as E, type Member as M, Payload as P, type SecureContent as S, type Thread as T, type Plan as a, type Price as b, type PlanConnection as c, type AuthProvider as d, type MemberAuth as e, type AuthTokens as f, type MemberCard as g, type MemberInvoice as h, type MemberReceipt as i, type CheckoutTotal as j, type CustomField as k, type Post as l, type PaginatedData as m, type MemberDisplayInfo as n };

package/lib/models-le7xaT4H.d.ts

@@ -0,0 +1,193 @@
+import { Payload } from './types/utils/payloads.mjs';
+
+/**
+ * @fileoverview Convenience type exports for Memberstack SDK.
+ * These types provide direct access to core data models without needing
+ * to navigate the Payload.Transforms namespace.
+ *
+ * @example
+ * ```typescript
+ * import type { Member, Plan, PlanConnection } from '@memberstack/dom';
+ *
+ * function displayMember(member: Member) {
+ *   console.log(member.auth.email);
+ * }
+ * ```
+ */
+
+/**
+ * A Memberstack member (authenticated user).
+ *
+ * @example
+ * ```typescript
+ * const { data: member } = await memberstack.getCurrentMember();
+ * if (member) {
+ *   console.log('Email:', member.auth.email);
+ *   console.log('Verified:', member.verified);
+ *   console.log('Plans:', member.planConnections.map(p => p.planId));
+ * }
+ * ```
+ */
+type Member = Payload.Transforms["Member"];
+/**
+ * A membership plan in your Memberstack app.
+ *
+ * @example
+ * ```typescript
+ * const { data: plans } = await memberstack.getPlans();
+ * plans.forEach((plan: Plan) => {
+ *   console.log(`${plan.name}: ${plan.prices?.[0]?.amount}`);
+ * });
+ * ```
+ */
+type Plan = Payload.Transforms["Plan"];
+/**
+ * A price option for a plan (monthly, yearly, etc.).
+ *
+ * @example
+ * ```typescript
+ * const plan = plans[0];
+ * plan.prices?.forEach((price: Price) => {
+ *   console.log(`${price.name}: ${price.amount} ${price.currency}/${price.interval.type}`);
+ * });
+ * ```
+ */
+type Price = Payload.Transforms["Price"];
+/**
+ * A member's connection to a plan (subscription or one-time purchase).
+ *
+ * @example
+ * ```typescript
+ * const activePlans = member.planConnections.filter(
+ *   (conn: PlanConnection) => conn.active
+ * );
+ * ```
+ */
+type PlanConnection = Payload.Transforms["MemberPlanConnection"];
+/**
+ * A content group that restricts access to URLs.
+ *
+ * @example
+ * ```typescript
+ * const { data: groups } = await memberstack.getRestrictedUrlGroups();
+ * const accessibleGroups = groups.filter(
+ *   (g: ContentGroup) => g.activeMemberHasAccess
+ * );
+ * ```
+ */
+type ContentGroup = Payload.Transforms["RestrictedUrlGroup"];
+/**
+ * App configuration and settings.
+ *
+ * @example
+ * ```typescript
+ * const { data: app } = await memberstack.getApp();
+ * console.log('App:', app.name);
+ * console.log('Mode:', app.mode); // 'live' or 'sandbox'
+ * ```
+ */
+type App = Payload.Transforms["App"];
+/**
+ * Authentication provider configuration (Google, Facebook, etc.).
+ */
+type AuthProvider = Payload.Transforms["AuthProvider"];
+/**
+ * Authentication response with tokens and member data.
+ */
+type MemberAuth = Payload.Transforms["MemberAuth"];
+/**
+ * Auth tokens returned after login/signup.
+ */
+type AuthTokens = MemberAuth["tokens"];
+/**
+ * A saved payment card for a member.
+ *
+ * @example
+ * ```typescript
+ * const { data: cards } = await memberstack.getMemberCards();
+ * const defaultCard = cards.find((card: MemberCard) => card.default);
+ * ```
+ */
+type MemberCard = Payload.Transforms["MemberCard"];
+/**
+ * An invoice for a member's subscription.
+ */
+type MemberInvoice = Payload.Transforms["MemberInvoice"];
+/**
+ * A payment receipt.
+ */
+type MemberReceipt = Payload.Transforms["MemberReceipt"];
+/**
+ * Checkout total calculation including taxes and fees.
+ */
+type CheckoutTotal = Payload.Transforms["TotalCheckoutAmount"];
+/**
+ * Gated content returned by getSecureContent().
+ */
+type SecureContent = Payload.Transforms["SecureContent"];
+/**
+ * A custom field defined in your Memberstack app.
+ */
+type CustomField = Payload.Transforms["CustomField"];
+/**
+ * App branding configuration.
+ */
+type Branding = Payload.Transforms["Branding"];
+/**
+ * A community post.
+ */
+type Post = Payload.Transforms["Post"];
+/**
+ * A thread/reply on a post.
+ */
+type Thread = Payload.Transforms["Thread"];
+/**
+ * Extract the data type from a Memberstack SDK response.
+ *
+ * @example
+ * ```typescript
+ * import type { ExtractData, GetCurrentMemberPayload } from '@memberstack/dom';
+ *
+ * // Get the member type from the response
+ * type MemberData = ExtractData<GetCurrentMemberPayload>;
+ * // MemberData = Member | null
+ * ```
+ */
+type ExtractData<T> = T extends {
+    data: infer D;
+} ? D : never;
+/**
+ * Generic paginated response shape.
+ *
+ * @example
+ * ```typescript
+ * type InvoicesPage = PaginatedData<MemberInvoice>;
+ * // { data: MemberInvoice[], hasNext: boolean, endCursor: string | null, totalCount: number }
+ * ```
+ */
+type PaginatedData<T> = {
+    data: T[];
+    hasNext: boolean;
+    endCursor: string | null;
+    totalCount: number;
+};
+/**
+ * Common member fields for display purposes.
+ *
+ * @example
+ * ```typescript
+ * function getMemberDisplayInfo(member: Member): MemberDisplayInfo {
+ *   return {
+ *     id: member.id,
+ *     email: member.auth.email,
+ *     profileImage: member.profileImage,
+ *     verified: member.verified,
+ *   };
+ * }
+ * ```
+ */
+type MemberDisplayInfo = Pick<Member, 'id' | 'profileImage' | 'verified'> & {
+    email: string;
+};
+
+export type { App as A, Branding as B, ContentGroup as C, ExtractData as E, Member as M, Plan as P, SecureContent as S, Thread as T, Price as a, PlanConnection as b, AuthProvider as c, MemberAuth as d, AuthTokens as e, MemberCard as f, MemberInvoice as g, MemberReceipt as h, CheckoutTotal as i, CustomField as j, Post as k, PaginatedData as l, MemberDisplayInfo as m };