fix: Update Twurple dependencies and enhance feature handling

- Downgraded @twurple/pubsub from version 8.0.0 to 7.4.0 in package.json.
- Enhanced twurple.interfaces.ts to include partial types for api, chat, and pubsub features.
- Implemented createFeatureDisabledError and createDisabledFeatureProxy functions in twurple.utils.ts to handle disabled features more gracefully.

Author: tacxou

package.json

@@ -61,7 +61,7 @@
     "typescript": "^5.0.0",
     "@twurple/api": "^8.0.0",
     "@twurple/chat": "^8.0.0",
-    "@twurple/pubsub": "^8.0.0"
+    "@twurple/pubsub": "^7.4.0"
   },
   "publishConfig": {
     "access": "public"

playground/.gitignore

@@ -0,0 +1 @@
+tokens.*.json

playground/bun.lock

@@ -0,0 +1,18 @@
+{
+  "name": "playground",
+  "version": "1.0.0",
+  "private": true,
+  "dependencies": {
+    "@nestjs/config": "^4.0.3",
+    "@tacxou/nestjs_module_twurple": "link:../",
+    "@twurple/api": "^8.0.3",
+    "@twurple/chat": "^8.0.3",
+    "@twurple/pubsub": "^7.4.0",
+    "@twurple/auth": "^8.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "@types/bun": "latest",
+    "typescript": "latest"
+  }
+}

playground/package.json

@@ -0,0 +1,32 @@
+import { Module } from '@nestjs/common'
+import { TwurpleModule, TwurpleOptions } from '@tacxou/nestjs_module_twurple'
+import { ConfigModule, ConfigService } from '@nestjs/config'
+import cfgapp from './config'
+import { AppService } from './app.service'
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [await cfgapp],
+    }),
+    TwurpleModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (config: ConfigService) => {
+        // const cfg = config.get<TwurpleOptions>('twurple.options')
+        // console.log('cfg', cfg)
+        // console.log('cfg', await cfgapp())
+        return {
+          config: (await cfgapp()).twurple.options,
+          features: {
+            chat: true,
+          },
+        }
+      },
+    }),
+  ],
+  providers: [AppService],
+})
+export class AppModule {
+}

playground/src/app.module.ts

@@ -0,0 +1,35 @@
+import { Injectable, Logger, OnApplicationBootstrap } from '@nestjs/common'
+import { InjectTwurpleChat } from '@tacxou/nestjs_module_twurple'
+import { ChatClient, ChatMessage } from '@twurple/chat'
+import { readFileSync } from 'fs'
+
+@Injectable()
+export class AppService implements OnApplicationBootstrap {
+  private readonly package: Partial<any>
+  protected readonly logger: Logger = new Logger(AppService.name)
+
+  public constructor(@InjectTwurpleChat() private readonly chat: ChatClient) {
+    this.package = JSON.parse(readFileSync('package.json', 'utf-8'))
+  }
+
+  public onApplicationBootstrap() {
+    this.logger.log(`Now listening with version <${this.package.version}> 🕹️`)
+
+    this.chat.onMessage((channel, user, message) => {
+      if (message === '!ping') {
+        void this.chat.say(channel, `Pong @${user}`)
+      }
+    })
+
+    void this.chat.connect()
+
+    this.chat.onConnect(() => {
+      this.logger.log('Chat connected')
+    })
+
+    this.chat.onDisconnect(() => {
+      this.logger.log('Chat disconnected')
+    })
+
+  }
+}

playground/src/app.service.ts

@@ -0,0 +1,73 @@
+import { TwurpleOptions } from "@tacxou/nestjs_module_twurple"
+import { exchangeCode  , RefreshingAuthProvider } from "@twurple/auth"
+import fs from 'fs/promises'
+
+export interface ConfigInstance {
+  twurple: {
+    options: TwurpleOptions
+  }
+}
+
+// noinspection JSUnresolvedReference
+export default async (): Promise<ConfigInstance> => {
+  // const tokenData = await getAppToken(
+  //   process.env['STREAMKITS_TWURPLE_CLIENTID'] ?? '',
+  //   process.env['STREAMKITS_TWURPLE_CLIENTSECRET'] ?? '',
+  // )
+  // console.log(tokenData)
+  // const tokenData = {
+  //   accessToken: '[ACCESS_TOKEN]',
+  //   refreshToken: '[REFRESH_TOKEN]',
+  //   expiresIn: 1,
+  //   obtainmentTimestamp: 0,
+  // }
+
+  const params = new URLSearchParams({
+    client_id: process.env.STREAMKITS_TWURPLE_CLIENTID!,
+    redirect_uri: 'https://a1b2c3d4.ngrok-free.app',
+    response_type: 'code',
+    scope: [
+      'chat:read',
+      'chat:edit',
+      'channel:read:redemptions'
+    ].join(' ')
+  });
+
+  const url = `https://id.twitch.tv/oauth2/authorize?${params}`;
+
+  console.log(url);
+
+  // const tokenData = await exchangeCode(
+  //   process.env['STREAMKITS_TWURPLE_CLIENTID'] ?? '',
+  //   process.env['STREAMKITS_TWURPLE_CLIENTSECRET'] ?? '',
+  //   '[CODE]',
+  //   'https://a1b2c3d4.ngrok-free.app',
+  // )
+  // console.log(tokenData)
+
+  const tokenData = JSON.parse(await fs.readFile('./tokens.125328655.json', 'utf-8'))
+  const authProvider = new RefreshingAuthProvider({
+    clientId: process.env['STREAMKITS_TWURPLE_CLIENTID'] ?? '',
+    clientSecret: process.env['STREAMKITS_TWURPLE_CLIENTSECRET'] ?? '',
+  })
+  authProvider.onRefresh(async (userId, newTokenData) => await fs.writeFile(`./tokens.${userId}.json`, JSON.stringify(newTokenData, null, 4), 'utf-8'))
+  await authProvider.addUserForToken(tokenData, ['chat'])
+
+  return {
+    twurple: {
+      options: {
+        authProvider,
+        features: {
+          api: {},
+          chat: {
+            channels: ['tacxtv'],
+            logger: {
+              minLevel: 'debug',
+            }
+          },
+          pubsub: {},
+        },
+      },
+    },
+  }
+}

playground/src/config.ts

@@ -0,0 +1,9 @@
+import { NestFactory } from '@nestjs/core'
+import { AppModule } from './app.module'
+import cfgapp from './config'
+
+;(async () => {
+  await cfgapp()
+  const app = await NestFactory.createApplicationContext(AppModule)
+  app.enableShutdownHooks()
+})()

playground/src/main.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "baseUrl": ".",
+    "paths": {
+      "@tacxou/nestjs_module_twurple": ["../src/index.ts"],
+      "@nestjs/common": ["../node_modules/@nestjs/common"],
+      "@nestjs/common/*": ["../node_modules/@nestjs/common/*"],
+      "@nestjs/core": ["../node_modules/@nestjs/core"],
+      "@nestjs/core/*": ["../node_modules/@nestjs/core/*"]
+    }
+  },
+  "include": ["src/**/*.ts"]
+}

playground/tsconfig.json

@@ -1,5 +1,8 @@
 import { AuthProvider } from '@twurple/auth'
 import { ModuleMetadata, Type } from '@nestjs/common'
+import { ChatClientOptions } from '@twurple/chat'
+import { ApiConfig } from '@twurple/api'
+import { PubSubClientConfig } from '@twurple/pubsub/lib/PubSubClient'
 
 export interface TwurpleModuleOptions {
   config: TwurpleOptions
@@ -17,9 +20,9 @@ export interface TwurpleModuleFeatureOptions {
 export interface TwurpleOptions {
   authProvider: AuthProvider
   features?: {
-    api?: TwurpleModuleFeatureOptions
-    chat?: TwurpleModuleFeatureOptions
-    pubsub?: TwurpleModuleFeatureOptions
+    api?: TwurpleModuleFeatureOptions & Partial<ApiConfig>
+    chat?: TwurpleModuleFeatureOptions & Partial<ChatClientOptions>
+    pubsub?: TwurpleModuleFeatureOptions & Partial<PubSubClientConfig>
   }
 }