@memberstack/dom 2.0.0 → 2.0.2-beta.0

package/lib/types/params.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/lib/types/payloads.d.mts

@@ -1,105 +1,266 @@
 import { Payload } from './utils/payloads.mjs';
 
+/**
+ * @fileoverview Response payload types for Memberstack SDK methods.
+ * All SDK methods return Promise<PayloadType> where PayloadType wraps the data.
+ */
+
+/** Response from getApp() - contains app configuration */
 type AppPayload = Response<Payload.Transforms["App"]>;
+/** Response from deleteMember() - contains deletion confirmation */
 type DeleteMemberPayload = Response<Payload.Transforms["DeletedMember"]>;
+/** Response from getAppAndMember() - contains both app and member data */
 type GetAppAndMemberPayload = Response<Payload.Transforms["GetAppAndMember"]>;
+/** Response from addMemberCard() - contains updated member data */
 type AddMemberCardPayload = Response<Payload.Transforms["Member"]>;
+/** Response from cancelPlan() - contains updated member data */
 type CancelPlanPayload = Response<Payload.Transforms["Member"]>;
+/** Response from removePlan() - contains removal confirmation */
 type RemovePlanPayload = Response<Payload.Transforms["RemovePlan"]>;
-type GetCurrentMemberPayload = Response<Payload.Transforms["Member"]>;
+/**
+ * Response from getCurrentMember() - contains member data or null if not logged in.
+ *
+ * @example
+ * ```typescript
+ * const { data: member } = await memberstack.getCurrentMember();
+ * if (member) {
+ *   console.log('Logged in:', member.auth.email);
+ * }
+ * ```
+ */
+type GetCurrentMemberPayload = Response<Payload.Transforms["Member"] | null>;
+/** Response from getMemberJSON() - contains member's JSON store */
 type GetMemberJSONPayload = Response<Payload.Transforms["MemberJSON"]>;
+/** Response from getMemberCards() - contains array of saved payment cards */
 type GetMemberCardsPayload = Response<Payload.Transforms["MemberCard"][]>;
+/** Response from connectProvider()/disconnectProvider() - contains updated auth providers */
 type ConnectProviderPayload = Response<Payload.Transforms["AuthProviders"]>;
+/** Response from getMemberInvoices() - paginated list of invoices */
 type GetMemberInvoicesPayload = PaginatedResponse<Payload.Transforms["MemberInvoice"]>;
+/** Response from getMemberReceipts() - paginated list of receipts */
 type GetMemberReceiptsPayload = PaginatedResponse<Payload.Transforms["MemberReceipt"]>;
+/** Response from updateMemberProfileImage() - contains new profile image URL */
 type UpdateMemberProfileImagePayload = Response<{
     profileImage: string;
 }>;
+/** Response from getSecureContent() - contains the gated content HTML */
 type GetSecureContentPayload = Response<Payload.Transforms["SecureContent"]>;
+/** Response from setPassword() - contains updated member data */
 type SetPasswordPayload = Response<Payload.Transforms["Member"]>;
+/** Response from getRestrictedUrlGroups() - array of content access groups */
 type GetRestrictedUrlGroupsPayload = Response<Payload.Transforms["RestrictedUrlGroup"][]>;
+/** Response from getPlans() - array of available plans */
 type GetPlansPayload = Response<Payload.Transforms["Plan"][]>;
+/** Response from getPlan() - single plan details */
 type GetPlanPayload = Response<Payload.Transforms["Plan"]>;
+/**
+ * Response from loginMemberEmailPassword() - contains member and tokens.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.loginMemberEmailPassword({
+ *   email: 'user@example.com',
+ *   password: 'password123'
+ * });
+ * console.log('Logged in:', data.member.auth.email);
+ * ```
+ */
 type LoginMemberEmailPasswordPayload = Response<Payload.Transforms["MemberAuth"]>;
+/** Response from sendMemberLoginPasswordlessEmail() - success indicator */
 type SendMemberLoginPasswordlessEmailPayload = Response<{
     success: boolean;
 }>;
+/** Response from logout() - optional redirect URL */
 type LogoutMemberPayload = Response<{
     redirect?: string;
 }>;
+/** Response from purchasePlans() - contains purchase details */
 type PurchasePlansPayload = Response<Payload.Transforms["Purchase"]>;
+/** Response from addPlan() - contains updated plan connections */
 type AddPlanPayload = Response<Payload.Transforms["AddPlan"]>;
+/** Response from purchasePlansWithCheckout() - contains Stripe checkout URL */
 type PurchasePlansWithCheckoutPayload = Response<Payload.Transforms["PurchaseWithCheckout"]>;
+/** Response from launchStripeCustomerPortal() - contains portal URL */
 type LaunchStripeCustomerPortalPayload = Response<Payload.Transforms["LaunchStripeCustomerPortal"]>;
+/** Response from openStripeCustomerPortal() - contains portal URL */
 type OpenStripeCustomerPortalPayload = Response<Payload.Transforms["OpenStripeCustomerPortal"]>;
+/**
+ * Response from signupMemberEmailPassword() - contains new member and tokens.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.signupMemberEmailPassword({
+ *   email: 'newuser@example.com',
+ *   password: 'password123'
+ * });
+ * console.log('Signed up:', data.member.id);
+ * ```
+ */
 type SignupMemberEmailPasswordPayload = Response<Payload.Transforms["MemberAuth"]>;
+/** Response from signupMemberAuthProvider() - contains member and tokens */
 type SignupMemberAuthProviderPayload = Response<Payload.Transforms["MemberAuth"]>;
+/** Response from updateDefaultCard() - contains updated member data */
 type UpdateDefaultCardPayload = Response<Payload.Transforms["Member"]>;
+/** Response from updateMemberAuth() - contains updated member data */
 type UpdateMemberAuthPayload = Response<Payload.Transforms["Member"]>;
+/** Response from updateMember() - contains updated member data */
 type UpdateMemberPayload = Response<Payload.Transforms["Member"]>;
+/** Response from updatePlanPayment() - contains updated member data */
 type UpdatePlanPaymentPayload = Response<Payload.Transforms["Member"]>;
+/** Response from refreshMemberTokens() - contains new access tokens */
 type RefreshMemberTokensPayload = Response<Payload.Transforms["MemberAuth"]["tokens"]>;
+/** Response from sendMemberResetPasswordEmail() - success message */
 type SendMemberResetPasswordEmailPayload = Response<string>;
+/** Response from replacePlan() - contains purchase/upgrade details */
 type ReplacePlanPayload = Response<Payload.Transforms["Purchase"]>;
+/** Response from getAuthProviders() - array of configured OAuth providers */
 type GetAuthProvidersPayload = Response<Payload.Transforms["AuthProvider"][]>;
+/** Response from getTotalCheckoutAmount() - calculated checkout total */
 type GetTotalCheckoutAmountPayload = Response<Payload.Transforms["TotalCheckoutAmount"]>;
+/** Response from getAuthenticationClientSecret() - Stripe client secret for SCA */
 type GetAuthenticationClientSecretPayload = Response<Payload.Transforms["AuthenticationClientSecret"]>;
+/** Response from sendMemberVerificationEmail() - success indicator */
 type SendMemberVerificationEmailPayload = Response<Payload.Transforms["SendMemberVerificationEmail"]>;
+/** Response from resetMemberPassword() - success indicator */
 type ResetMemberPassworPayload = Response<Payload.Transforms["ResetMemberPassword"]>;
+/** Response from getPosts() - contains posts array */
 type GetPostsPayload = Response<Payload.Transforms["Posts"]>;
+/** Response from getThreads() - contains threads array */
 type GetThreadsPayload = Response<Payload.Transforms["Threads"]>;
+/** Response from createPost() - contains created post */
 type CreatePostPayload = Response<Payload.Transforms["Post"]>;
+/** Response from createThread() - contains created thread */
 type CreateThreadPayload = Response<Payload.Transforms["Thread"]>;
+/** Response from updatePost() - contains updated post */
 type UpdatePostPayload = Response<Payload.Transforms["Post"]>;
+/** Response from updateThread() - contains updated thread */
 type UpdateThreadPayload = Response<Payload.Transforms["Thread"]>;
+/**
+ * Response from getDataTables() - list of all data tables.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.getDataTables();
+ * data.tables.forEach(table => console.log(table.name, table.key));
+ * ```
+ */
 type GetDataTablesPayload = Response<{
     tables: DataTableResponse[];
 }>;
+/**
+ * Response from getDataTable() - single table schema.
+ *
+ * @example
+ * ```typescript
+ * const { data: table } = await memberstack.getDataTable({ table: 'posts' });
+ * console.log('Fields:', table.fields.map(f => f.name));
+ * ```
+ */
 type GetDataTablePayload = Response<DataTableResponse>;
+/**
+ * Response from getDataRecords() - paginated records list.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.getDataRecords({ table: 'posts', limit: 10 });
+ * console.log('Records:', data.records.length);
+ * console.log('Has more:', data.pagination.hasMore);
+ * ```
+ */
 type GetDataRecordsPayload = Response<{
+    /** Array of data records */
     records: DataRecordResponse[];
+    /** Pagination information */
     pagination: {
+        /** Number of records returned */
         limit: number;
+        /** Cursor for next page (null if no more) */
         endCursor: number | null;
+        /** Whether more records exist */
         hasMore: boolean;
     };
 }>;
+/** Response from createDataRecord() - the created record */
 type CreateDataRecordPayload = Response<DataRecordResponse>;
+/** Response from getDataRecord() - single record data */
 type GetDataRecordPayload = Response<DataRecordResponse>;
+/** Response from updateDataRecord() - the updated record */
 type UpdateDataRecordPayload = Response<DataRecordResponse>;
+/** Response from deleteDataRecord() - deleted record ID */
 type DeleteDataRecordPayload = Response<{
     id: string;
 }>;
+/**
+ * Response from queryDataRecords() - advanced query results.
+ * Can return either records with pagination or a count result.
+ *
+ * @example Records response
+ * ```typescript
+ * const { data } = await memberstack.queryDataRecords({
+ *   table: 'posts',
+ *   query: { where: { published: { equals: true } }, take: 10 }
+ * });
+ * if ('records' in data) {
+ *   console.log('Found:', data.records.length);
+ * }
+ * ```
+ */
 type QueryDataRecordsPayload = Response<{
+    /** Array of matching records */
     records: QueryDataRecordResponse[];
+    /** Pagination info (if applicable) */
     pagination?: {
         limit: number;
         hasMore: boolean;
         endCursor: number;
     };
 }> | Response<{
+    /** Count result when using _count query */
     _count: number;
 }>;
+/**
+ * Data table schema and configuration.
+ */
 type DataTableResponse = {
+    /** Unique table ID */
     id: string;
+    /** Table key/slug for API calls */
     key: string;
+    /** Display name */
     name: string;
+    /** Create permission rule */
     createRule: string;
+    /** Read permission rule */
     readRule: string;
+    /** Update permission rule */
     updateRule: string;
+    /** Delete permission rule */
     deleteRule: string;
+    /** ISO timestamp of creation */
     createdAt: string;
+    /** ISO timestamp of last update */
     updatedAt?: string;
+    /** Total number of records in table */
     recordCount: number;
+    /** Array of field definitions */
     fields: {
+        /** Unique field ID */
         id: string;
+        /** Field key for data access */
         key: string;
+        /** Display name */
         name: string;
+        /** Field type (text, number, boolean, date, reference, etc.) */
         type: string;
+        /** Whether field is required */
         required: boolean;
+        /** Default value if not provided */
         defaultValue?: any;
+        /** Display order in table */
         tableOrder?: number;
+        /** For reference fields: ID of referenced table */
         referencedTableId?: string;
+        /** For reference fields: referenced table info */
         referencedTable?: {
             id: string;
             key: string;
@@ -107,36 +268,74 @@ type DataTableResponse = {
         };
     }[];
 };
+/**
+ * Single data record from a table.
+ */
 type DataRecordResponse = {
+    /** Unique record ID */
     id: string;
+    /** Key of the table this record belongs to */
     tableKey: string;
+    /** ID of member who created this record (if applicable) */
     createdByMemberId?: string;
+    /** Record data as key-value pairs */
     data: Record<string, any>;
+    /** ISO timestamp of creation */
     createdAt: string;
+    /** ISO timestamp of last update */
     updatedAt: string;
+    /** Internal ordering value for pagination */
     internalOrder: number;
+    /** Whether current authenticated member owns this record */
     activeMemberOwnsIt: boolean;
 };
+/**
+ * Result of a reference field connect/disconnect operation.
+ */
 type ReferenceFieldResult = {
+    /** Number of records affected */
     count: number;
+    /** Action that was performed */
     action: 'connected' | 'disconnected' | 'unchanged';
 };
+/**
+ * Result of a member reference field operation.
+ */
 type MemberReferenceFieldResult = {
+    /** Number of records affected */
     count: number;
+    /** Whether the current member is referenced */
     hasself: boolean;
+    /** Action that was performed */
     action: 'connected' | 'disconnected' | 'unchanged';
 };
+/**
+ * Enhanced record response for query API including relationships.
+ */
 type QueryDataRecordResponse = DataRecordResponse & {
+    /** Included relationships appear as top-level properties */
     [relationName: string]: any;
+    /** Count of related records when using _count */
     _count?: Record<string, number>;
 };
+/**
+ * Paginated response wrapper for list endpoints.
+ */
 type PaginatedResponse<T> = {
+    /** Whether more pages exist */
     hasNext: boolean;
+    /** Cursor for fetching next page */
     endCursor: string | null;
+    /** Total count of all matching items */
     totalCount: number;
+    /** Array of items for current page */
     data: T[];
 };
+/**
+ * Standard response wrapper - all SDK methods return this shape.
+ */
 type Response<T> = {
+    /** The response data */
     data: T;
 };