@grey-ts/types 2.0.1 → 2.2.0

package/dist/index.d.ts

@@ -233,7 +233,7 @@ declare namespace GreyHack {
          *
          * If the provided username is empty, an error will be thrown, preventing any further script execution.
          */
-        changePassword(username: string, password: string): boolean | string;
+        changePassword(username: string, password: string): true | string;
         /**
          * Closes a program associated with the provided PID.
          *
@@ -457,7 +457,7 @@ declare namespace GreyHack {
          *
          * If this method is used within an SSH encryption process, the new name exceeds 128 characters, or the path is too long, an error will be thrown, causing an interruption of script execution. In case the current file gets deleted, this method will return null.
          */
-        copy(destFolder?: string, newName?: string): string | boolean | null;
+        copy(destFolder?: string, newName?: string): string | true | null;
         /**
          * Delete the current file.
          *
@@ -466,7 +466,8 @@ declare namespace GreyHack {
          * Note that deleting a file will leave a log entry.
          */
         delete(): string;
-        /** Returns a boolean indicating if the user who launched the script has the requested permissions.
+        /**
+         * Returns a boolean indicating if the user who launched the script has the requested permissions.
          *
          * In case the file gets deleted, this method will return null instead.
          */
@@ -484,7 +485,7 @@ declare namespace GreyHack {
          *
          * If this method is used within an SSH encryption process, the new name exceeds 128 characters, or the path is too long, an error will be thrown, causing an interruption of script execution. In case the current file gets deleted, this method will return null.
          */
-        move(destFolder: string, newName?: string): string | boolean | null;
+        move(destFolder: string, newName?: string): string | true | null;
         /**
          * Returns a string containing the file path. If the file has been deleted, this method will still return the path it had prior to deletion.
          * @param symLinkOriginalPath return the original path of the linked file instead
@@ -598,7 +599,8 @@ declare namespace GreyHack {
      * Using this method in a SSH encryption process will cause an error to be thrown preventing further script execution.
      */
     function getCustomObject<T = object>(): T & Record<string, any>;
-    /** Returns by default the {@link Router router} to which the executing computer is connected to.
+    /**
+     * Returns by default the {@link Router router} to which the executing computer is connected to.
      *
      * Optionally an IP address can be provided. In case of failure `null` is returned.
      *
@@ -620,7 +622,8 @@ declare namespace GreyHack {
      */
     function getShell(): Shell;
     function getShell(username?: string, password?: string): Shell | null;
-    /** Returns the switch on the local network whose IP address matches
+    /**
+     * Returns the switch on the local network whose IP address matches
      * @example
      * const switch = getSwitch("192.168.1.4");
      * if (switch) print("This device is a switch!");
@@ -753,7 +756,8 @@ declare namespace GreyHack {
     function yield(): null;
     /** Returns the type of the object */
     function getType(value: any): string;
-    /** Checks if the given object is of a specific type
+    /**
+     * Checks if the given object is of a specific type
      * @example
      * const metax = includeLib("/lib/metaxploit.so");
      * if (isType(metax, "MetaxploitLib")) {
@@ -923,13 +927,15 @@ declare namespace GreyHack {
          * If the launch was successful, true will be returned. In case of failure, a string with details will be returned.
          */
         rshellClient(ip: string, port: number, processName?: string): true | string;
-        /** This method returns an array of {@link Shell} objects that have been reverse shell connected to this computer.
+        /**
+         * This method returns an array of {@link Shell} objects that have been reverse shell connected to this computer.
          *
          * To manage the connections received, the rshell service must be installed on the machine that receives the victims' connections.
          *
          * In case of failure a string will be returned with details. */
         rshellServer(): Shell[] | string;
-        /** Returns an array where each item is a string representing a memory area which has vulnerabilities related to the provided library.
+        /**
+         * Returns an array where each item is a string representing a memory area which has vulnerabilities related to the provided library.
          *
          * These memory areas can be used to make further scans via {@link Metaxploit.scanAddress}.
          *
@@ -1018,37 +1024,48 @@ declare namespace GreyHack {
     }
     interface DebugLibrary {
         classID: "debugLibrary";
-        /** Applies a patch containing corrected code to the specified text file at the provided path.
+        /**
+         * Applies a patch containing corrected code to the specified text file at the provided path.
          *
-         * Returns a string with the result of the operation. */
+         * Returns a string with the result of the operation.
+         */
         applyPatch(path: string): string;
-        /** Returns a list containing a single partial computer object if zero-day vulnerabilities are detected within the specified memory zone.
+        /**
+         * Returns a list containing a single partial computer object if zero-day vulnerabilities are detected within the specified memory zone.
          *
          * If a file path is provided, a partial file object associated with this path will also be included in the array.
          *
          * Additionally, if this file is a library, its corresponding metaLib object is added to the returned array.
          *
-         * In case of an error, a string with details is returned. */
+         * In case of an error, a string with details is returned.
+         */
         payload(memZone: string): string | [Partial<Computer>];
         payload(memZone: string, filePath: string): string | [Partial<Computer>, Partial<File>] | [Partial<Computer>, Partial<File>, MetaLib];
-        /** Scans the library in debug mode to identify potential code errors that may lead to vulnerabilities.
+        /**
+         * Scans the library in debug mode to identify potential code errors that may lead to vulnerabilities.
          *
-         * If issues are detected, the relevant code snippets are printed. In case of an error, a string containing the error message is returned. */
+         * If issues are detected, the relevant code snippets are printed. In case of an error, a string containing the error message is returned.
+         */
         scan(): string;
-        /** Conducts automated tests on the specified lines of code.
+        /**
+         * Conducts automated tests on the specified lines of code.
          *
          * If potential vulnerabilities are detected due to errors in these lines, this method will print partial objects that could be obtained by exploiting the vulnerability, along with the affected memory zone and detailed vulnerability information.
          *
-         * In case of failure, this function returns a string with an error message. */
+         * In case of failure, this function returns a string with an error message.
+         */
         unitTesting(errorLines: number[]): string;
     }
     interface Crypto {
         classID: "cryptoLib";
-        /** Returns a string containing the password based on the file which was generated via aireplay.
+        /**
+         * Returns a string containing the password based on the file which was generated via aireplay.
          *
-         * In case of failure, it will return null instead. If the provided path is empty, an error will be thrown, interrupting the script execution. */
+         * In case of failure, it will return null instead. If the provided path is empty, an error will be thrown, interrupting the script execution.
+         */
         aircrack(path: string): string | null;
-        /** Used to inject frames on wireless interfaces.
+        /**
+         * Used to inject frames on wireless interfaces.
          *
          * Once the command with `Control+C` is stopped, it will save the captured information in a text file called `file.cap` in the path where the terminal is currently located.
          *
@@ -1058,15 +1075,19 @@ declare namespace GreyHack {
          *
          * If there is an error, a string will be returned with the message indicating the problem. On success, it will return null, it is advised though to verify that the capture file actually exists.
          *
-         * In case any of the provided values deviate from the signature types or bssid/essid is empty, an error will be thrown preventing any further script execution. */
+         * In case any of the provided values deviate from the signature types or bssid/essid is empty, an error will be thrown preventing any further script execution.
+         */
         aireplay(bssid: string, essid: string, maxAcks?: number): string | null;
-        /** Enables or disables the monitor mode of a network device.
+        /**
+         * Enables or disables the monitor mode of a network device.
          *
          * Monitor mode can only be enabled on Wifi cards.
          *
-         * If it wasn't possible to enable or disable the monitor mode, this method will return either false or a string with details. In case of success, it will return true. */
+         * If it wasn't possible to enable or disable the monitor mode, this method will return either false or a string with details. In case of success, it will return true.
+         */
         airmon(option: "start" | "stop", device: netDevice): boolean | string;
-        /** Returns a decrypted password via the provided password MD5 hash.
+        /**
+         * Returns a decrypted password via the provided password MD5 hash.
          *
          * Keep in mind that this method is not decrypting a password but rather checking for existing passwords within the game world with a matching MD5 hash.
          *
@@ -1092,28 +1113,37 @@ declare namespace GreyHack {
          * }
          */
         decipher(hash: string): string | null;
-        /** Decrypts the specified file using the provided key.
+        /**
+         * Decrypts the specified file using the provided key.
          *
-         * On success, the method returns true. If decryption fails, a descriptive error message is returned as a string. */
+         * On success, the method returns true. If decryption fails, a descriptive error message is returned as a string.
+         */
         decrypt(filePath: string, password: string): true | string;
-        /** Encrypts the specified file using the provided key.
+        /**
+         * Encrypts the specified file using the provided key.
          *
-         * On success, the method returns true. If encryption fails, a descriptive error message is returned as a string. */
+         * On success, the method returns true. If encryption fails, a descriptive error message is returned as a string.
+         */
         encrypt(filePath: string, password: string): true | string;
-        /** Checks whether the specified file is encrypted.
+        /**
+         * Checks whether the specified file is encrypted.
          *
-         * Returns true if the file is encrypted, or zero if it is not. If the check fails (e.g., due to a missing or unreadable file), a descriptive error message is returned as a string. */
+         * Returns true if the file is encrypted, or false if it is not. If the check fails (e.g., due to a missing or unreadable file), a descriptive error message is returned as a string.
+         */
         isEncrypted(filePath: string): boolean | string;
-        /** Returns an array of the existing users on the computer where the SMTP service is running.
+        /**
+         * Returns an array of the existing users on the computer where the SMTP service is running.
          *
          * If these users also have an email account registered on the SMTP server, it will be indicated in the array.
          *
-         * SMTP services are usually running on port 25. In case of failure, this method will return a string containing the cause.  */
+         * SMTP services are usually running on port 25. In case of failure, this method will return a string containing the cause.
+         */
         smtpUserList(ip: string, port: number): string[] | string;
     }
     interface BlockChain {
         classID: "blockchainLib";
-        /**  Returns a number representing the total amount of mined coins.
+        /**
+         * Returns a number representing the total amount of mined coins.
          *
          * In case of an error, it will return a string with the details.
          * @example
@@ -1128,105 +1158,138 @@ declare namespace GreyHack {
          * print(`There are ${mined} coins mined for this coin`);
          */
         amountMined(coinName: string): number | string;
-        /** Returns a number representing the current unit value of the cryptocurrency.
+        /**
+         * Returns a number representing the current unit value of the cryptocurrency.
          *
-         * In case of an error, a string with the error details will be returned. */
+         * In case of an error, a string with the error details will be returned.
+         */
         coinPrice(coinName: string): number | string;
-        /** Creates a wallet and returns a wallet object on success, which can be used to manage cryptocurrencies.
+        /**
+         * Creates a wallet and returns a wallet object on success, which can be used to manage cryptocurrencies.
          *
-         * In case of an error, it will return a string with the details. */
+         * In case of an error, it will return a string with the details.
+         */
         createWallet(user: string, password: string): Wallet | string;
-        /** Removes a cryptocurrency from the world. The credentials used in the creation of the cryptocurrency are required.
+        /**
+         * Removes a cryptocurrency from the world. The credentials used in the creation of the cryptocurrency are required.
          *
          * On success, it will return a true.
          *
-         * On failure, it will return a string containing details. */
+         * On failure, it will return a string containing details.
+         */
         deleteCoin(coinName: string, user: string, password: string): true | string;
-        /** Returns a coin object used to manage the currency.
+        /**
+         * Returns a coin object used to manage the currency.
          *
-         * In case of an error, it will return a string with the details. */
+         * In case of an error, it will return a string with the details.
+         */
         getCoin(coinName: string, user: string, password: string): Coin | string;
-        /** Returns a string with the name of the coin owned by the player.
+        /**
+         * Returns a string with the name of the coin owned by the player.
          *
-         * In case of an error, it returns a string with details. */
+         * In case of an error, it returns a string with details.
+         */
         getCoinName(user: string, password: string): string;
         /** Returns a wallet object on success. In case of an error, it will return a string indicating the reason. */
         loginWallet(user: string, password: string): Wallet | string;
-        /** Returns an object with the latest changes in the value of a specific cryptocurrency.
+        /**
+         * Returns an object with the latest changes in the value of a specific cryptocurrency.
          *
          * The key of the object is an index represented by a number. The value is an array, where index 0 is the historical price of the coin and index 1 is the date when the price change occurred.
          *
-         * If no coin exists with this name, the method will return null. */
+         * If no coin exists with this name, the method will return null.
+         */
         showHistory(coinName: string): Record<number, [number, string]> | string | null;
     }
     interface AptClient {
         classID: "aptClientLib";
-        /** Inserts a repository address into the `/etc/apt/sources.txt` file.
+        /**
+         * Inserts a repository address into the `/etc/apt/sources.txt` file.
          *
          * On success, it will return an empty string. In case of failure, it will return a string with an error message.
         */
         addRepo(repositoryAddress: string, port?: number): string;
-        /** Checks if there is a newer version of the program or library in the repository.
+        /**
+         * Checks if there is a newer version of the program or library in the repository.
          *
          * On success, it will return a boolean, with false indicating that there is no new version, while true indicates that there is a new version available.
          *
-         * In case of failure, it will return a string containing an error message. */
+         * In case of failure, it will return a string containing an error message.
+         */
         checkUpgrade(filePath: string): boolean | string;
-        /** Deletes a repository address from the `/etc/apt/sources.txt` file.
+        /**
+         * Deletes a repository address from the `/etc/apt/sources.txt` file.
          *
-         * On success, it will return an empty string. In case of failure, it will return a string with an error message. */
+         * On success, it will return an empty string. In case of failure, it will return a string with an error message.
+         */
         delRepo(repositoryAddress: string): string;
-        /** Installs a program or library from a remote repository listed in `/etc/apt/sources.txt`.
+        /**
+         * Installs a program or library from a remote repository listed in `/etc/apt/sources.txt`.
          *
          * If no path is specified, the program installs in `/lib` if it is a library or in `/bin` otherwise.
          *
-         * On success, this method will return true. In case of failure, it will return a string containing an error message. */
+         * On success, this method will return true. In case of failure, it will return a string containing an error message.
+         */
         install(package: string, installPath?: string): true | string;
-        /** Search specifically looks for a package in any of the repositories listed in `/etc/apt/sources.txt`.
+        /**
+         * Search specifically looks for a package in any of the repositories listed in `/etc/apt/sources.txt`.
          *
          * On success, it will return a string containing all packages that partially match the provided search value.
          *
-         * On failure, it will return a string with various error messages. */
+         * On failure, it will return a string with various error messages.
+         */
         search(package: string): string;
-        /** Show displays all the packages available in a repository. The repository must be listed in the `/etc/apt/sources.txt` file.
+        /**
+         * Show displays all the packages available in a repository. The repository must be listed in the `/etc/apt/sources.txt` file.
          *
          * If it cannot find a repository, it will return various error messages.
          *
-         * On success, it will return a string containing all packages and their descriptions, with each entry separated by a newline. */
+         * On success, it will return a string containing all packages and their descriptions, with each entry separated by a newline.
+         */
         show(repositoryAddress: string): string;
-        /** Update refreshes the list of available packages after adding a new repository in `/etc/apt/sources.txt`, or if the remote repository has updated its information in `/server/conf/repod.conf`.
+        /**
+         * Update refreshes the list of available packages after adding a new repository in `/etc/apt/sources.txt`, or if the remote repository has updated its information in `/server/conf/repod.conf`.
          *
          * If the update is successful, an empty string will be returned. In case of failure, a string with an error message will be returned.
          *
-         * If for some reason the `/etc/apt/sources.txt` is malformed this method will return false. */
+         * If for some reason the `/etc/apt/sources.txt` is malformed this method will return false.
+         */
         update(): string | false;
     }
     interface SmartAppliance {
         classID: "SmartAppliance";
         /** Returns a string with the appliance model ID. */
         model(): string;
-        /** Overrides the power and temperature settings of the appliance.
+        /**
+         * Overrides the power and temperature settings of the appliance.
          *
-         * If successful, true is returned; otherwise, it returns a string detailing the error. */
+         * If successful, true is returned; otherwise, it returns a string detailing the error.
+         */
         overrideSettings(power: number, temperature: number): true | string;
-        /** Activates or deactivates the sound alarm indicating any appliance malfunction.
+        /**
+         * Activates or deactivates the sound alarm indicating any appliance malfunction.
          *
-         * If successful, true is returned; otherwise, a string containing error details is returned. */
+         * If successful, true is returned; otherwise, a string containing error details is returned.
+         */
         setAlarm(enable: boolean): true | string;
     }
     interface TrafficNet {
         classID: "TrafficNet";
-        /** Accesses the traffic camera system, opening a window with controls to switch between different cameras.
+        /**
+         * Accesses the traffic camera system, opening a window with controls to switch between different cameras.
          *
-         * If the window opens successfully, this method returns true. In case of an error, it returns a string with details. */
+         * If the window opens successfully, this method returns true. In case of an error, it returns a string with details.
+         */
         cameraLinkSystem(): true | string;
         /** Returns string which contains job and name of a NPC. If an error occurs, a string with details is returned. */
         getCredentialsInfo(): string;
-        /** Performs a search for the specified license plate to locate the vehicle.
+        /**
+         * Performs a search for the specified license plate to locate the vehicle.
          *
          * If the vehicle is visible on any camera, the viewer will switch to the camera currently displaying it and return true.
          *
-         * If the vehicle cannot be located or the license plate is incorrect, a string indicating the error is returned. */
+         * If the vehicle cannot be located or the license plate is incorrect, a string indicating the error is returned.
+         */
         locateVehicle(licensePlate: string, password: string): true | string;
     }
 }
@@ -1365,7 +1428,8 @@ declare namespace GreyHack {
         /**
          * Returns an array where each item is an open port related to the device of the provided LAN IP address. The device needs to be within the network of the router.
          *
-         * In case of failure, this method will return null or a string with details. In case an empty ip is provided this method will throw a runtime exception. */
+         * In case of failure, this method will return null or a string with details. In case an empty ip is provided this method will throw a runtime exception.
+         */
         devicePorts(ip: string): Port[] | string | null;
         /**
          * Returns an array where each item is a string representing a LAN IP address.
@@ -1448,7 +1512,7 @@ declare namespace GreyHack {
          *
          * In case of failure, this method will return a string with the cause. Otherwise, true will be returned. In case the string for sourceFile or destinationFolder is empty, an error will be thrown, preventing further script execution. Utilizing this method in an SSH encryption process will trigger an error, halting further script execution.
          */
-        scp(file: string, folder: string, remoteShell: Shell, isUpload?: boolean): boolean | string;
+        scp(file: string, folder: string, remoteShell: Shell, isUpload?: boolean): true | string;
         /**
          * Launches an active terminal.
          *
@@ -1540,12 +1604,23 @@ interface String {
      * In case the string is not numeric it will return the original string.
      */
     toInt(): string | number;
-    /** Removes the leading and trailing white space and line terminator characters from a string. */
+    /** Removes the leading and trailing white space characters from a string. */
     trim(): string;
     /** Returns a number which is parsed from the string. In case the string is not numeric it will return a zero. */
     val(): number;
     /** Returns an array where each item is a string representing all available characters in the string. Could be compared to using {@link String.split|split} but with empty separator. */
     values(): string[];
+    /** Removes the leading white space characters from a string. */
+    trimStart(): string;
+    /** Removes the trailing white space characters from a string. */
+    trimEnd(): string;
+    /**
+     * Returns true if searchString appears as a substring of this string, at one or more positions that are greater than or equal to position; otherwise, returns false.
+     *
+     * @param searchString search string
+     * @param position If position is undefined, 0 is assumed, so as to search all of the string.
+     */
+    includes(searchString: string, position?: number): boolean;
     /** Returns true if this string starts with the searchString. Otherwise returns false. */
     startsWith(searchString: string, position?: number): boolean;
     /** Returns true if this string ends with the searchString. Otherwise returns false. */
@@ -1569,6 +1644,11 @@ interface String {
 interface Number {
     /** Returns a string representation of a number. */
     toString(): string;
+    /**
+     * Returns a string representing a number in fixed-point notation.
+     * @param fractionDigits Number of digits after the decimal point.
+     */
+    toFixed(fractionDigits?: number): string;
 }
 type PropertyKey = number | string | symbol;
 interface Object {
@@ -1681,7 +1761,19 @@ interface Array<T> {
     /** Returns a sum of all values inside the array. Any non-numeric values will be considered a zero. */
     sum(): number;
     values(): T[];
-    /** Combines two or more arrays. This method returns a new array without modifying any existing arrays.
+    /**
+    * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
+    * @param value value to fill array section with
+    * @param start index to start filling the array at. If start is negative, it is treated as
+    * length+start where length is the length of the array.
+    * @param end index to stop filling the array at. If end is negative, it is treated as
+    * length+end.
+    */
+    fill(value: T, start?: number, end?: number): this;
+    /** Determines whether an array includes a certain element, returning true or false as appropriate. */
+    includes(searchElement: T, fromIndex?: number): boolean;
+    /**
+     * Combines two or more arrays. This method returns a new array without modifying any existing arrays.
      * @param items Additional arrays and/or items to add to the end of the array.
      */
     concat(...items: (T | T[])[]): T[];
@@ -1695,13 +1787,22 @@ interface Array<T> {
     some(predicate: (value: T, index: number, array: T[]) => unknown): boolean;
     /** Determines whether all the members of an array satisfy the specified test. */
     every(predicate: (value: T, index: number, array: T[]) => unknown): boolean;
-    /** Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array.
+    /**
+     * Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array.
      *
      * For example, -2 refers to the second to last element of the array.
      * @param start The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
      * @param end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.
      * */
     slice(start?: number, end?: number): T[];
+    /**
+     * Removes elements from an array and returns the deleted elements.
+     *
+     * For example, -2 refers to the second to last element of the array.
+     * @param start  The zero-based location in the array from which to start removing elements
+     * @param end The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array.
+     * */
+    splice(start: number, deleteCount?: number): T[];
     /** Returns a string representation of an array. */
     toString(): string;
     [n: number]: T;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@grey-ts/types",
-	"version": "2.0.1",
+	"version": "2.2.0",
 	"description": "TypeScript definitions for GreyHack's functions and objects",
 	"license": "MIT",
 	"types": "dist/index.d.ts",