@memberstack/dom 2.0.1 → 2.0.2-beta.0

package/lib/types/params.d.ts

@@ -1,211 +1,599 @@
+/**
+ * Parameters for signing up a new member with email and password.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.signupMemberEmailPassword({
+ *   email: 'user@example.com',
+ *   password: 'securePassword123',
+ *   customFields: { firstName: 'John', company: 'Acme Inc' },
+ *   plans: [{ planId: 'pln_free_tier' }]
+ * });
+ * ```
+ */
 type SignupMemberEmailPasswordParams = {
+    /** Member's email address (must be unique within your app) */
     email: string;
+    /** Member's password (minimum 8 characters recommended) */
     password: string;
+    /** Custom field values to set during signup (keys must match your app's custom fields) */
     customFields?: Record<string, any>;
+    /** Metadata to store with the member (not displayed in dashboard) */
     metaData?: Record<string, any>;
+    /** Array of plans to assign on signup */
     plans?: {
         planId: string;
     }[];
+    /** reCAPTCHA token if captcha is enabled for your app */
     captchaToken?: string;
+    /** Team invite token to join a team during signup */
     inviteToken?: string;
 };
+/**
+ * Parameters for joining a team with an invite token.
+ */
 type JoinTeamParams = {
+    /** The invite token received from team admin */
     inviteToken: string;
 };
+/**
+ * Parameters for retrieving team information.
+ */
 type GetTeamParams = {
+    /** The ID of the team to retrieve */
     teamId: string;
 };
+/**
+ * Parameters for removing a member from a team.
+ */
 type RemoveMemberFromTeamParams = {
+    /** The ID of the team */
     teamId: string;
+    /** The ID of the member to remove */
     memberId: string;
 };
+/**
+ * Parameters for generating a team invite token.
+ */
 type GenerateInviteTokenParams = {
+    /** The ID of the team to generate an invite for */
     teamId: string;
 };
+/**
+ * Parameters for retrieving posts from a channel.
+ */
 type GetPostsParams = {
+    /** The key/identifier of the channel */
     channelKey: string;
+    /** Sort order for posts */
     order?: "newest" | "oldest";
+    /** Cursor for pagination (post ID to start after) */
     after?: string;
+    /** Maximum number of posts to return */
     limit?: number;
 };
+/**
+ * Parameters for retrieving threads (replies) on a post.
+ */
 type GetThreadsParams = {
+    /** The ID of the parent post */
     postId: string;
+    /** Sort order for threads */
     order?: "newest" | "oldest";
+    /** Cursor for pagination (thread ID to start after) */
     after?: string;
+    /** Maximum number of threads to return */
     limit?: number;
 };
+/**
+ * Parameters for creating a new post in a channel.
+ */
 type CreatePostParams = {
+    /** The key/identifier of the channel to post in */
     channelKey: string;
+    /** The content of the post (supports markdown) */
     content: string;
 };
+/**
+ * Parameters for updating an existing post.
+ */
 type UpdatePostParams = {
+    /** The ID of the post to update */
     postId: string;
+    /** The new content for the post */
     content: string;
 };
+/**
+ * Parameters for deleting a post.
+ */
 type DeletePostParams = {
+    /** The ID of the post to delete */
     postId: string;
 };
+/**
+ * Parameters for voting on a post.
+ */
 type PostVoteParams = {
+    /** The ID of the post to vote on */
     postId: string;
+    /** The vote type: UP, DOWN, or NONE to remove vote */
     vote: "UP" | "DOWN" | "NONE";
 };
+/**
+ * Parameters for voting on a thread.
+ */
 type ThreadVoteParams = {
+    /** The ID of the thread to vote on */
     threadId: string;
+    /** The vote type: UP, DOWN, or NONE to remove vote */
     vote: "UP" | "DOWN" | "NONE";
 };
+/**
+ * Parameters for creating a reply thread on a post.
+ */
 type CreateThreadParams = {
+    /** The ID of the post to reply to */
     postId: string;
+    /** The content of the reply (supports markdown) */
     content: string;
 };
+/**
+ * Parameters for updating an existing thread.
+ */
 type UpdateThreadParams = {
+    /** The ID of the thread to update */
     threadId: string;
+    /** The new content for the thread */
     content: string;
 };
+/**
+ * Parameters for deleting a thread.
+ */
 type DeleteThreadParams = {
+    /** The ID of the thread to delete */
     threadId: string;
 };
+/**
+ * Parameters for updating a member's profile image.
+ *
+ * @example
+ * ```typescript
+ * const fileInput = document.querySelector('input[type="file"]');
+ * await memberstack.updateMemberProfileImage({
+ *   profileImage: fileInput.files[0]
+ * });
+ * ```
+ */
 type UpdateMemberProfileImageParams = {
+    /** The image file to upload (accepts standard image formats) */
     profileImage: File;
 };
+/**
+ * Parameters for retrieving secure/gated content.
+ *
+ * @example
+ * ```typescript
+ * const { data: content } = await memberstack.getSecureContent({
+ *   contentId: 'cnt_premium_article_123'
+ * });
+ * ```
+ */
 type GetSecureContentParams = {
+    /** The ID of the secure content block to retrieve */
     contentId: string;
 };
+/**
+ * Parameters for setting a password (for passwordless or OAuth users).
+ *
+ * @example
+ * ```typescript
+ * // After signing up with Google, user can set a password
+ * await memberstack.setPassword({
+ *   password: 'myNewPassword123'
+ * });
+ * ```
+ */
 type SetPasswordParams = {
+    /** The new password to set (minimum 8 characters recommended) */
     password: string;
 };
+/**
+ * Parameters for signing up with an OAuth provider.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.signupWithProvider({
+ *   provider: 'google',
+ *   customFields: { referralSource: 'twitter' },
+ *   plans: [{ planId: 'pln_starter' }]
+ * });
+ * ```
+ */
 type SignupWithProviderParams = {
+    /** OAuth provider name ('google', 'facebook', etc.) */
     provider: string;
+    /** Custom field values to set during signup */
     customFields?: Record<string, any>;
+    /** Array of plans to assign on signup */
     plans?: {
         planId: string;
     }[];
+    /** If true, allows login to existing account (default: false) */
     allowLogin?: boolean;
+    /** Team invite token to join a team during signup */
+    inviteToken?: string;
 };
+/**
+ * Parameters for logging in with an OAuth provider.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.loginWithProvider({
+ *   provider: 'google',
+ *   allowSignup: false // Only allow existing accounts
+ * });
+ * ```
+ */
 type LoginWithProviderParams = {
+    /** OAuth provider name ('google', 'facebook', etc.) */
     provider: string;
+    /** If true, creates new account if one doesn't exist (default: false) */
     allowSignup?: boolean;
 };
+/**
+ * Parameters for completing a passwordless login flow.
+ *
+ * @example
+ * ```typescript
+ * // After user receives email with code
+ * await memberstack.loginMemberPasswordless({
+ *   email: 'user@example.com',
+ *   passwordlessToken: '123456'
+ * });
+ * ```
+ */
 type LoginMemberPasswordlessParams = {
+    /** The verification code from the email */
     passwordlessToken: string;
+    /** The email address that received the code */
     email: string;
 };
+/**
+ * Parameters for sending a passwordless login email.
+ */
 type SendMemberLoginPasswordlessEmailParams = {
+    /** The email address to send the login code to */
     email: string;
 };
+/**
+ * Parameters for signing up with an auth provider code (internal use).
+ */
 type SignupMemberAuthProviderParams = {
+    /** The authorization code from OAuth flow */
     code: string;
+    /** The OAuth provider */
     provider: "GOOGLE" | "FACEBOOK";
+    /** Plan ID to assign (deprecated, use plans array) */
     planId?: string;
+    /** Custom field values to set during signup */
     customFields?: Record<string, any>;
+    /** Metadata to store with the member */
     metaData?: Record<string, any>;
+    /** Array of plans to assign on signup */
     plans?: {
         planId: string;
     }[];
+    /** Payment information for paid plans */
     payment?: {
         stripe?: {
             paymentMethodId: string;
         };
     };
 };
+/**
+ * Parameters for logging in with email and password.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.loginMemberEmailPassword({
+ *   email: 'user@example.com',
+ *   password: 'password123'
+ * });
+ * console.log('Logged in:', data.member.auth.email);
+ * ```
+ */
 type LoginMemberEmailPasswordParams = {
+    /** Member's email address */
     email: string;
+    /** Member's password */
     password: string;
 };
+/**
+ * Parameters for updating member profile data.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.updateMember({
+ *   customFields: {
+ *     firstName: 'Jane',
+ *     company: 'New Company Inc'
+ *   }
+ * });
+ * ```
+ */
 type UpdateMemberParams = {
+    /** Custom field values to update (keys must match your app's custom fields) */
     customFields?: Record<string, any>;
 };
+/**
+ * Parameters for updating member authentication credentials.
+ *
+ * @example Change email
+ * ```typescript
+ * await memberstack.updateMemberAuth({
+ *   email: 'newemail@example.com'
+ * });
+ * ```
+ *
+ * @example Change password
+ * ```typescript
+ * await memberstack.updateMemberAuth({
+ *   oldPassword: 'currentPassword',
+ *   newPassword: 'newSecurePassword123'
+ * });
+ * ```
+ */
 type UpdateMemberAuthParams = {
+    /** New email address (will require verification) */
     email?: string;
+    /** Current password (required when changing password) */
     oldPassword?: string;
+    /** New password to set */
     newPassword?: string;
 };
+/**
+ * Parameters for purchasing plans with payment.
+ */
 type PurchasePlansParams = {
+    /** Array of plans to purchase with optional specific price */
     plans: {
         planId: string;
         priceId?: string;
     }[];
+    /** Payment method information */
     payment: {
+        /** Saved card ID from member's cards */
         cardId?: string;
+        /** Stripe payment method */
         stripe?: {
             paymentMethodId: string;
         };
     };
 };
+/**
+ * Parameters for adding a free plan to a member.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.addPlan({
+ *   planId: 'pln_free_tier'
+ * });
+ * ```
+ */
 type AddPlanParams = {
+    /** The ID of the free plan to add */
     planId: string;
 };
+/**
+ * Parameters for launching Stripe Checkout for plan purchase.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.purchasePlansWithCheckout({
+ *   priceId: 'prc_monthly_pro',
+ *   successUrl: 'https://yoursite.com/thank-you',
+ *   cancelUrl: 'https://yoursite.com/pricing',
+ *   couponId: 'SAVE20'
+ * });
+ * ```
+ */
 type PurchasePlansWithCheckoutParams = {
+    /** The price ID to purchase (from your Memberstack dashboard) */
     priceId: string;
+    /** Stripe coupon ID to apply discount */
     couponId?: string;
+    /** URL to redirect on checkout cancellation */
     cancelUrl?: string;
+    /** URL to redirect on successful purchase */
     successUrl?: string;
+    /** Auto-redirect to Stripe Checkout (default: true) */
     autoRedirect?: boolean;
+    /** Custom metadata to attach to the Stripe checkout session */
     metadataForCheckout?: object;
 };
+/**
+ * Parameters for launching Stripe Customer Portal.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.launchStripeCustomerPortal({
+ *   returnUrl: 'https://yoursite.com/account'
+ * });
+ * ```
+ */
 type LaunchStripeCustomerPortalParams = {
+    /** Price IDs to show update options for */
     priceIds?: string[];
+    /** Stripe portal configuration object */
     configuration?: object;
+    /** URL to return to after leaving the portal */
     returnUrl?: string;
+    /** Auto-redirect to Stripe portal (default: true) */
     autoRedirect?: boolean;
 };
+/**
+ * Parameters for opening Stripe Customer Portal (alias for launchStripeCustomerPortal).
+ */
 type OpenStripeCustomerPortalParams = {
+    /** Stripe portal configuration object */
     configuration?: object;
+    /** URL to return to after leaving the portal */
     returnUrl?: string;
+    /** Auto-redirect to Stripe portal (default: true) */
     autoRedirect?: boolean;
 };
+/**
+ * Parameters for removing a plan from a member.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.removePlan({
+ *   planId: 'pln_free_tier'
+ * });
+ * ```
+ */
 type RemovePlanParams = {
+    /** The ID of the plan to remove */
     planId: string;
 };
+/**
+ * Parameters for canceling a subscription plan connection.
+ */
 type CancelPlanParams = {
+    /** The ID of the plan connection to cancel */
     planConnectionId: string;
 };
+/**
+ * Parameters for adding a payment card to a member.
+ */
 type AddMemberCardParams = {
+    /** Stripe payment method ID for the card */
     stripePaymentMethodId: string;
+    /** Set as default payment method */
     default?: boolean;
 };
+/**
+ * Parameters for updating the default payment card.
+ */
 type UpdateDefaultCardParams = {
+    /** The ID of the card to set as default */
     cardId: string;
 };
+/**
+ * Parameters for updating payment method on a plan.
+ */
 type UpdatePlanPaymentParams = {
+    /** The plan connection ID to update */
     planConnectionId: string;
+    /** The card ID to use for future payments */
     cardId: string;
 };
+/**
+ * Parameters for retrieving member receipts.
+ */
 type GetMemberReceiptsParams = {
+    /** Number of receipts to return */
     first?: number;
+    /** Cursor for pagination */
     after?: string;
+    /** Sort order */
     order?: "ASC" | "DESC";
 };
+/**
+ * Parameters for retrieving member invoices.
+ */
 type GetMemberInvoicesParams = {
+    /** Number of invoices to return */
     first?: number;
+    /** Cursor for pagination */
     after?: string;
+    /** Sort order */
     order?: "ASC" | "DESC";
 };
+/**
+ * Parameters for updating member JSON store.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.updateMemberJSON({
+ *   json: { preferences: { theme: 'dark', notifications: true } }
+ * });
+ * ```
+ */
 type UpdateMemberJSONParams = {
+    /** JSON object to store (completely replaces existing JSON) */
     json: object;
 };
+/**
+ * Parameters for retrieving member purchases with optional expansions.
+ */
 type GetMemberPurchasesParams = {
+    /** Include full plan details */
     expandPlan?: boolean;
+    /** Include full price details */
     expandPrice?: boolean;
+    /** Include card details */
     expandCard?: boolean;
+    /** Include subscription details */
     expandSubscription?: boolean;
 };
+/**
+ * Parameters for retrieving a specific plan.
+ */
 type GetPlanParams = {
+    /** The ID of the plan to retrieve */
     planId: string;
 };
+/**
+ * Parameters for retrieving plans list.
+ */
 type GetPlansParams = {
+    /** Filter by plan status */
     status?: "ALL" | "ACTIVE" | "INACTIVE";
 };
+/**
+ * Parameters for sending a password reset email.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.sendMemberResetPasswordEmail({
+ *   email: 'user@example.com'
+ * });
+ * ```
+ */
 type SendMemberResetPasswordEmailParams = {
+    /** Email address of the member requesting password reset */
     email: string;
 };
+/**
+ * Parameters for completing a password reset.
+ *
+ * @example
+ * ```typescript
+ * // Token comes from the reset email link
+ * await memberstack.resetMemberPassword({
+ *   token: 'reset_token_from_email',
+ *   newPassword: 'newSecurePassword123'
+ * });
+ * ```
+ */
 type ResetMemberPasswordParams = {
+    /** Reset token from the password reset email */
     token: string;
+    /** The new password to set */
     newPassword: string;
 };
+/**
+ * Parameters for replacing/upgrading a plan.
+ */
 type ReplacePlanParams = {
+    /** The current plan connection to replace */
     planConnectionId: string;
+    /** The new plan ID to switch to */
     newPlanId?: string;
+    /** Specific price ID for the new plan */
     priceId?: string;
+    /** Payment method for the new plan */
     payment?: {
         cardId?: string;
         stripe?: {
@@ -213,109 +601,345 @@ type ReplacePlanParams = {
         };
     };
 };
+/**
+ * Parameters for getting authentication client secret.
+ */
 type GetAuthenticationClientSecretParams = {
+    /** The plan connection requiring authentication */
     planConnectionId: string;
 };
+/**
+ * Parameters for calculating total checkout amount.
+ */
 type GetTotalCheckoutAmountParams = {
+    /** Array of price IDs to calculate total for */
     priceIds: string[];
 };
+/**
+ * Parameters for retrieving records from a data table.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.getDataRecords({
+ *   table: 'posts',
+ *   limit: 10,
+ *   sortBy: 'createdAt',
+ *   sortDirection: 'DESC'
+ * });
+ * ```
+ */
 type GetDataRecordsParams = {
+    /** The table key/identifier */
     table: string;
+    /** ISO date string - only return records created after this date */
     createdAfter?: string;
+    /** ISO date string - only return records created before this date */
     createdBefore?: string;
+    /** Field name to sort by */
     sortBy?: string;
+    /** Sort direction */
     sortDirection?: 'ASC' | 'DESC';
+    /** Maximum number of records to return (1-100) */
     limit?: number;
+    /** Cursor for pagination (internalOrder value from previous response) */
     after?: string;
 };
+/**
+ * Parameters for creating a new data record.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.createDataRecord({
+ *   table: 'posts',
+ *   data: {
+ *     title: 'My First Post',
+ *     content: 'Hello world!',
+ *     published: true
+ *   }
+ * });
+ * ```
+ */
 type CreateDataRecordParams = {
+    /** The table key/identifier */
     table: string;
+    /** Record data as key-value pairs (keys must match table fields) */
     data: Record<string, any>;
+    /** Optional member ID to associate with the record */
     memberId?: string;
 };
+/**
+ * Parameters for retrieving a single data record.
+ */
 type GetDataRecordParams = {
+    /** The table key/identifier */
     table: string;
+    /** The ID of the record to retrieve */
     recordId: string;
 };
+/**
+ * Selector for referencing records by ID in reference field operations.
+ */
 type ReferenceSelector = {
+    /** The ID of the record to reference */
     id: string;
 };
+/**
+ * Operations for connecting/disconnecting reference field relationships.
+ *
+ * @example Connect a record
+ * ```typescript
+ * await memberstack.updateDataRecord({
+ *   recordId: 'rec_abc',
+ *   data: {
+ *     author: { connect: { id: 'rec_author123' } }
+ *   }
+ * });
+ * ```
+ */
 type ReferenceOperation = {
+    /** Connect one or more records to this reference field */
     connect?: ReferenceSelector | ReferenceSelector[];
+    /** Disconnect one or more records from this reference field */
     disconnect?: ReferenceSelector | ReferenceSelector[];
 };
+/**
+ * Selector for referencing the current member in member reference fields.
+ */
 type MemberReferenceSelector = {
+    /** Set to true to reference the current authenticated member */
     self: true;
 };
+/**
+ * Operations for connecting/disconnecting member reference relationships.
+ */
 type MemberReferenceOperation = {
+    /** Connect the current member to this field */
     connect?: MemberReferenceSelector | MemberReferenceSelector[];
+    /** Disconnect the current member from this field */
     disconnect?: MemberReferenceSelector | MemberReferenceSelector[];
 };
+/**
+ * Parameters for updating an existing data record.
+ *
+ * @example
+ * ```typescript
+ * await memberstack.updateDataRecord({
+ *   recordId: 'rec_abc123',
+ *   data: {
+ *     title: 'Updated Title',
+ *     published: false
+ *   }
+ * });
+ * ```
+ */
 type UpdateDataRecordParams = {
+    /** The ID of the record to update */
     recordId: string;
+    /** Fields to update as key-value pairs */
     data: Record<string, any>;
 };
+/**
+ * Parameters for deleting a data record.
+ */
 type DeleteDataRecordParams = {
+    /** The ID of the record to delete */
     recordId: string;
 };
+/**
+ * Parameters for retrieving a data table schema.
+ */
 type GetDataTableParams = {
+    /** The table key/identifier */
     table: string;
 };
+/**
+ * Filter operators for query where clauses.
+ * Follows Prisma-like syntax for powerful filtering.
+ *
+ * @example
+ * ```typescript
+ * {
+ *   where: {
+ *     age: { gte: 18, lt: 65 },
+ *     name: { contains: 'john', mode: 'insensitive' },
+ *     status: { in: ['active', 'pending'] }
+ *   }
+ * }
+ * ```
+ */
 type WhereOperators = {
+    /** Exact match */
     equals?: any;
+    /** Not equal */
     not?: any;
+    /** Value is in array */
     in?: any[];
+    /** Value is not in array */
     notIn?: any[];
+    /** Less than */
     lt?: any;
+    /** Less than or equal */
     lte?: any;
+    /** Greater than */
     gt?: any;
+    /** Greater than or equal */
     gte?: any;
+    /** String contains substring */
     contains?: string;
+    /** String starts with prefix */
     startsWith?: string;
+    /** String ends with suffix */
     endsWith?: string;
+    /** Full-text search */
     search?: string;
+    /** Case sensitivity mode for string operations */
     mode?: 'insensitive' | 'default';
 };
+/**
+ * Where clause for filtering records with support for logical operators.
+ *
+ * @example Complex where clause
+ * ```typescript
+ * {
+ *   where: {
+ *     AND: [
+ *       { status: { equals: 'published' } },
+ *       { OR: [
+ *         { category: 'tech' },
+ *         { featured: true }
+ *       ]}
+ *     ]
+ *   }
+ * }
+ * ```
+ */
 type WhereClause = {
+    /** Field conditions - key is field name, value is condition */
     [field: string]: any | WhereOperators;
+    /** All conditions must match */
     AND?: WhereClause[];
+    /** At least one condition must match */
     OR?: WhereClause[];
+    /** Condition must not match */
     NOT?: WhereClause;
 };
+/**
+ * Clause for counting related records.
+ */
 type CountClause = {
     select: {
+        /** Relation name to count */
         [relationName: string]: boolean;
     };
 };
+/**
+ * Clause for selecting specific fields in query results.
+ */
 type SelectClause = {
+    /** Field name - true to include, false to exclude */
     [fieldName: string]: boolean | CountClause;
 };
+/**
+ * Clause for including related records in query results.
+ *
+ * @example Include with nested query
+ * ```typescript
+ * {
+ *   include: {
+ *     author: true,
+ *     comments: {
+ *       where: { approved: true },
+ *       orderBy: { createdAt: 'desc' },
+ *       take: 5
+ *     },
+ *     _count: { select: { likes: true } }
+ *   }
+ * }
+ * ```
+ */
+/** Base include options for a relation */
+type IncludeOptions = boolean | {
+    where?: WhereClause;
+    include?: IncludeClause;
+    select?: SelectClause;
+    orderBy?: OrderByClause;
+    take?: number;
+    skip?: number;
+};
 type IncludeClause = {
-    [relationName: string]: boolean | {
-        where?: WhereClause;
-        include?: IncludeClause;
-        select?: SelectClause;
-        orderBy?: OrderByClause;
-        take?: number;
-        skip?: number;
-    };
+    /** Relation name - true to include all, or object for nested query */
+    [relationName: string]: IncludeOptions | boolean | CountClause;
+} & {
+    /** Include counts of related records */
     _count?: boolean | CountClause;
 };
+/**
+ * Clause for sorting query results.
+ *
+ * @example
+ * ```typescript
+ * { orderBy: { createdAt: 'desc' } }
+ * ```
+ */
 type OrderByClause = {
+    /** Field name to sort by - 'asc' for ascending, 'desc' for descending */
     [fieldName: string]: 'asc' | 'desc';
 };
+/**
+ * Main query structure for advanced record querying.
+ * Follows Prisma-like syntax for powerful data operations.
+ *
+ * @example Full query
+ * ```typescript
+ * {
+ *   where: { published: { equals: true } },
+ *   include: { author: true },
+ *   orderBy: { createdAt: 'desc' },
+ *   take: 10,
+ *   skip: 0
+ * }
+ * ```
+ */
 type DataRecordsQuery = {
+    /** Filter conditions */
     where?: WhereClause;
+    /** Related records to include */
     include?: IncludeClause;
+    /** Fields to select (alternative to include) */
     select?: SelectClause;
+    /** Sort order */
     orderBy?: OrderByClause;
+    /** Maximum records to return (1-100) */
     take?: number;
+    /** Records to skip (0-10,000) for offset pagination */
     skip?: number;
+    /** Cursor for cursor-based pagination */
     after?: string;
+    /** Include record counts */
     _count?: boolean | CountClause;
 };
+/**
+ * Parameters for advanced data record queries.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await memberstack.queryDataRecords({
+ *   table: 'posts',
+ *   query: {
+ *     where: {
+ *       published: { equals: true },
+ *       category: { in: ['tech', 'news'] }
+ *     },
+ *     orderBy: { createdAt: 'desc' },
+ *     take: 10
+ *   }
+ * });
+ * ```
+ */
 type QueryDataRecordsParams = {
+    /** The table key/identifier */
     table: string;
+    /** Query configuration */
     query: DataRecordsQuery;
 };