docs: enhance type definitions and improve documentation in Iterable components

Author: lposen

src/core/classes/Iterable.ts

@@ -57,8 +57,10 @@ export class Iterable {
 
   /**
    * Current configuration of the Iterable SDK
+   *
+   * @readonly
    */
-  static savedConfig: IterableConfig = new IterableConfig();
+  static savedConfig: Readonly<IterableConfig> = new IterableConfig();
 
   /**
    * In-app message manager for the current user.

src/core/classes/IterableConfig.ts

@@ -301,8 +301,11 @@ export class IterableConfig {
    */
   toDict() {
     return {
+      /** The name of the Iterable push integration. */
       pushIntegrationName: this.pushIntegrationName,
+      /** Whether automatic push registration is enabled. */
       autoPushRegistration: this.autoPushRegistration,
+      /** The display interval between in-app messages (in seconds). */
       inAppDisplayInterval: this.inAppDisplayInterval,
       /**
        * A boolean indicating if a URL handler is present.
@@ -334,13 +337,22 @@ export class IterableConfig {
       authHandlerPresent: this.authHandler != undefined,
       /** The log level for the SDK. */
       logLevel: this.logLevel,
+      /** The number of seconds before JWT expiration to refresh the token. */
       expiringAuthTokenRefreshPeriod: this.expiringAuthTokenRefreshPeriod,
+      /** The array of allowed URL protocols that the SDK can handle. */
       allowedProtocols: this.allowedProtocols,
+      /**
+       * @deprecated Whether to use in-memory storage for in-app messages on Android.
+       */
       androidSdkUseInMemoryStorageForInApps:
         this.androidSdkUseInMemoryStorageForInApps,
+      /** Whether to use in-memory storage for in-app messages. */
       useInMemoryStorageForInApps: this.useInMemoryStorageForInApps,
+      /** The data region determining the data center and endpoints. */
       dataRegion: this.dataRegion,
+      /** The push platform to use for push notifications. */
       pushPlatform: this.pushPlatform,
+      /** Whether encryption is enforced for PII stored on disk (Android only). */
       encryptionEnforced: this.encryptionEnforced,
     };
   }

src/inbox/components/IterableInbox.tsx

@@ -1,5 +1,10 @@
 import { useIsFocused } from '@react-navigation/native';
-import { useEffect, useState } from 'react';
+import {
+  useEffect,
+  useState,
+  type PropsWithChildren,
+  type ReactElement,
+} from 'react';
 import {
   Animated,
   NativeEventEmitter,
@@ -161,6 +166,9 @@ export interface IterableInboxProps
  * It handles fetching messages, displaying them in a list, and showing individual message details.
  * It also manages the state of the inbox, including loading state, selected message, and visible message impressions.
  *
+ * @category React Components
+ * @group React Components
+ *
  * @example
  * ```tsx
  * const [visible, setVisible] = useState<boolean>(false);
@@ -186,15 +194,18 @@ export interface IterableInboxProps
  * )
  * ```
  */
-export const IterableInbox = ({
-  returnToInboxTrigger = true,
-  messageListItemLayout = () => null,
-  customizations = {} as IterableInboxCustomizations,
-  tabBarHeight = 80,
-  tabBarPadding = 20,
-  safeAreaMode = true,
-  showNavTitle = true,
-}: IterableInboxProps) => {
+export const IterableInbox = (
+  params: PropsWithChildren<IterableInboxProps>
+): ReactElement => {
+  const {
+    returnToInboxTrigger = true,
+    messageListItemLayout = () => null,
+    customizations = {} as IterableInboxCustomizations,
+    tabBarHeight = 80,
+    tabBarPadding = 20,
+    safeAreaMode = true,
+    showNavTitle = true,
+  } = params;
   const defaultInboxTitle = 'Inbox';
   const inboxDataModel = new IterableInboxDataModel();
 

src/inbox/types/IterableInboxCustomizations.ts

@@ -24,7 +24,7 @@ export interface IterableInboxCustomizations {
   noMessagesBody?: string;
 
   /**
-   * CThe container that holds the unread indicator.
+   * The container that holds the unread indicator.
    */
   unreadIndicatorContainer?: {
     /** The flex direction of the container.  */

src/index.tsx

@@ -39,12 +39,11 @@ export {
   IterableInboxMetadata,
   type IterableHtmlInAppContentRaw,
   type IterableInAppContent,
+  type IterableInAppMessageRaw,
 } from './inApp';
 export {
   IterableInbox,
   IterableInboxDataModel,
-  IterableInboxEmptyState,
-  IterableInboxMessageCell,
   type IterableInboxCustomizations,
   type IterableInboxEmptyStateProps,
   type IterableInboxImpressionRowInfo,