feat: add new channel endpoint data

Author: zSoulweaver

bun.lock

@@ -4,6 +4,7 @@
     "": {
       "name": "kient",
       "dependencies": {
+        "@kakasoo/deep-strict-types": "^2.0.2",
         "defu": "^6.1.4",
         "destr": "^2.0.3",
         "hono": "^4.7.2",
@@ -150,6 +151,10 @@
 
     "@jridgewell/sourcemap-codec": ["@jridgewell/[email protected]", "", {}, "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ=="],
 
+    "@kakasoo/deep-strict-types": ["@kakasoo/[email protected]", "", { "dependencies": { "@kakasoo/proto-typescript": "^1.28.7" } }, "sha512-UdIQK2gkAiamPZonXfoiTyrtLJ7/pgFIQDJ+o8Frftf0YcRSGkFG8fIYg1uuThW0CNBZSH2dSyaGD9ElfLjZIw=="],
+
+    "@kakasoo/proto-typescript": ["@kakasoo/[email protected]", "", {}, "sha512-5lbFseSDzrZaQifPyDlFgCnB0duFb3ISi3fU7DGTMnZatIVEBz5rZZX0Wkq6HwsX5TNm0b+2d3s03tmPKh4WWw=="],
+
     "@rollup/rollup-android-arm-eabi": ["@rollup/[email protected]", "", { "os": "android", "cpu": "arm" }, "sha512-qZdlImWXur0CFakn2BJ2znJOdqYZKiedEPEVNTBrpfPjc/YuTGcaYZcdmNFTkUj3DU0ZM/AElcM8Ybww3xVLzA=="],
 
     "@rollup/rollup-android-arm64": ["@rollup/[email protected]", "", { "os": "android", "cpu": "arm64" }, "sha512-4KW7P53h6HtJf5Y608T1ISKvNIYLWRKMvfnG0c44M6In4DQVU58HZFEVhWINDZKp7FZps98G3gxwC1sb0wXUUg=="],

example/get-channels.ts

@@ -1,14 +1,14 @@
 import { env } from 'bun'
-import { Kient } from 'kient'
+import { Kient, kientToJSON } from 'kient'
 
 const kient = new Kient()
 kient.setAuthToken(env.KICK_TOKEN as string)
 
-const currentUser = await kient.api.channel.getAuthorisedUser()
-console.log(currentUser.toJSON())
+// const currentUser = await kient.api.channel.getAuthorisedUser()
+// console.log(currentUser.toJSON())
 
-const multipleUsers = await kient.api.channel.getByIds([1, 2, 3])
-console.log(multipleUsers.map((user) => user.toJSON()))
+// const multipleUsers = await kient.api.channel.getByIds([1, 2, 3])
+// console.log(kientToJSON(multipleUsers))
 
-const specificUser = await kient.api.channel.getById(2)
+const specificUser = await kient.api.channel.getById(676)
 console.log(specificUser.toJSON())

package.json

@@ -39,6 +39,7 @@
 		"typescript": "^5.6.3"
 	},
 	"dependencies": {
+		"@kakasoo/deep-strict-types": "^2.0.2",
 		"defu": "^6.1.4",
 		"destr": "^2.0.3",
 		"hono": "^4.7.2",

src/api/channel/get-channels.ts

@@ -12,9 +12,20 @@ export interface ChannelResponse {
 	}
 	channel_description: string
 	slug: string
-	stream?: {
-		key: string
-		url: string
+	stream: {
+		key?: string
+		url?: string
+		category: {
+			id: number
+			name: string
+			thumbnail: string
+		}
+		is_live: boolean
+		is_mature: boolean
+		language: string
+		start_time: string
+		stream_title: string
+		viewer_count: number
 	}
 	stream_title: string
 }
@@ -36,9 +47,19 @@ export async function getChannelsByID(kient: Kient, ids: number[] = []) {
 			slug: channelData.slug,
 			bannerPicture: channelData.banner_picture,
 			channelDescription: channelData.channel_description,
-			streamTitle: channelData.stream_title,
-			category: channelData.category,
-			stream: channelData.stream,
+			stream: {
+				category: channelData.stream.category,
+				isLive: channelData.stream.is_live,
+				isMature: channelData.stream.is_mature,
+				language: channelData.stream.language,
+				startTime: channelData.stream.start_time,
+				streamTitle: channelData.stream.stream_title,
+				viewerCount: channelData.stream.viewer_count,
+			},
+			ingest: {
+				key: channelData.stream.key || '',
+				url: channelData.stream.url || '',
+			},
 		})
 		channelInstances.push(channel)
 	}

src/structures/channel.ts

@@ -1,8 +1,15 @@
+import type { DeepStrictOmit } from '@kakasoo/deep-strict-types'
 import type { Kient } from '../kient'
 import { flatten, type Flattened } from '../util/flatten'
 import { Base } from './base'
 import { Category } from './category'
 
+type ChannelParams = DeepStrictOmit<Flattened<Channel>, 'stream.startTime'> & {
+	stream: {
+		startTime: string
+	}
+}
+
 /**
  * Data structure of a user's channel
  *
@@ -30,19 +37,50 @@ export class Channel extends Base {
 	channelDescription: string
 
 	/**
-	 * The stream title of the channel
+	 * The channel's current stream details
+	 * Note: If the channel is currently not live, this will show data of the most recent broadcast ot live, this will show data of the most recent broadcast ot live, this will show data of the most recent broadcast
 	 */
-	streamTitle: string
+	stream: {
+		/**
+		 * The current directory category of the stream
+		 */
+		category: Category
 
-	/**
-	 * The current directory category of the channel
-	 */
-	category: Category
+		/**
+		 * Indicates if the stream is currently live
+		 */
+		isLive: boolean
+
+		/**
+		 * Indicates if the stream is for mature audiences only
+		 */
+		isMature: boolean
+
+		/**
+		 * The primary language of the stream
+		 */
+		language: string
+
+		/**
+		 * The start time of the stream
+		 */
+		startTime: Date
+
+		/**
+		 * The title of the stream
+		 */
+		streamTitle: string
+
+		/**
+		 * The viewer count of the stream
+		 */
+		viewerCount: number
+	}
 
 	/**
-	 * The stream key details of the channel
+	 * The channel's private ingest details
 	 */
-	stream?: {
+	ingest?: {
 		/**
 		 * The stream key of the channel
 		 */
@@ -55,16 +93,28 @@ export class Channel extends Base {
 	}
 
 	/** @internal */
-	constructor(kient: Kient, data: Flattened<Channel>) {
+	constructor(kient: Kient, data: ChannelParams) {
 		super(kient)
 
 		this.id = data.id
 		this.slug = data.slug
 		this.bannerPicture = data.bannerPicture
 		this.channelDescription = data.channelDescription
-		this.streamTitle = data.streamTitle
-		this.category = new Category(kient, data.category)
-		this.stream = data.stream
+		this.stream = {
+			category: new Category(kient, data.stream.category),
+			isLive: data.stream.isLive,
+			isMature: data.stream.isMature,
+			language: data.stream.language,
+			startTime: new Date(data.stream.startTime),
+			streamTitle: data.stream.streamTitle,
+			viewerCount: data.stream.viewerCount,
+		}
+		if (data.ingest?.key && data.ingest.url) {
+			this.ingest = {
+				key: data.ingest.key,
+				url: data.ingest.url,
+			}
+		}
 	}
 
 	toJSON() {