@nativewrappers/common 0.0.87 → 0.0.89

package/Command.d.ts

@@ -23,8 +23,33 @@ export declare class Command<T extends Parameter[] = Parameter[]> {
     readonly name: string | string[];
     readonly help: string;
     readonly params?: T | undefined;
+    /**
+     * Registers a new executable command with optional parameter validation and permission restrictions.
+     * @param name The unique identifier(s) for the command, either as a single string or an array of strings.
+     * @param help A description of the command, displayed as a chat suggestion.
+     * @param handler The function to execute when the command is executed.
+     * @param params An optional array of parameter definitions specifying the command's expected arguments,
+     *               including their names, types, and descriptive help text for chat suggestions.
+     * @param restricted Determines the command's access permissions:
+     *                   - Defaults to `true`, restricting usage to users with the "command.commandName" ACE permission.
+     *                   - A string such as `"group.admin"` grants the command permission to the specified principal.
+     *                   - An array of strings grants permission to multiple principals.
+     */
     constructor(name: string | string[], help: string, handler: CommandHandler<T>, params?: T | undefined, restricted?: Restricted);
+    /**
+     * Maps the arguments received from a command call to the defined parameters while validating the argument types.
+     * @param source The client that executed the command, or -1 if executed by the server.
+     * @param args The arguments passed to the command.
+     * @param raw The raw input string passed to the command.
+     * @returns A mapped object containing parsed parameters.
+     */
     private mapArguments;
+    /**
+     * Executes the command with the given arguments and source, validating and mapping the arguments before calling the handler.
+     * @param source The client that executed the command.
+     * @param args The arguments passed to the command.
+     * @param raw The raw input string passed to the command.
+     */
     call(source: number, args: string[], raw?: string): Promise<void>;
 }
 export {};

package/Command.js

@@ -1,17 +1,18 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { GlobalData } from "./GlobalData";
 const commands = [];
 $SERVER: {
   on("playerJoining", () => emitNet("chat:addSuggestions", source, commands));
 }
-function registerCommand(name, commandHandler, restricted) {
+function registerCommand(name, commandHandler, restricted = true) {
   if (Array.isArray(name)) {
     for (const command of name) {
       registerCommand(command, commandHandler, restricted);
     }
     return;
   }
-  RegisterCommand(name, commandHandler, !!restricted);
+  RegisterCommand(name, commandHandler, GlobalData.IS_CLIENT ? false : !!restricted);
   $SERVER: {
     const ace = `command.${name}`;
     if (typeof restricted === "string") {
@@ -27,6 +28,18 @@ function registerCommand(name, commandHandler, restricted) {
 }
 __name(registerCommand, "registerCommand");
 class Command {
+  /**
+   * Registers a new executable command with optional parameter validation and permission restrictions.
+   * @param name The unique identifier(s) for the command, either as a single string or an array of strings.
+   * @param help A description of the command, displayed as a chat suggestion.
+   * @param handler The function to execute when the command is executed.
+   * @param params An optional array of parameter definitions specifying the command's expected arguments,
+   *               including their names, types, and descriptive help text for chat suggestions.
+   * @param restricted Determines the command's access permissions:
+   *                   - Defaults to `true`, restricting usage to users with the "command.commandName" ACE permission.
+   *                   - A string such as `"group.admin"` grants the command permission to the specified principal.
+   *                   - An array of strings grants permission to multiple principals.
+   */
   constructor(name, help, handler, params, restricted = true) {
     this.name = name;
     this.help = help;
@@ -55,6 +68,13 @@ class Command {
     __name(this, "Command");
   }
   #handler;
+  /**
+   * Maps the arguments received from a command call to the defined parameters while validating the argument types.
+   * @param source The client that executed the command, or -1 if executed by the server.
+   * @param args The arguments passed to the command.
+   * @param raw The raw input string passed to the command.
+   * @returns A mapped object containing parsed parameters.
+   */
   mapArguments(source2, args, raw) {
     const mapped = {
       source: source2,
@@ -95,6 +115,12 @@ class Command {
     });
     return result ? mapped : null;
   }
+  /**
+   * Executes the command with the given arguments and source, validating and mapping the arguments before calling the handler.
+   * @param source The client that executed the command.
+   * @param args The arguments passed to the command.
+   * @param raw The raw input string passed to the command.
+   */
   async call(source2, args, raw = args.join(" ")) {
     const parsed = this.mapArguments(source2, args, raw);
     if (!parsed) return;

package/package.json

@@ -8,7 +8,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.87",
+  "version": "0.0.89",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"