ayiin 2.0.0 → 2.0.1

package/ayiin/methods/index.d.ts

@@ -9,15 +9,55 @@ declare class BaseMethods<C extends Crypt, M extends Mailer, T extends Tools> {
     mailer: M;
     tools: T;
     constructor(options?: Options);
+    /**
+     * Converts an ASCII string to its corresponding Hex representation.
+     * @param {string} asciiString - The ASCII string to be converted.
+     * @returns {string} - The Hex representation of the ASCII string.
+     */
     asciiToHex: (asciiString: string) => string;
+    /**
+     * Converts a Hex string to its corresponding ASCII representation.
+     * @param {string} hexString - The Hex string to be converted.
+     * @returns {string} - The ASCII representation of the Hex string.
+     */
     hexToAscii: (hexString: string) => string;
+    /**
+     * Encrypts a plaintext message using the given key.
+     * @param {string} text - The plaintext message to be encrypted.
+     * @param {string} key - The encryption key.
+     * @returns {string} - The encrypted data in Hex format.
+     */
     encrypt: (text: string, key: string, bufferEncoding?: BufferEncoding) => string;
+    /**
+     * Decrypts an encrypted message using the given key.
+     * @param {string} encrypted - The encrypted data in Hex format.
+     * @param {string} key - The decryption key.
+     * @returns {string} - The decrypted plaintext message.
+     */
     decrypt: (text: string, key: string, bufferEncoding?: BufferEncoding) => string;
     md5: (data: string, encoding: BinaryToTextEncoding) => string;
+    /**
+     * Send an email
+     * @param {Mail.Options} options
+     * */
     sendMail: (options: Mail.Options) => Promise<{
         success: boolean;
         message: string;
     }>;
+    /**
+     * Format money
+     * @returns {string}
+     * @memberof Tools
+     * @param {number} amount
+     * @param {"long" | "short"} [compactDisplay="long"]
+     * */
+    formatMoney: (value: number) => string;
+    /**
+     * Generate a random string
+     * @returns {string}
+     * @memberof Tools
+     * @param {number} length
+     * */
     randomString: (length: number) => string;
 }
 declare class Methods extends BaseMethods<Crypt, Mailer, Tools> {

package/ayiin/methods/index.js

@@ -17,12 +17,52 @@ const tools_1 = __importDefault(require("./tools"));
 const mailer_1 = __importDefault(require("./mailer"));
 class BaseMethods {
     constructor(options) {
+        /**
+         * Converts an ASCII string to its corresponding Hex representation.
+         * @param {string} asciiString - The ASCII string to be converted.
+         * @returns {string} - The Hex representation of the ASCII string.
+         */
         this.asciiToHex = (asciiString) => this.crypt.asciiToHex(asciiString);
+        /**
+         * Converts a Hex string to its corresponding ASCII representation.
+         * @param {string} hexString - The Hex string to be converted.
+         * @returns {string} - The ASCII representation of the Hex string.
+         */
         this.hexToAscii = (hexString) => this.crypt.hexToAscii(hexString);
+        /**
+         * Encrypts a plaintext message using the given key.
+         * @param {string} text - The plaintext message to be encrypted.
+         * @param {string} key - The encryption key.
+         * @returns {string} - The encrypted data in Hex format.
+         */
         this.encrypt = (text, key, bufferEncoding) => this.crypt.encrypt(text, key, bufferEncoding);
+        /**
+         * Decrypts an encrypted message using the given key.
+         * @param {string} encrypted - The encrypted data in Hex format.
+         * @param {string} key - The decryption key.
+         * @returns {string} - The decrypted plaintext message.
+         */
         this.decrypt = (text, key, bufferEncoding) => this.crypt.decrypt(text, key, bufferEncoding);
         this.md5 = (data, encoding) => this.crypt.md5(data, encoding);
+        /**
+         * Send an email
+         * @param {Mail.Options} options
+         * */
         this.sendMail = (options) => __awaiter(this, void 0, void 0, function* () { return yield this.mailer.sendMail(options); });
+        /**
+         * Format money
+         * @returns {string}
+         * @memberof Tools
+         * @param {number} amount
+         * @param {"long" | "short"} [compactDisplay="long"]
+         * */
+        this.formatMoney = (value) => this.tools.formatMoney(value);
+        /**
+         * Generate a random string
+         * @returns {string}
+         * @memberof Tools
+         * @param {number} length
+         * */
         this.randomString = (length) => this.tools.randomString(length);
         this.crypt = new crypt_1.default();
         this.mailer = new mailer_1.default(options);

package/ayiin/methods/mailer.d.ts

@@ -9,6 +9,10 @@ type ResponseMailer = {
 declare class Mailer {
     client?: nodemailer.Transporter<SMTPTransport.SentMessageInfo, SMTPTransport.Options>;
     constructor(opts?: Options);
+    /**
+     * Send an email
+     * @param {Mail.Options} options
+     * */
     sendMail: (options: Mail.Options) => Promise<ResponseMailer>;
 }
 export default Mailer;

package/ayiin/methods/mailer.js

@@ -15,6 +15,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const nodemailer_1 = __importDefault(require("nodemailer"));
 class Mailer {
     constructor(opts) {
+        /**
+         * Send an email
+         * @param {Mail.Options} options
+         * */
         this.sendMail = (options) => __awaiter(this, void 0, void 0, function* () {
             return yield new Promise((resolve, reject) => {
                 if (!this.client) {

package/ayiin/methods/tools.d.ts

@@ -1,4 +1,11 @@
 declare class Tools {
+    /**
+     * Format money
+     * @returns {string}
+     * @memberof Tools
+     * @param {number} amount
+     * */
+    formatMoney: (amount: number) => string;
     /**
      * Generate a random string
      * @returns {string}

package/ayiin/methods/tools.js

@@ -2,6 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class Tools {
     constructor() {
+        /**
+         * Format money
+         * @returns {string}
+         * @memberof Tools
+         * @param {number} amount
+         * */
+        this.formatMoney = (amount) => {
+            return new Intl.NumberFormat('id-ID', {
+                style: 'currency',
+                currency: 'IDR'
+            }).format(amount);
+        };
         /**
          * Generate a random string
          * @returns {string}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "ayiin",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Library Pribadi Yang Gak Ada Isinya",
   "main": "ayiin/index.js",
   "scripts": {
     "build": "yarn tsc"
   },
-  "repository": "https://github.com/AyiinXd/midtrans",
+  "repository": "https://github.com/AyiinXd/ayiin",
   "author": {
     "name": "AyiinXd",
     "url": "https://github.com/AyiinXd"