docs: use typedoc monorepo mode to generate an html reference API site

Author: mikehardy

.gitignore

@@ -538,6 +538,7 @@ Pods/*
 packages/**/version.js
 packages/**/version.ts
 typedoc.raw.json
+reference/
 tests/ios/Firebase
 tests/ios/resetXcode.sh
 .tmp

.spellcheck.dict.txt

@@ -132,6 +132,7 @@ NoSQL
 Notifee
 notifee
 NPE
+npm
 NPM
 OAuth
 onboarding

docs/reference-api-readme.md

@@ -0,0 +1,7 @@
+# API reference
+
+This site documents the TypeScript and JavaScript APIs for the [`react-native-firebase`](https://github.com/invertase/react-native-firebase) packages published on npm under the `@react-native-firebase/*` scope.
+
+The **app** module is required; all other modules are optional peer packages. Use the sidebar to open each package. Cross-package types (for example `FirebaseApp`) link between modules when they are part of this documentation build.
+
+For guides and setup, see the [main documentation](https://rnfirebase.io).

package.json

@@ -22,6 +22,8 @@
     "lint:spellcheck": "spellchecker --quiet --files=\"docs/**/*.md\" --dictionaries=\"./.spellcheck.dict.txt\" --reports=\"spelling.json\" --plugins spell indefinite-article repeated-words syntax-mentions syntax-urls frontmatter",
     "tsc:compile": "tsc --project .",
     "lint:all": "yarn lint && yarn lint:markdown && yarn lint:spellcheck && yarn tsc:compile",
+    "reference:api": "typedoc",
+    "reference:api:gh-pages": "typedoc --out apidocs-out --hostedBaseUrl https://invertase.github.io/react-native-firebase/ --useHostedBaseUrlForAbsoluteLinks",
     "tests:ai:mocks": "yarn ts-node ./scripts/fetch_ai_mock_responses.ts && yarn ts-node ./packages/ai/__tests__/test-utils/convert-mocks.ts",
     "tests:jest": "jest",
     "tests:jest-watch": "jest --watch",
@@ -106,6 +108,7 @@
     "spellchecker-cli": "^7.0.2",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.28.18",
     "typescript": "^5.9.3"
   },
   "resolutions": {

packages/ai/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.ts"],
+  "tsconfig": "tsconfig.json"
+}

packages/app-distribution/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.d.ts"]
+}

packages/app/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.ts"],
+  "tsconfig": "tsconfig.json"
+}

packages/auth/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.d.ts"]
+}

packages/database/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.d.ts"]
+}

packages/firestore/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/index.ts", "lib/pipelines/index.ts"],
+  "tsconfig": "tsconfig.json"
+}