[MOB-9676] docs and doc generator

.eslintignore

@@ -1,3 +1,4 @@
+docs/
 integration-testing/
 lib/
 node_modules/

.eslintrc.js

@@ -12,7 +12,7 @@ module.exports = {
   overrides: [
     {
       files: ['*.ts', '*.tsx'],
-      plugins: ['@typescript-eslint/eslint-plugin'],
+      plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc'],
       extends: [
         'plugin:@typescript-eslint/recommended',
         // We need more verbose typing to enable the below rule, but we should
@@ -33,6 +33,7 @@ module.exports = {
           'error',
           { allow: ['/package\\.json$'] },
         ],
+        'tsdoc/syntax': 'warn',
       },
     },
     {

.gitignore

@@ -84,4 +84,5 @@ android/generated
 # Iterable
 .env
 .xcode.env.local
-coverage/
+coverage/
+docs/

example/src/hooks/useIterableApp.tsx

@@ -28,7 +28,7 @@ interface IterableAppProps {
   config: IterableConfig | null;
   /**
    * Call to initialize the Iterable SDK
-   * @param navigation The navigation prop from the screen
+   * @param navigation - The navigation prop from the screen
    * @returns Promise<boolean> Whether the initialization was successful
    */
   initialize: (navigation: Navigation) => void;
@@ -47,15 +47,15 @@ interface IterableAppProps {
   loginInProgress?: boolean;
   /** Logs the user out */
   logout: () => void;
-  /** TODO: Ask @evantk91 or @Ayyanchira what this is for */
+  /** Should the iterable inbox return to the list of messages? */
   returnToInboxTrigger: boolean;
   /** Sets the API key for the user */
   setApiKey: (value: string) => void;
   /** Sets whether the tab in focus is the `Inbox` tab */
   setIsInboxTab: (value: boolean) => void;
   /** Sets whether the login is in progress */
   setLoginInProgress: (value: boolean) => void;
-  /** TODO: Ask @evantk91 or @Ayyanchira what this is for */
+  /** Sets whether the iterable inbox should return to the list of messages */
   setReturnToInboxTrigger: (value: boolean) => void;
   /** Sets the user ID for the user */
   setUserId: (value: string) => void;

package.json

@@ -41,6 +41,7 @@
     "test:coverage": "jest --coverage",
     "typecheck": "tsc",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "docs": "typedoc",
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
     "prepare": "bob build",
     "release": "release-it"
@@ -83,6 +84,7 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-jest": "^28.9.0",
     "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-tsdoc": "^0.3.0",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
     "react": "18.3.1",
@@ -93,6 +95,9 @@
     "react-native-webview": "^13.12.3",
     "release-it": "^15.0.0",
     "turbo": "^1.10.7",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-coverage": "^3.3.0",
+    "typedoc-plugin-mermaid": "^1.12.0",
     "typescript": "^5.2.2"
   },
   "resolutions": {