[CHA-188] Added typedoc to package reqs.

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: API Reference
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      deployments: write
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - name: Install Package Dependencies
+        run: npm ci
+
+      - name: Build Documentation
+        run: npm run docs
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-region: eu-west-2
+          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-labs-sdk-builds-ably-chat-js
+          role-session-name: "${{ github.run_id }}-${{ github.run_number }}"
+
+      - name: Upload Documentation
+        uses: ably/sdk-upload-action@v2
+        with:
+          sourcePath: typedoc/generated
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          artifactName: typedoc

package.json

@@ -15,7 +15,8 @@
     "build": "npm run build:mjs && npm run build:cjs",
     "build:mjs": "tsc --project tsconfig.mjs.json && cp package.mjs.json dist/mjs/package.json",
     "build:cjs": "tsc --project tsconfig.cjs.json && cp package.cjs.json dist/cjs/package.json",
-    "demo:reload": "npm run build && cd demo && npm i file:../"
+    "demo:reload": "npm run build && cd demo && npm i file:../",
+    "docs": "typedoc"
   },
   "repository": {
     "type": "git",
@@ -46,6 +47,7 @@
     "eslint-plugin-react-refresh": "^0.4.6",
     "eslint-plugin-security": "^1.7.1",
     "prettier": "^3.2.5",
+    "typedoc": "^0.25.13",
     "typescript": "^5.4.5",
     "vitest": "^1.4.0"
   },

tsconfig.base.json

@@ -1,6 +1,12 @@
 {
-  "include": ["./src/**/*.ts"],
-  "exclude": ["./src/**/*.test.tsx", "./src/**/*.test.ts", "./src/fakes/**/*.ts"],
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "exclude": [
+    "./src/**/*.test.tsx",
+    "./src/**/*.test.ts",
+    "./src/fakes/**/*.ts"
+  ],
   "compilerOptions": {
     "target": "es6",
     "rootDir": "./src",
@@ -14,7 +20,13 @@
     "skipLibCheck": true,
     "allowJs": true,
     "allowSyntheticDefaultImports": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "types": ["node"]
+    "lib": [
+      "DOM",
+      "DOM.Iterable",
+      "ESNext"
+    ],
+    "types": [
+      "node"
+    ]
   }
 }

typedoc.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "out": "typedoc/generated",
+  "readme": "typedoc/landing-page.md",
+  "tsconfig": "tsconfig.base.json",
+  "treatWarningsAsErrors": false,
+  "includeVersion": true,
+  "validation": true,
+  "requiredToBeDocumented": [
+    "Accessor",
+    "Class",
+    "Constructor",
+    "Enum",
+    "EnumMember",
+    "Function",
+    "Interface",
+    "Method",
+    "Parameter",
+    "Property",
+    "TypeAlias",
+    "Variable",
+    "Namespace"
+  ]
+}

typedoc/landing-page.md

@@ -0,0 +1,10 @@
+# Ably Chat JavaScript Client Library SDK API Reference
+
+The JavaScript Client Library SDK supports chat functionality over Ably. The JavaScript API references are generated
+from the [Ably Chat JavaScript Client Library SDK source code](https://github.com/ably-labs/ably-chat-js)
+using [TypeDoc](https://typedoc.org) and structured by classes.
+
+The Chat SDK is built on top of the Ably Realtime SDK and provides a higher-level API for building chat applications. It
+includes features such as entering/leaving conversations, sending messages, room reactions, presence, typing indicators,
+and more.
+