Merge pull request #14 from seamapi/typedoc

Author: razor-x

.github/workflows/check.yml

@@ -124,3 +124,14 @@ jobs:
           node_version: ${{ matrix.node }}
       - name: Typecheck
         run: npm run typecheck
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/setup
+      - name: Build docs
+        run: npm run docs:build

.gitignore

@@ -13,6 +13,7 @@
 !ava.config.js
 
 # Build directories
+docs
 package
 
 # Environment versions file

package-lock.json

@@ -52,6 +52,7 @@
     "prebuild:ts": "del 'index.*' 'connect.*' 'lib'",
     "postbuild:ts": "tsc-alias --project tsconfig.build.json",
     "typecheck": "tsc",
+    "docs:build": "typedoc",
     "test": "c8 ava",
     "pretest": "tsx src/index.ts",
     "test:update": "ava --update-snapshots",
@@ -110,6 +111,7 @@
     "tsup": "^7.2.0",
     "tsx": "^3.12.1",
     "type-fest": "^4.3.1",
+    "typedoc": "^0.25.2",
     "typescript": "^5.1.0"
   }
 }

package.json

@@ -1,2 +1,3 @@
 export * from './options.js'
+export * from './routes//index.js'
 export * from './seam-http.js'

src/lib/seam/connect/index.ts

@@ -10,9 +10,10 @@ interface SeamHttpCommonOptions extends ClientOptions {
   endpoint?: string
 }
 
-export type SeamHttpFromPublishableKeyOptions = SeamHttpCommonOptions
+export interface SeamHttpFromPublishableKeyOptions
+  extends SeamHttpCommonOptions {}
 
-export type SeamHttpOptionsFromEnv = SeamHttpCommonOptions
+export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {}
 
 export interface SeamHttpOptionsWithClient {
   client: Client

src/lib/seam/connect/options.ts

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+  "entryPoints": ["src/index.ts", "src/connect.ts"],
+  "out": "docs",
+  "tsconfig": "./tsconfig.build.json",
+  "navigationLinks": {
+    "GitHub": "https://github.com/seamapi/react"
+  }
+}