@dereekb/discord 14.0.0 → 14.1.0

package/nestjs/index.esm.js

@@ -1,8 +1,8 @@
-import { GatewayIntentBits, Client, Events, TextChannel, InteractionType } from 'discord.js';
+import { GatewayIntentBits, Client, Events, Routes, TextChannel, InteractionType } from 'discord.js';
 import { Injectable, Inject, Logger, Module, Post, Req, Controller } from '@nestjs/common';
 import { isTestNodeEnv, RawBody } from '@dereekb/nestjs';
 import { ConfigService, ConfigModule } from '@nestjs/config';
-import { discordOAuthFactory, exchangeAuthorizationCode, refreshAccessToken, readCurrentUser, discordOAuthAuthorizeUrlFactory, discordAccessTokenFromTokenResponse } from '@dereekb/discord';
+import { discordOAuthFactory, exchangeAuthorizationCode, refreshAccessToken, readCurrentUser, revokeToken, discordOAuthAuthorizeUrlFactory, discordAccessTokenFromTokenResponse } from '@dereekb/discord';
 import { handlerFactory, handlerConfigurerFactory, handlerMappedSetFunctionFactory, isHexWithByteLength } from '@dereekb/util';
 import { createPublicKey, verify } from 'node:crypto';
 
@@ -42,7 +42,7 @@ function _create_class$6(Constructor, protoProps, staticProps) {
     if (staticProps) _defineProperties$6(Constructor, staticProps);
     return Constructor;
 }
-function _define_property$7(obj, key, value) {
+function _define_property$8(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -92,7 +92,7 @@ function _define_property$7(obj, key, value) {
  */ var DiscordServiceConfig = /*#__PURE__*/ function() {
     function DiscordServiceConfig() {
         _class_call_check$8(this, DiscordServiceConfig);
-        _define_property$7(this, "discord", void 0);
+        _define_property$8(this, "discord", void 0);
     }
     _create_class$6(DiscordServiceConfig, null, [
         {
@@ -150,7 +150,7 @@ function _create_class$5(Constructor, protoProps, staticProps) {
     if (protoProps) _defineProperties$5(Constructor.prototype, protoProps);
     return Constructor;
 }
-function _define_property$6(obj, key, value) {
+function _define_property$7(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -167,7 +167,7 @@ function _instanceof(left, right) {
         return !!right[Symbol.hasInstance](left);
     } else return left instanceof right;
 }
-function _object_spread$2(target) {
+function _object_spread$3(target) {
     for(var i = 1; i < arguments.length; i++){
         var source = arguments[i] != null ? arguments[i] : {};
         var ownKeys = Object.keys(source);
@@ -177,7 +177,7 @@ function _object_spread$2(target) {
             }));
         }
         ownKeys.forEach(function(key) {
-            _define_property$6(target, key, source[key]);
+            _define_property$7(target, key, source[key]);
         });
     }
     return target;
@@ -289,16 +289,22 @@ function _ts_generator$4(thisArg, body) {
  */ var DiscordApi = /*#__PURE__*/ function() {
     function DiscordApi(config) {
         _class_call_check$7(this, DiscordApi);
-        _define_property$6(this, "config", void 0);
-        _define_property$6(this, "logger", new Logger('DiscordApi'));
+        _define_property$7(this, "config", void 0);
+        _define_property$7(this, "logger", new Logger('DiscordApi'));
         /**
      * The underlying discord.js Client instance.
-     */ _define_property$6(this, "client", void 0);
+     */ _define_property$7(this, "client", void 0);
         this.config = config;
-        var clientOptions = config.discord.clientOptions;
-        this.client = new Client(_object_spread$2({
+        var _config_discord = config.discord, botToken = _config_discord.botToken, clientOptions = _config_discord.clientOptions;
+        this.client = new Client(_object_spread$3({
             intents: DEFAULT_DISCORD_INTENTS
         }, clientOptions));
+        // login() is the only other thing that sets the REST token, so without this the REST client is
+        // unusable when autoLogin is false. Setting it here is what lets a consumer use the REST API
+        // (fetchChannelMessages, for instance) without opening a gateway websocket.
+        if (isUsableDiscordBotToken(botToken)) {
+            this.client.rest.setToken(botToken);
+        }
     }
     _create_class$5(DiscordApi, [
         {
@@ -416,6 +422,64 @@ function _ts_generator$4(thisArg, body) {
                     return _this.client.off(Events.MessageCreate, handler);
                 };
             }
+        },
+        {
+            key: "fetchChannelMessages",
+            value: /**
+     * Fetches a page of a channel's message history.
+     *
+     * Goes through the REST client rather than `client.channels.fetch(...).messages.fetch(...)` for
+     * three reasons: it needs no gateway session (only a token), `@discordjs/rest` already applies
+     * Discord's per-route bucket rate limiting and 429 retries, and the returned `APIMessage` is plain
+     * JSON rather than a discord.js `Message` carrying a live client back-reference.
+     *
+     * Pair with `discordScanMessagesFactory` from `@dereekb/discord` to walk a channel's history.
+     *
+     * @param input - The channel to read and the pagination filter to read it with.
+     * @returns The page of messages, newest-first.
+     *
+     * @example
+     * ```ts
+     * const page = await discordApi.fetchChannelMessages({ channelId, limit: 50 });
+     * ```
+     */ function fetchChannelMessages(input) {
+                return _async_to_generator$4(function() {
+                    var channelId, before, after, around, limit, query, data;
+                    return _ts_generator$4(this, function(_state) {
+                        switch(_state.label){
+                            case 0:
+                                channelId = input.channelId, before = input.before, after = input.after, around = input.around, limit = input.limit;
+                                query = new URLSearchParams();
+                                if (before) {
+                                    query.set('before', before);
+                                }
+                                if (after) {
+                                    query.set('after', after);
+                                }
+                                if (around) {
+                                    query.set('around', around);
+                                }
+                                if (limit != null) {
+                                    query.set('limit', String(limit));
+                                }
+                                return [
+                                    4,
+                                    this.client.rest.get(Routes.channelMessages(channelId), {
+                                        query: query
+                                    })
+                                ];
+                            case 1:
+                                data = _state.sent();
+                                return [
+                                    2,
+                                    {
+                                        data: data
+                                    }
+                                ];
+                        }
+                    });
+                }).call(this);
+            }
         }
     ]);
     return DiscordApi;
@@ -425,9 +489,36 @@ DiscordApi = __decorate([
     __param(0, Inject(DiscordServiceConfig))
 ], DiscordApi);
 
+function _array_like_to_array$2(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _array_without_holes$2(arr) {
+    if (Array.isArray(arr)) return _array_like_to_array$2(arr);
+}
 function _class_call_check$6(instance, Constructor) {
     if (!(instance instanceof Constructor)) throw new TypeError("Cannot call a class as a function");
 }
+function _iterable_to_array$2(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) {
+        return Array.from(iter);
+    }
+}
+function _non_iterable_spread$2() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _to_consumable_array$2(arr) {
+    return _array_without_holes$2(arr) || _iterable_to_array$2(arr) || _unsupported_iterable_to_array$2(arr) || _non_iterable_spread$2();
+}
+function _unsupported_iterable_to_array$2(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _array_like_to_array$2(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array$2(o, minLen);
+}
 /**
  * Factory that creates a DiscordServiceConfig from environment variables.
  *
@@ -475,6 +566,36 @@ DiscordModule = __decorate([
         ]
     })
 ], DiscordModule);
+/**
+ * Convenience function used to generate ModuleMetadata for an app's DiscordModule.
+ *
+ * Mirrors `appDiscordOAuthModuleMetadata`, letting an app supply its own config factory
+ * instead of re-declaring the whole provider.
+ *
+ * @param config - The module metadata configuration including an optional config factory.
+ * @returns NestJS ModuleMetadata for registering the DiscordModule.
+ */ function appDiscordModuleMetadata(config) {
+    var _config_discordServiceConfigFactory;
+    var imports = config.imports, exports = config.exports, providers = config.providers;
+    return {
+        imports: [
+            ConfigModule
+        ].concat(_to_consumable_array$2(imports !== null && imports !== void 0 ? imports : [])),
+        exports: [
+            DiscordApi
+        ].concat(_to_consumable_array$2(exports !== null && exports !== void 0 ? exports : [])),
+        providers: [
+            {
+                provide: DiscordServiceConfig,
+                inject: [
+                    ConfigService
+                ],
+                useFactory: (_config_discordServiceConfigFactory = config.discordServiceConfigFactory) !== null && _config_discordServiceConfigFactory !== void 0 ? _config_discordServiceConfigFactory : discordServiceConfigFactory
+            },
+            DiscordApi
+        ].concat(_to_consumable_array$2(providers !== null && providers !== void 0 ? providers : []))
+    };
+}
 
 function _array_like_to_array$1(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
@@ -484,6 +605,17 @@ function _array_like_to_array$1(arr, len) {
 function _array_without_holes$1(arr) {
     if (Array.isArray(arr)) return _array_like_to_array$1(arr);
 }
+function _define_property$6(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else obj[key] = value;
+    return obj;
+}
 function _iterable_to_array$1(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) {
         return Array.from(iter);
@@ -492,6 +624,39 @@ function _iterable_to_array$1(iter) {
 function _non_iterable_spread$1() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
+function _object_spread$2(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property$6(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys$2(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props$2(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    else {
+        ownKeys$2(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
 function _to_consumable_array$1(arr) {
     return _array_without_holes$1(arr) || _iterable_to_array$1(arr) || _unsupported_iterable_to_array$1(arr) || _non_iterable_spread$1();
 }
@@ -536,6 +701,32 @@ function _unsupported_iterable_to_array$1(o, minLen) {
         intents: _to_consumable_array$1(DEFAULT_DISCORD_INTENTS).concat(_to_consumable_array$1(additionalIntents))
     };
 }
+/**
+ * Creates a {@link DiscordFetchMessagePageFetchFunction} bound to a single channel.
+ *
+ * This is the bridge between the `DiscordApi` REST client and the fetch-only scanning/pagination
+ * utilities in `@dereekb/discord`, which take an injected fetch function and know nothing about
+ * discord.js or a bot token.
+ *
+ * @param discordApi - The api to fetch messages through.
+ * @param channelId - The channel to read messages from.
+ * @returns A fetch function that pages through that channel's messages.
+ *
+ * @example
+ * ```ts
+ * const scan = discordScanMessagesFactory({
+ *   fetch: discordApiChannelMessagesFetchFunction(discordApi, channelId)
+ * });
+ *
+ * await scan({ baseInput: {}, afterMessageId, handleMessages });
+ * ```
+ */ function discordApiChannelMessagesFetchFunction(discordApi, channelId) {
+    return function(input) {
+        return discordApi.fetchChannelMessages(_object_spread_props$2(_object_spread$2({}, input), {
+            channelId: channelId
+        }));
+    };
+}
 
 function _class_call_check$5(instance, Constructor) {
     if (!(instance instanceof Constructor)) throw new TypeError("Cannot call a class as a function");
@@ -900,6 +1091,19 @@ function _ts_generator$3(thisArg, body) {
                 return readCurrentUser(this.oauthContext);
             }
         },
+        {
+            key: "revokeToken",
+            get: /**
+     * Configured pass-through for {@link revokeToken}.
+     *
+     * Ends Discord's side of the authorization. Deleting the stored credentials alone leaves the grant
+     * live at Discord, so a token captured before the disconnect stays usable.
+     *
+     * @returns Function to revoke an access or refresh token.
+     */ function get() {
+                return revokeToken(this.oauthContext);
+            }
+        },
         {
             /**
      * Builds a {@link DiscordOAuthAuthorizeUrlFactory} for the app's client id.
@@ -1853,4 +2057,4 @@ DiscordWebhookModule = __decorate([
     })
 ], DiscordWebhookModule);
 
-export { DEFAULT_DISCORD_INTENTS, DISCORD_BOT_TOKEN_ENV_VAR, DISCORD_BOT_TOKEN_PLACEHOLDER, DISCORD_CLIENT_ID_CONFIG_KEY, DISCORD_CLIENT_SECRET_CONFIG_KEY, DISCORD_ED25519_PUBLIC_KEY_BYTE_LENGTH, DISCORD_PUBLIC_KEY_ENV_VAR, DISCORD_SERVICE_NAME, DiscordApi, DiscordModule, DiscordOAuthApi, DiscordOAuthServiceConfig, DiscordServiceConfig, DiscordWebhookController, DiscordWebhookModule, DiscordWebhookService, DiscordWebhookServiceConfig, appDiscordOAuthModuleMetadata, discordClientOptionsWithIntents, discordDefaultClientOptions, discordInteractionHandlerConfigurerFactory, discordInteractionHandlerFactory, discordOAuthServiceConfigFactory, discordServiceConfigFactory, discordWebhookEventVerifier, discordWebhookInteraction, discordWebhookServiceConfigFactory, isUsableDiscordBotToken };
+export { DEFAULT_DISCORD_INTENTS, DISCORD_BOT_TOKEN_ENV_VAR, DISCORD_BOT_TOKEN_PLACEHOLDER, DISCORD_CLIENT_ID_CONFIG_KEY, DISCORD_CLIENT_SECRET_CONFIG_KEY, DISCORD_ED25519_PUBLIC_KEY_BYTE_LENGTH, DISCORD_PUBLIC_KEY_ENV_VAR, DISCORD_SERVICE_NAME, DiscordApi, DiscordModule, DiscordOAuthApi, DiscordOAuthServiceConfig, DiscordServiceConfig, DiscordWebhookController, DiscordWebhookModule, DiscordWebhookService, DiscordWebhookServiceConfig, appDiscordModuleMetadata, appDiscordOAuthModuleMetadata, discordApiChannelMessagesFetchFunction, discordClientOptionsWithIntents, discordDefaultClientOptions, discordInteractionHandlerConfigurerFactory, discordInteractionHandlerFactory, discordOAuthServiceConfigFactory, discordServiceConfigFactory, discordWebhookEventVerifier, discordWebhookInteraction, discordWebhookServiceConfigFactory, isUsableDiscordBotToken };

package/nestjs/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/discord/nestjs",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "type": "module",
   "peerDependencies": {
-    "@dereekb/discord": "14.0.0",
-    "@dereekb/nestjs": "14.0.0",
-    "@dereekb/rxjs": "14.0.0",
-    "@dereekb/util": "14.0.0",
+    "@dereekb/discord": "14.1.0",
+    "@dereekb/nestjs": "14.1.0",
+    "@dereekb/rxjs": "14.1.0",
+    "@dereekb/util": "14.1.0",
     "@nestjs/common": "^12.0.1",
     "@nestjs/config": "^12.0.0",
     "discord.js": "^14.26.3",

package/nestjs/src/lib/discord/discord.api.d.ts

@@ -1,7 +1,18 @@
-import { Client, type Message } from 'discord.js';
+import { type APIMessage, Client, type Message } from 'discord.js';
 import { type OnModuleDestroy, type OnModuleInit } from '@nestjs/common';
 import { DiscordServiceConfig } from './discord.config';
-import { type DiscordChannelId } from '@dereekb/discord';
+import { type DiscordChannelId, type DiscordMessagePageFilter, type DiscordMessagePageResult } from '@dereekb/discord';
+/**
+ * Input for {@link DiscordApi.fetchChannelMessages}.
+ *
+ * Extends the shared pagination filter with the channel to read from.
+ */
+export interface DiscordFetchChannelMessagesInput extends DiscordMessagePageFilter {
+    /**
+     * The channel to read messages from.
+     */
+    readonly channelId: DiscordChannelId;
+}
 /**
  * Injectable service that wraps the discord.js Client for bot operations.
  *
@@ -66,4 +77,23 @@ export declare class DiscordApi implements OnModuleInit, OnModuleDestroy {
      * @returns An unsubscribe function that removes the registered handler.
      */
     onMessage(handler: (message: Message) => void): () => void;
+    /**
+     * Fetches a page of a channel's message history.
+     *
+     * Goes through the REST client rather than `client.channels.fetch(...).messages.fetch(...)` for
+     * three reasons: it needs no gateway session (only a token), `@discordjs/rest` already applies
+     * Discord's per-route bucket rate limiting and 429 retries, and the returned `APIMessage` is plain
+     * JSON rather than a discord.js `Message` carrying a live client back-reference.
+     *
+     * Pair with `discordScanMessagesFactory` from `@dereekb/discord` to walk a channel's history.
+     *
+     * @param input - The channel to read and the pagination filter to read it with.
+     * @returns The page of messages, newest-first.
+     *
+     * @example
+     * ```ts
+     * const page = await discordApi.fetchChannelMessages({ channelId, limit: 50 });
+     * ```
+     */
+    fetchChannelMessages(input: DiscordFetchChannelMessagesInput): Promise<DiscordMessagePageResult<APIMessage>>;
 }

package/nestjs/src/lib/discord/discord.module.d.ts

@@ -1,3 +1,4 @@
+import { type ModuleMetadata } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { DiscordServiceConfig } from './discord.config';
 /**
@@ -18,3 +19,28 @@ export declare function discordServiceConfigFactory(configService: ConfigService
  */
 export declare class DiscordModule {
 }
+/**
+ * Factory that creates a {@link DiscordServiceConfig} from the app's config service.
+ */
+export type DiscordServiceConfigFactory = (configService: ConfigService) => DiscordServiceConfig;
+export interface ProvideAppDiscordMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
+    /**
+     * Optional override for the DiscordServiceConfigFactory.
+     *
+     * An app that only uses the REST api should supply a factory with `autoLogin: false`, so a cold
+     * start never opens a gateway websocket it will not use.
+     *
+     * @default discordServiceConfigFactory
+     */
+    readonly discordServiceConfigFactory?: DiscordServiceConfigFactory;
+}
+/**
+ * Convenience function used to generate ModuleMetadata for an app's DiscordModule.
+ *
+ * Mirrors `appDiscordOAuthModuleMetadata`, letting an app supply its own config factory
+ * instead of re-declaring the whole provider.
+ *
+ * @param config - The module metadata configuration including an optional config factory.
+ * @returns NestJS ModuleMetadata for registering the DiscordModule.
+ */
+export declare function appDiscordModuleMetadata(config: ProvideAppDiscordMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/discord/discord.util.d.ts

@@ -1,4 +1,6 @@
-import { type GatewayIntentBits, type ClientOptions } from 'discord.js';
+import { type APIMessage, type GatewayIntentBits, type ClientOptions } from 'discord.js';
+import { type DiscordApi } from './discord.api';
+import { type DiscordChannelId, type DiscordFetchMessagePageFetchFunction, type DiscordMessagePageFilter } from '@dereekb/discord';
 /**
  * Returns default ClientOptions for a bot that reads guild messages.
  *
@@ -26,3 +28,24 @@ export declare function discordDefaultClientOptions(): Partial<ClientOptions>;
  * ```
  */
 export declare function discordClientOptionsWithIntents(additionalIntents: GatewayIntentBits[]): Partial<ClientOptions>;
+/**
+ * Creates a {@link DiscordFetchMessagePageFetchFunction} bound to a single channel.
+ *
+ * This is the bridge between the `DiscordApi` REST client and the fetch-only scanning/pagination
+ * utilities in `@dereekb/discord`, which take an injected fetch function and know nothing about
+ * discord.js or a bot token.
+ *
+ * @param discordApi - The api to fetch messages through.
+ * @param channelId - The channel to read messages from.
+ * @returns A fetch function that pages through that channel's messages.
+ *
+ * @example
+ * ```ts
+ * const scan = discordScanMessagesFactory({
+ *   fetch: discordApiChannelMessagesFetchFunction(discordApi, channelId)
+ * });
+ *
+ * await scan({ baseInput: {}, afterMessageId, handleMessages });
+ * ```
+ */
+export declare function discordApiChannelMessagesFetchFunction(discordApi: DiscordApi, channelId: DiscordChannelId): DiscordFetchMessagePageFetchFunction<DiscordMessagePageFilter, APIMessage>;

package/nestjs/src/lib/oauth/oauth.api.d.ts

@@ -43,6 +43,15 @@ export declare class DiscordOAuthApi {
      * @returns Function to read the Discord user an access token belongs to.
      */
     get readCurrentUser(): (input: import("@dereekb/discord").DiscordOAuthReadCurrentUserInput) => Promise<import("@dereekb/discord").DiscordOAuthCurrentUser>;
+    /**
+     * Configured pass-through for {@link revokeToken}.
+     *
+     * Ends Discord's side of the authorization. Deleting the stored credentials alone leaves the grant
+     * live at Discord, so a token captured before the disconnect stays usable.
+     *
+     * @returns Function to revoke an access or refresh token.
+     */
+    get revokeToken(): (input: import("@dereekb/discord").DiscordOAuthRevokeTokenInput) => Promise<void>;
     /**
      * Builds a {@link DiscordOAuthAuthorizeUrlFactory} for the app's client id.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/discord",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -17,9 +17,9 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/nestjs": "14.0.0",
-    "@dereekb/rxjs": "14.0.0",
-    "@dereekb/util": "14.0.0",
+    "@dereekb/nestjs": "14.1.0",
+    "@dereekb/rxjs": "14.1.0",
+    "@dereekb/util": "14.1.0",
     "@nestjs/common": "^12.0.1",
     "@nestjs/config": "^12.0.0",
     "discord.js": "^14.26.3",