chore: gitignore autogenned sdk typedoc

2026-06-06 00:56:56 +00:00 · 2026-02-01 15:11:42 +01:00
parent 28cbe4e8ed
commit 92cde437af
11 changed files with 4 additions and 429 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -48,4 +48,6 @@ packages/db/generated/client
 slack-import-emojis/target
 **/*/emojis.json

-.idea
+.idea
+
+/apps/docs/src/content/docs/typedoc-sdk
--- a/apps/docs/astro.config.mjs
+++ b/apps/docs/astro.config.mjs
@@ -23,7 +23,7 @@ export default defineConfig({
        starlightTypeDoc({
          entryPoints: ['../../packages/sdk/src/index.ts'],
          tsconfig: '../../packages/sdk/tsconfig.json',
-          output: 'sdk-typedoc',
+          output: 'typedoc-sdk',
          sidebar: {
            label: 'SDK Reference',
          },
--- a/apps/docs/src/content/docs/sdk-typedoc/README.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/README.md
@@ -1,23 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "@hctv/sdk"
---
-
-## Classes
-
- [ChatClient](/sdk-typedoc/classes/chatclient/)
- [HctvSdk](/sdk-typedoc/classes/hctvsdk/)
-
-## Interfaces
-
- [ChatClientOptions](/sdk-typedoc/interfaces/chatclientoptions/)
- [ChatMessage](/sdk-typedoc/interfaces/chatmessage/)
- [SystemMessage](/sdk-typedoc/interfaces/systemmessage/)
-
-## Type Aliases
-
- [HistoryHandler](/sdk-typedoc/type-aliases/historyhandler/)
- [MessageHandler](/sdk-typedoc/type-aliases/messagehandler/)
- [SystemMessageHandler](/sdk-typedoc/type-aliases/systemmessagehandler/)
--- a/apps/docs/src/content/docs/sdk-typedoc/classes/ChatClient.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/classes/ChatClient.md
@@ -1,172 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "ChatClient"
---
-
-Defined in: [chat.ts:14](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L14)
-
-## Constructors
-
-### Constructor
-
-> **new ChatClient**(`botToken`, `options?`): `ChatClient`
-
-Defined in: [chat.ts:24](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L24)
-
-#### Parameters
-
-##### botToken
-
-`string`
-
-##### options?
-
-[`ChatClientOptions`](/sdk-typedoc/interfaces/chatclientoptions/)
-
-#### Returns
-
-`ChatClient`
-
-## Accessors
-
-### currentChannel
-
-#### Get Signature
-
-> **get** **currentChannel**(): `string` \| `null`
-
-Defined in: [chat.ts:187](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L187)
-
-##### Returns
-
-`string` \| `null`
-
-***
-
-### isConnected
-
-#### Get Signature
-
-> **get** **isConnected**(): `boolean`
-
-Defined in: [chat.ts:183](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L183)
-
-##### Returns
-
-`boolean`
-
-## Methods
-
-### connect()
-
-> **connect**(`channelName`): `Promise`\<`void`\>
-
-Defined in: [chat.ts:29](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L29)
-
-#### Parameters
-
-##### channelName
-
-`string`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### disconnect()
-
-> **disconnect**(): `void`
-
-Defined in: [chat.ts:147](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L147)
-
-#### Returns
-
-`void`
-
-***
-
-### onHistory()
-
-> **onHistory**(`handler`): () => `void`
-
-Defined in: [chat.ts:171](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L171)
-
-#### Parameters
-
-##### handler
-
-[`HistoryHandler`](/sdk-typedoc/type-aliases/historyhandler/)
-
-#### Returns
-
-> (): `void`
-
-##### Returns
-
-`void`
-
-***
-
-### onMessage()
-
-> **onMessage**(`handler`): () => `void`
-
-Defined in: [chat.ts:161](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L161)
-
-#### Parameters
-
-##### handler
-
-[`MessageHandler`](/sdk-typedoc/type-aliases/messagehandler/)
-
-#### Returns
-
-> (): `void`
-
-##### Returns
-
-`void`
-
-***
-
-### onSystemMessage()
-
-> **onSystemMessage**(`handler`): () => `void`
-
-Defined in: [chat.ts:166](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L166)
-
-#### Parameters
-
-##### handler
-
-[`SystemMessageHandler`](/sdk-typedoc/type-aliases/systemmessagehandler/)
-
-#### Returns
-
-> (): `void`
-
-##### Returns
-
-`void`
-
-***
-
-### sendMessage()
-
-> **sendMessage**(`message`): `void`
-
-Defined in: [chat.ts:154](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L154)
-
-#### Parameters
-
-##### message
-
-`string`
-
-#### Returns
-
-`void`
--- a/apps/docs/src/content/docs/sdk-typedoc/classes/HctvSdk.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/classes/HctvSdk.md
@@ -1,34 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "HctvSdk"
---
-
-Defined in: [index.ts:3](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/index.ts#L3)
-
-## Constructors
-
-### Constructor
-
-> **new HctvSdk**(`args`): `HctvSdk`
-
-Defined in: [index.ts:7](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/index.ts#L7)
-
-#### Parameters
-
-##### args
-
-`ConstructorArgs`
-
-#### Returns
-
-`HctvSdk`
-
-## Properties
-
-### chat
-
-> **chat**: [`ChatClient`](/sdk-typedoc/classes/chatclient/)
-
-Defined in: [index.ts:5](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/index.ts#L5)
--- a/apps/docs/src/content/docs/sdk-typedoc/interfaces/ChatClientOptions.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/interfaces/ChatClientOptions.md
@@ -1,18 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "ChatClientOptions"
---
-
-Defined in: [chat.ts:192](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L192)
-
-## Properties
-
-### baseUrl?
-
-> `optional` **baseUrl**: `string`
-
-Defined in: [chat.ts:194](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/chat.ts#L194)
-
-Custom WebSocket base URL (default: wss://hackclub.tv/api/chat)
--- a/apps/docs/src/content/docs/sdk-typedoc/interfaces/ChatMessage.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/interfaces/ChatMessage.md
@@ -1,80 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "ChatMessage"
---
-
-Defined in: [types.ts:1](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L1)
-
-## Properties
-
-### channelName
-
-> **channelName**: `string`
-
-Defined in: [types.ts:3](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L3)
-
-***
-
-### displayName?
-
-> `optional` **displayName**: `string`
-
-Defined in: [types.ts:5](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L5)
-
-***
-
-### id
-
-> **id**: `string`
-
-Defined in: [types.ts:2](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L2)
-
-***
-
-### isBot
-
-> **isBot**: `boolean`
-
-Defined in: [types.ts:10](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L10)
-
-***
-
-### message
-
-> **message**: `string`
-
-Defined in: [types.ts:7](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L7)
-
-***
-
-### pfpUrl?
-
-> `optional` **pfpUrl**: `string`
-
-Defined in: [types.ts:6](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L6)
-
-***
-
-### timestamp
-
-> **timestamp**: `number`
-
-Defined in: [types.ts:8](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L8)
-
-***
-
-### type
-
-> **type**: `"message"` \| `"systemMsg"`
-
-Defined in: [types.ts:9](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L9)
-
-***
-
-### username
-
-> **username**: `string`
-
-Defined in: [types.ts:4](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L4)
--- a/apps/docs/src/content/docs/sdk-typedoc/interfaces/SystemMessage.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/interfaces/SystemMessage.md
@@ -1,40 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "SystemMessage"
---
-
-Defined in: [types.ts:13](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L13)
-
-## Properties
-
-### channelName
-
-> **channelName**: `string`
-
-Defined in: [types.ts:15](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L15)
-
-***
-
-### message
-
-> **message**: `string`
-
-Defined in: [types.ts:16](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L16)
-
-***
-
-### timestamp
-
-> **timestamp**: `number`
-
-Defined in: [types.ts:17](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L17)
-
-***
-
-### type
-
-> **type**: `"connected"` \| `"disconnected"` \| `"error"`
-
-Defined in: [types.ts:14](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L14)
--- a/apps/docs/src/content/docs/sdk-typedoc/type-aliases/HistoryHandler.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/type-aliases/HistoryHandler.md
@@ -1,20 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "HistoryHandler"
---
-
-> **HistoryHandler** = (`messages`) => `void`
-
-Defined in: [types.ts:35](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L35)
-
-## Parameters
-
-### messages
-
-[`ChatMessage`](/sdk-typedoc/interfaces/chatmessage/)[]
-
-## Returns
-
-`void`
--- a/apps/docs/src/content/docs/sdk-typedoc/type-aliases/MessageHandler.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/type-aliases/MessageHandler.md
@@ -1,20 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "MessageHandler"
---
-
-> **MessageHandler** = (`message`) => `void`
-
-Defined in: [types.ts:33](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L33)
-
-## Parameters
-
-### message
-
-[`ChatMessage`](/sdk-typedoc/interfaces/chatmessage/)
-
-## Returns
-
-`void`
--- a/apps/docs/src/content/docs/sdk-typedoc/type-aliases/SystemMessageHandler.md
+++ b/apps/docs/src/content/docs/sdk-typedoc/type-aliases/SystemMessageHandler.md
@@ -1,20 +0,0 @@
---
-editUrl: false
-next: false
-prev: false
-title: "SystemMessageHandler"
---
-
-> **SystemMessageHandler** = (`message`) => `void`
-
-Defined in: [types.ts:34](https://github.com/SrIzan10/hclive/blob/df845b5601eb6cb26def868034edc3500b99a4bd/packages/sdk/src/types.ts#L34)
-
-## Parameters
-
-### message
-
-[`SystemMessage`](/sdk-typedoc/interfaces/systemmessage/)
-
-## Returns
-
-`void`