Add comprehensive comments and documentation to shared helpers

Author: Definence

src/helpers/profile_helpers.ts

@@ -0,0 +1,34 @@
+/**
+ * Profile-related constants and business logic that works across React Native and Web
+ */
+
+/**
+ * Helper class containing profile type constants and related utilities
+ */
+export class ProfileHelpers {
+  /**
+   * Map of profile type keys to their display names
+   * Used throughout the application to identify and display different profile types
+   */
+  static profileTypes = {
+    model: 'Model',
+    photo: 'Photographer',
+    makeUp: 'Make-up Artist',
+    hair: 'Hair Stylist',
+    video: 'Videographer',
+    influencer: 'Influencer',
+    stylist: 'Stylist',
+    prop: 'Prop Stylist',
+    manicurist: 'Manicurist',
+    parts: 'Hand / Foot Model',
+    studio: 'Rental Studio',
+    retoucher: 'Retoucher',
+    producer: 'Producer',
+    creative: 'Creative Director',
+    casting: 'Casting Director',
+    designer: 'Designer',
+    eComManager: 'E-Commerce Manager',
+    studioManager: 'Studio Manager',
+    other: 'Other',
+  }
+}

src/helpers/stripe_helpers.ts

@@ -2,57 +2,105 @@
  * Stripe-related business logic that works across React Native and Web
  */
 
+/**
+ * Represents a Stripe card payment method
+ */
 export interface StripeCard {
+  /** Card brand (e.g., 'visa', 'mastercard', 'american express') */
   brand: string;
+  /** Last 4 digits of the card number */
   last4?: string;
+  /** Expiration month (1-12) */
   exp_month?: number;
+  /** Expiration year (4 digits) */
   exp_year?: number;
 }
 
+/**
+ * Represents a Stripe US bank account payment method
+ */
 export interface StripeUSBankAccount {
+  /** Name of the bank */
   bank_name: string;
+  /** Last 4 digits of the account number */
   last4: string;
 }
 
+/**
+ * Represents a Stripe payment method object as returned by the API
+ */
 export interface StripePaymentMethod {
   data: {
+    /** Type of payment method */
     type: 'card' | 'us_bank_account';
+    /** Card details if type is 'card' */
     card?: StripeCard;
+    /** US bank account details if type is 'us_bank_account' */
     us_bank_account?: StripeUSBankAccount;
   };
 }
 
+/**
+ * Represents a default payment method from Stripe customer invoice settings
+ */
 export interface StripeDefaultPaymentMethod {
+  /** Payment method ID */
   id: string;
+  /** Type of payment method */
   type: 'card' | 'us_bank_account';
+  /** Stripe object type */
   object?: string;
+  /** Card details if type is 'card' */
   card?: StripeCard;
+  /** US bank account details if type is 'us_bank_account' */
   us_bank_account?: StripeUSBankAccount;
 }
 
+/**
+ * Represents a Stripe customer object as returned by the API
+ */
 export interface StripeCustomer {
   data: {
+    /** Invoice settings containing default payment method */
     invoice_settings?: {
+      /** Default payment method for invoices */
       default_payment_method?: StripeDefaultPaymentMethod;
     };
+    /** Legacy card sources (deprecated in favor of payment methods) */
     sources?: {
+      /** Array of card sources */
       data: Array<StripeCard & { id?: string; object?: string }>;
     };
   };
 }
 
+/**
+ * Normalized payment method object used internally in the application
+ */
 export interface CustomerDefaultPaymentMethod {
+  /** Whether this is a payment method (true) or legacy source (false) */
   isPaymentMethod: boolean;
+  /** Formatted display label for the payment method */
   label: string;
+  /** Last 4 digits of the card or account */
   last4: string;
+  /** Expiration month (for cards only) */
   expMonth?: number;
+  /** Expiration year (for cards only) */
   expYear?: number;
+  /** Bank name (for US bank accounts only) */
   bankName?: string;
+  /** Card brand (for cards only) */
   brand?: string;
+  /** Payment method or source ID */
   id: string;
+  /** Stripe object type */
   object: string;
 }
 
+/**
+ * Helper class containing Stripe-related business logic and formatting utilities
+ */
 export class StripeHelpers {
   /**
    * Returns a formatted card brand label. Abbreviates "American Express" to "Amex".

src/helpers/user_helpers.ts

@@ -0,0 +1,49 @@
+/**
+ * User-related business logic that works across React Native and Web
+ */
+
+import { ProfileHelpers } from './profile_helpers'
+
+/**
+ * User interface representing user data structure
+ */
+export interface User {
+  /** Whether the user is on a waitlist */
+  waitlisted?: boolean
+  /** Array of user profiles, each containing a profile type */
+  profiles?: Array<{
+    /** The type of profile (e.g., 'Model', 'Photographer', etc.) */
+    profile_type: string
+  }>
+}
+
+/**
+ * Helper class containing user-related business logic utilities
+ */
+export class UserHelpers {
+  /**
+   * Determines if a user is eligible for the Digital Content Creator (DCC) flow
+   * A user is eligible if they are waitlisted and have a profile type that qualifies as a digital content creator
+   * @param user - The user object to check for DCC eligibility
+   * @returns true if the user is eligible for DCC flow, false otherwise
+   */
+  static dccEligible(user: User): boolean {
+    if (!user.waitlisted || !user.profiles?.length) return false
+
+    const profileType = user.profiles[0].profile_type
+    const digitalContentCreatorProfiles = [
+      ProfileHelpers.profileTypes.photo,
+      ProfileHelpers.profileTypes.hair,
+      ProfileHelpers.profileTypes.makeUp,
+      ProfileHelpers.profileTypes.stylist,
+      ProfileHelpers.profileTypes.model,
+      ProfileHelpers.profileTypes.influencer,
+      ProfileHelpers.profileTypes.video,
+      ProfileHelpers.profileTypes.manicurist,
+      ProfileHelpers.profileTypes.prop,
+      ProfileHelpers.profileTypes.parts,
+    ]
+
+    return digitalContentCreatorProfiles.includes(profileType)
+  }
+}

src/index.ts

@@ -1 +1,8 @@
+/**
+ * Shared utilities and helpers that work across React Native and Web platforms
+ * This module exports all helper classes and their associated types/interfaces
+ */
+
 export * from './helpers/stripe_helpers';
+export * from './helpers/profile_helpers';
+export * from './helpers/user_helpers';