feat: initial docs

Author: zSoulweaver

.gitignore

@@ -173,3 +173,8 @@ dist
 
 # Finder (MacOS) folder config
 .DS_Store
+
+# Vitepress docs
+docs/.vitepress/dist
+docs/.vitepress/cache
+docs/typedoc

bun.lockb

@@ -0,0 +1,33 @@
+import { defineConfig } from 'vitepress'
+// @ts-expect-error vite will import json
+import typedocSidebar from '../typedoc/typedoc-sidebar.json'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+	title: 'Kient',
+	description: 'Typescript first API wrapper for Kick.com',
+	themeConfig: {
+		// https://vitepress.dev/reference/default-theme-config
+		nav: [
+			{ text: 'Home', link: '/' },
+			{ text: 'Examples', link: '/markdown-examples' },
+			{ text: 'API Reference', link: '/typedoc/' },
+		],
+
+		sidebar: [
+			{
+				text: 'Examples',
+				items: [
+					{ text: 'Markdown Examples', link: '/markdown-examples' },
+					{ text: 'Runtime API Examples', link: '/api-examples' },
+				],
+			},
+			{
+				text: 'API Reference',
+				items: typedocSidebar,
+			},
+		],
+
+		socialLinks: [{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }],
+	},
+})

docs/.vitepress/config.ts

@@ -0,0 +1,49 @@
+---
+outline: deep
+---
+
+# Runtime API Examples
+
+This page demonstrates usage of some of the runtime APIs provided by VitePress.
+
+The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
+
+```md
+<script setup>
+import { useData } from 'vitepress'
+
+const { theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+```
+
+<script setup>
+import { useData } from 'vitepress'
+
+const { site, theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+
+## More
+
+Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

docs/api-examples.md

@@ -0,0 +1,25 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "Kient"
+  text: "Typescript first API wrapper for Kick.com"
+  tagline: My great project tagline
+  actions:
+    - theme: brand
+      text: Markdown Examples
+      link: /markdown-examples
+    - theme: alt
+      text: API Examples
+      link: /api-examples
+
+features:
+  - title: Feature A
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature B
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Feature C
+    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+---
+

docs/index.md

@@ -0,0 +1,85 @@
+# Markdown Extension Examples
+
+This page demonstrates some of the built-in markdown extensions provided by VitePress.
+
+## Syntax Highlighting
+
+VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
+
+**Input**
+
+````md
+```js{4}
+export default {
+  data () {
+    return {
+      msg: 'Highlighted!'
+    }
+  }
+}
+```
+````
+
+**Output**
+
+```js{4}
+export default {
+  data () {
+    return {
+      msg: 'Highlighted!'
+    }
+  }
+}
+```
+
+## Custom Containers
+
+**Input**
+
+```md
+::: info
+This is an info box.
+:::
+
+::: tip
+This is a tip.
+:::
+
+::: warning
+This is a warning.
+:::
+
+::: danger
+This is a dangerous warning.
+:::
+
+::: details
+This is a details block.
+:::
+```
+
+**Output**
+
+::: info
+This is an info box.
+:::
+
+::: tip
+This is a tip.
+:::
+
+::: warning
+This is a warning.
+:::
+
+::: danger
+This is a dangerous warning.
+:::
+
+::: details
+This is a details block.
+:::
+
+## More
+
+Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

docs/markdown-examples.md

@@ -3,13 +3,22 @@
   "module": "src/index.ts",
   "type": "module",
   "scripts": {
-    "dev": "bun run --watch example/get-clips.ts"
+    "dev": "bun run --watch example/init.ts",
+    "docs:prepare": "typedoc",
+    "docs:dev": "typedoc && vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
     "@deepkit/bun": "^1.0.1-alpha.153",
     "@deepkit/type-compiler": "^1.0.1-alpha.150",
-    "@types/bun": "^1.1.6"
+    "@types/bun": "^1.1.6",
+    "typedoc": "^0.26.5",
+    "typedoc-plugin-markdown": "^4.2.3",
+    "typedoc-plugin-missing-exports": "^3.0.0",
+    "typedoc-vitepress-theme": "^1.0.1",
+    "vitepress": "^1.3.1"
   },
   "peerDependencies": {
     "typescript": "^5.5.4"

package.json

@@ -5,6 +5,7 @@ export interface APIClientOptions {
 	ofetch?: FetchOptions<ResponseType>
 }
 
+/** @internal */
 export class APIClient {
 	private readonly apiFetch: $Fetch
 

src/api.client.ts

@@ -1,5 +1,6 @@
 import type { Kient } from '../kient'
 
+/** @internal */
 export class APIBase {
 	protected readonly kient: Kient
 

src/api/api-base.ts

@@ -2,6 +2,11 @@ import { APIBase } from '../api-base'
 import { getChannel } from './get-channel'
 import { getClips } from './get-clip'
 
+/**
+ * Description placeholder
+ *
+ * @group APIs
+ */
 export class ChannelsAPI extends APIBase {
 	/**
 	 * Returns channel and user information of the specified channel

src/api/channels/index.ts

@@ -1,5 +1,5 @@
 import defu from 'defu'
-import { WSClient } from './ws.client'
+import { WSClient, type WSClientOptions } from './ws.client'
 import { EventEmitter } from 'tseep'
 import type { KientEventEmitters } from './events'
 import { ChannelsAPI } from './api/channels'
@@ -9,24 +9,23 @@ type DeepPartial<T> = T extends object ? { [P in keyof T]?: DeepPartial<T[P]> }
 
 export interface KientOptions {
 	connectToWebsocket: boolean
-	pusher: {
-		appKey: string
-		cluster: string
-	}
 	apiClient: APIClientOptions
+	wsClient: WSClientOptions
 }
 
 const defaultKientOptions: KientOptions = {
 	connectToWebsocket: true,
-	pusher: {
-		appKey: '32cbd69e4b950bf97679',
-		cluster: 'us2',
-	},
 	apiClient: {
 		ofetch: {
 			baseURL: 'https://api.kick.com/private/v1',
 		},
 	},
+	wsClient: {
+		pusher: {
+			appKey: '32cbd69e4b950bf97679',
+			cluster: 'us2',
+		},
+	},
 }
 
 export class Kient extends EventEmitter<KientEventEmitters> {
@@ -44,12 +43,7 @@ export class Kient extends EventEmitter<KientEventEmitters> {
 	}
 
 	connectWebsocket() {
-		this._wsClient = new WSClient(this, {
-			pusher: {
-				appKey: this.kientOptions.pusher.appKey,
-				cluster: this.kientOptions.pusher.cluster,
-			},
-		})
+		this._wsClient = new WSClient(this, this.kientOptions.wsClient)
 	}
 
 	api = {

src/kient.ts

@@ -4,8 +4,14 @@ import type { Kient } from '../kient'
 // biome-ignore lint/style/useImportType: deepkit/type
 import { Directory } from './directory'
 
+/**
+ * Data structure of a stream category
+ *
+ * @group API Structures
+ */
 export class Category {
 	constructor(
+		/** @internal */
 		public kient: Kient & Group<'exclude'>,
 
 		public id: string,

src/structures/category.ts

@@ -2,6 +2,11 @@
 import { serialize, Group } from '@deepkit/type'
 import type { Kient } from '../kient'
 
+/**
+ * Data structure of a user's channel
+ *
+ * @group API Structures
+ */
 export class Channel {
 	constructor(
 		public kient: Kient & Group<'exclude'>,

src/structures/channel.ts

@@ -2,6 +2,11 @@
 import { serialize, Group } from '@deepkit/type'
 import type { Kient } from '../kient'
 
+/**
+ * Data structure of a channel's chatroom
+ *
+ * @group API Structures
+ */
 export class Chatroom {
 	constructor(
 		public kient: Kient & Group<'exclude'>,

src/structures/chatroom.ts

@@ -8,6 +8,11 @@ import { Channel } from './channel'
 // biome-ignore lint/style/useImportType: deepkit/type
 import { User } from './user'
 
+/**
+ * Data structure of a clip from a livestream
+ *
+ * @group API Structures
+ */
 export class Clip {
 	constructor(
 		public kient: Kient & Group<'exclude'>,

src/structures/clip.ts

@@ -2,6 +2,11 @@
 import { serialize, Group } from '@deepkit/type'
 import type { Kient } from '../kient'
 
+/**
+ * Data structure of a directory
+ *
+ * @group API Structures
+ */
 export class Directory {
 	constructor(
 		public kient: Kient & Group<'exclude'>,

src/structures/directory.ts

@@ -2,6 +2,11 @@
 import { serialize, Group } from '@deepkit/type'
 import type { Kient } from '../kient'
 
+/**
+ * Data structure of a channel's panels in their about page
+ *
+ * @group API Structures
+ */
 export class Panel {
 	constructor(public kient: Kient & Group<'exclude'>) {}
 

src/structures/panel.ts

@@ -2,6 +2,11 @@
 import { serialize, Group } from '@deepkit/type'
 import type { Kient } from '../kient'
 
+/**
+ * Data structure of a channel's social media links
+ *
+ * @group API Structures
+ */
 export class Social {
 	constructor(public kient: Kient & Group<'exclude'>) {}