ts-twitch-api 0.1.0

package/README.md

@@ -0,0 +1,91 @@
+# ts-twitch-api
+
+Very simple `TwitchApi` class and TypeScript interfaces for all Twitch API endpoints
+
+* Auto-generated from [twitch-api-swagger](https://github.com/DmitryScaletta/twitch-api-swagger)
+* Uses `fetch` under the hood
+* Includes types for all endpoints
+  * _Request Query Parameters_
+  * _Request Body_
+  * _Response Body_
+* Includes descriptions for the fields
+
+## TODO
+
+* Pass RequestInit object
+
+## Installation
+
+```bash
+npm i ts-twitch-api
+
+pnpm i ts-twitch-api
+
+yarn add ts-twitch-api
+```
+
+## Usage
+
+### Types only
+
+```ts
+import type {
+  UpdateAutoModSettingsParams,
+  UpdateAutoModSettingsBody,
+  UpdateAutoModSettingsResponse,
+} from 'ts-twitch-api';
+
+const updateAutoModSettings = async (
+  params: UpdateAutoModSettingsParams,
+  body: UpdateAutoModSettingsBody,
+) => {
+  const searchParams = new URLSearchParams(params);
+  const url = `https://api.twitch.tv/helix/moderation/automod/settings?${searchParams}`;
+  const response = await fetch(url, {
+    method: 'PUT',
+    body: JSON.stringify(body),
+    headers: {
+      Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
+      'Client-Id': process.env.CLIENT_ID,
+      'Content-Type': 'application/json',
+    },
+  });
+  return response.json() as Promise<UpdateAutoModSettingsResponse>;
+}
+```
+
+### `TwitchApi` class
+
+```ts
+import { TwitchApi } from 'ts-twitch-api';
+
+const twitchApi = new TwitchApi({
+  accessToken: process.env.ACCESS_TOKEN,
+  clientId: process.env.CLIENT_ID,
+});
+
+const response = await twitchApi.chat.updateChatSettings(
+  // query params
+  { broadcaster_id: '1', moderator_id: '2' },
+  // body
+  { emote_mode: true },
+);
+
+if (response.ok) {
+  console.log(response.data);
+} else {
+  console.error(response.status);
+}
+
+const streams = await twitchApi.streams.getStreams(
+  // some endpoints accept multiple ids like this: `id=1234&id=5678`
+  { user_id: ['1', '2'] },
+  // override accessToken and/or clientId for different requests
+  '<accessToken>',
+  '<clientId>',
+);
+
+if (streams.ok) {
+  console.log(streams.data);
+}
+```

package/index.ts

@@ -0,0 +1,2 @@
+export * from './twitch-api';
+export * from './twitch-api.generated';

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "ts-twitch-api",
+  "version": "0.1.0",
+  "description": "Very simple TwitchApi class and TypeScript interfaces for all Twitch API endpoints",
+  "author": "DmitryScaletta",
+  "license": "MIT",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DmitryScaletta/ts-twitch-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/DmitryScaletta/ts-twitch-api/issues"
+  },
+  "main": "index.ts",
+  "files": [
+    "index.ts",
+    "twitch-api.ts",
+    "twitch-api.generated.ts"
+  ],
+  "type": "module",
+  "devDependencies": {
+    "@types/node": "^20.11.2",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "node --import tsx ./scripts/build.ts",
+    "gen": "pnpm dlx openapi-typescript https://github.com/DmitryScaletta/twitch-api-swagger/raw/main/openapi.json --output twitch-api.generated.ts"
+  }
+}