@grammyjs/commands 0.9.0 → 0.11.0

package/out/utils/checks.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchesPattern = exports.isCommandOptions = exports.isMiddleware = exports.isAdmin = void 0;
+function isAdmin(ctx) {
+    return ctx
+        .getAuthor()
+        .then((author) => ["administrator", "creator"].includes(author.status));
+}
+exports.isAdmin = isAdmin;
+function isMiddleware(obj) {
+    if (!obj)
+        return false;
+    if (Array.isArray(obj))
+        return obj.every(isMiddleware);
+    const objType = typeof obj;
+    switch (objType) {
+        case "function":
+            return true;
+        case "object":
+            return Object.keys(obj).includes("middleware");
+    }
+    return false;
+}
+exports.isMiddleware = isMiddleware;
+function isCommandOptions(obj) {
+    if (typeof obj !== "object" || !obj)
+        return false;
+    const { prefix, matchOnlyAtStart, targetedCommands, ignoreCase } = obj;
+    if (typeof prefix === "string")
+        return true;
+    if (typeof matchOnlyAtStart === "boolean")
+        return true;
+    if (targetedCommands &&
+        ["ignored", "optional", "required"].includes(targetedCommands))
+        return true;
+    if (typeof ignoreCase === "boolean")
+        return true;
+    return false;
+}
+exports.isCommandOptions = isCommandOptions;
+function matchesPattern(value, pattern, ignoreCase = false) {
+    const transformedValue = ignoreCase ? value.toLowerCase() : value;
+    const transformedPattern = pattern instanceof RegExp && ignoreCase && !pattern.flags.includes("i")
+        ? new RegExp(pattern, pattern.flags + "i")
+        : pattern;
+    return typeof transformedPattern === "string"
+        ? transformedValue === transformedPattern
+        : transformedPattern.test(transformedValue);
+}
+exports.matchesPattern = matchesPattern;

package/out/utils/errors.d.ts

@@ -0,0 +1,12 @@
+import { UncompliantCommand } from "../command-group.js";
+import { BotCommandScope } from "../deps.node.js";
+export declare class InvalidScopeError extends Error {
+    constructor(scope: BotCommandScope);
+}
+export declare class CustomPrefixNotSupportedError extends Error {
+    readonly offendingCommands: string[];
+    constructor(message: string, offendingCommands: string[]);
+}
+export declare class UncompliantCommandsError extends Error {
+    constructor(commands: Array<UncompliantCommand>);
+}

package/out/utils/errors.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UncompliantCommandsError = exports.CustomPrefixNotSupportedError = exports.InvalidScopeError = void 0;
+class InvalidScopeError extends Error {
+    constructor(scope) {
+        super(`Invalid scope: ${scope}`);
+        this.name = "InvalidScopeError";
+    }
+}
+exports.InvalidScopeError = InvalidScopeError;
+class CustomPrefixNotSupportedError extends Error {
+    constructor(message, offendingCommands) {
+        super(message);
+        this.offendingCommands = offendingCommands;
+        this.name = "CustomPrefixNotSupportedError";
+    }
+}
+exports.CustomPrefixNotSupportedError = CustomPrefixNotSupportedError;
+class UncompliantCommandsError extends Error {
+    constructor(commands) {
+        const message = [
+            `Tried to set bot commands with one or more commands that do not comply with the Bot API requirements for command names. Offending command(s):`,
+            commands.map(({ name, reasons, language }) => `- (language: ${language}) ${name}: ${reasons.join(", ")}`)
+                .join("\n"),
+            "If you want to filter these commands out automatically, set `ignoreUncompliantCommands` to `true`",
+        ].join("\n");
+        super(message);
+    }
+}
+exports.UncompliantCommandsError = UncompliantCommandsError;

package/out/{jaro-winkler.d.ts → utils/jaro-winkler.d.ts}

@@ -1,6 +1,6 @@
-import { Commands } from "./commands.js";
-import { Context, LanguageCode } from "./deps.node.js";
-import type { CommandElementals } from "./types.js";
+import { CommandGroup } from "../command-group.js";
+import { Context, LanguageCode } from "../deps.node.js";
+import type { CommandElementals } from "../types.js";
 export declare function distance(s1: string, s2: string): number;
 export type JaroWinklerOptions = {
     ignoreCase?: boolean;
@@ -14,5 +14,5 @@ type CommandSimilarity = {
 };
 export declare function JaroWinklerDistance(s1: string, s2: string, options: Pick<Partial<JaroWinklerOptions>, "ignoreCase">): number;
 export declare function isLanguageCode(value: string | undefined): value is LanguageCode;
-export declare function fuzzyMatch<C extends Context>(userInput: string, commands: Commands<C>, options: Partial<JaroWinklerOptions>): CommandSimilarity | null;
+export declare function fuzzyMatch<C extends Context>(userInput: string, commands: CommandGroup<C>, options: Partial<JaroWinklerOptions>): CommandSimilarity | null;
 export {};

package/out/{jaro-winkler.js → utils/jaro-winkler.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fuzzyMatch = exports.isLanguageCode = exports.JaroWinklerDistance = exports.distance = void 0;
-const deps_node_js_1 = require("./deps.node.js");
+const deps_node_js_1 = require("../deps.node.js");
 function distance(s1, s2) {
     if (s1.length === 0 || s2.length === 0) {
         return 0;
@@ -102,9 +102,7 @@ function fuzzyMatch(userInput, commands, options) {
      * https://en.wikipedia.org/wiki/IETF_language_tag
      */
     const possiblyISO639 = (_a = options.language) === null || _a === void 0 ? void 0 : _a.split("-")[0];
-    const language = isLanguageCode(possiblyISO639)
-        ? possiblyISO639
-        : undefined;
+    const language = isLanguageCode(possiblyISO639) ? possiblyISO639 : undefined;
     const cmds = options.ignoreLocalization
         ? commands.toElementals()
         : commands.toElementals(language);
@@ -112,9 +110,7 @@ function fuzzyMatch(userInput, commands, options) {
         const similarity = JaroWinklerDistance(userInput, command.name, {
             ...options,
         });
-        return similarity > best.similarity
-            ? { command, similarity }
-            : best;
+        return similarity > best.similarity ? { command, similarity } : best;
     }, { command: null, similarity: 0 });
     return bestMatch.similarity > similarityThreshold ? bestMatch : null;
 }

package/out/utils/set-bot-commands.d.ts

@@ -0,0 +1,24 @@
+import { SetMyCommandsParams, UncompliantCommand } from "../command-group.js";
+import { Api } from "../deps.node.js";
+/**
+ * Options for the `setBotCommands` function.
+ */
+export interface SetBotCommandsOptions {
+    /**
+     * Whether to remove invalid commands from the list of calls to the Bot API.
+     *
+     * If set to `false`, the method will throw an error if any of the commands
+     * is invalid according to the {@link https://core.telegram.org/bots/api#botcommand|official Bot API documentation}.
+     *
+     * Defaults to `false`.
+     */
+    ignoreUncompliantCommands?: boolean;
+}
+/**
+ * Performs validation and sets the provided commands for the bot.
+ * @param api Instance of the Api class for the bot the commands are being set for.
+ * @param commandParams List of commands to set.
+ * @param uncompliantCommands List of commands that do not comply with the Bot API rules.
+ * @param options Options object`
+ */
+export declare function setBotCommands(api: Api, commandParams: SetMyCommandsParams[], uncompliantCommands: UncompliantCommand[], options?: Partial<SetBotCommandsOptions>): Promise<void>;

package/out/utils/set-bot-commands.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setBotCommands = void 0;
+const errors_js_1 = require("./errors.js");
+/**
+ * Performs validation and sets the provided commands for the bot.
+ * @param api Instance of the Api class for the bot the commands are being set for.
+ * @param commandParams List of commands to set.
+ * @param uncompliantCommands List of commands that do not comply with the Bot API rules.
+ * @param options Options object`
+ */
+async function setBotCommands(api, commandParams, uncompliantCommands, options) {
+    const { ignoreUncompliantCommands = false } = options !== null && options !== void 0 ? options : {};
+    if (uncompliantCommands.length && !ignoreUncompliantCommands) {
+        throw new errors_js_1.UncompliantCommandsError(uncompliantCommands);
+    }
+    await Promise.all(commandParams.map((args) => api.raw.setMyCommands(args)));
+}
+exports.setBotCommands = setBotCommands;

package/package.json

@@ -1,30 +1,30 @@
 {
-    "name": "@grammyjs/commands",
-    "version": "0.9.0",
-    "description": "grammY Commands Plugin",
-    "main": "out/mod.js",
-    "scripts": {
-        "backport": "deno task backport",
-        "prepare": "deno task backport"
-    },
-    "keywords": [
-        "grammY",
-        "telegram",
-        "bot",
-        "commands"
-    ],
-    "author": "Roz <roz@rjmunhoz.me>",
-    "license": "MIT",
-    "dependencies": {
-        "@grammyjs/types": "^3.8.1",
-        "grammy": "^1.17.1",
-        "ts-pattern": "^5.0.1"
-    },
-    "devDependencies": {
-        "deno-bin": "^1.45.2",
-        "typescript": "^5.1.6"
-    },
-    "files": [
-        "out"
-    ]
+  "name": "@grammyjs/commands",
+  "version": "0.11.0",
+  "description": "grammY Commands Plugin",
+  "main": "out/mod.js",
+  "scripts": {
+    "backport": "deno task backport",
+    "prepare": "deno task backport"
+  },
+  "keywords": [
+    "grammY",
+    "telegram",
+    "bot",
+    "commands"
+  ],
+  "author": "Roz <roz@rjmunhoz.me>",
+  "license": "MIT",
+  "dependencies": {
+    "@grammyjs/types": "^3.8.1",
+    "grammy": "^1.17.1",
+    "ts-pattern": "^5.0.1"
+  },
+  "devDependencies": {
+    "deno-bin": "^1.45.2",
+    "typescript": "^5.1.6"
+  },
+  "files": [
+    "out"
+  ]
 }

package/out/errors.d.ts

@@ -1,4 +0,0 @@
-import { BotCommandScope } from "./deps.node.js";
-export declare class InvalidScopeError extends Error {
-    constructor(scope: BotCommandScope);
-}

package/out/errors.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidScopeError = void 0;
-class InvalidScopeError extends Error {
-    constructor(scope) {
-        super(`Invalid scope: ${scope}`);
-        this.name = "InvalidScopeError";
-    }
-}
-exports.InvalidScopeError = InvalidScopeError;

package/out/utils.d.ts

@@ -1,2 +0,0 @@
-export type MaybeArray<T> = T | T[];
-export declare const ensureArray: <T>(value: MaybeArray<T>) => T[];

package/out/utils.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureArray = void 0;
-const ensureArray = (value) => Array.isArray(value) ? value : [value];
-exports.ensureArray = ensureArray;